Class: Tag

Inherits:
ApplicationRecord show all
Includes:
Housekeeping, Shared::AttributeAnnotations, Shared::IsData, Shared::MatrixHooks, Shared::PolymorphicAnnotator
Defined in:
app/models/tag.rb

Overview

A Tag links a ControlledVocabularyTerm::Keyword to a Data object.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Housekeeping

#has_polymorphic_relationship?

Methods included from ActiverecordUtilities

#trim_attributes

Instance Attribute Details

- (Integer) keyword_id

Returns the keyword used in this tag

Returns:

  • (Integer)

    the keyword used in this tag



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'app/models/tag.rb', line 27

class Tag < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::AttributeAnnotations
  include Shared::MatrixHooks
  include Shared::PolymorphicAnnotator
  polymorphic_annotates(:tag_object)
  acts_as_list scope: [:tag_object_id, :tag_object_type, :keyword_id]

  belongs_to :keyword, inverse_of: :tags, validate: true
  belongs_to :controlled_vocabulary_term, foreign_key: :keyword_id, inverse_of: :tags # Not all tagged subclasses are Keyword based, use this object for display

  validates :keyword, presence: true
  validate :keyword_is_allowed_on_object
  validate :object_can_be_tagged_with_keyword

  validates_uniqueness_of :keyword_id, scope: [:tag_object_id, :tag_object_type]

  accepts_nested_attributes_for :keyword, reject_if: :reject_keyword, allow_destroy: true

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or objects.empty?
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # The column name containing the attribute name being annotated
  def self.annotated_attribute_column
    :tag_object_attribute
  end

  # @return [{"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false]
  #   the hash corresponding to the keyword used in this tag if it exists
  def matrix_column_item
    mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mci.any?
      return { :matrix_column_item => mci.first, :descriptor => tag_object }
    else
      return false
    end
  end

  # @return [{"matrix_row_item": matrix_column_item, "object": object}, false]
  # the hash corresponding to the keyword used in this tag if it exists
  def matrix_row_item
    mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mri.any?
      return { :matrix_row_item => mri.first, :object => tag_object }
    else
      return false
    end
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or !objects.any?
    raise 'cross project tagging of objects detected' if objects.first.project_id != Keyword.find(keyword_id).project_id
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # @return [Boolean]
  #   destroy all tags with the keyword_id provided, true if success, false if failure
  def self.batch_remove(keyword_id, klass = nil)
    return false if keyword_id.blank?
    if klass.blank?
      return true if Tag.where(keyword_id: keyword_id).destroy_all
    else
      return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
    end
    false
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

end

- (Integer) position

Returns a user definable sort code on the tags on an object, handled by acts_as_list

Returns:

  • (Integer)

    a user definable sort code on the tags on an object, handled by acts_as_list



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'app/models/tag.rb', line 27

class Tag < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::AttributeAnnotations
  include Shared::MatrixHooks
  include Shared::PolymorphicAnnotator
  polymorphic_annotates(:tag_object)
  acts_as_list scope: [:tag_object_id, :tag_object_type, :keyword_id]

  belongs_to :keyword, inverse_of: :tags, validate: true
  belongs_to :controlled_vocabulary_term, foreign_key: :keyword_id, inverse_of: :tags # Not all tagged subclasses are Keyword based, use this object for display

  validates :keyword, presence: true
  validate :keyword_is_allowed_on_object
  validate :object_can_be_tagged_with_keyword

  validates_uniqueness_of :keyword_id, scope: [:tag_object_id, :tag_object_type]

  accepts_nested_attributes_for :keyword, reject_if: :reject_keyword, allow_destroy: true

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or objects.empty?
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # The column name containing the attribute name being annotated
  def self.annotated_attribute_column
    :tag_object_attribute
  end

  # @return [{"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false]
  #   the hash corresponding to the keyword used in this tag if it exists
  def matrix_column_item
    mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mci.any?
      return { :matrix_column_item => mci.first, :descriptor => tag_object }
    else
      return false
    end
  end

  # @return [{"matrix_row_item": matrix_column_item, "object": object}, false]
  # the hash corresponding to the keyword used in this tag if it exists
  def matrix_row_item
    mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mri.any?
      return { :matrix_row_item => mri.first, :object => tag_object }
    else
      return false
    end
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or !objects.any?
    raise 'cross project tagging of objects detected' if objects.first.project_id != Keyword.find(keyword_id).project_id
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # @return [Boolean]
  #   destroy all tags with the keyword_id provided, true if success, false if failure
  def self.batch_remove(keyword_id, klass = nil)
    return false if keyword_id.blank?
    if klass.blank?
      return true if Tag.where(keyword_id: keyword_id).destroy_all
    else
      return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
    end
    false
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

