axtro-acts-as-taggable-on 2.0.4

data/lib/acts_as_taggable_on/acts_as_taggable_on/ownership.rb

@@ -0,0 +1,101 @@
+module ActsAsTaggableOn::Taggable
+  module Ownership
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Ownership::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Ownership::ClassMethods
+     
+      base.class_eval do
+        after_save :save_owned_tags    
+      end
+      
+      base.initialize_acts_as_taggable_on_ownership
+    end
+    
+    module ClassMethods
+      def acts_as_taggable_on(*args)
+        initialize_acts_as_taggable_on_ownership
+        super(*args)
+      end
+      
+      def initialize_acts_as_taggable_on_ownership      
+        tag_types.map(&:to_s).each do |tag_type|
+          class_eval %(
+            def #{tag_type}_from(owner)
+              owner_tag_list_on(owner, '#{tag_type}')
+            end      
+          )
+        end        
+      end
+    end
+    
+    module InstanceMethods
+      def owner_tags_on(owner, context)
+        base_tags.where([%(#{Tagging.table_name}.context = ? AND
+                           #{Tagging.table_name}.tagger_id = ? AND
+                           #{Tagging.table_name}.tagger_type = ?), context.to_s, owner.id, owner.class.to_s]).all
+      end
+
+      def cached_owned_tag_list_on(context)
+        variable_name = "@owned_#{context}_list"
+        cache = instance_variable_get(variable_name) || instance_variable_set(variable_name, {})
+      end
+      
+      def owner_tag_list_on(owner, context)
+        add_custom_context(context)
+
+        cache = cached_owned_tag_list_on(context)
+        cache.delete_if { |key, value| key.id == owner.id && key.class == owner.class }
+        
+        cache[owner] ||= TagList.new(*owner_tags_on(owner, context).map(&:name))
+      end
+      
+      def set_owner_tag_list_on(owner, context, new_list)
+        add_custom_context(context)
+        
+        cache = cached_owned_tag_list_on(context)
+        cache.delete_if { |key, value| key.id == owner.id && key.class == owner.class }
+
+        cache[owner] = TagList.from(new_list)
+      end
+      
+      def reload
+        self.class.tag_types.each do |context|
+          instance_variable_set("@owned_#{context}_list", nil)
+        end
+      
+        super
+      end
+    
+      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:
+            tag_list = Tag.find_or_create_all_with_like_by_name(tag_list.uniq)            
+
+            owned_tags = owner_tags_on(owner, context)              
+            old_tags   = owned_tags - tag_list
+            new_tags   = tag_list   - owned_tags
+          
+            # Find all taggings that belong to the taggable (self), are owned by the owner, 
+            # have the correct context, and are removed from the list.
+            old_taggings = Tagging.where(:taggable_id => id, :taggable_type => self.class.base_class.to_s,
+                                         :tagger_type => owner.class.to_s, :tagger_id => owner.id,
+                                         :tag_id => old_tags, :context => context).all
+          
+            if old_taggings.present?
+              # Destroy old taggings:
+              Tagging.destroy_all(:id => old_taggings.map(&:id))
+            end
+
+            # 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
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_taggable_on/related.rb

@@ -0,0 +1,65 @@
+module ActsAsTaggableOn::Taggable
+  module Related
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Related::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Related::ClassMethods
+      base.initialize_acts_as_taggable_on_related
+    end
+    
+    module ClassMethods
+      def initialize_acts_as_taggable_on_related
+        tag_types.map(&:to_s).each do |tag_type|
+          class_eval %(
+            def find_related_#{tag_type}(options = {})
+              related_tags_for('#{tag_type}', self.class, options)
+            end
+            alias_method :find_related_on_#{tag_type}, :find_related_#{tag_type}
+
+            def find_related_#{tag_type}_for(klass, options = {})
+              related_tags_for('#{tag_type}', klass, options)
+            end
+
+            def find_matching_contexts(search_context, result_context, options = {})
+              matching_contexts_for(search_context.to_s, result_context.to_s, self.class, options)
+            end
+
+            def find_matching_contexts_for(klass, search_context, result_context, options = {})
+              matching_contexts_for(search_context.to_s, result_context.to_s, klass, options)
+            end
+          )
+        end        
+      end
+      
+      def acts_as_taggable_on(*args)
+        super(*args)
+        initialize_acts_as_taggable_on_related
+      end
+    end
+    
+    module InstanceMethods
+      def matching_contexts_for(search_context, result_context, klass, options = {})
+        tags_to_find = tags_on(search_context).collect { |t| t.name }
+
+        exclude_self = "#{klass.table_name}.id != #{id} AND" if self.class == klass
+        
+        klass.scoped({ :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
+                       :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
+                       :conditions => ["#{exclude_self} #{klass.table_name}.id = #{Tagging.table_name}.taggable_id AND #{Tagging.table_name}.taggable_type = '#{klass.to_s}' AND #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND #{Tag.table_name}.name IN (?) AND #{Tagging.table_name}.context = ?", tags_to_find, result_context],
+                       :group      => grouped_column_names_for(klass),
+                       :order      => "count DESC" }.update(options))
+      end
+      
+      def related_tags_for(context, klass, options = {})
+        tags_to_find = tags_on(context).collect { |t| t.name }
+
+        exclude_self = "#{klass.table_name}.id != #{id} AND" if self.class == klass
+
+        klass.scoped({ :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
+                       :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
+                       :conditions => ["#{exclude_self} #{klass.table_name}.id = #{Tagging.table_name}.taggable_id AND #{Tagging.table_name}.taggable_type = '#{klass.to_s}' AND #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND #{Tag.table_name}.name IN (?)", tags_to_find],
+                       :group      => grouped_column_names_for(klass),
+                       :order      => "count DESC" }.update(options))
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_tagger.rb

@@ -0,0 +1,67 @@
+module ActsAsTaggableOn
+  module Tagger
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      ##
+      # Make a model a tagger. This allows an instance of a model to claim ownership
+      # of tags.
+      #
+      # Example:
+      #   class User < ActiveRecord::Base
+      #     acts_as_tagger
+      #   end
+      def acts_as_tagger(opts={})
+        class_eval do
+          has_many :owned_taggings, opts.merge(:as => :tagger, :dependent => :destroy,
+                                               :include => :tag, :class_name => "Tagging")
+          has_many :owned_tags, :through => :owned_taggings, :source => :tag, :uniq => true
+        end
+
+        include ActsAsTaggableOn::Tagger::InstanceMethods
+        extend ActsAsTaggableOn::Tagger::SingletonMethods
+      end
+
+      def is_tagger?
+        false
+      end
+    end
+
+    module InstanceMethods
+      ##
+      # Tag a taggable model with tags that are owned by the tagger. 
+      #
+      # @param taggable The object that will be tagged
+      # @param [Hash] options An hash with options. Available options are:
+      #               * <tt>:with</tt> - The tags that you want to
+      #               * <tt>:on</tt>   - The context on which you want to tag
+      #
+      # Example:
+      #   @user.tag(@photo, :with => "paris, normandy", :on => :locations)
+      def tag(taggable, opts={})
+        opts.reverse_merge!(:force => true)
+
+        return false unless taggable.respond_to?(:is_taggable?) && taggable.is_taggable?
+
+        raise "You need to specify a tag context using :on"                unless opts.has_key?(:on)
+        raise "You need to specify some tags using :with"                  unless opts.has_key?(:with)
+        raise "No context :#{opts[:on]} defined in #{taggable.class.to_s}" unless (opts[:force] || taggable.tag_types.include?(opts[:on]))
+
+        taggable.set_owner_tag_list_on(self, opts[:on].to_s, opts[:with])
+        taggable.save
+      end
+
+      def is_tagger?
+        self.class.is_tagger?
+      end
+    end
+
+    module SingletonMethods
+      def is_tagger?
+        true
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/compatibility/Gemfile

@@ -0,0 +1,6 @@
+source :gemcutter
+
+# Rails 2.3
+gem 'rails',        '2.3.5'
+gem 'rspec',        '1.3.0', :require => 'spec'
+gem 'sqlite3-ruby', '1.2.5', :require => 'sqlite3'

data/lib/acts_as_taggable_on/compatibility/active_record_backports.rb

@@ -0,0 +1,17 @@
+module ActsAsTaggableOn
+  module ActiveRecord
+    module Backports
+      def self.included(base)
+        base.class_eval do
+          named_scope :where,    lambda { |conditions| { :conditions => conditions } }  
+          named_scope :joins,    lambda { |joins|      { :joins => joins } }
+          named_scope :group,    lambda { |group|      { :group => group } }
+          named_scope :order,    lambda { |order|      { :order => order } }
+          named_scope :select,   lambda { |select|     { :select => select } }
+          named_scope :limit,    lambda { |limit|      { :limit => limit } }
+          named_scope :readonly, lambda { |readonly|   { :readonly => readonly } }   
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/tag.rb

@@ -0,0 +1,65 @@
+class Tag < ActiveRecord::Base
+  include ActsAsTaggableOn::ActiveRecord::Backports if ActiveRecord::VERSION::MAJOR < 3
+  
+  attr_accessible :name
+
+  ### ASSOCIATIONS:
+
+  has_many :taggings, :dependent => :destroy
+
+  ### VALIDATIONS:
+
+  validates_presence_of :name
+  validates_uniqueness_of :name, :scope => :store_id
+
+  ### SCOPES:
+
+  def self.named(name)
+    where(["name LIKE ?", name])
+  end
+  
+  def self.named_any(list)
+    where(list.map { |tag| sanitize_sql(["name LIKE ?", tag.to_s]) }.join(" OR "))
+  end
+  
+  def self.named_like(name)
+    where(["name LIKE ?", "%#{name}%"])
+  end
+
+  def self.named_like_any(list)
+    where(list.map { |tag| sanitize_sql(["name LIKE ?", "%#{tag.to_s}%"]) }.join(" OR "))
+  end
+
+  ### CLASS METHODS:
+
+  def self.find_or_create_with_like_by_name(name)
+    named_like(name).first || create(:name => name)
+  end
+
+  def self.find_or_create_all_with_like_by_name(*list)
+    list = [list].flatten
+
+    return [] if list.empty?
+
+    existing_tags = Tag.named_any(list).all
+    new_tag_names = list.reject { |name| existing_tags.any? { |tag| tag.name.mb_chars.downcase == name.mb_chars.downcase } }
+    created_tags  = new_tag_names.map { |name| Tag.create(:name => name) }
+
+    existing_tags + created_tags
+  end
+
+  ### INSTANCE METHODS:
+
+  def ==(object)
+    super || (object.is_a?(Tag) && name == object.name)
+  end
+
+  def to_s
+    name
+  end
+
+  def count
+    read_attribute(:count).to_i
+  end
+
+end

data/lib/acts_as_taggable_on/tag_list.rb

@@ -0,0 +1,95 @@
+class TagList < Array
+
+  cattr_accessor :delimiter
+  self.delimiter = ','
+
+  attr_accessor :owner
+
+  def initialize(*args)
+    add(*args)
+  end
+  
+  ##
+  # Returns a new TagList using the given tag string.
+  #
+  # Example:
+  #   tag_list = TagList.from("One , Two,  Three")
+  #   tag_list # ["One", "Two", "Three"]
+  def self.from(string)
+    string = string.join(", ") if string.respond_to?(:join)
+
+    new.tap do |tag_list|
+      string = string.to_s.dup
+
+      # Parse the quoted tags
+      string.gsub!(/(\A|#{delimiter})\s*"(.*?)"\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
+      string.gsub!(/(\A|#{delimiter})\s*'(.*?)'\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
+
+      tag_list.add(string.split(delimiter))
+    end
+  end
+
+  ##
+  # Add tags to the tag_list. Duplicate or blank tags will be ignored.
+  # Use the <tt>:parse</tt> option to add an unparsed tag string.
+  #
+  # Example:
+  #   tag_list.add("Fun", "Happy")
+  #   tag_list.add("Fun, Happy", :parse => true)
+  def add(*names)
+    extract_and_apply_options!(names)
+    concat(names)
+    clean!
+    self
+  end
+
+  ##
+  # Remove specific tags from the tag_list.
+  # Use the <tt>:parse</tt> option to add an unparsed tag string.
+  #
+  # Example:
+  #   tag_list.remove("Sad", "Lonely")
+  #   tag_list.remove("Sad, Lonely", :parse => true)
+  def remove(*names)
+    extract_and_apply_options!(names)
+    delete_if { |name| names.include?(name) }
+    self
+  end
+
+  ##
+  # Transform the tag_list into a tag string suitable for edting in a form.
+  # The tags are joined with <tt>TagList.delimiter</tt> and quoted if necessary.
+  #
+  # Example:
+  #   tag_list = TagList.new("Round", "Square,Cube")
+  #   tag_list.to_s # 'Round, "Square,Cube"'
+  def to_s
+    tags = frozen? ? self.dup : self
+    tags.send(:clean!)
+
+    tags.map do |name|
+      name.include?(delimiter) ? "\"#{name}\"" : name
+    end.join(delimiter.ends_with?(" ") ? delimiter : "#{delimiter} ")
+  end
+
+  private
+  
+  # Remove whitespace, duplicates, and blanks.
+  def clean!
+    reject!(&:blank?)
+    map!(&:strip)
+    uniq!
+  end
+
+  def extract_and_apply_options!(args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options.assert_valid_keys :parse
+
+    if options[:parse]
+      args.map! { |a| self.class.from(a) }
+    end
+
+    args.flatten!
+  end
+
+end

data/lib/acts_as_taggable_on/tagging.rb

@@ -0,0 +1,23 @@
+class Tagging < ActiveRecord::Base #:nodoc:
+  include ActsAsTaggableOn::ActiveRecord::Backports if ActiveRecord::VERSION::MAJOR < 3
+
+  attr_accessible :tag,
+                  :tag_id,
+                  :context,
+                  :taggable,
+                  :taggable_type,
+                  :taggable_id,
+                  :tagger,
+                  :tagger_type,
+                  :tagger_id
+
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+  belongs_to :tagger,   :polymorphic => true
+
+  validates_presence_of :context
+  validates_presence_of :tag_id
+
+  validates_uniqueness_of :tag_id, :scope => [ :taggable_type, :taggable_id, :context, :tagger_id, :tagger_type ]
+
+end