acts-as-taggable-on 1.0.13 → 1.0.19

data/README.rdoc

@@ -151,6 +151,12 @@ A helper is included to assist with generating tag clouds.
 
 Here is an example that generates a tag cloud.
 
+Helper:
+
+  module PostsHelper
+    include TagsHelper
+  end
+
 Controller:
 
   class PostController < ApplicationController
@@ -160,7 +166,8 @@ Controller:
   end
 
 View:
-  <% tag_cloud @tags, %w(css1 css2 css3 css4) do |tag, css_class| %>
+
+  <% tag_cloud(@tags, %w(css1 css2 css3 css4)) do |tag, css_class| %>
     <%= link_to tag.name, { :action => :tag, :id => tag.name }, :class => css_class %>
   <% end %>
 
@@ -187,5 +194,6 @@ CSS:
 * slainer68 - STI fix
 * harrylove - migration instructions and fix-ups
 * lawrencepit - cached tag work
+* sobrinho - fixed tag_cloud helper
 
 Copyright (c) 2007-2009 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/), released under the MIT license

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gemspec.email = "michael@intridea.com"
     gemspec.homepage = "http://github.com/mbleigh/acts-as-taggable-on"
     gemspec.authors = ["Michael Bleigh"]
-    gemspec.files =  FileList["[A-Z]*", "{lib,spec,rails}/**/*"] - FileList["**/*.log"]
+    gemspec.files =  FileList["[A-Z]*", "{generators,lib,spec,rails}/**/*"] - FileList["**/*.log"]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.0.13
+1.0.19

data/generators/acts_as_taggable_on_migration/acts_as_taggable_on_migration_generator.rb

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

data/generators/acts_as_taggable_on_migration/templates/migration.rb

@@ -0,0 +1,29 @@
+class ActsAsTaggableOnMigration < ActiveRecord::Migration
+  def self.up
+    create_table :tags do |t|
+      t.column :name, :string
+    end
+    
+    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.
+      t.column :taggable_type, :string
+      t.column :context, :string
+      
+      t.column :created_at, :datetime
+    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/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -19,15 +19,15 @@ module ActiveRecord
           args.compact! if args
           for tag_type in args
             tag_type = tag_type.to_s
-            # use aliased_join_table_name for context condition so that sphix can join multiple
+            # use aliased_join_table_name for context condition so that sphinx can join multiple
             # tag references from same model without getting an ambiguous column error
-            self.class_eval do
+            class_eval do
               has_many "#{tag_type.singularize}_taggings".to_sym, :as => :taggable, :dependent => :destroy,
-                :include => :tag, :conditions => ['#{aliased_join_table_name rescue "taggings"}.context = ?',tag_type], :class_name => "Tagging"
+                :include => :tag, :conditions => ['#{aliased_join_table_name || Tagging.table_name rescue Tagging.table_name}.context = ?',tag_type], :class_name => "Tagging"
               has_many "#{tag_type}".to_sym, :through => "#{tag_type.singularize}_taggings".to_sym, :source => :tag
             end
 
-            self.class_eval <<-RUBY
+            class_eval <<-RUBY
               def self.taggable?
                 true
               end
@@ -86,7 +86,7 @@ module ActiveRecord
           if respond_to?(:tag_types)
             write_inheritable_attribute( :tag_types, (tag_types + args).uniq )
           else
-            self.class_eval do
+            class_eval do
               write_inheritable_attribute(:tag_types, args.uniq)
               class_inheritable_reader :tag_types
 
@@ -117,6 +117,7 @@ module ActiveRecord
         # Pass either a tag string, or an array of strings or tags
         #
         # Options:
+        #   :any - find models that match any of the given tags
         #   :exclude - Find models that are not tagged with the given tags
         #   :match_all - Find models that match all of the given tags, not just one
         #   :conditions - A piece of SQL conditions to add to the query
