acts-as-taggable-on 2.0.0.pre1 → 2.0.0.pre3

data/Gemfile

@@ -1,8 +1,6 @@
 source :gemcutter
 
-gem 'rails', '3.0.0.beta'
-
-group :test do
-  gem 'rspec', '2.0.0.beta.1'
-  gem 'sqlite3-ruby', :require => 'sqlite3'
-end
+# Rails 3.0
+gem 'rails',        '3.0.0.beta'
+gem 'rspec',        '2.0.0.beta.1'
+gem 'sqlite3-ruby', '1.2.5',       :require => 'sqlite3'

data/README.rdoc

@@ -31,6 +31,16 @@ To install the gem, add this to your config/environment.rb:
   
 After that, you can run "rake gems:install" to install the gem if you don't already have it.
 
+== Rails 3.0
+
+Acts As Taggable On is now useable in Rails 3.0, thanks to the excellent work of Szymon Nowak
+and Jelle Vandebeeck. Because backwards compatibility is hard to maintain, their work is available
+in the feature/rails3_compatibility branch.
+
+A Rails 3.0 compatible version of the gem is also available: 
+  
+  gem install acts-as-taggable-on -v=2.0.0.pre1
+
 === Post Installation (Rails)
 
 1. script/generate acts_as_taggable_on_migration

data/Rakefile

@@ -1,5 +1,45 @@
-gem 'rspec', '2.0.0.beta.1'
-require 'rspec/core/rake_task'
+begin
+  # Rspec 2.0
+  require 'rspec/core/rake_task'
+
+  desc 'Default: run specs'
+  task :default => :spec  
+  Rspec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+  
+  Rspec::Core::RakeTask.new('rcov') do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end  
+  
+rescue LoadError
+  # Rspec 1.3.0
+  require 'spec/rake/spectask'
+
+  desc 'Default: run specs'
+  task :default => :spec
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList["spec/**/*_spec.rb"]
+  end
+
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = FileList["spec/**/*_spec.rb"]
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+rescue LoadError
+  puts "Rspec not available. Install it with: gem install rspec"  
+end
+
+namespace 'rails2.3' do
+  task :spec do
+    gemfile = File.join(File.dirname(__FILE__), 'lib', 'acts_as_taggable_on', 'compatibility', 'Gemfile')
+    ENV['BUNDLE_GEMFILE'] = gemfile
+    Rake::Task['spec'].invoke    
+  end
+end
 
 begin
   require 'jeweler'
@@ -14,17 +54,5 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-desc 'Default: run specs'
-task :default => :spec
-Rspec::Core::RakeTask.new do |t|
-  t.pattern = "spec/**/*_spec.rb"
-end
-
-Rspec::Core::RakeTask.new('rcov') do |t|
-  t.pattern = "spec/**/*_spec.rb"
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -1 +1 @@
-2.0.0.pre1
+2.0.0.pre3

data/lib/acts-as-taggable-on.rb

@@ -1,27 +1,30 @@
-begin
-  # Try to require the preresolved locked set of gems.
-  require File.expand_path("../.bundle/environment", __FILE__)
-rescue LoadError
-  # Fall back on doing an unlocked resolve at runtime.
-  require "rubygems"
-  require "bundler"
-  Bundler.setup
-end
-
-Bundler.require
-
 require "active_record"
 require "action_view"
 
-require "acts_as_taggable_on/group_helper"
+if ActiveRecord::VERSION::MAJOR < 3
+  require "acts_as_taggable_on/compatibility/active_record_backports"
+  require "acts_as_taggable_on/compatibility/tag"
+  require "acts_as_taggable_on/compatibility/tagging"
+end
+
 require "acts_as_taggable_on/acts_as_taggable_on"
+require "acts_as_taggable_on/acts_as_taggable_on/core"
+require "acts_as_taggable_on/acts_as_taggable_on/aggregate"
+require "acts_as_taggable_on/acts_as_taggable_on/cache"
+require "acts_as_taggable_on/acts_as_taggable_on/ownership"
+require "acts_as_taggable_on/acts_as_taggable_on/related"
+
 require "acts_as_taggable_on/acts_as_tagger"
 require "acts_as_taggable_on/tag"
 require "acts_as_taggable_on/tag_list"
 require "acts_as_taggable_on/tags_helper"
 require "acts_as_taggable_on/tagging"
 
