bborn-acts_as_taggable_on_steroids 2.0.beta2

data/lib/acts_as_taggable.rb

@@ -0,0 +1,246 @@
+require 'tag_list'
+require 'tag'
+require 'tagging'
+require 'tags_helper'
+
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    module Taggable #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        def acts_as_taggable
+          has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
+          has_many :tags, :through => :taggings
+          
+          before_save :save_cached_tag_list
+          after_save  :save_tags
+          
+          include ActiveRecord::Acts::Taggable::InstanceMethods
+          extend ActiveRecord::Acts::Taggable::SingletonMethods
+          
+          alias_method_chain :reload, :tag_list
+        end
+        
+        def cached_tag_list_column_name
+          "cached_tag_list"
+        end
+        
+        def set_cached_tag_list_column_name(value = nil, &block)
+          define_attr_method :cached_tag_list_column_name, value, &block
+        end
+      end
+      
+      module SingletonMethods
+        # Pass either a tag, string, or an array of strings or tags.
+        # 
+        # Options:
+        # - +:match_any+ - match any of the given tags (default).
+        # - +:match_all+ - match all of the given tags.
+        # 
+        def tagged_with(tags, options = {})
+          tags = tags.is_a?(Array) ? TagList.new(tags.map(&:to_s)) : TagList.from(tags)
+          return [] if tags.empty?
+          
+          records = select("DISTINCT #{quoted_table_name}.*")
+          
+          if options[:match_all]
+            records.search_all_tags(tags)
+          else
+            records.search_any_tags(tags)
+          end
+        end
+        
+        # Matches records that have none of the given tags.
+        def not_tagged_with(tags)
+          tags = tags.is_a?(Array) ? TagList.new(tags.map(&:to_s)) : TagList.from(tags)
+          
+          sub = Tagging.select("#{Tagging.table_name}.taggable_id").joins(:tag).
+            where(:taggable_type => base_class.name, "#{Tag.table_name}.name" => tags)
+          
+          where("#{quoted_table_name}.#{primary_key} NOT IN (" + sub.to_sql + ")")
+        end
+        
+        # Returns an array of related tags. Related tags are all the other tags
+        # that are found on the models tagged with the provided tags.
+        def related_tags(tags)
+          search_related_tags(tags)
+        end
+        
+        # Counts the number of occurences of all tags.
+        # See <tt>Tag.counts</tt> for options.
+        def tag_counts(options = {})
+          tags = Tag.joins(:taggings).
+            where("#{Tagging.table_name}.taggable_type" => base_class.name)
+          
+          if options[:tags]
+            tags = tags.where("#{Tag.table_name}.name" => options.delete(:tags))
+          end
+          
+          unless descends_from_active_record?
+            tags = tags.joins("INNER JOIN #{quoted_table_name} ON " +
+              "#{quoted_table_name}.#{primary_key} = #{Tagging.quoted_table_name}.taggable_id")
+            tags = tags.where(type_condition)
+          end
+          
+          if scoped != unscoped
+            sub  = scoped.except(:select).select("#{quoted_table_name}.#{primary_key}")
+            tags = tags.where("#{Tagging.quoted_table_name}.taggable_id IN (#{sub.to_sql})")
+          end
+          
+          tags.counts(options)
+        end
+        
+        # Returns an array of related tags.
+        # Related tags are all the other tags that are found on the models
+        # tagged with the provided tags.
+        # 
+        # Pass either a tag, string, or an array of strings or tags.
+        # 
+        # Options:
+        # - +:order+ - SQL Order how to order the tags. Defaults to "count_all DESC, tags.name".
+        # - +:include+
+        # 
+        # DEPRECATED: use #related_tags instead.
+        def find_related_tags(tags, options = {})
+          rs = related_tags(tags).order(options[:order] || "count DESC, #{Tag.quoted_table_name}.name")
+          rs = rs.includes(options[:include]) if options[:include]
+          rs
+        end
+        
+        # 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
+        # - +:include+
+        # 
+        # DEPRECATED: use #tagged_with and #not_tagged_with instead.
+        def find_tagged_with(*args)
+          options = args.extract_options!
+          tags = args.first
+          
+          records = self
+          records = records.where(options[:conditions]) if options[:conditions]
+          records = records.includes(options[:include]) if options[:include]
+          records = records.order(options[:order])      if options[:order]
+          
+          if options[:exclude]
+            records.not_tagged_with(tags)
+          else
+            records.tagged_with(tags, options)
+          end
+        end
+        
+        def caching_tag_list?
+          column_names.include?(cached_tag_list_column_name)
+        end
+        
+        protected
+          def joins_tags(options = {}) # :nodoc:
+            options[:suffix] = "_#{options[:suffix]}" if options[:suffix]
+            
+            taggings_alias = connection.quote_table_name(Tagging.table_name + options[:suffix].to_s)
+            tags_alias = connection.quote_table_name(Tag.table_name + options[:suffix].to_s)
+            
+            taggings = "INNER JOIN #{Tagging.quoted_table_name} AS #{taggings_alias} " +
+              "ON #{taggings_alias}.taggable_id = #{quoted_table_name}.#{primary_key} " +
+              "AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}"
+            
+            tags = "INNER JOIN #{Tag.quoted_table_name} AS #{tags_alias} " +
+              "ON #{tags_alias}.id = #{taggings_alias}.tag_id "
+            tags += "AND #{tags_alias}.name LIKE #{quote_value(options[:tag_name])}" if options[:tag_name]
+            
+            joins([taggings, tags])
+          end
+          
+          def search_all_tags(tags)
+            records = self
+            
+            tags.dup.each_with_index do |tag_name, index|
+              records = records.joins_tags(:suffix => index, :tag_name => tag_name)
+            end
+            
+            records
+          end
+          
+          def search_any_tags(tags)
+            joins(:tags).where(Tag.arel_table[:name].matches_any(tags.dup))
+          end
+          
+          def search_related_tags(tags)
+            tags = tags.is_a?(Array) ? TagList.new(tags.map(&:to_s)) : TagList.from(tags)
+            sub = select("#{quoted_table_name}.#{primary_key}").search_any_tags(tags)
+            _tags = tags.map { |tag| tag.downcase }
+            
+            Tag.select("#{Tag.quoted_table_name}.*, COUNT(#{Tag.quoted_table_name}.id) AS count").
+              joins(:taggings).
+              where("#{Tagging.table_name}.taggable_type" => base_class.name).
+              where("#{Tagging.quoted_table_name}.taggable_id IN (" + sub.to_sql + ")").
+              group("#{Tag.quoted_table_name}.name").
+              having(Tag.arel_table[:name].does_not_match_all(_tags))
+          end
+      end
+      
+      module InstanceMethods
+        def tag_list
+          return @tag_list if @tag_list
+          
+          if self.class.caching_tag_list? and !(cached_value = send(self.class.cached_tag_list_column_name)).nil?
+            @tag_list = TagList.from(cached_value)
+          else
+            @tag_list = TagList.new(*tags.map(&:name))
+          end
+        end
+        
+        def tag_list=(value)
+          @tag_list = TagList.from(value)
+        end
+        
+        def save_cached_tag_list
+          if self.class.caching_tag_list?
+            self[self.class.cached_tag_list_column_name] = tag_list.to_s
+          end
+        end
+        
+        def save_tags
+          return unless @tag_list
+          
+          new_tag_names = @tag_list - tags.map(&:name)
+          old_tags = tags.reject { |tag| @tag_list.include?(tag.name) }
+          
+          self.class.transaction do
+            if old_tags.any?
+              taggings.where(:tag_id => old_tags.map(&:id)).each(&:destroy)
+              taggings.reset
+            end
+            
+            new_tag_names.each do |new_tag_name|
+              tags << Tag.find_or_create_with_like_by_name(new_tag_name)
+            end
+          end
+          
+          true
+        end
+        
+        # Calculate the tag counts for the tags used by this model.
+        # See <tt>Tag.counts</tt> for available options.
+        def tag_counts(options = {})
+          return [] if tag_list.blank?
+          self.class.tag_counts(options.merge(:tags => tag_list))
+        end
+        
+        def reload_with_tag_list(*args) #:nodoc:
+          @tag_list = nil
+          reload_without_tag_list(*args)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Taggable)
+

