has_many_polymorphs 2.2 → 2.9

data/CHANGELOG

@@ -1,12 +1,3 @@
-v2.2. Various fixes.
-
-v2.13. Merge various fixes for Rails 2.2.2.
-
-v2.12. Improvements to the test suite; bugfixes for STI children (rsl). Remove fancy dependency system in favor of using Dispatcher::to_prepare every time.
-
-v2.11. Rails 1.2.6 tagging generator compatibility; change test suite to use included integration app.
-
-v2.10. Add :parent_conditions option; bugfix for nullified conditions; bugfix for self-referential tagging generator; allow setting of has_many_polymorphs_options hash in Configuration's after_initialize if you need to adjust the autoload behavior; clear error message on missing or improperly namespaced models; fix .build on double-sided relationships; add :namespace key for easier set up of Camping apps or other unusual class structures.
 
 v2.9. Gem version renumbering; my apologies if this messes anyone up.
 

data/README

@@ -1,14 +1,11 @@
+
 Has_many_polymorphs
 
 An ActiveRecord plugin for self-referential and double-sided polymorphic associations.
 
 == License
 
-Copyright 2006-2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. 
-
-The public certificate for the gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem]. 
-
-If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.
+Copyright 2007 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. 
 
 == Description
 
@@ -29,14 +26,14 @@ The plugin also includes a generator for a tagging system, a common use case (se
 
 == Requirements
 
-* Rails 2.2.2 or greater
+* Rails 1.2.3 or grguest
 
 = Usage
 
 == Installation
 
 To install the Rails plugin, run:
-  script/plugin install git://github.com/fauna/has_many_polymorphs.git
+  script/plugin install svn://rubyforge.org/var/svn/fauna/has_many_polymorphs/trunk
 
 There's also a gem version. To install it instead, run: 
   sudo gem install has_many_polymorphs
@@ -64,21 +61,6 @@ One of the child models:
     # nothing
   end
 
-For your parent and child models, you don't need any special fields in your migration. For the join model (GuestsKennel), use a migration like so:
-
-  class CreateGuestsKennels < ActiveRecord::Migration
-    def self.up
-      create_table :guests_kennels do |t|
-        t.references :guest, :polymorphic => true
-        t.references :kennel
-      end
-    end
-  
-    def self.down
-      drop_table :guests_kennels
-    end
-  end
-
 See ActiveRecord::Associations::PolymorphicClassMethods for more configuration options.
 
 == Helper methods example
@@ -129,21 +111,6 @@ Now, dogs and cats can eat birds and cats. Birds can't eat anything (they aren't
 
 In this case, each guest/eaten relationship is called a Devouring.
 
-In your migration, you need to declare both sides as polymorphic:
-
-  class CreateDevourings < ActiveRecord::Migration
-    def self.up
-      create_table :devourings do |t|
-        t.references :guest, :polymorphic => true
-        t.references :eaten, :polymorphic => true
-      end
-    end
-  
-    def self.down
-      drop_table :devourings
-    end
-  end
-
 See ActiveRecord::Associations::PolymorphicClassMethods for more.
 
 == Tagging generator
@@ -186,20 +153,7 @@ If you are having trouble, think very carefully about how your model classes, ke
 
 Note that because of the way Rails reloads model classes, the plugin can sometimes bog down your development server. Set <tt>config.cache_classes = true</tt> in <tt>config/environments/development.rb</tt> to avoid this. 
 
-== Reporting problems
-
-The support forum is here[http://rubyforge.org/forum/forum.php?forum_id=16450].
-
-Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.
-
 == Further resources
 
-* http://blog.evanweaver.com/articles/2007/08/15/polymorphs-tutorial
-* http://blog.evanweaver.com/articles/2007/02/22/polymorphs-25-total-insanity-branch
-* http://blog.evanweaver.com/articles/2007/02/09/how-to-find-the-most-popular-tags
-* http://blog.evanweaver.com/articles/2007/01/13/growing-up-your-acts_as_taggable
-* http://blog.evanweaver.com/articles/2006/12/02/polymorphs-19
-* http://blog.evanweaver.com/articles/2006/11/05/directed-double-polymorphic-associations
-* http://blog.evanweaver.com/articles/2006/11/04/namespaced-model-support-in-has_many_polymorphs
-* http://blog.evanweaver.com/articles/2006/09/26/sti-support-in-has_many_polymorphs
-* http://blog.evanweaver.com/articles/2006/09/11/make-polymorphic-children-belong-to-only-one-parent
+* http://blog.evanweaver.com/pages/code#polymorphs
+* http://rubyforge.org/forum/forum.php?forum_id=16450

data/TODO

@@ -1,2 +1,3 @@
 
+* Controller for tagging generator
 * Tag cloud method

data/generators/tagging/tagging_generator.rb

@@ -7,8 +7,6 @@ class TaggingGenerator < Rails::Generator::NamedBase
   attr_reader :taggable_models
 
   def initialize(runtime_args, runtime_options = {})
-    parse!(runtime_args, runtime_options)
-    
     @parent_association_name = (runtime_args.include?("--self-referential") ? "tagger" : "tag")
     @taggable_models = runtime_args.reject{|opt| opt =~ /^--/}.map do |taggable|
       ":" + taggable.underscore.pluralize
@@ -25,9 +23,7 @@ class TaggingGenerator < Rails::Generator::NamedBase
   def verify models
     puts "** Warning: only one taggable model specified; tests may not run properly." if models.size < 2
     models.each do |model|
-      model = model[1..-1].classify
-      next if model == "Tag" # don't load ourselves when --self-referential is used
-      self.class.const_get(model) rescue puts "** Error: model #{model[1..-1].classify} could not be loaded." or exit
+      self.class.const_get(model[1..-1].classify) rescue puts "** Error: model #{model[1..-1].classify} could not be loaded." or exit
     end
   end
   
@@ -85,13 +81,4 @@ class TaggingGenerator < Rails::Generator::NamedBase
       opt.on("--self-referential",
              "Allow tags to tag themselves.") { |v| options[:self_referential] = v }
     end
-    
-    # Useful for generating tests/fixtures
-    def model_one
-      taggable_models[0][1..-1].classify
-    end
-    
-    def model_two
-      taggable_models[1][1..-1].classify rescue model_one
-    end
 end

data/generators/tagging/templates/tag_test.rb

@@ -1,15 +1,10 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class TagTest < ActiveSupport::TestCase
-  fixtures <%= taggable_models[0..1].join(", ") -%>
-  
-  def setup
-    @obj = <%= model_two %>.find(:first)
-    @obj.tag_with "pale imperial"
-  end
+class TagTest < Test::Unit::TestCase
+  fixtures :tags, :taggings, :recipes, :posts
 
   def test_to_s
-    assert_equal "imperial pale", <%= model_two -%>.find(:first).tags.to_s
+    assert_equal "delicious sexy", Recipe.find(2).tags.to_s
   end
   
 end

data/generators/tagging/templates/tagging.rb

@@ -10,7 +10,7 @@ class Tagging < ActiveRecord::Base
   # acts_as_list :scope => :taggable
     
   # This callback makes sure that an orphaned <tt>Tag</tt> is deleted if it no longer tags anything.
-  def after_destroy
-    <%= parent_association_name -%>.destroy_without_callbacks if <%= parent_association_name -%> and <%= parent_association_name -%>.taggings.count == 0
+  def before_destroy
+    <%= parent_association_name -%>.destroy_without_callbacks if <%= parent_association_name -%> and <%= parent_association_name -%>.taggings.count == 1
   end    
 end

data/generators/tagging/templates/tagging_extensions.rb

@@ -1,3 +1,4 @@
+
 class ActiveRecord::Base #:nodoc:
 
   # These extensions make models taggable. This file is automatically generated and required by your app if you run the tagging generator included with has_many_polymorphs.
@@ -12,7 +13,7 @@ class ActiveRecord::Base #:nodoc:
         begin
           tag = Tag.find_or_create_by_name(tag_name)
           raise Tag::Error, "tag could not be saved: #{tag_name}" if tag.new_record?
-          tags << tag
+          tag.taggables << self
         rescue ActiveRecord::StatementInvalid => e
           raise unless e.to_s =~ /duplicate/i
         end
@@ -25,13 +26,13 @@ class ActiveRecord::Base #:nodoc:
       outgoing = tag_cast_to_string(outgoing)
   <% if options[:self_referential] %>  
       # because of http://dev.rubyonrails.org/ticket/6466
-      taggings.destroy(*(taggings.find(:all, :include => :<%= parent_association_name -%>).select do |tagging| 
+      taggings.destroy(taggings.find(:all, :include => :<%= parent_association_name -%>).select do |tagging| 
         outgoing.include? tagging.<%= parent_association_name -%>.name
-      end))
+      end)
   <% else -%>   
-      <%= parent_association_name -%>s.delete(*(<%= parent_association_name -%>s.select do |tag|
+      <%= parent_association_name -%>s.delete(<%= parent_association_name -%>s.select do |tag|
         outgoing.include? tag.name    
-      end))
+      end)
   <% end -%>
     end
 
@@ -65,11 +66,11 @@ class ActiveRecord::Base #:nodoc:
       <%= parent_association_name -%>s.to_s
       #:startdoc:
     end
-
-    def tag_list=(value)
-        tag_with(value)
-    end    
-
+    
+    #:stopdoc:
+    alias :<%= parent_association_name -%>s= :tag_with
+    #:startdoc:
+    
     private 
     
     def tag_cast_to_string obj #:nodoc:
@@ -102,102 +103,8 @@ class ActiveRecord::Base #:nodoc:
     end
 
   end
-  
-  module TaggingFinders
-    # Find all the objects tagged with the supplied list of tags
-    # 
-    # Usage : Model.tagged_with("ruby")
-    #         Model.tagged_with("hello", "world")
-    #         Model.tagged_with("hello", "world", :limit => 10)
-    #
-    # XXX This query strategy is not performant, and needs to be rewritten as an inverted join or a series of unions
-    # 
-    def tagged_with(*tag_list)
-      options = tag_list.last.is_a?(Hash) ? tag_list.pop : {}
-      tag_list = parse_tags(tag_list)
-      
-      scope = scope(:find)
-      options[:select] ||= "#{table_name}.*"
-      options[:from] ||= "#{table_name}, tags, taggings"
-      
-      sql  = "SELECT #{(scope && scope[:select]) || options[:select]} "
-      sql << "FROM #{(scope && scope[:from]) || options[:from]} "
-
-      add_joins!(sql, options[:joins], scope)
-      
-      sql << "WHERE #{table_name}.#{primary_key} = taggings.taggable_id "
-      sql << "AND taggings.taggable_type = '#{ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s}' "
-      sql << "AND taggings.tag_id = tags.id "
-      
-      tag_list_condition = tag_list.map {|name| "'#{name}'"}.join(", ")
-      
-      sql << "AND (tags.name IN (#{sanitize_sql(tag_list_condition)})) "
-      sql << "AND #{sanitize_sql(options[:conditions])} " if options[:conditions]
-      
-      columns = column_names.map do |column| 
-        "#{table_name}.#{column}"
-      end.join(", ")
-      
-      sql << "GROUP BY #{columns} "
-      sql << "HAVING COUNT(taggings.tag_id) = #{tag_list.size}"
-      
-      add_order!(sql, options[:order], scope)
-      add_limit!(sql, options, scope)
-      add_lock!(sql, options, scope)
-      
-      find_by_sql(sql)
-    end
-   
-   def self.tagged_with_any(*tag_list)
-     options = tag_list.last.is_a?(Hash) ? tag_list.pop : {}
-     tag_list = parse_tags(tag_list)
-   
-     scope = scope(:find)
-     options[:select] ||= "#{table_name}.*"
-     options[:from] ||= "#{table_name}, tags, taggings"
-   
-     sql  = "SELECT #{(scope && scope[:select]) || options[:select]} "
-     sql << "FROM #{(scope && scope[:from]) || options[:from]} "
-
-     add_joins!(sql, options, scope)
-   
-     sql << "WHERE #{table_name}.#{primary_key} = taggings.taggable_id "
-     sql << "AND taggings.taggable_type = '#{ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s}' "
-     sql << "AND taggings.tag_id = tags.id "
-     
-     sql << "AND ("
-     or_options = []
-     tag_list.each do |name|
-       or_options << "tags.name = '#{name}'"
-     end
-     or_options_joined = or_options.join(" OR ")
-     sql << "#{or_options_joined}) "
-     
-     
-     sql << "AND #{sanitize_sql(options[:conditions])} " if options[:conditions]
-      
-     columns = column_names.map do |column| 
-       "#{table_name}.#{column}"
-     end.join(", ")
-      
-     sql << "GROUP BY #{columns} "
-   
-     add_order!(sql, options[:order], scope)
-     add_limit!(sql, options, scope)
-     add_lock!(sql, options, scope)
-   
-     find_by_sql(sql)
-   end
-    
-    def parse_tags(tags)
-      return [] if tags.blank?
-      tags = Array(tags).first
-      tags = tags.respond_to?(:flatten) ? tags.flatten : tags.split(Tag::DELIMITER)
-      tags.map { |tag| tag.strip.squeeze(" ") }.flatten.compact.map(&:downcase).uniq
-    end
-    
-  end
 
   include TaggingExtensions
-  extend  TaggingFinders
+
 end
+

data/generators/tagging/templates/tagging_test.rb

@@ -1,63 +1,38 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class TaggingTest < ActiveSupport::TestCase
-  fixtures :tags, :taggings, <%= taggable_models[0..1].join(", ") -%>
+class TaggingTest < Test::Unit::TestCase
+  fixtures :taggings, :tags, :posts, :recipes
 
   def setup
-    @objs = <%= model_two %>.find(:all, :limit => 2)
-    
-    @obj1 = @objs[0]
-    @obj1.tag_with("pale")
-    @obj1.reload
-    
-    @obj2 = @objs[1]
-    @obj2.tag_with("pale imperial")
-    @obj2.reload
-    
-<% if taggable_models.size > 1 -%>
-    @obj3 = <%= model_one -%>.find(:first)
-<% end -%>
+    @obj1 = Recipe.find(1)
+    @obj2 = Recipe.find(2)
+    @obj3 = Post.find(1)
     @tag1 = Tag.find(1)  
     @tag2 = Tag.find(2)  
     @tagging1 = Tagging.find(1)
   end
 
   def test_tag_with
-    @obj2.tag_with "hoppy pilsner"
-    assert_equal "hoppy pilsner", @obj2.tag_list
-  end
-  
-  def test_find_tagged_with
-    @obj1.tag_with "seasonal lager ipa"
-    @obj2.tag_with ["lager", "stout", "fruity", "seasonal"]
-    
-    result1 = [@obj1]
-    assert_equal <%= model_two %>.tagged_with("ipa"), result1
-    assert_equal <%= model_two %>.tagged_with("ipa lager"), result1
-    assert_equal <%= model_two %>.tagged_with("ipa", "lager"), result1
-    
-    result2 = [@obj1.id, @obj2.id].sort
-    assert_equal <%= model_two %>.tagged_with("seasonal").map(&:id).sort, result2
-    assert_equal <%= model_two %>.tagged_with("seasonal lager").map(&:id).sort, result2
-    assert_equal <%= model_two %>.tagged_with("seasonal", "lager").map(&:id).sort, result2
+    @obj2.tag_with "dark columbian"
+    assert_equal "columbian dark", @obj2.tag_list
   end
   
 <% if options[:self_referential] -%>  
   def test_self_referential_tag_with
     @tag1.tag_with [1, 2]
-    assert @tag1.tags.any? {|obj| obj == @tag1}
-    assert !@tag2.tags.any? {|obj| obj == @tag1}
+    assert @tag1.tags.include?(@tag1)
+    assert !@tag2.tags.include?(@tag1)
   end
 
 <% end -%>
   def test__add_tags
     @obj1._add_tags "porter longneck"
-    assert Tag.find_by_name("porter").taggables.any? {|obj| obj == @obj1}
-    assert Tag.find_by_name("longneck").taggables.any? {|obj| obj == @obj1}
-    assert_equal "longneck pale porter", @obj1.tag_list    
+    assert Tag.find_by_name("porter").taggables.include?(@obj1)
+    assert Tag.find_by_name("longneck").taggables.include?(@obj1)
+    assert_equal "delicious longneck porter", @obj1.tag_list    
     
     @obj1._add_tags [2]
-    assert_equal "imperial longneck pale porter", @obj1.tag_list        
+    assert_equal "delicious longneck porter sexy", @obj1.tag_list        
   end
   
   def test__remove_tags
@@ -66,7 +41,7 @@ class TaggingTest < ActiveSupport::TestCase
   end
   
   def test_tag_list
-    assert_equal "imperial pale", @obj2.tag_list
+    assert_equal "delicious sexy", @obj2.tag_list
   end
     
   def test_taggable
@@ -74,9 +49,7 @@ class TaggingTest < ActiveSupport::TestCase
       @tagging1.send(:taggable?, true) 
     end
     assert !@tagging1.send(:taggable?)
-<% if taggable_models.size > 1 -%>
     assert @obj3.send(:taggable?)
-<% end -%>
 <% if options[:self_referential] -%>  
     assert @tag1.send(:taggable?)
 <% end -%>    

data/generators/tagging/templates/taggings.yml

@@ -1,15 +1,13 @@
 --- 
-<% if taggable_models.size > 1 -%>
 taggings_003: 
   <%= parent_association_name -%>_id: "2"
   id: "3"
-  taggable_type: <%= model_one %>
-  taggable_id: "1"                
-<% end -%>
+  taggable_type: <%= model_one = taggable_models[0][1..-1].classify %>
+  taggable_id: "1"
 taggings_004: 
   <%= parent_association_name -%>_id: "2"
   id: "4"
-  taggable_type: <%= model_two %>
+  taggable_type: <%= model_two = (taggable_models[1][1..-1].classify rescue model_one) %>
   taggable_id: "2"
 taggings_001: 
   <%= parent_association_name -%>_id: "1"

data/generators/tagging/templates/tags.yml

@@ -1,7 +1,7 @@
 --- 
 tags_001: 
-  name: pale
+  name: delicious
   id: "1"
 tags_002: 
-  name: imperial
+  name: sexy
   id: "2"