mbleigh-acts-as-taggable-on 1.0.0 → 1.0.1

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 2008-06-23
+
+* Can now find related objects of another class (tristanzdunn)
+* Removed extraneous down migration cruft (azabaj)
+
 == 2008-06-09
  
  * Added support for Single Table Inheritance

data/README

@@ -35,12 +35,23 @@ GemPlugin
 Acts As Taggable On is also available as a gem plugin using Rails 2.1's gem dependencies.
 To install the gem, add this to your config/environment.rb:
   
-  config.gem "mbleigh-acts-as-taggable-on", :source => "http://gems.github.com"
+  config.gem "mbleigh-acts-as-taggable-on", :source => "http://gems.github.com", :lib => "acts-as-taggable-on"
   
 After that, you can run "rake gems:install" to install the gem if you don't already have it.
 See http://ryandaigle.com/articles/2008/4/1/what-s-new-in-edge-rails-gem-dependencies for
 additional details about gem dependencies in Rails.
 
+** NOTE **
+Some issues have been experienced with "rake gems:install". If that doesn't work to install the gem,
+try just installing it as a normal gem:
+
+  gem install mbleigh-acts-as-taggable-on --source http://gems.github.com
+
+Post Installation (Rails)
+-------------------------
+1. script/generate acts_as_taggable_on_migration
+2. rake db/migrate
+
 Testing
 =======
 
@@ -135,14 +146,19 @@ Contributors
 ============
 
 * Michael Bleigh - Original Author
-* Brendan Lim - Related objects
+* Brendan Lim - Related Objects
 * Pradeep Elankumaran - Taggers
+* Sinclair Bain - Patch King
 
 Patch Contributors
 ------------------
 
+* tristanzdunn - Related objects of other classes
+* azabaj - Fixed migrate down
 * Peter Cooper - named_scope fix
 * slainer68 - STI fix
+* harrylove - migration instructions and fix-ups
+* lawrencepit - cached tag work
 
 Resources
 =========

data/generators/acts_as_taggable_on_migration/acts_as_taggable_on_migration_generator.rb

@@ -2,7 +2,6 @@ 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"
-      m.migration_template 'add_users_migration.rb', 'db/migrate', :migration_file_name => "add_users_to_acts_as_taggable_on_migration"
-    end 
+    end
   end
 end

data/generators/acts_as_taggable_on_migration/templates/migration.rb

@@ -7,6 +7,8 @@ class ActsAsTaggableOnMigration < ActiveRecord::Migration
     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.

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -6,12 +6,17 @@ module ActiveRecord
       end
       
       module ClassMethods
+        def taggable?
+          false
+        end
+        
         def acts_as_taggable
           acts_as_taggable_on :tags
         end
         
         def acts_as_taggable_on(*args)
-          puts "Registering #{args.inspect} with #{self.inspect}"
+          args.flatten! if args
+          args.compact! if args
           for tag_type in args
             tag_type = tag_type.to_s
             self.class_eval do
@@ -21,6 +26,10 @@ module ActiveRecord
             end
             
             self.class_eval <<-RUBY
+              def self.taggable?
+                true
+              end
+              
               def self.caching_#{tag_type.singularize}_list?
                 caching_tag_list_on?("#{tag_type}")
               end
@@ -46,18 +55,21 @@ module ActiveRecord
               end
               
               def find_related_#{tag_type}(options = {})
-                related_tags_on('#{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)
-            puts "Appending #{args.inspect} onto #{tag_types.inspect}"
-            write_inheritable_attribute(:tag_types, tag_types + args)
+            write_inheritable_attribute( :tag_types, (tag_types + args).uniq )
           else
             self.class_eval do
-              write_inheritable_attribute(:tag_types, args)
+              write_inheritable_attribute(:tag_types, args.uniq)
               class_inheritable_reader :tag_types
             
               has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
@@ -207,9 +219,10 @@ module ActiveRecord
         
         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, owner)).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)))
@@ -238,18 +251,22 @@ module ActiveRecord
         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_on(context, options={})
