acts-as-taggable-on 1.0.13 → 2.0.0

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -1,381 +1,51 @@
-module ActiveRecord
-  module Acts
-    module TaggableOn
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def taggable?
-          false
-        end
-
-        def acts_as_taggable
-          acts_as_taggable_on :tags
-        end
-
-        def acts_as_taggable_on(*args)
-          args.flatten! if args
-          args.compact! if args
-          for tag_type in args
-            tag_type = tag_type.to_s
-            # use aliased_join_table_name for context condition so that sphix can join multiple
-            # tag references from same model without getting an ambiguous column error
-            self.class_eval do
-              has_many "#{tag_type.singularize}_taggings".to_sym, :as => :taggable, :dependent => :destroy,
-                :include => :tag, :conditions => ['#{aliased_join_table_name rescue "taggings"}.context = ?',tag_type], :class_name => "Tagging"
-              has_many "#{tag_type}".to_sym, :through => "#{tag_type.singularize}_taggings".to_sym, :source => :tag
-            end
-
-            self.class_eval <<-RUBY
-              def self.taggable?
-                true
-              end
-
-              def self.caching_#{tag_type.singularize}_list?
-                caching_tag_list_on?("#{tag_type}")
-              end
-
-              def self.#{tag_type.singularize}_counts(options={})
-                tag_counts_on('#{tag_type}',options)
-              end
-
-              def #{tag_type.singularize}_list
-                tag_list_on('#{tag_type}')
-              end
-
-              def #{tag_type.singularize}_list=(new_tags)
-                set_tag_list_on('#{tag_type}',new_tags)
-              end
-
-              def #{tag_type.singularize}_counts(options = {})
-                tag_counts_on('#{tag_type}',options)
-              end
-
-              def #{tag_type}_from(owner)
-                tag_list_on('#{tag_type}', owner)
-              end
-
-              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
-
-              def top_#{tag_type}(limit = 10)
-                tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
-              end
-
-              def self.top_#{tag_type}(limit = 10)
-                tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
-              end
-            RUBY
-          end
-
-          if respond_to?(:tag_types)
-            write_inheritable_attribute( :tag_types, (tag_types + args).uniq )
-          else
-            self.class_eval do
-              write_inheritable_attribute(:tag_types, args.uniq)
-              class_inheritable_reader :tag_types
-
-              has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
-              has_many :base_tags, :class_name => "Tag", :through => :taggings, :source => :tag
-
-              attr_writer :custom_contexts
-
-              before_save :save_cached_tag_list
-              after_save :save_tags
-
-              if respond_to?(:named_scope)
-                named_scope :tagged_with, lambda{ |*args|
-                  find_options_for_find_tagged_with(*args)
-                }
-              end
-            end
-
-            include ActiveRecord::Acts::TaggableOn::InstanceMethods
-            extend ActiveRecord::Acts::TaggableOn::SingletonMethods
-            alias_method_chain :reload, :tag_list
-          end
-        end
-      end
-
-      module SingletonMethods
-        include ActiveRecord::Acts::TaggableOn::GroupHelper
-        # Pass either a tag string, or an array of strings or tags
-        #
-        # Options:
-        #   :exclude - Find models that are not tagged with the given tags
-        #   :match_all - Find models that match all of the given tags, not just one
-        #   :conditions - A piece of SQL conditions to add to the query
-        #   :on - scopes the find to a context
-        def find_tagged_with(*args)
-          options = find_options_for_find_tagged_with(*args)
-          options.blank? ? [] : find(:all,options)
-        end
-
-        def caching_tag_list_on?(context)
-          column_names.include?("cached_#{context.to_s.singularize}_list")
-        end
-
-        def tag_counts_on(context, options = {})
-          Tag.find(:all, find_options_for_tag_counts(options.merge({:on => context.to_s})))
-        end
-
-        def all_tag_counts(options = {})
-          Tag.find(:all, find_options_for_tag_counts(options))
-        end
-
-        def find_options_for_find_tagged_with(tags, options = {})
-          tags = TagList.from(tags)
-
-          return {} if tags.empty?
-
-          joins = []
-          conditions = []
-
-          context = options.delete(:on)
-
-
-          if options.delete(:exclude)
-            tags_conditions = tags.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
-            conditions << "#{table_name}.#{primary_key} NOT IN (SELECT #{Tagging.table_name}.taggable_id FROM #{Tagging.table_name} JOIN #{Tag.table_name} ON #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND (#{tags_conditions}) WHERE #{Tagging.table_name}.taggable_type = #{quote_value(base_class.name)})"
-
-          else
-            tags.each do |tag|
-              safe_tag = tag.gsub(/[^a-zA-Z0-9]/, '')
-              prefix   = "#{safe_tag}_#{rand(1024)}"
-
-              taggings_alias = "#{table_name}_taggings_#{prefix}"
-              tags_alias     = "#{table_name}_tags_#{prefix}"
-
-              tagging_join  = "JOIN #{Tagging.table_name} #{taggings_alias}" +
-                              "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
-                              " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}"
-              tagging_join << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context
-
-              tag_join     = "JOIN #{Tag.table_name} #{tags_alias}" +
-                             "  ON #{tags_alias}.id = #{taggings_alias}.tag_id" +
-                             " AND " + sanitize_sql(["#{tags_alias}.name like ?", tag])
-
-              joins << tagging_join
-              joins << tag_join
-            end
-          end
-
-          taggings_alias, tags_alias = "#{table_name}_taggings_group", "#{table_name}_tags_group"
-
-          if options.delete(:match_all)
-            joins << "LEFT OUTER JOIN #{Tagging.table_name} #{taggings_alias}" +
-                     "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
-                     " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}"
-
-            group = "#{grouped_column_names_for(self)} HAVING COUNT(#{taggings_alias}.taggable_id) = #{tags.size}"
-          end
-
-          { :joins      => joins.join(" "),
-            :group      => group,
-            :conditions => conditions.join(" AND ") }.update(options)
-        end
-
-        # Calculate the tag counts for all tags.
-        #
-        # Options:
-        #  :start_at - Restrict the tags to those created after a certain time
-        #  :end_at - Restrict the tags to those created before a certain time
-        #  :conditions - A piece of SQL conditions to add to the query
-        #  :limit - The maximum number of tags to return
-        #  :order - A piece of SQL to order by. Eg 'tags.count desc' or 'taggings.created_at desc'
-        #  :at_least - Exclude tags with a frequency less than the given value
-        #  :at_most - Exclude tags with a frequency greater than the given value
-        #  :on - Scope the find to only include a certain context
-        def find_options_for_tag_counts(options = {})
-          options.assert_valid_keys :start_at, :end_at, :conditions, :at_least, :at_most, :order, :limit, :on, :id
-
-          scope = scope(:find)
-          start_at = sanitize_sql(["#{Tagging.table_name}.created_at >= ?", options.delete(:start_at)]) if options[:start_at]
-          end_at = sanitize_sql(["#{Tagging.table_name}.created_at <= ?", options.delete(:end_at)]) if options[:end_at]
-
-          taggable_type = sanitize_sql(["#{Tagging.table_name}.taggable_type = ?", base_class.name])
-          taggable_id = sanitize_sql(["#{Tagging.table_name}.taggable_id = ?", options.delete(:id)]) if options[:id]
-          options[:conditions] = sanitize_sql(options[:conditions]) if options[:conditions]
-
-          conditions = [
-            taggable_type,
-            taggable_id,
-            options[:conditions],
-            start_at,
-            end_at
-          ]
-
-          conditions = conditions.compact.join(' AND ')
-          conditions = merge_conditions(conditions, scope[:conditions]) if scope
-
-          joins = ["LEFT OUTER JOIN #{Tagging.table_name} ON #{Tag.table_name}.id = #{Tagging.table_name}.tag_id"]
-          joins << sanitize_sql(["AND #{Tagging.table_name}.context = ?",options.delete(:on).to_s]) unless options[:on].nil?
-
-          joins << " INNER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{Tagging.table_name}.taggable_id"
-          unless self.descends_from_active_record?
-            # Current model is STI descendant, so add type checking to the join condition
-            joins << " AND #{table_name}.#{self.inheritance_column} = '#{self.name}'"
-          end
-
-          joins << scope[:joins] if scope && scope[:joins]
-
-          at_least  = sanitize_sql(['COUNT(*) >= ?', options.delete(:at_least)]) if options[:at_least]
-          at_most   = sanitize_sql(['COUNT(*) <= ?', options.delete(:at_most)]) if options[:at_most]
-          having    = [at_least, at_most].compact.join(' AND ')
-          group_by  = "#{grouped_column_names_for(Tag)} HAVING COUNT(*) > 0"
-          group_by << " AND #{having}" unless having.blank?
-
-          { :select     => "#{Tag.table_name}.*, COUNT(*) AS count",
-            :joins      => joins.join(" "),
-            :conditions => conditions,
-            :group      => group_by,
-            :limit      => options[:limit],
-            :order      => options[:order]
-          }
-        end
-
-        def is_taggable?
-          true
-        end
-      end
-
-      module InstanceMethods
-        include ActiveRecord::Acts::TaggableOn::GroupHelper
-
-        def custom_contexts
-          @custom_contexts ||= []
-        end
-
-        def is_taggable?
-          self.class.is_taggable?
-        end
-
-        def add_custom_context(value)
-          custom_contexts << value.to_s unless custom_contexts.include?(value.to_s) or self.class.tag_types.map(&:to_s).include?(value.to_s)
-        end
-
-        def tag_list_on(context, owner=nil)
-          var_name = context.to_s.singularize + "_list"
-          add_custom_context(context)
-          return instance_variable_get("@#{var_name}") unless instance_variable_get("@#{var_name}").nil?
-
-          if !owner && self.class.caching_tag_list_on?(context) and !(cached_value = cached_tag_list_on(context)).nil?
-            instance_variable_set("@#{var_name}", TagList.from(self["cached_#{var_name}"]))
-          else
-            instance_variable_set("@#{var_name}", TagList.new(*tags_on(context, owner).map(&:name)))
-          end
-        end
-
-        def tags_on(context, owner=nil)
-          if owner
-            opts = {:conditions => ["#{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]}
-          else
-            opts = {:conditions => ["#{Tagging.table_name}.context = ?", context.to_s]}
-          end
-          base_tags.find(:all, opts)
-        end
-
-        def cached_tag_list_on(context)
-          self["cached_#{context.to_s.singularize}_list"]
-        end
-
-        def set_tag_list_on(context,new_list, tagger=nil)
-          instance_variable_set("@#{context.to_s.singularize}_list", TagList.from_owner(tagger, new_list))
-          add_custom_context(context)
-        end
-
-        def tag_counts_on(context, options={})
-          self.class.tag_counts_on(context, options.merge(:id => self.id))
-        end
-
-        def related_tags_for(context, klass, options = {})
-          search_conditions = related_search_options(context, klass, options)
-
-          klass.find(:all, search_conditions)
-        end
-
-        def related_search_options(context, klass, options = {})
-          tags_to_find = self.tags_on(context).collect { |t| t.name }
-
-          exclude_self = "#{klass.table_name}.id != #{self.id} AND" if self.class == klass
-
-          { :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
-        
-        def matching_contexts_for(search_context, result_context, klass, options = {})
-          search_conditions = matching_context_search_options(search_context, result_context, klass, options)
-
-          klass.find(:all, search_conditions)
-        end
-        
-        def matching_context_search_options(search_context, result_context, klass, options = {})
-          tags_to_find = self.tags_on(search_context).collect { |t| t.name }
+module ActsAsTaggableOn
+  module Taggable
+    def taggable?
+      false
+    end
 
-          exclude_self = "#{klass.table_name}.id != #{self.id} AND" if self.class == klass
+    ##
+    # This is an alias for calling <tt>acts_as_taggable_on :tags</tt>.
+    #
+    # Example:
+    #   class Book < ActiveRecord::Base
+    #     acts_as_taggable
+    #   end
+    def acts_as_taggable
+      acts_as_taggable_on :tags
+    end
 
-          { :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
+    ##
+    # Make a model taggable on specified contexts.
+    #
+    # @param [Array] tag_types An array of taggable contexts
+    #
+    # Example:
+    #   class User < ActiveRecord::Base
+    #     acts_as_taggable_on :languages, :skills
+    #   end
+    def acts_as_taggable_on(*tag_types)
+      tag_types = tag_types.to_a.flatten.compact.map(&:to_sym)
+
+      if taggable?
+        write_inheritable_attribute(:tag_types, (self.tag_types + tag_types).uniq)
+      else
+        write_inheritable_attribute(:tag_types, tag_types)
+        class_inheritable_reader(:tag_types)
         
-        def save_cached_tag_list
-          self.class.tag_types.map(&:to_s).each do |tag_type|
-            if self.class.send("caching_#{tag_type.singularize}_list?")
-              self["cached_#{tag_type.singularize}_list"] = send("#{tag_type.singularize}_list").to_s
-            end
-          end
-        end
+        class_eval do
+          has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
+          has_many :base_tags, :class_name => "Tag", :through => :taggings, :source => :tag
 
-        def save_tags
-          (custom_contexts + self.class.tag_types.map(&:to_s)).each do |tag_type|
-            next unless instance_variable_get("@#{tag_type.singularize}_list")
-            owner = instance_variable_get("@#{tag_type.singularize}_list").owner
-            new_tag_names = instance_variable_get("@#{tag_type.singularize}_list") - tags_on(tag_type).map(&:name)
-            old_tags = tags_on(tag_type, owner).reject { |tag| instance_variable_get("@#{tag_type.singularize}_list").include?(tag.name) }
-
-            self.class.transaction do
-              base_tags.delete(*old_tags) if old_tags.any?
-              new_tag_names.each do |new_tag_name|
-                new_tag = Tag.find_or_create_with_like_by_name(new_tag_name)
-                Tagging.create(:tag_id => new_tag.id, :context => tag_type,
-                               :taggable => self, :tagger => owner)
-              end
-            end
+          def self.taggable?
+            true
           end
-
-          true
-        end
-
-        def reload_with_tag_list(*args)
-          self.class.tag_types.each do |tag_type|
-            self.instance_variable_set("@#{tag_type.to_s.singularize}_list", nil)
-          end
-
-          reload_without_tag_list(*args)
+        
+          include ActsAsTaggableOn::Taggable::Core
+          include ActsAsTaggableOn::Taggable::Collection
+          include ActsAsTaggableOn::Taggable::Cache
+          include ActsAsTaggableOn::Taggable::Ownership
+          include ActsAsTaggableOn::Taggable::Related
         end
       end
     end

data/lib/acts_as_taggable_on/acts_as_tagger.rb

@@ -1,52 +1,67 @@
-module ActiveRecord
-  module Acts
-    module Tagger
-      def self.included(base)
-        base.extend ClassMethods
-      end
-      
-      module ClassMethods
-        def acts_as_tagger(opts={})
-          has_many :owned_taggings, opts.merge(:as => :tagger, :dependent => :destroy, 
+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
-          include ActiveRecord::Acts::Tagger::InstanceMethods
-          extend ActiveRecord::Acts::Tagger::SingletonMethods       
-        end
-        
-        def is_tagger?
-          false
         end
+
+        include ActsAsTaggableOn::Tagger::InstanceMethods
+        extend ActsAsTaggableOn::Tagger::SingletonMethods
       end
-      
-      module InstanceMethods
-        def self.included(base)
-        end
-        
-        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_tag_list_on(opts[:on].to_s, opts[:with], self)
-          taggable.save
-        end
-        
-        def is_tagger?
-          self.class.is_tagger?
-        end
+
+      def is_tagger?
+        false
       end
-      
-      module SingletonMethods
-        def is_tagger?
-          true
-        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

@@ -1,26 +1,65 @@
 class Tag < ActiveRecord::Base
-  has_many :taggings, :dependent => :destroy
+  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
+
+  ### SCOPES:
+
+  def self.named(name)
+    where(["name LIKE ?", name])
+  end
   
-  named_scope :named, lambda { |name| { :conditions => ["name = ?", name] } }
-  named_scope :named_like, lambda { |name| { :conditions => ["name LIKE ?", "%#{name}%"] } }
+  def self.named_any(list)
+    where(list.map { |tag| sanitize_sql(["name LIKE ?", tag.to_s]) }.join(" OR "))
+  end
   
-  # LIKE is used for cross-database case-insensitivity
+  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)
-    find(:first, :conditions => ["name LIKE ?", name]) || create(: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