johnsbrn-acts-as-taggable-on 1.0.5

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 5
+:major: 1
+:minor: 0

data/generators/acts_as_taggable_on_migration/acts_as_taggable_on_migration_generator.rb

@@ -0,0 +1,7 @@
+class ActsAsTaggableOnMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "acts_as_taggable_on_migration"
+    end
+  end
+end

data/generators/acts_as_taggable_on_migration/templates/migration.rb

@@ -0,0 +1,29 @@
+class ActsAsTaggableOnMigration < ActiveRecord::Migration
+  def self.up
+    create_table :tags do |t|
+      t.column :name, :string
+    end
+    
+    create_table :taggings do |t|
+      t.column :tag_id, :integer
+      t.column :taggable_id, :integer
+      t.column :tagger_id, :integer
+      t.column :tagger_type, :string
+      
+      # You should make sure that the column created is
+      # long enough to store the required class names.
+      t.column :taggable_type, :string
+      t.column :context, :string
+      
+      t.column :created_at, :datetime
+    end
+    
+    add_index :taggings, :tag_id
+    add_index :taggings, [:taggable_id, :taggable_type, :context]
+  end
+  
+  def self.down
+    drop_table :taggings
+    drop_table :tags
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'acts_as_taggable_on/acts_as_taggable_on'
+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
+
+RAILS_DEFAULT_LOGGER.info "** acts_as_taggable_on: initialized properly."

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -0,0 +1,316 @@
+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
+            self.class_eval do
+              has_many "#{tag_type.singularize}_taggings".to_sym, :as => :taggable, :dependent => :destroy, 
+                :include => :tag, :conditions => ["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
+            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{ |tags, options|
+                  find_options_for_find_tagged_with(tags, options)
+                }
+              end
+            end
+            
+            include ActiveRecord::Acts::TaggableOn::InstanceMethods
+            extend ActiveRecord::Acts::TaggableOn::SingletonMethods                
+            alias_method_chain :reload, :tag_list
+          end
+        end
+        
+        def is_taggable?
+          false
+        end
+      end
+      
+      module SingletonMethods
+        # 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 find_options_for_find_tagged_with(tags, options = {})
+          tags = tags.is_a?(Array) ? TagList.new(tags.map(&:to_s)) : TagList.from(tags)
+
+          return {} if tags.empty?
+
+          conditions = []
+          conditions << sanitize_sql(options.delete(:conditions)) if options[:conditions]
+          
+          unless (on = options.delete(:on)).nil?
+            conditions << sanitize_sql(["context = ?",on.to_s])
+          end
+
+          taggings_alias, tags_alias = "#{table_name}_taggings", "#{table_name}_tags"
+
+          if options.delete(:exclude)
+            tags_conditions = tags.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
+            conditions << sanitize_sql(["#{table_name}.id NOT IN (SELECT #{Tagging.table_name}.taggable_id FROM #{Tagging.table_name} LEFT OUTER JOIN #{Tag.table_name} ON #{Tagging.table_name}.tag_id = #{Tag.table_name}.id WHERE (#{tags_conditions}) AND #{Tagging.table_name}.taggable_type = #{quote_value(base_class.name)})", tags])
+          else
+            conditions << tags.map { |t| sanitize_sql(["#{tags_alias}.name LIKE ?", t]) }.join(" OR ")
+
+            if options.delete(:match_all)
+              group = "#{taggings_alias}.taggable_id HAVING COUNT(#{taggings_alias}.taggable_id) = #{tags.size}"
+            end
+          end
+          
+          { :select => "DISTINCT #{table_name}.*",
+            :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)} " +
+                      "LEFT OUTER JOIN #{Tag.table_name} #{tags_alias} ON #{tags_alias}.id = #{taggings_alias}.tag_id",
+            :conditions => conditions.join(" AND "),
+            :group      => group
+          }.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
+          
+          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]
+
+          type_and_context = "#{Tagging.table_name}.taggable_type = #{quote_value(base_class.name)}"
+          
+          conditions = [
+            type_and_context,
+            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 << "LEFT OUTER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{Tagging.table_name}.taggable_id"
+          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  = "#{Tag.table_name}.id, #{Tag.table_name}.name HAVING COUNT(*) > 0"
+          group_by << " AND #{having}" unless having.blank?
+
+          { :select     => "#{Tag.table_name}.id, #{Tag.table_name}.name, COUNT(*) AS count", 
+            :joins      => joins.join(" "),
+            :conditions => conditions,
+            :group      => group_by
+          }.update(options)
+        end    
+        
+        def is_taggable?
+          true
+        end                
+      end
+    
+      module InstanceMethods
+        
+        def tag_types
+          self.class.tag_types
+        end
+        
+        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 => ["context = ? AND tagger_id = ? AND tagger_type = ?",
+                                    context.to_s, owner.id, owner.class.to_s]}
+          else
+            opts = {:conditions => ["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,{:conditions => ["#{Tag.table_name}.name IN (?)", tag_list_on(context)]}.reverse_merge!(options))
+        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 }
+
+          { :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count", 
+            :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
+            :conditions => ["#{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      => "#{klass.table_name}.id",
+            :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"] = send("#{tag_type.singularize}_list").to_s
+            end
+          end
+        end
+        
+        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).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
+          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)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_tagger.rb

@@ -0,0 +1,52 @@
+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, 
+                                               :include => :tag, :class_name => "Tagging")
+          has_many :owned_tags, :through => :owned_taggings, :source => :tag
+          include ActiveRecord::Acts::Tagger::InstanceMethods
+          extend ActiveRecord::Acts::Tagger::SingletonMethods       
+        end
+        
+        def is_tagger?
+          false
+        end
+      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
+      end
+      
+      module SingletonMethods
+        def is_tagger?
+          true
+        end
+      end
+      
+    end
+  end
+end

