Module: ActsAsTaggableOn::Taggable::Ownership

Defined in:
lib/acts_as_taggable_on/taggable/ownership.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object


3
4
5
6
7
8
9
10
11
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 3

def self.included(base)
  base.extend ActsAsTaggableOn::Taggable::Ownership::ClassMethods

  base.class_eval do
    after_save :save_owned_tags
  end

  base.initialize_acts_as_taggable_on_ownership
end

Instance Method Details

#cached_owned_tag_list_on(context) ⇒ Object


59
60
61
62
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 59

def cached_owned_tag_list_on(context)
  variable_name = "@owned_#{context}_list"
  (instance_variable_defined?(variable_name) && instance_variable_get(variable_name)) || instance_variable_set(variable_name, {})
end

#owner_tag_list_on(owner, context) ⇒ Object


64
65
66
67
68
69
70
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 64

def owner_tag_list_on(owner, context)
  add_custom_context(context)

  cache = cached_owned_tag_list_on(context)

  cache[owner] ||= ActsAsTaggableOn::TagList.new(*owner_tags_on(owner, context).map(&:name))
end

#owner_tags(owner) ⇒ Object


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 30

def owner_tags(owner)
  if owner.nil?
    scope = base_tags
  else
    scope = base_tags.where(
      "#{ActsAsTaggableOn::Tagging.table_name}" => {
        tagger_id: owner.id,
        tagger_type: owner.class.base_class.to_s
      }
    )
  end

  # when preserving tag order, return tags in created order
  # if we added the order to the association this would always apply
  if self.class.preserve_tag_order?
    scope.order("#{ActsAsTaggableOn::Tagging.table_name}.id")
  else
    scope
  end
end

#owner_tags_on(owner, context) ⇒ Object


51
52
53
54
55
56
57
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 51

def owner_tags_on(owner, context)
  owner_tags(owner).where(
    "#{ActsAsTaggableOn::Tagging.table_name}" => {
      context: context
    }
  )
end

#reload(*args) ⇒ Object


80
81
82
83
84
85
86
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 80

def reload(*args)
  self.class.tag_types.each do |context|
    instance_variable_set("@owned_#{context}_list", nil)
  end

  super(*args)
end

#save_owned_tagsObject


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
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 88

def save_owned_tags
  tagging_contexts.each do |context|
    cached_owned_tag_list_on(context).each do |owner, tag_list|

      # Find existing tags or create non-existing tags:
      tags = find_or_create_tags_from_list_with_context(tag_list.uniq, context)

      # Tag objects for owned tags
      owned_tags = owner_tags_on(owner, context).to_a

      # Tag maintenance based on whether preserving the created order of tags
      if self.class.preserve_tag_order?
        old_tags, new_tags = owned_tags - tags, tags - owned_tags

        shared_tags = owned_tags & tags

        if shared_tags.any? && tags[0...shared_tags.size] != shared_tags
          index = shared_tags.each_with_index { |_, i| break i unless shared_tags[i] == tags[i] }

          # Update arrays of tag objects
          old_tags |= owned_tags.from(index)
          new_tags |= owned_tags.from(index) & shared_tags

          # Order the array of tag objects to match the tag list
          new_tags = tags.map { |t| new_tags.find { |n| n.name.downcase == t.name.downcase } }.compact
        end
      else
        # Delete discarded tags and create new tags
        old_tags = owned_tags - tags
        new_tags = tags - owned_tags
      end

      # Find all taggings that belong to the taggable (self), are owned by the owner,
      # have the correct context, and are removed from the list.
      ActsAsTaggableOn::Tagging.where(taggable_id: id, taggable_type: self.class.base_class.to_s,
                                      tagger_type: owner.class.base_class.to_s, tagger_id: owner.id,
                                      tag_id: old_tags, context: context).destroy_all if old_tags.present?

      # Create new taggings:
      new_tags.each do |tag|
        taggings.create!(tag_id: tag.id, context: context.to_s, tagger: owner, taggable: self)
      end
    end
  end

  true
end

#set_owner_tag_list_on(owner, context, new_list) ⇒ Object


72
73
74
75
76
77
78
# File 'lib/acts_as_taggable_on/taggable/ownership.rb', line 72

def set_owner_tag_list_on(owner, context, new_list)
  add_custom_context(context)

  cache = cached_owned_tag_list_on(context)

  cache[owner] = ActsAsTaggableOn.default_parser.new(new_list).parse
end