acts_as_taggable_on 3.0.0.rc1

data/lib/acts_as_taggable_on/taggable.rb

@@ -0,0 +1,105 @@
+module ActsAsTaggableOn
+  module Taggable
+    def taggable?
+      false
+    end
+
+    ##
+    # 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
+
+    ##
+    # This is an alias for calling <tt>acts_as_ordered_taggable_on :tags</tt>.
+    #
+    # Example:
+    #   class Book < ActiveRecord::Base
+    #     acts_as_ordered_taggable
+    #   end
+    def acts_as_ordered_taggable
+      acts_as_ordered_taggable_on :tags
+    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)
+      taggable_on(false, tag_types)
+    end
+    
+    
+    ##
+    # Make a model taggable on specified contexts
+    # and preserves the order in which tags are created
+    #
+    # @param [Array] tag_types An array of taggable contexts
+    #
+    # Example:
+    #   class User < ActiveRecord::Base
+    #     acts_as_ordered_taggable_on :languages, :skills
+    #   end
+    def acts_as_ordered_taggable_on(*tag_types)
+      taggable_on(true, tag_types)
+    end
+    
+    private
+    
+      # Make a model taggable on specified contexts
+      # and optionally preserves the order in which tags are created
+      #
+      # Seperate methods used above for backwards compatibility
+      # so that the original acts_as_taggable_on method is unaffected
+      # as it's not possible to add another arguement to the method
+      # without the tag_types being enclosed in square brackets
+      #
+      # NB: method overridden in core module in order to create tag type
+      #     associations and methods after this logic has executed
+      #
+      def taggable_on(preserve_tag_order, *tag_types)
+        tag_types = tag_types.to_a.flatten.compact.map(&:to_sym)
+
+        if taggable?
+          self.tag_types = (self.tag_types + tag_types).uniq
+          self.preserve_tag_order = preserve_tag_order
+        else
+          class_attribute :tag_types
+          self.tag_types = tag_types
+          class_attribute :preserve_tag_order
+          self.preserve_tag_order = preserve_tag_order
+        
+          class_eval do
+            has_many :taggings, :as => :taggable, :dependent => :destroy, :class_name => "ActsAsTaggableOn::Tagging"
+            has_many :base_tags, :through => :taggings, :source => :tag, :class_name => "ActsAsTaggableOn::Tag"
+
+            def self.taggable?
+              true
+            end
+
+            include ActsAsTaggableOn::Utils
+          end
+        end
+
+        # each of these add context-specific methods and must be
+        # called on each call of taggable_on
+        include ActsAsTaggableOn::Taggable::Core
+        include ActsAsTaggableOn::Taggable::Collection
+        include ActsAsTaggableOn::Taggable::Cache
+        include ActsAsTaggableOn::Taggable::Ownership
+        include ActsAsTaggableOn::Taggable::Related
+        include ActsAsTaggableOn::Taggable::Dirty
+      end
+
+  end
+end

data/lib/acts_as_taggable_on/tagger.rb

@@ -0,0 +1,76 @@
+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_with_compatibility :owned_taggings, 
+            opts.merge(
+              :as => :tagger, 
+              :dependent => :destroy,
+              :class_name => "ActsAsTaggableOn::Tagging"
+            )
+
+          has_many_with_compatibility :owned_tags, 
+                                      :through => :owned_taggings, 
+                                      :source => :tag, 
+                                      :class_name => "ActsAsTaggableOn::Tag", 
+                                      :uniq => true
+        end
+
+        include ActsAsTaggableOn::Tagger::InstanceMethods
+        extend ActsAsTaggableOn::Tagger::SingletonMethods
+      end
+
+      def is_tagger?
+        false
+      end
+    end
+
+    module InstanceMethods
+      ##
+      # Tag a taggable model with tags that are owned by the tagger.
+      #
+      # @param taggable The object that will be tagged
+      # @param [Hash] options An hash with options. Available options are:
+      #               * <tt>:with</tt> - The tags that you want to
+      #               * <tt>:on</tt>   - The context on which you want to tag
+      #
+      # Example:
+      #   @user.tag(@photo, :with => "paris, normandy", :on => :locations)
+      def tag(taggable, opts={})
+        opts.reverse_merge!(:force => true)
+        skip_save = opts.delete(:skip_save)
+        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 unless skip_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/tagging.rb