-ActiveRecord::Base.send :include, ActiveRecord::Acts::TaggableOn
-ActiveRecord::Base.send :include, ActiveRecord::Acts::Tagger
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ActsAsTaggableOn::Taggable
+  ActiveRecord::Base.send :include, ActsAsTaggableOn::Tagger
+end
 
-ActionView::Base.send :include, TagsHelper
+if defined?(ActionView::Base)
+  ActionView::Base.send :include, TagsHelper
+end

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -1,426 +1,41 @@
-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 sphinx can join multiple
-            # tag references from same model without getting an ambiguous column error
-            class_eval do
-              has_many "#{tag_type.singularize}_taggings".to_sym, :as => :taggable, :dependent => :destroy,
-                :include => :tag, :conditions => ['#{aliased_join_table_name || Tagging.table_name rescue Tagging.table_name}.context = ?',tag_type], :class_name => "Tagging"
-              has_many "#{tag_type}".to_sym, :through => "#{tag_type.singularize}_taggings".to_sym, :source => :tag
-            end
-
-            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
-            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
-
-              scope :tagged_with, lambda{ |*args|
-                find_options_for_find_tagged_with(*args)
-              }
-            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:
-        #   :any - find models that match any of the given tags
-        #   :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)
-        #   find_options_for_find_tagged_with(*args)
-        # end
-
-        def caching_tag_list_on?(context)
-          column_names.include?("cached_#{context.to_s.singularize}_list")
-        end
-
-        def tag_counts_on(context, options = {})
-          find_for_tag_counts(options.merge({:on => context.to_s}))
-        end
-
-        def all_tag_counts(options = {})
-          find_for_tag_counts(options)
-        end
-
-        def find_options_for_find_tagged_with(tags, options = {})
-          tag_list = TagList.from(tags)
-
-          return {} if tag_list.empty?
-
-          joins = []
-          conditions = []
-
-          context = options.delete(:on)
-
-          if options.delete(:exclude)
-            tags_conditions = tag_list.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)})"
-
-          elsif options.delete(:any)
-            tags_conditions = tag_list.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
-            conditions << "#{table_name}.#{primary_key} 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 = Tag.named_any(tag_list)
-            return { :conditions => "1 = 0" } unless tags.length == tag_list.length
-
-            tags.each do |tag|
-              safe_tag = tag.name.gsub(/[^a-zA-Z0-9]/, '')
-              prefix   = "#{safe_tag}_#{rand(1024)}"
-
-              taggings_alias = "#{table_name}_taggings_#{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)}" +
-                              " AND #{taggings_alias}.tag_id = #{tag.id}"
-              tagging_join << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context
-
-              joins << tagging_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
-
-          Tag.joins(joins.join(" ")).group(group).where(conditions.join(" AND ")).readonly(false)
-
-          # { :joins      => joins.join(" "),
-          #   :group      => group,
-          #   :conditions => conditions.join(" AND "),
-          #   :readonly   => false }.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_for_tag_counts(options = {})
-          options.assert_valid_keys :start_at, :end_at, :conditions, :at_least, :at_most, :order, :limit, :on, :id
-
-          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 ')
-
-          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 descends_from_active_record?
-            # Current model is STI descendant, so add type checking to the join condition
-            joins << " AND #{table_name}.#{inheritance_column} = '#{name}'"
-          end
-
-          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?
-
-          Tag.select("#{Tag.table_name}.*, COUNT(*) AS count").joins(joins.join(" ")).where(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)
-          add_custom_context(context)
-          cache = tag_list_cache_on(context)
-          return owner ? cache[owner] : cache[owner] if cache[owner]
-
-          if !owner && self.class.caching_tag_list_on?(context) and !(cached_value = cached_tag_list_on(context)).nil?
-            cache[owner] = TagList.from(cached_tag_list_on(context))
-          else
-            cache[owner] = TagList.new(*tags_on(context, owner).map(&:name))
-          end
-        end
-
-        def all_tags_list_on(context)
-          variable_name = "@all_#{context.to_s.singularize}_list"
-          return instance_variable_get(variable_name) if instance_variable_get(variable_name)
-          instance_variable_set(variable_name, TagList.new(all_tags_on(context).map(&:name)).freeze)
-        end
-
-        def all_tags_on(context)
-          opts =  ["#{Tagging.table_name}.context = ?", context.to_s]
-          base_tags.where(opts).order("#{Tagging.table_name}.created_at")
-        end
-
-        def tags_on(context, owner = nil)
-          if owner
-            opts = ["#{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 = ["#{Tagging.table_name}.context = ? AND #{Tagging.table_name}.tagger_id IS NULL", context.to_s]
-          end
-          base_tags.where(opts)
-        end
-
-        def cached_tag_list_on(context)
-          self["cached_#{context.to_s.singularize}_list"]
-        end
-
-        def tag_list_cache_on(context)
-          variable_name = "@#{context.to_s.singularize}_list"
-          cache = instance_variable_get(variable_name)
-          instance_variable_set(variable_name, cache = {}) unless cache
-          cache
-        end
-
-        def set_tag_list_on(context, new_list, tagger = nil)
-          tag_list_cache_on(context)[tagger] = TagList.from(new_list)
-          add_custom_context(context)
-        end
-
-        def tag_counts_on(context, options={})
-          self.class.tag_counts_on(context, options.merge(:id => id))
-        end
-
-        def related_tags_for(context, klass, options = {})
-          search_conditions = related_search_options(context, klass, options)
-
-          klass.select(search_conditions[:select]).from(search_conditions[:from]).where(search_conditions[:conditions]).group(search_conditions[:group]).order(search_conditions[:order])
-        end
-
-        def related_search_options(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
-
-          { :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.select(search_conditions[:select]).from(search_conditions[:from]).where(search_conditions[:conditions]).group(search_conditions[:group]).order(search_conditions[:order])
-        end
-
-        def matching_context_search_options(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
-
-          { :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 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"] = tag_list_cache_on(tag_type.singularize).to_a.flatten.compact.join(', ')
-            end
-          end
-        end
-
-        def save_tags
-          contexts = custom_contexts + self.class.tag_types.map(&:to_s)
-
-          transaction do
-            contexts.each do |context|
-              cache = tag_list_cache_on(context)
-
-              cache.each do |owner, list|
-                new_tags = Tag.find_or_create_all_with_like_by_name(list.uniq)
-                taggings = Tagging.where({ :taggable_id => self.id, :taggable_type => self.class.base_class.to_s })
-
-                # Destroy old taggings:
-                if owner
-                  old_tags = tags_on(context, owner) - new_tags
-                  old_taggings = Tagging.where({ :taggable_id => self.id, :taggable_type => self.class.base_class.to_s, :tag_id => old_tags, :tagger_id => owner.id, :tagger_type => owner.class.to_s, :context => context })
-
-                  Tagging.destroy_all :id => old_taggings.map(&:id)
-                else
-                  old_tags = tags_on(context) - new_tags
-                  base_tags.delete(*old_tags)
-                end
+module ActsAsTaggableOn
+  module Taggable
+    def taggable?
+      false
+    end
 
-                new_tags.reject! { |tag| taggings.any? { |tagging|
-                    tagging.tag_id      == tag.id &&
-                    tagging.tagger_id   == (owner ? owner.id : nil) &&
-                    tagging.tagger_type == (owner ? owner.class.to_s : nil) &&
-                    tagging.context     == context
-                  }
-                }
+    def acts_as_taggable
+      acts_as_taggable_on :tags
+    end
 
-                # create new taggings:
-                new_tags.each do |tag|
-                  Tagging.create!(:tag_id => tag.id, :context => context, :tagger => owner, :taggable => self)
-                end
-              end
-            end
-          end
+    def acts_as_taggable_on(*tag_types)
+      tag_types = tag_types.to_a.flatten.compact.map(&:to_sym)
 
-          true
+      if taggable?
+        write_inheritable_attribute(:tag_types, (self.tag_types + tag_types).uniq)
+      else
+        if ::ActiveRecord::VERSION::MAJOR < 3
+          include ActsAsTaggableOn::ActiveRecord::Backports
         end
+      
+        write_inheritable_attribute(:tag_types, tag_types)
+        class_inheritable_reader(:tag_types)
+        
+        class_eval do
+          has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
+          has_many :base_tags, :class_name => "Tag", :through => :taggings, :source => :tag
 
-        def reload_with_tag_list(*args)
-          self.class.tag_types.each do |tag_type|
-            instance_variable_set("@#{tag_type.to_s.singularize}_list", nil)
+          def self.taggable?
+            true
           end
-
-          reload_without_tag_list(*args)
         end
-
       end
+      
+      include Core
+      include Aggregate
+      include Cache
+      include Ownership
+      include Related
     end
   end
 end