@@ -139,9 +140,9 @@ module ActiveRecord
         end
 
         def find_options_for_find_tagged_with(tags, options = {})
-          tags = TagList.from(tags)
+          tag_list = TagList.from(tags)
 
-          return {} if tags.empty?
+          return {} if tag_list.empty?
 
           joins = []
           conditions = []
@@ -150,28 +151,30 @@ module ActiveRecord
 
 
           if options.delete(:exclude)
-            tags_conditions = tags.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
+            tags_conditions = tag_list.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
             conditions << "#{table_name}.#{primary_key} NOT IN (SELECT #{Tagging.table_name}.taggable_id FROM #{Tagging.table_name} JOIN #{Tag.table_name} ON #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND (#{tags_conditions}) WHERE #{Tagging.table_name}.taggable_type = #{quote_value(base_class.name)})"
 
+          elsif options.delete(:any)
+            tags_conditions = tag_list.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
+            conditions << "#{table_name}.#{primary_key} IN (SELECT #{Tagging.table_name}.taggable_id FROM #{Tagging.table_name} JOIN #{Tag.table_name} ON #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND (#{tags_conditions}) WHERE #{Tagging.table_name}.taggable_type = #{quote_value(base_class.name)})"
+
           else
+            tags = Tag.named_like_any(tag_list)
+            return { :conditions => "1 = 0" } unless tags.length == tag_list.length
+                      
             tags.each do |tag|
-              safe_tag = tag.gsub(/[^a-zA-Z0-9]/, '')
+              safe_tag = tag.name.gsub(/[^a-zA-Z0-9]/, '')
               prefix   = "#{safe_tag}_#{rand(1024)}"
 
               taggings_alias = "#{table_name}_taggings_#{prefix}"
-              tags_alias     = "#{table_name}_tags_#{prefix}"
 
               tagging_join  = "JOIN #{Tagging.table_name} #{taggings_alias}" +
                               "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
-                              " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}"
+                              " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}" +
+                              " AND #{taggings_alias}.tag_id = #{tag.id}"
               tagging_join << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context
 
-              tag_join     = "JOIN #{Tag.table_name} #{tags_alias}" +
-                             "  ON #{tags_alias}.id = #{taggings_alias}.tag_id" +
-                             " AND " + sanitize_sql(["#{tags_alias}.name like ?", tag])
-
               joins << tagging_join
-              joins << tag_join
             end
           end
 
@@ -187,7 +190,8 @@ module ActiveRecord
 
           { :joins      => joins.join(" "),
             :group      => group,
-            :conditions => conditions.join(" AND ") }.update(options)
+            :conditions => conditions.join(" AND "),
+            :readonly   => false }.update(options)
         end
 
         # Calculate the tag counts for all tags.
@@ -225,14 +229,32 @@ module ActiveRecord
 
           joins = ["LEFT OUTER JOIN #{Tagging.table_name} ON #{Tag.table_name}.id = #{Tagging.table_name}.tag_id"]
           joins << sanitize_sql(["AND #{Tagging.table_name}.context = ?",options.delete(:on).to_s]) unless options[:on].nil?
-
           joins << " INNER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{Tagging.table_name}.taggable_id"
-          unless self.descends_from_active_record?
+          
+          unless descends_from_active_record?
             # Current model is STI descendant, so add type checking to the join condition
-            joins << " AND #{table_name}.#{self.inheritance_column} = '#{self.name}'"
+            joins << " AND #{table_name}.#{inheritance_column} = '#{name}'"
           end
 