@@ -0,0 +1,34 @@
+module ActsAsTaggableOn
+  class Tagging < ::ActiveRecord::Base #:nodoc:
+    attr_accessible :tag,
+                    :tag_id,
+                    :context,
+                    :taggable,
+                    :taggable_type,
+                    :taggable_id,
+                    :tagger,
+                    :tagger_type,
+                    :tagger_id if defined?(ActiveModel::MassAssignmentSecurity)
+
+    belongs_to :tag, :class_name => 'ActsAsTaggableOn::Tag'
+    belongs_to :taggable, :polymorphic => true
+    belongs_to :tagger,   :polymorphic => true
+
+    validates_presence_of :context
+    validates_presence_of :tag_id
+
+    validates_uniqueness_of :tag_id, :scope => [ :taggable_type, :taggable_id, :context, :tagger_id, :tagger_type ]
+
+    after_destroy :remove_unused_tags
+
+    private
+
+    def remove_unused_tags
+      if ActsAsTaggableOn.remove_unused_tags
+        if tag.taggings.count.zero?
+          tag.destroy
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/tags_helper.rb

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

data/lib/acts_as_taggable_on/utils.rb

@@ -0,0 +1,34 @@
+module ActsAsTaggableOn
+  module Utils
+    def self.included(base)
+
+      base.send :include, ActsAsTaggableOn::Utils::OverallMethods
+      base.extend ActsAsTaggableOn::Utils::OverallMethods
+    end
+
+    module OverallMethods
+      def using_postgresql?
+        ::ActiveRecord::Base.connection && ::ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      end
+
+      def using_sqlite?
+        ::ActiveRecord::Base.connection && ::ActiveRecord::Base.connection.adapter_name == 'SQLite'
+      end
+
+      def sha_prefix(string)
+        Digest::SHA1.hexdigest("#{string}#{rand}")[0..6]
+      end
+      
+      private
+      def like_operator
+        using_postgresql? ? 'ILIKE' : 'LIKE'
+      end
+
+      # escape _ and % characters in strings, since these are wildcards in SQL.
+       def escape_like(str)
+         str.gsub(/[!%_]/){ |x| '!' + x }
+       end
+    end
+
+  end
+end

data/lib/acts_as_taggable_on/version.rb