data/lib/generators/acts_as_taggable_migration/acts_as_taggable_migration_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActsAsTaggableMigrationGenerator < Rails::Generators::Base 
+  include Rails::Generators::Migration
+
+  def self.source_root
+     @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+  end
+
+  def self.next_migration_number(dirname)
+     Time.now.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_migration
+     migration_template "migration.rb", File.join("db/migrate", "#{file_name}.rb")
+  end
+
+  protected
+
+  def file_name
+    "acts_as_taggable_migration"
+  end
+end

data/lib/generators/acts_as_taggable_migration/templates/migration.rb

@@ -0,0 +1,22 @@
+class ActsAsTaggableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :tags do |t|
+      t.string :name
+    end
+    
+    create_table :taggings do |t|
+      t.references :tag
+      t.references :taggable, :polymorphic => true
+      t.datetime   :created_at
+    end
+    
+    add_index :tags, :name
+    add_index :taggings, :tag_id
+    add_index :taggings, [:taggable_id, :taggable_type]
+  end
+  
+  def self.down
+    drop_table :taggings
+    drop_table :tags
+  end
+end

data/lib/tag.rb

@@ -0,0 +1,59 @@
+require 'active_support/core_ext/module/deprecation'
+
+class Tag < ActiveRecord::Base
+  cattr_accessor :destroy_unused
+  self.destroy_unused = false
+
+  has_many :taggings, :dependent => :delete_all
+
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  def ==(object)
+    super || (object.is_a?(Tag) && name == object.name)
+  end
+  
+  def to_s
+    name
+  end
+  
+  def count
+    read_attribute(:count).to_i
+  end
+  
+  class << self
+    def find_or_create_with_like_by_name(name)
+      where(arel_table[:name].matches(name)).first || create(:name => name)
+    end
+
+    # Calculate the tag counts for all tags.
+    # 
+    # - +:start_at+ - restrict the tags to those created after a certain time
+    # - +:end_at+   - restrict the tags to those created before a certain time
+    # - +:at_least+ - exclude tags with a frequency less than the given value
+    # - +:at_most+  - exclude tags with a frequency greater than the given value
+    # 
+    # Deprecated:
+    # 
+    # - +:conditions+
+    # - +:limit+
+    # - +:order+
+    # 
+    def counts(options = {})
+      options.assert_valid_keys :start_at, :end_at, :at_least, :at_most, :conditions, :limit, :order
+      
+      tags = joins(:taggings).group(:name)
+      tags = tags.having(['count >= ?', options[:at_least]]) if options[:at_least]
+      tags = tags.having(['count <= ?', options[:at_most]])  if options[:at_most]
+      tags = tags.where("#{Tagging.quoted_table_name}.created_at >= ?", options[:start_at]) if options[:start_at]
+      tags = tags.where("#{Tagging.quoted_table_name}.created_at <= ?", options[:end_at])   if options[:end_at]
+      
+      # TODO: deprecation warning
+      tags = tags.where(options[:conditions]) if options[:conditions]
+      tags = tags.limit(options[:limit])      if options[:limit]
+      tags = tags.order(options[:order])      if options[:order]
+      
+      tags.select("#{quoted_table_name}.*, COUNT(#{quoted_table_name}.id) AS count")
+    end
+  end
+end

