module ActsAsTaggableOn::Taggable::Ownership

Public Class Methods

included(base) click to toggle source
# 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

Public Instance Methods

cached_owned_tag_list_on(context) click to toggle source
# File lib/acts_as_taggable_on/taggable/ownership.rb, line 48
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) click to toggle source
# File lib/acts_as_taggable_on/taggable/ownership.rb, line 53
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_on(owner, context) click to toggle source
# File lib/acts_as_taggable_on/taggable/ownership.rb, line 30
def owner_tags_on(owner, context)
  if owner.nil?
    scope = base_tags.where([%Q(#{ActsAsTaggableOn::Tagging.table_name}.context = ?), context.to_s])
  else
    scope = base_tags.where([%Q(#{ActsAsTaggableOn::Tagging.table_name}.context = ? AND
                                #{ActsAsTaggableOn::Tagging.table_name}.tagger_id = ? AND
                                #{ActsAsTaggableOn::Tagging.table_name}.tagger_type = ?), context.to_s, owner.id, 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
reload(*args) click to toggle source
Calls superclass method
# File lib/acts_as_taggable_on/taggable/ownership.rb, line 69
def reload(*args)
  self.class.tag_types.each do |context|
    instance_variable_set("@owned_#{context}_list", nil)
  end

  super(*args)
end
save_owned_tags() click to toggle source
# File lib/acts_as_taggable_on/taggable/ownership.rb, line 77
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) click to toggle source
# File lib/acts_as_taggable_on/taggable/ownership.rb, line 61
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