@@ -0,0 +1,4 @@
+module ActsAsTaggableOn
+  VERSION = '3.0.0.rc1'
+end
+

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -0,0 +1,265 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe "Acts As Taggable On" do
+  before(:each) do
+    clean_database!
+  end
+
+  it "should provide a class method 'taggable?' that is false for untaggable models" do
+    UntaggableModel.should_not be_taggable
+  end
+
+  describe "Taggable Method Generation To Preserve Order" do
+    before(:each) do
+      clean_database!
+      TaggableModel.tag_types = []
+      TaggableModel.preserve_tag_order = false
+      TaggableModel.acts_as_ordered_taggable_on(:ordered_tags)
+      @taggable = TaggableModel.new(:name => "Bob Jones")
+    end
+
+    it "should respond 'true' to preserve_tag_order?" do
+      @taggable.class.preserve_tag_order?.should be_true
+    end
+  end
+
+  describe "Taggable Method Generation" do
+    before(:each) do
+      clean_database!
+      TaggableModel.tag_types = []
+      TaggableModel.acts_as_taggable_on(:tags, :languages, :skills, :needs, :offerings)
+      @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 create an instance attribute for tag types" do
+      @taggable.should respond_to(:tag_types)
+    end
+
+    it "should have all tag types" do
+      @taggable.tag_types.should == [:tags, :languages, :skills, :needs, :offerings]
+    end
+
+    it "should create a class attribute for preserve tag order" do
+      @taggable.class.should respond_to(:preserve_tag_order?)
+    end
+
+    it "should create an instance attribute for preserve tag order" do
+      @taggable.should respond_to(:preserve_tag_order?)
+    end
+
+    it "should respond 'false' to preserve_tag_order?" do
+      @taggable.class.preserve_tag_order?.should be_false
+    end
+
+    it "should generate an association for each tag type" do
+      @taggable.should respond_to(:tags, :skills, :languages)
+    end
+
+    it "should add tagged_with and tag_counts to singleton" do
+      TaggableModel.should respond_to(:tagged_with, :tag_counts)
+    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
+
+    it "should generate a tag_list accessor, that includes owned tags, for each tag type" do
+      @taggable.should respond_to(:all_tags_list, :all_skills_list, :all_languages_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 "Matching Contexts" do
+    it "should find objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+      taggable3 = TaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.offering_list = "one, two"
+      taggable1.save!
+
+      taggable2.need_list = "one, two"
+      taggable2.save!
+
+      taggable3.offering_list = "one, two"
+      taggable3.save!
+
+      taggable1.find_matching_contexts(:offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts(:offerings, :needs).should_not include(taggable3)
+    end
+
+    it "should find other related objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = OtherTaggableModel.create!(:name => "Taggable 2")
+      taggable3 = OtherTaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.offering_list = "one, two"
+      taggable1.save
+
+      taggable2.need_list = "one, two"
+      taggable2.save
+
+      taggable3.offering_list = "one, two"
+      taggable3.save
+
+      taggable1.find_matching_contexts_for(OtherTaggableModel, :offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts_for(OtherTaggableModel, :offerings, :needs).should_not include(taggable3)
+    end
+
+    it "should not include the object itself in the list of related objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+
+      taggable1.offering_list = "one, two"
+      taggable1.need_list = "one, two"
+      taggable1.save
+
+      taggable2.need_list = "one, two"
+      taggable2.save
+
+      taggable1.find_matching_contexts_for(TaggableModel, :offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts_for(TaggableModel, :offerings, :needs).should_not include(taggable1)
+    end
+
+  end
+
+  describe 'Tagging Contexts' do
+    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
+  end
+
+  context 'when tagging context ends in an "s" when singular (ex. "status", "glass", etc.)' do
+   describe 'caching' do
+     before  { @taggable = OtherCachedModel.new(:name => "John Smith") }
+     subject { @taggable }
+
+     it { should respond_to(:save_cached_tag_list) }
+     its(:cached_language_list) { should be_blank }
+     its(:cached_status_list)   { should be_blank }
+     its(:cached_glass_list)    { should be_blank }
+
+     context 'language taggings cache after update' do
+       before  { @taggable.update_attributes(:language_list => 'ruby, .net') }
+       subject { @taggable }
+
+       its(:language_list)        { should == ['ruby', '.net']}
+       its(:cached_language_list) { should == 'ruby, .net' }           # passes
+       its(:instance_variables)   { should     include((RUBY_VERSION < '1.9' ? '@language_list' : :@language_list)) }
+     end
+
+     context 'status taggings cache after update' do
+       before  { @taggable.update_attributes(:status_list => 'happy, married') }
+       subject { @taggable }
+
+       its(:status_list)        { should     == ['happy', 'married'] }
+       its(:cached_status_list) { should     == 'happy, married'     } # fails
+       its(:cached_status_list) { should_not == ''                   } # fails, is blank
+       its(:instance_variables) { should     include((RUBY_VERSION < '1.9' ? '@status_list' : :@status_list)) }
+       its(:instance_variables) { should_not include((RUBY_VERSION < '1.9' ? '@statu_list' : :@statu_list))  } # fails, note: one "s"
+
+     end
+
+     context 'glass taggings cache after update' do
+       before do
+         @taggable.update_attributes(:glass_list => 'rectangle, aviator')
+       end
+
+       subject { @taggable }
+       its(:glass_list)         { should     == ['rectangle', 'aviator'] }
+       its(:cached_glass_list)  { should     == 'rectangle, aviator'     } # fails
+       its(:cached_glass_list)  { should_not == ''                       } # fails, is blank
+       if RUBY_VERSION < '1.9'
+         its(:instance_variables) { should     include('@glass_list')      }
+         its(:instance_variables) { should_not include('@glas_list')       } # fails, note: one "s"
+       else
+         its(:instance_variables) { should     include(:@glass_list)      }
+         its(:instance_variables) { should_not include(:@glas_list)       } # fails, note: one "s"
+       end
+
+     end
+   end
+  end
+
+  describe "taggings" do
+    before(:each) do
+      @taggable = TaggableModel.new(:name => "Art Kram")
+    end
+
+    it 'should return [] taggings' do
+      @taggable.taggings.should == []
+    end
+  end
+
+  describe "@@remove_unused_tags" do
+    before do
+      @taggable = TaggableModel.create(:name => "Bob Jones")
+      @tag = ActsAsTaggableOn::Tag.create(:name => "awesome")
+
+      @tagging = ActsAsTaggableOn::Tagging.create(:taggable => @taggable, :tag => @tag, :context => 'tags')
+    end
+
+    context "if set to true" do
+      before do
+        ActsAsTaggableOn.remove_unused_tags = true
+      end
+
+      it "should remove unused tags after removing taggings" do
+        @tagging.destroy
+        ActsAsTaggableOn::Tag.find_by_name("awesome").should be_nil
+      end
+    end
+
+    context "if set to false" do
+      before do
+        ActsAsTaggableOn.remove_unused_tags = false
+      end
+
+      it "should not remove unused tags after removing taggings" do
+        @tagging.destroy
+        ActsAsTaggableOn::Tag.find_by_name("awesome").should == @tag
+      end
+    end
+  end
+
+end