litmus-acts-as-taggable-on 2.0.4

data/lib/acts_as_taggable_on/acts_as_taggable_on/related.rb

@@ -0,0 +1,65 @@
+module ActsAsTaggableOn::Taggable
+  module Related
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Related::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Related::ClassMethods
+      base.initialize_acts_as_taggable_on_related
+    end
+    
+    module ClassMethods
+      def initialize_acts_as_taggable_on_related
+        tag_types.map(&:to_s).each do |tag_type|
+          class_eval %(
+            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
+
+            def find_matching_contexts(search_context, result_context, options = {})
+              matching_contexts_for(search_context.to_s, result_context.to_s, self.class, options)
+            end
+
+            def find_matching_contexts_for(klass, search_context, result_context, options = {})
+              matching_contexts_for(search_context.to_s, result_context.to_s, klass, options)
+            end
+          )
+        end        
+      end
+      
+      def acts_as_taggable_on(*args)
+        super(*args)
+        initialize_acts_as_taggable_on_related
+      end
+    end
+    
+    module InstanceMethods
+      def matching_contexts_for(search_context, result_context, klass, options = {})
+        tags_to_find = tags_on(search_context).collect { |t| t.name }
+
+        exclude_self = "#{klass.table_name}.id != #{id} AND" if self.class == klass
+        
+        klass.scoped({ :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
+                       :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
+                       :conditions => ["#{exclude_self} #{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 (?) AND #{Tagging.table_name}.context = ?", tags_to_find, result_context],
+                       :group      => grouped_column_names_for(klass),
+                       :order      => "count DESC" }.update(options))
+      end
+      
+      def related_tags_for(context, klass, options = {})
+        tags_to_find = tags_on(context).collect { |t| t.name }
+
+        exclude_self = "#{klass.table_name}.id != #{id} AND" if self.class == klass
+
+        klass.scoped({ :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
+                       :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
+                       :conditions => ["#{exclude_self} #{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      => grouped_column_names_for(klass),
+                       :order      => "count DESC" }.update(options))
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_tagger.rb

@@ -0,0 +1,67 @@
+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 :owned_taggings, opts.merge(:as => :tagger, :dependent => :destroy,
+                                               :include => :tag, :class_name => "Tagging")
+          has_many :owned_tags, :through => :owned_taggings, :source => :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)
+
+        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
+      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/compatibility/Gemfile

@@ -0,0 +1,6 @@
+source :gemcutter
+
+# Rails 2.3
+gem 'rails',        '2.3.5'
+gem 'rspec',        '1.3.0', :require => 'spec'
+gem 'sqlite3-ruby', '1.2.5', :require => 'sqlite3'

data/lib/acts_as_taggable_on/compatibility/active_record_backports.rb

@@ -0,0 +1,17 @@
+module ActsAsTaggableOn
+  module ActiveRecord
+    module Backports
+      def self.included(base)
+        base.class_eval do
+          named_scope :where,    lambda { |conditions| { :conditions => conditions } }  
+          named_scope :joins,    lambda { |joins|      { :joins => joins } }
+          named_scope :group,    lambda { |group|      { :group => group } }
+          named_scope :order,    lambda { |order|      { :order => order } }
+          named_scope :select,   lambda { |select|     { :select => select } }
+          named_scope :limit,    lambda { |limit|      { :limit => limit } }
+          named_scope :readonly, lambda { |readonly|   { :readonly => readonly } }   
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/tag.rb

@@ -0,0 +1,67 @@
+class Tag < ActiveRecord::Base
+  include ActsAsTaggableOn::ActiveRecord::Backports if ActiveRecord::VERSION::MAJOR < 3
+  include ::TagValidations
+  include ::TagCustomisations
+
+  attr_accessible :name
+
+  ### ASSOCIATIONS:
+
+  has_many :taggings, :dependent => :destroy
+
+  ### VALIDATIONS:
+
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  ### SCOPES:
+
+  def self.named(name)
+    where(["name LIKE ?", name])
+  end
+  
+  def self.named_any(list)
+    where(list.map { |tag| sanitize_sql(["name LIKE ?", tag.to_s]) }.join(" OR "))
+  end
+  
+  def self.named_like(name)
+    where(["name LIKE ?", "%#{name}%"])
+  end
+
+  def self.named_like_any(list)
+    where(list.map { |tag| sanitize_sql(["name LIKE ?", "%#{tag.to_s}%"]) }.join(" OR "))
+  end
+
+  ### CLASS METHODS:
+
+  def self.find_or_create_with_like_by_name(name)
+    named_like(name).first || create(:name => name)
+  end
+
+  def self.find_or_create_all_with_like_by_name(*list)
+    list = [list].flatten
+
+    return [] if list.empty?
+
+    existing_tags = Tag.named_any(list).all
+    new_tag_names = list.reject { |name| existing_tags.any? { |tag| tag.name.mb_chars.downcase == name.mb_chars.downcase } }
+    created_tags  = new_tag_names.map { |name| Tag.create(:name => name) }
+
+    existing_tags + created_tags
+  end
+
+  ### INSTANCE METHODS:
+
+  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 = ','
+
+  attr_accessor :owner
+
+  def initialize(*args)
+    add(*args)
+  end
+  
+  ##
+  # Returns a new TagList using the given tag string.
+  #
+  # Example:
+  #   tag_list = TagList.from("One , Two,  Three")
+  #   tag_list # ["One", "Two", "Three"]
+  def self.from(string)
+    string = string.join(", ") if string.respond_to?(:join)
+
+    new.tap 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
+
+  ##
+  # Add tags to the tag_list. Duplicate or blank tags will be ignored.
+  # Use the <tt>:parse</tt> option to add an unparsed tag string.
+  #
+  # Example:
+  #   tag_list.add("Fun", "Happy")
+  #   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.
+  # Use the <tt>:parse</tt> option to add an unparsed tag string.
+  #
+  # Example:
+  #   tag_list.remove("Sad", "Lonely")
+  #   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.
+  #
+  # Example:
+  #   tag_list = TagList.new("Round", "Square,Cube")
+  #   tag_list.to_s # 'Round, "Square,Cube"'
+  def to_s
+    tags = frozen? ? self.dup : self
+    tags.send(:clean!)
+
+    tags.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
+
+end

data/lib/acts_as_taggable_on/tagging.rb

@@ -0,0 +1,23 @@
+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
+  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

data/lib/acts_as_taggable_on/tags_helper.rb

@@ -0,0 +1,17 @@
+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

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

@@ -0,0 +1,31 @@
+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)
+    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,266 @@
+require File.dirname(__FILE__) + '/../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" 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 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