data/lib/acts_as_taggable_on/tag.rb

@@ -0,0 +1,23 @@
+class Tag < ActiveRecord::Base
+  has_many :taggings
+  
+  validates_presence_of :name
+  validates_uniqueness_of :name
+  
+  # LIKE is used for cross-database case-insensitivity
+  def self.find_or_create_with_like_by_name(name)
+    find(:first, :conditions => ["name LIKE ?", name]) || create(:name => name)
+  end
+  
+  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,93 @@
+class TagList < Array
+  cattr_accessor :delimiter
+  self.delimiter = ','
+  
+  def initialize(*args)
+    add(*args)
+  end
+  
+  attr_accessor :owner
+  
+  # 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
+  
+  # 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(string)
+      returning new do |tag_list|
+        string = string.to_s.dup
+        
+        # Parse the quoted tags
+        string.gsub!(/"(.*?)"\s*#{delimiter}?\s*/) { tag_list << $1; "" }
+        string.gsub!(/'(.*?)'\s*#{delimiter}?\s*/) { tag_list << $1; "" }
+        
+        tag_list.add(string.split(delimiter))
+      end
+    end
+    
+    def from_owner(owner, *tags)
+      returning from(*tags) do |taglist|
+        taglist.owner = owner
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/tagging.rb

@@ -0,0 +1,6 @@
+class Tagging < ActiveRecord::Base #:nodoc:
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+  belongs_to :tagger, :polymorphic => true
+  validates_presence_of :context
+end

data/lib/acts_as_taggable_on/tags_helper.rb

@@ -0,0 +1,11 @@
+module TagsHelper
+  # See the README for an example using tag_cloud.
+  def tag_cloud(tags, classes)
+    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/lib/autotest/discover.rb

@@ -0,0 +1,6 @@
+# Need this to get picked up by autotest?
+$:.push(File.join(File.dirname(__FILE__), %w[.. .. rspec]))  
+   
+Autotest.add_discovery do  
+  "rspec" 
+end

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -0,0 +1,151 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Acts As Taggable On" do
+  it "should provide a class method 'taggable?' that is false for untaggable models" do
+    UntaggableModel.should_not be_taggable
+  end
+  
+  describe "Taggable Method Generation" do
+    before(:each) do
+      [TaggableModel, Tag, Tagging, TaggableUser].each(&:delete_all)
+      @taggable = TaggableModel.new(:name => "Bob Jones")
+    end
+  
+    it "should respond 'true' to taggable?" do
+      @taggable.class.should be_taggable
+    end
+    
+    it "should create a class attribute for tag types" do
+      @taggable.class.should respond_to(:tag_types)
+    end
+  
+    it "should generate an association for each tag type" do
+      @taggable.should respond_to(:tags, :skills, :languages)
+    end
+    
+    it "should generate a cached column checker for each tag type" do
+     TaggableModel.should respond_to(:caching_tag_list?, :caching_skill_list?, :caching_language_list?)
+    end
+    
+    it "should add tagged_with and tag_counts to singleton" do
+      TaggableModel.should respond_to(:find_tagged_with, :tag_counts)
+    end
+    
+    it "should add saving of tag lists and cached tag lists to the instance" do
+      @taggable.should respond_to(:save_cached_tag_list)
+      @taggable.should respond_to(:save_tags)
+    end
+  
+    it "should generate a tag_list accessor/setter for each tag type" do
+      @taggable.should respond_to(:tag_list, :skill_list, :language_list)
+      @taggable.should respond_to(:tag_list=, :skill_list=, :language_list=)
+    end
+  end
+  
+  describe "Single Table Inheritance" do
+    before do
+      @taggable = TaggableModel.new(:name => "taggable")
+      @inherited_same = InheritingTaggableModel.new(:name => "inherited same")
+      @inherited_different = AlteredInheritingTaggableModel.new(:name => "inherited different")
+    end
+    
+    it "should pass on tag contexts to STI-inherited models" do
+      @inherited_same.should respond_to(:tag_list, :skill_list, :language_list)
+      @inherited_different.should respond_to(:tag_list, :skill_list, :language_list)
+    end
+    
+    it "should have tag contexts added in altered STI models" do
+      @inherited_different.should respond_to(:part_list)
+    end
+  end
+  
+  describe "Reloading" do
+    it "should save a model instantiated by Model.find" do
+      taggable = TaggableModel.create!(:name => "Taggable")
+      found_taggable = TaggableModel.find(taggable.id)
+      found_taggable.save
+    end
+  end
+  
+  describe "Related Objects" do
+    it "should find related objects based on tag names on context" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+      taggable3 = TaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.tag_list = "one, two"
+      taggable1.save
+      
+      taggable2.tag_list = "three, four"
+      taggable2.save
+      
+      taggable3.tag_list = "one, four"
+      taggable3.save
+      
+      taggable1.find_related_tags.should include(taggable3)
+      taggable1.find_related_tags.should_not include(taggable2)
+    end
+
+    it "should find other related objects based on tag names on context" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = OtherTaggableModel.create!(:name => "Taggable 2")
+      taggable3 = OtherTaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.tag_list = "one, two"
+      taggable1.save
+      
+      taggable2.tag_list = "three, four"
+      taggable2.save
+      
+      taggable3.tag_list = "one, four"
+      taggable3.save
+
+      taggable1.find_related_tags_for(OtherTaggableModel).should include(taggable3)
+      taggable1.find_related_tags_for(OtherTaggableModel).should_not include(taggable2)
+    end
+  end
+  
+  describe 'Tagging Contexts' do
+    before(:all) do
+      class Array
+        def freq
+          k=Hash.new(0)
+          self.each {|e| k[e]+=1}
+          k
+        end
+      end
+    end
+    
+    it 'should eliminate duplicate tagging contexts ' do
+      TaggableModel.acts_as_taggable_on(:skills, :skills)
+      TaggableModel.tag_types.freq[:skills].should_not == 3
+    end
+
+    it "should not contain embedded/nested arrays" do
+      TaggableModel.acts_as_taggable_on([:array], [:array])
+      TaggableModel.tag_types.freq[[:array]].should == 0
+    end
+
+    it "should _flatten_ the content of arrays" do
+      TaggableModel.acts_as_taggable_on([:array], [:array])
+      TaggableModel.tag_types.freq[:array].should == 1
+    end
+
+    it "should not raise an error when passed nil" do
+      lambda {
+        TaggableModel.acts_as_taggable_on()
+      }.should_not raise_error
+    end
+
+    it "should not raise an error when passed [nil]" do
+      lambda {
+        TaggableModel.acts_as_taggable_on([nil])
+      }.should_not raise_error
+    end
+
+    after(:all) do
+      class Array; remove_method :freq; end
+    end
+  end
+  
+end

data/spec/acts_as_taggable_on/acts_as_tagger_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "acts_as_tagger" do
+  context "Tagger Method Generation" do
+
+    before(:each) do
+      @tagger = TaggableUser.new()
+    end
+
+    it "should add #is_tagger? query method to the class-side" do
+      TaggableUser.should respond_to(:is_tagger?)
+    end
+    
+    it "should return true from the class-side #is_tagger?" do
+      TaggableUser.is_tagger?.should be_true
+    end
+    
+    it "should return false from the base #is_tagger?" do
+      ActiveRecord::Base.is_tagger?.should be_false
+    end
+    
+    it "should add #is_tagger? query method to the singleton" do
+      @tagger.should respond_to(:is_tagger?)
+    end
+    
+    it "should add #tag method on the instance-side" do
+      @tagger.should respond_to(:tag)
+    end
+    
+    it "should generate an association for #owned_taggings and #owned_tags" do
+      @tagger.should respond_to(:owned_taggings, :owned_tags)
+    end
+  end
+  
+  describe "#tag" do
+    context 'when called with a non-existent tag context' do
+      before(:each) do
+        @tagger = TaggableUser.new()
+        @taggable = TaggableModel.new(:name=>"Richard Prior")
+      end
+      
+      it "should by default not throw an exception " do
+        @taggable.tag_list_on(:foo).should be_empty
+        lambda {
+          @tagger.tag(@taggable, :with=>'this, and, that', :on=>:foo)
+        }.should_not raise_error
+      end
+      
+      it 'should by default create the tag context on-the-fly' do
+        @taggable.tag_list_on(:here_ond_now).should be_empty
+        @tagger.tag(@taggable, :with=>'that', :on=>:here_ond_now)
+        @taggable.tag_list_on(:here_ond_now).should include('that')
+      end
+      
+      it "should throw an exception when the default is over-ridden" do
+        @taggable.tag_list_on(:foo_boo).should be_empty
+        lambda {
+          @tagger.tag(@taggable, :with=>'this, and, that', :on=>:foo_boo, :force=>false)
+        }.should raise_error        
+      end
+
+      it "should not create the tag context on-the-fly when the default is over-ridden" do
+        @taggable.tag_list_on(:foo_boo).should be_empty
+        @tagger.tag(@taggable, :with=>'this, and, that', :on=>:foo_boo, :force=>false) rescue
+        @taggable.tag_list_on(:foo_boo).should be_empty
+      end
+
+    end
+  
+  end
+
+end

data/spec/acts_as_taggable_on/tag_list_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TagList do
+  before(:each) do
+    @tag_list = TagList.new("awesome","radical")
+  end
+  
+  it "should be an array" do
+    @tag_list.is_a?(Array).should be_true
+  end
+  
+  it "should be able to be add a new tag word" do
+    @tag_list.add("cool")
+    @tag_list.include?("cool").should be_true
+  end
+  
+  it "should be able to add delimited lists of words" do
+    @tag_list.add("cool, wicked", :parse => true)
+    @tag_list.include?("cool").should be_true
+    @tag_list.include?("wicked").should be_true
+  end
+  
+  it "should be able to remove words" do
+    @tag_list.remove("awesome")
+    @tag_list.include?("awesome").should be_false
+  end
+  
+  it "should be able to remove delimited lists of words" do
+    @tag_list.remove("awesome, radical", :parse => true)
+    @tag_list.should be_empty
+  end
+  
+  it "should give a delimited list of words when converted to string" do
+    @tag_list.to_s.should == "awesome, radical"
+  end
+  
+  it "should quote escape tags with commas in them" do
+    @tag_list.add("cool","rad,bodacious")
+    @tag_list.to_s.should == "awesome, radical, cool, \"rad,bodacious\""
+  end
+end

data/spec/acts_as_taggable_on/tag_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tag do
+  before(:each) do
+    @tag = Tag.new
+    @user = TaggableModel.create(:name => "Pablo")  
+  end
+  
+  it "should require a name" do
+    @tag.should have(1).errors_on(:name)
+    @tag.name = "something"
+    @tag.should have(0).errors_on(:name)    
+  end
+  
+  it "should equal a tag with the same name" do
+    @tag.name = "awesome"
+    new_tag = Tag.new(:name => "awesome")
+    new_tag.should == @tag
+  end
+  
+  it "should return its name when to_s is called" do
+    @tag.name = "cool"
+    @tag.to_s.should == "cool"
+  end
+end

data/spec/acts_as_taggable_on/taggable_spec.rb

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Taggable" do
+  before(:each) do
+    [TaggableModel, Tag, Tagging, TaggableUser].each(&:delete_all)
+    @taggable = TaggableModel.new(:name => "Bob Jones")
+  end
+  
+  it "should be able to create tags" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.instance_variable_get("@skill_list").instance_of?(TagList).should be_true
+    @taggable.save
+    
+    Tag.find(:all).size.should == 3
+  end
+  
+  it "should be able to create tags through the tag list directly" do
+    @taggable.tag_list_on(:test).add("hello")
+    @taggable.save    
+    @taggable.reload
+    @taggable.tag_list_on(:test).should == ["hello"]
+  end
+  
+  it "should differentiate between contexts" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.tag_list = "ruby, bob, charlie"
+    @taggable.save
+    @taggable.reload
+    @taggable.skill_list.include?("ruby").should be_true
+    @taggable.skill_list.include?("bob").should be_false
+  end
+  
+  it "should be able to remove tags through list alone" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.save
+    @taggable.reload
+    @taggable.should have(3).skills
+    @taggable.skill_list = "ruby, rails"
+    @taggable.save
+    @taggable.reload
+    @taggable.should have(2).skills
+  end
+  
+  it "should be able to find by tag" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.save
+    TaggableModel.find_tagged_with("ruby").first.should == @taggable
+  end
+  
+  it "should be able to find by tag with context" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.tag_list = "bob, charlie"
+    @taggable.save
+    TaggableModel.find_tagged_with("ruby").first.should == @taggable
+    TaggableModel.find_tagged_with("bob", :on => :skills).first.should_not == @taggable
+    TaggableModel.find_tagged_with("bob", :on => :tags).first.should == @taggable
+  end
+  
+  it "should be able to use the tagged_with named scope" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.tag_list = "bob, charlie"
+    @taggable.save
+    TaggableModel.tagged_with("ruby", {}).first.should == @taggable
+    TaggableModel.tagged_with("bob", :on => :skills).first.should_not == @taggable
+    TaggableModel.tagged_with("bob", :on => :tags).first.should == @taggable
+  end
+  
+  it "should not care about case" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "Ruby")
+    
+    Tag.find(:all).size.should == 1
+    TaggableModel.find_tagged_with("ruby").should == TaggableModel.find_tagged_with("Ruby")
+  end
+  
+  it "should be able to get tag counts on model as a whole" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "ruby, rails")
+    charlie = TaggableModel.create(:name => "Charlie", :skill_list => "ruby")
+    TaggableModel.tag_counts.should_not be_empty
+    TaggableModel.skill_counts.should_not be_empty
+  end
+  
+  it "should be able to get tag counts on an association" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "ruby, rails")
+    charlie = TaggableModel.create(:name => "Charlie", :skill_list => "ruby")
+    bob.tag_counts.first.count.should == 2
+    charlie.skill_counts.first.count.should == 1
+  end
+  
+  it "should be able to set a custom tag context list" do
+    bob = TaggableModel.create(:name => "Bob")
+    bob.set_tag_list_on(:rotors, "spinning, jumping")
+    bob.tag_list_on(:rotors).should == ["spinning","jumping"]
+    bob.save
+    bob.reload
+    bob.tags_on(:rotors).should_not be_empty
+  end
+  
+  it "should be able to find tagged on a custom tag context" do
+    bob = TaggableModel.create(:name => "Bob")
+    bob.set_tag_list_on(:rotors, "spinning, jumping")
+    bob.tag_list_on(:rotors).should == ["spinning","jumping"]
+    bob.save
+    TaggableModel.find_tagged_with("spinning", :on => :rotors).should_not be_empty
+  end
+  
+  describe "Single Table Inheritance" do
+    before do
+      [TaggableModel, Tag, Tagging, TaggableUser].each(&:delete_all)
+      @taggable = TaggableModel.new(:name => "taggable")
+      @inherited_same = InheritingTaggableModel.new(:name => "inherited same")
+      @inherited_different = AlteredInheritingTaggableModel.new(:name => "inherited different")
+    end
+    
+    it "should be able to save tags for inherited models" do
+      @inherited_same.tag_list = "bob, kelso"
+      @inherited_same.save
+      InheritingTaggableModel.find_tagged_with("bob").first.should == @inherited_same
+    end
+    
+    it "should find STI tagged models on the superclass" do
+      @inherited_same.tag_list = "bob, kelso"
+      @inherited_same.save
+      TaggableModel.find_tagged_with("bob").first.should == @inherited_same
+    end
+    
+    it "should be able to add on contexts only to some subclasses" do
+      @inherited_different.part_list = "fork, spoon"
+      @inherited_different.save
+      InheritingTaggableModel.find_tagged_with("fork", :on => :parts).should be_empty
+      AlteredInheritingTaggableModel.find_tagged_with("fork", :on => :parts).first.should == @inherited_different
+    end
+  end
+end

