bbenezech-acts-as-taggable-on 0.0.2

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, :uniq => true
+          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/group_helper.rb

@@ -0,0 +1,12 @@
+module ActiveRecord
+  module Acts
+    module TaggableOn
+      module GroupHelper
+        # all column names are necessary for PostgreSQL group clause
+        def grouped_column_names_for(object)
+          object.column_names.map { |column| "#{object.table_name}.#{column}" }.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/tag.rb

@@ -0,0 +1,27 @@
+class Tag < ActiveRecord::Base
+  has_many :taggings, :dependent => :destroy
+  
+  validates_presence_of :name
+  validates_uniqueness_of :name
+  
+  named_scope :named, lambda { |name| { :conditions => ["name = ?", name] } }
+  named_scope :named_like, lambda { |name| { :conditions => ["name LIKE ?", "%#{name}%"] } }
+  named_scope :named_like_any, lambda { |list| { :conditions => list.map { |tag| sanitize_sql(["name LIKE ?", tag.to_s]) }.join(" OR ") } }
+  
+  # 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,95 @@
+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)
+      string = string.join(", ") if string.respond_to?(:join)
+
+      returning new do |tag_list|
+        string = string.to_s.dup
+        
+        # Parse the quoted tags
+        string.gsub!(/(\A|#{delimiter})\s*"(.*?)"\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
+        string.gsub!(/(\A|#{delimiter})\s*'(.*?)'\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
+        
+        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,11 @@
+class Tagging < ActiveRecord::Base #:nodoc:
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+  belongs_to :tagger, :polymorphic => true
+  
+  validates_presence_of :context
+  acts_as_list :scope => 'taggable_id = #{taggable_id} AND taggable_type = \'#{taggable_type}\' AND context = \'#{context}\''
+  default_scope :order => 'position'
+  validates_presence_of :tag_id
+  validates_uniqueness_of :tag_id, :scope => [:taggable_type, :taggable_id, :context]
+end

data/lib/acts_as_taggable_on/tags_helper.rb

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

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'acts-as-taggable-on'
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::TaggableOn
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Tagger
+ActionView::Base.send :include, TagsHelper if defined?(ActionView::Base)

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -0,0 +1,207 @@
+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 create an instance attribute for tag types" do
+      @taggable.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
+
+    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
+
+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