-          joins << scope[:joins] if scope && scope[:joins]
+          # Based on a proposed patch by donV to ActiveRecord Base
+          # This is needed because merge_joins and construct_join are private in ActiveRecord Base
+          if scope && scope[:joins]
+            case scope[:joins]
+            when Array
+              scope_joins = scope[:joins].flatten
+              strings = scope_joins.select{|j| j.is_a? String}
+              joins << strings.join(' ') + " "
+              symbols = scope_joins - strings
+              join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, symbols, nil)
+              joins << " #{join_dependency.join_associations.collect { |assoc| assoc.association_join }.join} "
+              joins.flatten!
+            when Symbol, Hash
+              join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, scope[:joins], nil)
+              joins << " #{join_dependency.join_associations.collect { |assoc| assoc.association_join }.join} "
+            when String
+              joins << scope[:joins]
+            end
+          end
 
           at_least  = sanitize_sql(['COUNT(*) >= ?', options.delete(:at_least)]) if options[:at_least]
           at_most   = sanitize_sql(['COUNT(*) <= ?', options.delete(:at_most)]) if options[:at_most]
@@ -301,7 +323,7 @@ module ActiveRecord
         end
 
         def tag_counts_on(context, options={})
-          self.class.tag_counts_on(context, options.merge(:id => self.id))
+          self.class.tag_counts_on(context, options.merge(:id => id))
         end
 
         def related_tags_for(context, klass, options = {})
@@ -311,9 +333,9 @@ module ActiveRecord
         end
 
         def related_search_options(context, klass, options = {})
-          tags_to_find = self.tags_on(context).collect { |t| t.name }
+          tags_to_find = tags_on(context).collect { |t| t.name }
 