-          tags_to_find = self.tags_on(context).collect {|t| t.name}
-          search_conditions = { 
-            :select     => "#{self.class.table_name}.*, COUNT(#{Tag.table_name}.id) AS count", 
-            :from       => "#{self.class.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
-            :conditions => ["#{self.class.table_name}.id != #{self.id} AND #{self.class.table_name}.id = #{Tagging.table_name}.taggable_id AND #{Tagging.table_name}.taggable_type = '#{self.class.to_s}' AND #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND #{Tag.table_name}.name IN (?)",tags_to_find],
-            :group      => "#{self.class.table_name}.id",
+
+        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)
-          
-          self.class.find(:all, search_conditions)
         end
         
         def save_cached_tag_list

data/lib/acts_as_taggable_on/acts_as_tagger.rb

@@ -24,10 +24,14 @@ module ActiveRecord
         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 taggable.tag_types.include?(opts[:on])
+          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

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -1,11 +1,20 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe "acts_as_taggable_on" do
-  context "Taggable Method Generation" do
+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
@@ -33,7 +42,7 @@ describe "acts_as_taggable_on" do
     end
   end
   
-  context "inheritance" do
+  describe "Single Table Inheritance" do
     before do
       @taggable = TaggableModel.new(:name => "taggable")
       @inherited_same = InheritingTaggableModel.new(:name => "inherited same")
@@ -50,7 +59,7 @@ describe "acts_as_taggable_on" do
     end
   end
   
-  context "reloading" do
+  describe "Reloading" do
     it "should save a model instantiated by Model.find" do
       taggable = TaggableModel.create!(:name => "Taggable")
       found_taggable = TaggableModel.find(taggable.id)
@@ -58,7 +67,7 @@ describe "acts_as_taggable_on" do
     end
   end
   
-  context "related" do
+  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")
@@ -76,5 +85,67 @@ describe "acts_as_taggable_on" do
       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/taggable_spec.rb

@@ -2,6 +2,7 @@ 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
   
@@ -13,6 +14,13 @@ describe "Taggable" do
     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"
@@ -89,8 +97,9 @@ describe "Taggable" do
     TaggableModel.find_tagged_with("spinning", :on => :rotors).should_not be_empty
   end
   
-  context "inheritance" do
+  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")

data/spec/acts_as_taggable_on/tagger_spec.rb

@@ -2,6 +2,7 @@ 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

data/spec/schema.rb

@@ -1,16 +1,19 @@
 ActiveRecord::Schema.define :version => 0 do
-  create_table :tags, :force => true do |t|
-    t.column :name, :string
+  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
-  
-  create_table :taggings, :force => true do |t|
-    t.column :tag_id, :integer
-    t.column :taggable_id, :integer
-    t.column :taggable_type, :string
-    t.column :context, :string
-    t.column :created_at, :datetime
-    t.column :tagger_id, :integer
-    t.column :tagger_type, :string
+
+  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|
@@ -21,4 +24,9 @@ ActiveRecord::Schema.define :version => 0 do
   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_helper.rb

@@ -1,5 +1,9 @@
 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")
 
@@ -10,6 +14,10 @@ class TaggableModel < ActiveRecord::Base
   acts_as_taggable_on :skills
 end
 
+class OtherTaggableModel < ActiveRecord::Base
+  acts_as_taggable_on :tags, :languages
+end
+
 class InheritingTaggableModel < TaggableModel
 end
 
@@ -19,4 +27,7 @@ end
 
 class TaggableUser < ActiveRecord::Base
   acts_as_tagger
+end
+
+class UntaggableModel < ActiveRecord::Base
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mbleigh-acts-as-taggable-on
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Tagging for ActiveRecord with custom contexts and advanced features.

data/generators/acts_as_taggable_on_migration/templates/add_users_migration.rb

@@ -1,11 +0,0 @@
-class AddUsersToActsAsTaggableOnMigration < ActiveRecord::Migration
-  def self.up
-    add_column :taggings, :tagger_id, :integer
-    add_column :taggings, :tagger_type, :string
-  end
-  
-  def self.down
-    remove_column :taggings, :tagger_type
-    remove_column :taggings, :tagger_id
-  end
-end