end

- (Integer) project_id

the project ID

Returns:

  • (Integer)


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'app/models/tag.rb', line 27

class Tag < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::AttributeAnnotations
  include Shared::MatrixHooks
  include Shared::PolymorphicAnnotator
  polymorphic_annotates(:tag_object)
  acts_as_list scope: [:tag_object_id, :tag_object_type, :keyword_id]

  belongs_to :keyword, inverse_of: :tags, validate: true
  belongs_to :controlled_vocabulary_term, foreign_key: :keyword_id, inverse_of: :tags # Not all tagged subclasses are Keyword based, use this object for display

  validates :keyword, presence: true
  validate :keyword_is_allowed_on_object
  validate :object_can_be_tagged_with_keyword

  validates_uniqueness_of :keyword_id, scope: [:tag_object_id, :tag_object_type]

  accepts_nested_attributes_for :keyword, reject_if: :reject_keyword, allow_destroy: true

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or objects.empty?
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # The column name containing the attribute name being annotated
  def self.annotated_attribute_column
    :tag_object_attribute
  end

  # @return [{"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false]
  #   the hash corresponding to the keyword used in this tag if it exists
  def matrix_column_item
    mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mci.any?
      return { :matrix_column_item => mci.first, :descriptor => tag_object }
    else
      return false
    end
  end

  # @return [{"matrix_row_item": matrix_column_item, "object": object}, false]
  # the hash corresponding to the keyword used in this tag if it exists
  def matrix_row_item
    mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mri.any?
      return { :matrix_row_item => mri.first, :object => tag_object }
    else
      return false
    end
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or !objects.any?
    raise 'cross project tagging of objects detected' if objects.first.project_id != Keyword.find(keyword_id).project_id
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # @return [Boolean]
  #   destroy all tags with the keyword_id provided, true if success, false if failure
  def self.batch_remove(keyword_id, klass = nil)
    return false if keyword_id.blank?
    if klass.blank?
      return true if Tag.where(keyword_id: keyword_id).destroy_all
    else
      return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
    end
    false
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

end

- (String) tag_object_attribute

Returns the specific attribute being referenced with the tag (not required)

Returns:

  • (String)

    the specific attribute being referenced with the tag (not required)



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'app/models/tag.rb', line 27

class Tag < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::AttributeAnnotations
  include Shared::MatrixHooks
  include Shared::PolymorphicAnnotator
  polymorphic_annotates(:tag_object)
  acts_as_list scope: [:tag_object_id, :tag_object_type, :keyword_id]

  belongs_to :keyword, inverse_of: :tags, validate: true
  belongs_to :controlled_vocabulary_term, foreign_key: :keyword_id, inverse_of: :tags # Not all tagged subclasses are Keyword based, use this object for display

  validates :keyword, presence: true
  validate :keyword_is_allowed_on_object
  validate :object_can_be_tagged_with_keyword

  validates_uniqueness_of :keyword_id, scope: [:tag_object_id, :tag_object_type]

  accepts_nested_attributes_for :keyword, reject_if: :reject_keyword, allow_destroy: true

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or objects.empty?
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # The column name containing the attribute name being annotated
  def self.annotated_attribute_column
    :tag_object_attribute
  end

  # @return [{"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false]
  #   the hash corresponding to the keyword used in this tag if it exists
  def matrix_column_item
    mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mci.any?
      return { :matrix_column_item => mci.first, :descriptor => tag_object }
    else
      return false
    end
  end

  # @return [{"matrix_row_item": matrix_column_item, "object": object}, false]
  # the hash corresponding to the keyword used in this tag if it exists
  def matrix_row_item
    mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mri.any?
      return { :matrix_row_item => mri.first, :object => tag_object }
    else
      return false
    end
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or !objects.any?
    raise 'cross project tagging of objects detected' if objects.first.project_id != Keyword.find(keyword_id).project_id
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # @return [Boolean]
  #   destroy all tags with the keyword_id provided, true if success, false if failure
  def self.batch_remove(keyword_id, klass = nil)
    return false if keyword_id.blank?
    if klass.blank?
      return true if Tag.where(keyword_id: keyword_id).destroy_all
    else
      return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
    end
    false
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

end

- (Integer) tag_object_id

Returns Rails polymorphic, id of the object being tagged