-          exclude_self = "#{klass.table_name}.id != #{self.id} AND" if self.class == klass
+          exclude_self = "#{klass.table_name}.id != #{id} AND" if self.class == klass
 
           { :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
             :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
@@ -330,9 +352,9 @@ module ActiveRecord
         end
         
         def matching_context_search_options(search_context, result_context, klass, options = {})
-          tags_to_find = self.tags_on(search_context).collect { |t| t.name }
+          tags_to_find = tags_on(search_context).collect { |t| t.name }
 
-          exclude_self = "#{klass.table_name}.id != #{self.id} AND" if self.class == klass
+          exclude_self = "#{klass.table_name}.id != #{id} AND" if self.class == klass
 
           { :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
             :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
@@ -357,7 +379,7 @@ module ActiveRecord
             new_tag_names = instance_variable_get("@#{tag_type.singularize}_list") - tags_on(tag_type).map(&:name)
             old_tags = tags_on(tag_type, owner).reject { |tag| instance_variable_get("@#{tag_type.singularize}_list").include?(tag.name) }
 
-            self.class.transaction do
+            transaction do
               base_tags.delete(*old_tags) if old_tags.any?
               new_tag_names.each do |new_tag_name|
                 new_tag = Tag.find_or_create_with_like_by_name(new_tag_name)
@@ -372,7 +394,7 @@ module ActiveRecord
 
         def reload_with_tag_list(*args)
           self.class.tag_types.each do |tag_type|
-            self.instance_variable_set("@#{tag_type.to_s.singularize}_list", nil)
+            instance_variable_set("@#{tag_type.to_s.singularize}_list", nil)
           end
 
           reload_without_tag_list(*args)

data/lib/acts_as_taggable_on/tag.rb

@@ -1,11 +1,23 @@
 class Tag < ActiveRecord::Base
+  
+  attr_accessible :name
+  
+  ### ASSOCIATIONS:
+  
   has_many :taggings, :dependent => :destroy
   
+  ### VALIDATIONS:
+  
   validates_presence_of :name
   validates_uniqueness_of :name
   
+  ### NAMED SCOPES:
+  
   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 ") } }
+  
+  ### METHODS:
   
   # LIKE is used for cross-database case-insensitivity
   def self.find_or_create_with_like_by_name(name)

data/lib/acts_as_taggable_on/tag_list.rb

@@ -41,9 +41,10 @@ class TagList < Array
   #   tag_list = TagList.new("Round", "Square,Cube")
   #   tag_list.to_s # 'Round, "Square,Cube"'
   def to_s
-    clean!
+    tags = frozen? ? self.dup : self
+    tags.send(:clean!)
     
-    map do |name|
+    tags.map do |name|
       name.include?(delimiter) ? "\"#{name}\"" : name
     end.join(delimiter.ends_with?(" ") ? delimiter : "#{delimiter} ")
   end
@@ -55,7 +56,7 @@ class TagList < Array
     map!(&:strip)
     uniq!
   end
-  
+    
   def extract_and_apply_options!(args)
     options = args.last.is_a?(Hash) ? args.pop : {}
     options.assert_valid_keys :parse
@@ -79,8 +80,8 @@ class TagList < Array
         string = string.to_s.dup
         
         # Parse the quoted tags
-        string.gsub!(/"(.*?)"\s*#{delimiter}?\s*/) { tag_list << $1; "" }
-        string.gsub!(/'(.*?)'\s*#{delimiter}?\s*/) { tag_list << $1; "" }
+        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

data/lib/acts_as_taggable_on/tagging.rb

@@ -1,8 +1,14 @@
 class Tagging < ActiveRecord::Base #:nodoc:
+  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]
 end

data/lib/acts_as_taggable_on/tags_helper.rb

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

data/rails/init.rb

@@ -2,6 +2,4 @@ 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)
-
-RAILS_DEFAULT_LOGGER.info "** acts_as_taggable_on: initialized properly."
+ActionView::Base.send :include, TagsHelper if defined?(ActionView::Base)

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -176,16 +176,6 @@ describe "Acts As Taggable On" do
   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
@@ -212,10 +202,6 @@ describe "Acts As Taggable On" do
         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/tag_list_spec.rb

@@ -20,6 +20,18 @@ describe TagList do
     @tag_list.include?("wicked").should be_true
   end
   
+  it "should be able to add delimited list of words with quoted delimiters" do
+    @tag_list.add("'cool, wicked', \"really cool, really wicked\"", :parse => true)
+    @tag_list.include?("cool, wicked").should be_true
+    @tag_list.include?("really cool, really wicked").should be_true
+  end
+  
+  it "should be able to handle other uses of quotation marks correctly" do
+    @tag_list.add("john's cool car, mary's wicked toy", :parse => true)
+    @tag_list.include?("john's cool car").should be_true
+    @tag_list.include?("mary's wicked toy").should be_true
+  end
+  
   it "should be able to add an array of words" do
     @tag_list.add(["cool", "wicked"], :parse => true)
     @tag_list.include?("cool").should be_true
@@ -49,4 +61,10 @@ describe TagList do
     @tag_list.add("cool","rad,bodacious")
     @tag_list.to_s.should == "awesome, radical, cool, \"rad,bodacious\""
   end
+  
+  it "should be able to call to_s on a frozen tag list" do
+    @tag_list.freeze
+    lambda { @tag_list.add("cool","rad,bodacious") }.should raise_error(TypeError)
+    lambda { @tag_list.to_s }.should_not raise_error(TypeError)
+  end
 end

data/spec/acts_as_taggable_on/tag_spec.rb

@@ -7,6 +7,17 @@ describe Tag do
     Tag.delete_all
   end
   
+  describe "named like any" do
+    before(:each) do
+      Tag.create(:name => "awesome")
+      Tag.create(:name => "epic")
+    end
+    
+    it "should find both tags" do
+      Tag.named_like_any(["awesome", "epic"]).should have(2).items
+    end
+  end
+  
   describe "find or create by name" do
     before(:each) do
       @tag.name = "awesome"

data/spec/acts_as_taggable_on/taggable_spec.rb

@@ -77,6 +77,8 @@ describe "Taggable" do
     @taggable.save
     
     TaggableModel.tagged_with("ruby").first.should == @taggable
+    TaggableModel.tagged_with("ruby, css").first.should == @taggable
+    TaggableModel.tagged_with("ruby, nonexistingtag").should be_empty
     TaggableModel.tagged_with("bob", :on => :skills).first.should_not == @taggable
     TaggableModel.tagged_with("bob", :on => :tags).first.should == @taggable
   end
@@ -106,6 +108,12 @@ describe "Taggable" do
     TaggableModel.all_tag_counts.first.count.should == 3 # ruby
   end
   
+  it "should not return read-only records" do
+    TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
+    
+    TaggableModel.tagged_with("ruby").first.should_not be_readonly
+  end
+  
   it "should be able to get scoped tag counts" do
     bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
     frank = TaggableModel.create(:name => "Frank", :tag_list => "ruby, rails")
@@ -141,7 +149,17 @@ describe "Taggable" do
     TaggableModel.find_tagged_with("ruby, rails", :order => 'taggable_models.name').should == [bob, frank]
     TaggableModel.find_tagged_with(["ruby", "rails"], :order => 'taggable_models.name').should == [bob, frank]    
   end
-  
+
+  it "should be able to find tagged with any tag" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "fitter, happier, more productive", :skill_list => "ruby, rails, css")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "weaker, depressed, inefficient", :skill_list => "ruby, rails, css")
+    steve = TaggableModel.create(:name => 'Steve', :tag_list => 'fitter, happier, more productive', :skill_list => 'c++, java, ruby')
+    
+    TaggableModel.find_tagged_with(["ruby", "java"], :order => 'taggable_models.name', :any => true).should == [bob, frank, steve]
+    TaggableModel.find_tagged_with(["c++", "fitter"], :order => 'taggable_models.name', :any => true).should == [bob, steve]
+    TaggableModel.find_tagged_with(["depressed", "css"], :order => 'taggable_models.name', :any => true).should == [bob, frank]    
+  end
+    
   it "should be able to find tagged on a custom tag context" do
     bob = TaggableModel.create(:name => "Bob")
     bob.set_tag_list_on(:rotors, "spinning, jumping")