data/spec/acts_as_taggable_on/tagger_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Tagger" do
+  before(:each) do
+    [TaggableModel, Tag, Tagging, TaggableUser].each(&:delete_all)
+    @user = TaggableUser.new
+    @taggable = TaggableModel.new(:name => "Bob Jones")
+  end
+  
+  it "should have taggings" do
+    @user.tag(@taggable, :with=>'ruby,scheme', :on=>:tags)
+    @user.owned_taggings.size == 2
+  end
+  
+  it "should have tags" do
+    @user.tag(@taggable, :with=>'ruby,scheme', :on=>:tags)
+    @user.owned_tags.size == 2
+  end
+  
+  it "is tagger" do
+    @user.is_tagger?.should(be_true)
+  end  
+end

data/spec/acts_as_taggable_on/tagging_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tagging do
+  before(:each) do
+    @tagging = Tagging.new
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,32 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "taggings", :force => true do |t|
+    t.integer  "tag_id",        :limit => 11
+    t.integer  "taggable_id",   :limit => 11
+    t.string   "taggable_type"
+    t.string   "context"
+    t.datetime "created_at"
+    t.integer  "tagger_id",     :limit => 11
+    t.string   "tagger_type"
+  end
+
+  add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
+  add_index "taggings", ["taggable_id", "taggable_type", "context"], :name => "index_taggings_on_taggable_id_and_taggable_type_and_context"
+
+  create_table "tags", :force => true do |t|
+    t.string "name"
+  end
+  
+  create_table :taggable_models, :force => true do |t|
+    t.column :name, :string
+    t.column :type, :string
+    #t.column :cached_tag_list, :string
+  end
+  create_table :taggable_users, :force => true do |t|
+    t.column :name, :string
+  end
+  create_table :other_taggable_models, :force => true do |t|
+    t.column :name, :string
+    t.column :type, :string
+    #t.column :cached_tag_list, :string
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+
+module Spec::Example::ExampleGroupMethods
+  alias :context :describe
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+load(File.dirname(__FILE__) + '/schema.rb')
+
+class TaggableModel < ActiveRecord::Base
+  acts_as_taggable_on :tags, :languages
+  acts_as_taggable_on :skills
+end
+
+class OtherTaggableModel < ActiveRecord::Base
+  acts_as_taggable_on :tags, :languages
+end
+
+class InheritingTaggableModel < TaggableModel
+end
+
+class AlteredInheritingTaggableModel < TaggableModel
+  acts_as_taggable_on :parts
+end
+
+class TaggableUser < ActiveRecord::Base
+  acts_as_tagger
+end
+
+class UntaggableModel < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: johnsbrn-acts-as-taggable-on
+version: !ruby/object:Gem::Version 
+  version: 1.0.5
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-26 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Acts As Taggable On provides the ability to have multiple tag contexts on a single model in ActiveRecord. It also has support for tag clouds, related items, taggers, and more.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- generators/acts_as_taggable_on_migration
+- generators/acts_as_taggable_on_migration/acts_as_taggable_on_migration_generator.rb
+- generators/acts_as_taggable_on_migration/templates
+- generators/acts_as_taggable_on_migration/templates/migration.rb
+- lib/acts-as-taggable-on.rb
+- lib/acts_as_taggable_on
+- lib/acts_as_taggable_on/acts_as_taggable_on.rb
+- lib/acts_as_taggable_on/acts_as_tagger.rb
+- lib/acts_as_taggable_on/tag.rb
+- lib/acts_as_taggable_on/tag_list.rb
+- lib/acts_as_taggable_on/tagging.rb
+- lib/acts_as_taggable_on/tags_helper.rb
+- lib/autotest
+- lib/autotest/discover.rb
+- spec/acts_as_taggable_on
+- spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb
+- spec/acts_as_taggable_on/acts_as_tagger_spec.rb
+- spec/acts_as_taggable_on/tag_list_spec.rb
+- spec/acts_as_taggable_on/tag_spec.rb
+- spec/acts_as_taggable_on/taggable_spec.rb
+- spec/acts_as_taggable_on/tagger_spec.rb
+- spec/acts_as_taggable_on/tagging_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/acts-as-taggable-on
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Tagging for ActiveRecord with custom contexts and advanced features.
+test_files: []
+