Returns:

  • (Integer)

    Rails polymorphic, id of the object being tagged



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'app/models/tag.rb', line 27

class Tag < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::AttributeAnnotations
  include Shared::MatrixHooks
  include Shared::PolymorphicAnnotator
  polymorphic_annotates(:tag_object)
  acts_as_list scope: [:tag_object_id, :tag_object_type, :keyword_id]

  belongs_to :keyword, inverse_of: :tags, validate: true
  belongs_to :controlled_vocabulary_term, foreign_key: :keyword_id, inverse_of: :tags # Not all tagged subclasses are Keyword based, use this object for display

  validates :keyword, presence: true
  validate :keyword_is_allowed_on_object
  validate :object_can_be_tagged_with_keyword

  validates_uniqueness_of :keyword_id, scope: [:tag_object_id, :tag_object_type]

  accepts_nested_attributes_for :keyword, reject_if: :reject_keyword, allow_destroy: true

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or objects.empty?
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # The column name containing the attribute name being annotated
  def self.annotated_attribute_column
    :tag_object_attribute
  end

  # @return [{"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false]
  #   the hash corresponding to the keyword used in this tag if it exists
  def matrix_column_item
    mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mci.any?
      return { :matrix_column_item => mci.first, :descriptor => tag_object }
    else
      return false
    end
  end

  # @return [{"matrix_row_item": matrix_column_item, "object": object}, false]
  # the hash corresponding to the keyword used in this tag if it exists
  def matrix_row_item
    mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mri.any?
      return { :matrix_row_item => mri.first, :object => tag_object }
    else
      return false
    end
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or !objects.any?
    raise 'cross project tagging of objects detected' if objects.first.project_id != Keyword.find(keyword_id).project_id
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # @return [Boolean]
  #   destroy all tags with the keyword_id provided, true if success, false if failure
  def self.batch_remove(keyword_id, klass = nil)
    return false if keyword_id.blank?
    if klass.blank?
      return true if Tag.where(keyword_id: keyword_id).destroy_all
    else
      return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
    end
    false
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

end

- (String) tag_object_type

Returns Rails polymorphic, type of the object being tagged

Returns:

  • (String)

    Rails polymorphic, type of the object being tagged



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'app/models/tag.rb', line 27

class Tag < ApplicationRecord
  include Housekeeping
  include Shared::IsData
  include Shared::AttributeAnnotations
  include Shared::MatrixHooks
  include Shared::PolymorphicAnnotator
  polymorphic_annotates(:tag_object)
  acts_as_list scope: [:tag_object_id, :tag_object_type, :keyword_id]

  belongs_to :keyword, inverse_of: :tags, validate: true
  belongs_to :controlled_vocabulary_term, foreign_key: :keyword_id, inverse_of: :tags # Not all tagged subclasses are Keyword based, use this object for display

  validates :keyword, presence: true
  validate :keyword_is_allowed_on_object
  validate :object_can_be_tagged_with_keyword

  validates_uniqueness_of :keyword_id, scope: [:tag_object_id, :tag_object_type]

  accepts_nested_attributes_for :keyword, reject_if: :reject_keyword, allow_destroy: true

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or objects.empty?
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # The column name containing the attribute name being annotated
  def self.annotated_attribute_column
    :tag_object_attribute
  end

  # @return [{"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false]
  #   the hash corresponding to the keyword used in this tag if it exists
  def matrix_column_item
    mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mci.any?
      return { :matrix_column_item => mci.first, :descriptor => tag_object }
    else
      return false
    end
  end

  # @return [{"matrix_row_item": matrix_column_item, "object": object}, false]
  # the hash corresponding to the keyword used in this tag if it exists
  def matrix_row_item
    mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

    if mri.any?
      return { :matrix_row_item => mri.first, :object => tag_object }
    else
      return false
    end
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

  def self.tag_objects(objects, keyword_id = nil)
    return nil if keyword_id.nil? or !objects.any?
    raise 'cross project tagging of objects detected' if objects.first.project_id != Keyword.find(keyword_id).project_id
    objects.each do |o|
      o.tags << Tag.new(keyword_id: keyword_id)
    end
  end

  def self.exists?(global_id, keyword_id, project_id)
    o = GlobalID::Locator.locate(global_id)
    return false unless o
    Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
  end

  # @return [Boolean]
  #   destroy all tags with the keyword_id provided, true if success, false if failure
  def self.batch_remove(keyword_id, klass = nil)
    return false if keyword_id.blank?
    if klass.blank?
      return true if Tag.where(keyword_id: keyword_id).destroy_all
    else
      return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
    end
    false
  end

  protected

  def keyword_is_allowed_on_object
    return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
    if !keyword.can_tag.include?(tag_object.class.name)
      errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
    end
  end

  def object_can_be_tagged_with_keyword
    return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
    if !tag_object.taggable_with.include?(keyword.class.name)
      errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
    end
  end

  def reject_keyword(attributed)
    attributed['name'].blank? || attributed['definition'].blank?
  end