data/lib/tag_list.rb

@@ -0,0 +1,109 @@
+class TagList < Array
+  cattr_accessor :delimiter
+  self.delimiter = ','
+  
+  def initialize(*args)
+    add(*args)
+  end
+  
+  # Add tags to the tag_list. Duplicate or blank tags will be ignored.
+  #
+  #   tag_list.add("Fun", "Happy")
+  # 
+  # Use the <tt>:parse</tt> option to add an unparsed tag string.
+  #
+  #   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.
+  # 
+  #   tag_list.remove("Sad", "Lonely")
+  #
+  # Like #add, the <tt>:parse</tt> option can be used to remove multiple tags in a string.
+  # 
+  #   tag_list.remove("Sad, Lonely", :parse => true)
+  def remove(*names)
+    extract_and_apply_options!(names)
+    delete_if { |name| names.include?(name) }
+    self
+  end
+  
+  # Toggle the presence of the given tags.
+  # If a tag is already in the list it is removed, otherwise it is added.
+  def toggle(*names)
+    extract_and_apply_options!(names)
+    
+    names.each do |name|
+      include?(name) ? delete(name) : push(name)
+    end
+    
+    clean! 
+    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.
+  #
+  #   tag_list = TagList.new("Round", "Square,Cube")
+  #   tag_list.to_s # 'Round, "Square,Cube"'
+  def to_s
+    clean!
+    
+    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
+  
+  class << self
+    # Returns a new TagList using the given tag string.
+    # 
+    #   tag_list = TagList.from("One , Two,  Three")
+    #   tag_list # ["One", "Two", "Three"]
+    def from(source)
+      tag_list = new
+      
+      case source
+      when Array
+        tag_list.add(source)
+      else
+        string = source.to_s.dup
+        
+        # Parse the quoted tags
+        [
+          /\s*#{delimiter}\s*(['"])(.*?)\1\s*/,
+          /^\s*(['"])(.*?)\1\s*#{delimiter}?/
+        ].each do |re|
+          string.gsub!(re) { tag_list << $2; "" }
+        end
+        
+        tag_list.add(string.split(delimiter))
+      end
+      
+      tag_list
+    end
+  end
+end

data/lib/tagging.rb

@@ -0,0 +1,16 @@
+class Tagging < ActiveRecord::Base #:nodoc:
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+  
+  after_destroy :destroy_tag_if_unused
+  
+  private
+  
+  def destroy_tag_if_unused
+    if Tag.destroy_unused
+      if tag.taggings.count.zero?
+        tag.destroy
+      end
+    end
+  end
+end

data/lib/tags_helper.rb

@@ -0,0 +1,13 @@
+module TagsHelper
+  # See the README for an example using tag_cloud.
+  def tag_cloud(tags, classes)
+    return if tags.all.empty?
+    
+    max_count = tags.sort_by(&:count).last.count.to_f
+    
+    tags.each do |tag|
+      index = ((tag.count / max_count) * (classes.size - 1)).round
+      yield tag, classes[index]
+    end
+  end
+end

data/test/abstract_unit.rb

@@ -0,0 +1,106 @@
+require 'test/unit'
+
+begin
+  require File.dirname(__FILE__) + '/../../../../config/environment'
+rescue LoadError
+  require 'rubygems'
+  gem 'activesupport'
+  gem 'activerecord'
+  gem 'actionpack'
+  require 'active_support/dependencies'
+  require 'active_record'
+  require 'action_controller'
+end
+
+# Search for fixtures first
+fixture_path = File.dirname(__FILE__) + '/fixtures/'
+ActiveSupport::Dependencies.autoload_paths.insert(0, fixture_path)
+
+require "active_record/test_case"
+require "active_record/fixtures"
+
+require File.dirname(__FILE__) + '/../lib/acts_as_taggable'
+require_dependency File.dirname(__FILE__) + '/../lib/tag_list'
+require_dependency File.dirname(__FILE__) + '/../lib/tags_helper'
+
+ENV['DB'] ||= 'sqlite3'
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/debug.log')
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(ENV['DB'])
+
+load(File.dirname(__FILE__) + '/schema.rb')
+
+class ActiveSupport::TestCase #:nodoc:
+  include ActiveRecord::TestFixtures
+  
+  self.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+  
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+  
+  fixtures :all
+  
+  def assert_equivalent(expected, actual, message = nil)
+    if expected.first.is_a?(ActiveRecord::Base)
+      assert_equal expected.sort_by(&:id), actual.sort_by(&:id), message
+    else
+      assert_equal expected.sort, actual.sort, message
+    end
+  end
+  
+  def assert_tag_counts(tags, expected_values)
+    # Map the tag fixture names to real tag names
+    expected_values = expected_values.inject({}) do |hash, (tag, count)|
+      hash[tags(tag).name] = count
+      hash
+    end
+    
+    tags.each do |tag|
+      value = expected_values.delete(tag.name)
+      
+      assert_not_nil value, "Expected count for #{tag.name} was not provided"
+      assert_equal value, tag.count, "Expected value of #{value} for #{tag.name}, but was #{tag.count}"
+    end
+    
+    unless expected_values.empty?
+      assert false, "The following tag counts were not present: #{expected_values.inspect}"
+    end
+  end
+  
+  def assert_queries(num = 1)
+    $query_count = 0
+    yield
+  ensure
+    assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
+  end
+
+  def assert_no_queries(&block)
+    assert_queries(0, &block)
+  end
+  
+  # From Rails trunk
+  def assert_difference(expressions, difference = 1, message = nil, &block)
+    expression_evaluations = [expressions].flatten.collect{|expression| lambda { eval(expression, block.binding) } } 
+    
+    original_values = expression_evaluations.inject([]) { |memo, expression| memo << expression.call }
+    yield
+    expression_evaluations.each_with_index do |expression, i|
+      assert_equal original_values[i] + difference, expression.call, message
+    end
+  end
+  
+  def assert_no_difference(expressions, message = nil, &block)
+    assert_difference expressions, 0, message, &block
+  end
+end
+
+ActiveRecord::Base.connection.class.class_eval do  
+  def execute_with_counting(sql, name = nil, &block)
+    $query_count ||= 0
+    $query_count += 1
+    execute_without_counting(sql, name, &block)
+  end
+  
+  alias_method_chain :execute, :counting
+end