yetanothernguyen-acts-as-taggable-on 0.0.4

data/lib/acts_as_taggable_on/tagging.rb

@@ -0,0 +1,24 @@
+module ActsAsTaggableOn
+  class Tagging < ::ActiveRecord::Base #:nodoc:
+    include ActsAsTaggableOn::ActiveRecord::Backports if ::ActiveRecord::VERSION::MAJOR < 3
+
+    attr_accessible :tag,
+                    :tag_id,
+                    :context,
+                    :taggable,
+                    :taggable_type,
+                    :taggable_id,
+                    :tagger,
+                    :tagger_type,
+                    :tagger_id
+
+    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 ]
+  end
+end

data/lib/acts_as_taggable_on/tags_helper.rb

@@ -0,0 +1,17 @@
+module ActsAsTaggableOn
+  module TagsHelper
+    # See the README for an example using tag_cloud.
+    def tag_cloud(tags, classes)
+      tags = tags.all if tags.respond_to?(:all)
+
+      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)).round
+        yield tag, classes[index]
+      end
+    end
+  end
+end

data/lib/generators/acts_as_taggable_on/migration/migration_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/migration'
+
+module ActsAsTaggableOn
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for Tag and Tagging models"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/acts_as_taggable_on_migration'
+      end
+    end
+  end
+end
+

data/lib/generators/acts_as_taggable_on/migration/templates/active_record/migration.rb

@@ -0,0 +1,28 @@
+class ActsAsTaggableOnMigration < ActiveRecord::Migration
+  def self.up
+    create_table :tags do |t|
+      t.string :name
+    end
+
+    create_table :taggings do |t|
+      t.references :tag
+
+      # You should make sure that the column created is
+      # long enough to store the required class names.
+      t.references :taggable, :polymorphic => true
+      t.references :tagger, :polymorphic => true
+
+      t.string :context
+
+      t.datetime :created_at
+    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/rails/init.rb

@@ -0,0 +1 @@
+require 'acts-as-taggable-on'

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -0,0 +1,268 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+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" do
+    before(:each) do
+      clean_database!
+      TaggableModel.write_inheritable_attribute(: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 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 "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
+  
+    it "should not include the object itself in the list of related objects" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+  
+      taggable1.tag_list = "one"
+      taggable1.save
+  
+      taggable2.tag_list = "one, two"
+      taggable2.save
+  
+      taggable1.find_related_tags.should include(taggable2)
+      taggable1.find_related_tags.should_not include(taggable1)
+    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" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+  
+      taggable1.tag_list = "one"
+      taggable1.save
+  
+      taggable2.tag_list = "one, two"
+      taggable2.save
+  
+      taggable1.find_related_tags.should include(taggable2)
+      taggable1.find_related_tags.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
+  
+  describe 'Caching' do
+    before(:each) do
+      @taggable = CachedModel.new(:name => "Bob Jones")  
+    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 cached column checker for each tag type" do
+      CachedModel.should respond_to(:caching_tag_list?)
+    end  
+    
+    it 'should not have cached tags' do
+      @taggable.cached_tag_list.should be_blank  
+    end
+    
+    it 'should cache tags' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable.cached_tag_list.should == 'awesome, epic'
+    end
+    
+    it 'should keep the cache' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable = CachedModel.find(@taggable)  
+      @taggable.save!
+      @taggable.cached_tag_list.should == 'awesome, epic'   
+    end
+    
+    it 'should update the cache' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable.update_attributes(:tag_list => 'awesome')
+      @taggable.cached_tag_list.should == 'awesome'      
+    end
+    
+    it 'should remove the cache' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable.update_attributes(:tag_list => '')
+      @taggable.cached_tag_list.should be_blank  
+    end
+    
+    it 'should have a tag list' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable = CachedModel.find(@taggable.id)
+      @taggable.tag_list.sort.should == %w(awesome epic).sort
+    end
+    
+    it 'should keep the tag list' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable = CachedModel.find(@taggable.id)
+      @taggable.save!
+      @taggable.tag_list.sort.should == %w(awesome epic).sort
+    end
+  end
+
+end

data/spec/acts_as_taggable_on/acts_as_tagger_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "acts_as_tagger" do
+  before(:each) do
+    clean_database!
+  end
+  
+  describe "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_not include('that')
+        @taggable.all_tags_list_on(:here_ond_now).should include('that')
+      end
+      
+      it "should show all the tag list when both public and owned tags exist" do
+        @taggable.tag_list = 'ruby, python'
+        @tagger.tag(@taggable, :with => 'java, lisp', :on => :tags)
+        @taggable.all_tags_on(:tags).map(&:name).sort.should == %w(ruby python java lisp).sort
+      end
+      
+      it "should not add owned tags to the common list" do
+        @taggable.tag_list = 'ruby, python'
+        @tagger.tag(@taggable, :with => 'java, lisp', :on => :tags)
+        @taggable.tag_list.should == %w(ruby python)
+        @tagger.tag(@taggable, :with => '', :on => :tags)
+        @taggable.tag_list.should == %w(ruby python)
+      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
+    
+    describe "when called by multiple tagger's" do
+      before(:each) do
+        @user_x = TaggableUser.create(:name => "User X")
+        @user_y = TaggableUser.create(:name => "User Y")
+        @taggable = TaggableModel.create(:name => 'acts_as_taggable_on', :tag_list => 'plugin')
+        
+        @user_x.tag(@taggable, :with => 'ruby, rails',  :on => :tags)
+        @user_y.tag(@taggable, :with => 'ruby, plugin', :on => :tags)
+
+        @user_y.tag(@taggable, :with => '', :on => :tags)
+        @user_y.tag(@taggable, :with => '', :on => :tags)
+      end
+      
+      it "should delete owned tags" do        
+        @user_y.owned_tags.should == []
+      end
+      
+      it "should not delete other taggers tags" do
+        @user_x.owned_tags.should have(2).items
+      end
+      
+      it "should not delete original tags" do
+        @taggable.all_tags_list_on(:tags).should include('plugin')
+      end
+    end
+  end
+
+end