end

Class Method Details

+ (Object) annotated_attribute_column

The column name containing the attribute name being annotated



61
62
63
# File 'app/models/tag.rb', line 61

def self.annotated_attribute_column
  :tag_object_attribute
end

+ (Boolean) batch_remove(keyword_id, klass = nil) (protected)

Returns destroy all tags with the keyword_id provided, true if success, false if failure

Returns:

  • (Boolean)

    destroy all tags with the keyword_id provided, true if success, false if failure



125
126
127
128
129
130
131
132
133
# File 'app/models/tag.rb', line 125

def self.batch_remove(keyword_id, klass = nil)
  return false if keyword_id.blank?
  if klass.blank?
    return true if Tag.where(keyword_id: keyword_id).destroy_all
  else
    return true if Tag.where(keyword_id: keyword_id, tag_object_type: klass).destroy_all
  end
  false
end

+ (Boolean) exists?(global_id, keyword_id, project_id) (protected)

Returns:

  • (Boolean)


54
55
56
57
58
# File 'app/models/tag.rb', line 54

def self.exists?(global_id, keyword_id, project_id)
  o = GlobalID::Locator.locate(global_id)
  return false unless o
  Tag.where(project_id: project_id, tag_object: o, keyword_id: keyword_id).first
end

+ (Object) tag_objects(objects, keyword_id = nil) (protected)



47
48
49
50
51
52
# File 'app/models/tag.rb', line 47

def self.tag_objects(objects, keyword_id = nil)
  return nil if keyword_id.nil? or objects.empty?
  objects.each do |o|
    o.tags << Tag.new(keyword_id: keyword_id)
  end
end

Instance Method Details

- (Object) keyword_is_allowed_on_object (protected)



91
92
93
94
95
96
# File 'app/models/tag.rb', line 91

def keyword_is_allowed_on_object
  return true if keyword.nil? || tag_object.nil? || !keyword.respond_to?(:can_tag)
  if !keyword.can_tag.include?(tag_object.class.name)
    errors.add(:keyword, "this keyword class (#{tag_object.class}) can not be attached to a #{tag_object_type}")
  end
end

- ({"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false) matrix_column_item

Returns the hash corresponding to the keyword used in this tag if it exists

Returns:

  • ({"matrix_column_item": matrix_column_item, "descriptor": descriptor}, false)

    the hash corresponding to the keyword used in this tag if it exists



67
68
69
70
71
72
73
74
75
# File 'app/models/tag.rb', line 67

def matrix_column_item
  mci = ObservationMatrixColumnItem::TaggedDescriptor.where(controlled_vocabulary_term_id: keyword_id).limit(1)

  if mci.any?
    return { :matrix_column_item => mci.first, :descriptor => tag_object }
  else
    return false
  end
end

- ({"matrix_row_item": matrix_column_item, "object": object}, false) matrix_row_item

the hash corresponding to the keyword used in this tag if it exists

Returns:

  • ({"matrix_row_item": matrix_column_item, "object": object}, false)


79
80
81
82
83
84
85
86
87
# File 'app/models/tag.rb', line 79

def matrix_row_item
  mri = ObservationMatrixRowItem::TaggedRowItem.where(controlled_vocabulary_term_id: keyword_id).limit(1)

  if mri.any?
    return { :matrix_row_item => mri.first, :object => tag_object }
  else
    return false
  end
end

- (Object) object_can_be_tagged_with_keyword (protected)



98
99
100
101
102
103
# File 'app/models/tag.rb', line 98

def object_can_be_tagged_with_keyword
  return true if keyword.nil? || tag_object.nil? || !tag_object.respond_to?(:taggable_with)
  if !tag_object.taggable_with.include?(keyword.class.name)
    errors.add(:tag_object, "this tag_object_type (#{tag_object.class}) can not be tagged with this keyword class (#{keyword.class})")
  end
end

- (Object) reject_keyword(attributed) (protected)



105
106
107
# File 'app/models/tag.rb', line 105

def reject_keyword(attributed)
  attributed['name'].blank? || attributed['definition'].blank?
end