data/spec/acts_as_taggable_on/tagging_spec.rb

@@ -13,4 +13,13 @@ describe Tagging do
     @tagging.should_not be_valid
     @tagging.errors.on(:tag_id).should == "can't be blank"
   end
+  
+  it "should not create duplicate taggings" do
+    @taggable = TaggableModel.create(:name => "Bob Jones")
+    @tag = Tag.create(:name => "awesome")
+    
+    lambda {
+      2.times { Tagging.create(:taggable => @taggable, :tag => @tag, :context => 'tags') }
+    }.should change(Tagging, :count).by(1)
+  end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,20 @@
 # require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
 require 'rubygems'
-require 'activerecord'
+require 'active_record'
 require 'spec'
 
 module Spec::Example::ExampleGroupMethods
   alias :context :describe
 end
 
+class Array
+  def freq
+    k=Hash.new(0)
+    each {|e| k[e]+=1}
+    k
+  end
+end
+
 TEST_DATABASE_FILE = File.join(File.dirname(__FILE__), '..', 'test.sqlite3')
 
 File.unlink(TEST_DATABASE_FILE) if File.exist?(TEST_DATABASE_FILE)
@@ -16,7 +24,10 @@ ActiveRecord::Base.establish_connection(
 
 RAILS_DEFAULT_LOGGER = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
 
-load(File.dirname(__FILE__) + '/schema.rb')
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load(File.dirname(__FILE__) + '/schema.rb')
+end
 
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), '..', 'init')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts-as-taggable-on
 version: !ruby/object:Gem::Version 
-  version: 1.0.13
+  version: 1.0.19
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-11 00:00:00 +01:00
+date: 2010-01-21 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +27,8 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- generators/acts_as_taggable_on_migration/acts_as_taggable_on_migration_generator.rb
+- generators/acts_as_taggable_on_migration/templates/migration.rb
 - lib/acts-as-taggable-on.rb
 - lib/acts_as_taggable_on/acts_as_taggable_on.rb
 - lib/acts_as_taggable_on/acts_as_tagger.rb