has_many_polymorphs 2.10 → 2.11

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v2.11. Rails 1.2.6 tagging generator compatibility; change test suite to use included integration app; include commenting generator (not well tested) [Josh Stephenson].
+
 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/Manifest

@@ -1,57 +1,192 @@
-TODO
-test/unit/polymorph_test.rb
-test/test_helper.rb
-test/schema.rb
-test/modules/other_extension_module.rb
-test/modules/extension_module.rb
-test/models/wild_boar.rb
-test/models/tabby.rb
-test/models/petfood.rb
-test/models/person.rb
-test/models/parentship.rb
-test/models/kitten.rb
-test/models/frog.rb
-test/models/eaters_foodstuff.rb
-test/models/dog.rb
-test/models/cat.rb
-test/models/canine.rb
-test/models/beautiful_fight_relationship.rb
-test/models/aquatic/whale.rb
-test/models/aquatic/pupils_whale.rb
-test/models/aquatic/fish.rb
-test/fixtures/wild_boars.yml
-test/fixtures/petfoods.yml
-test/fixtures/people.yml
-test/fixtures/keep_your_enemies_close.yml
-test/fixtures/frogs.yml
-test/fixtures/eaters_foodstuffs.yml
-test/fixtures/cats.yml
-test/fixtures/bow_wows.yml
-test/fixtures/aquatic/whales.yml
-test/fixtures/aquatic/little_whale_pupils.yml
-test/fixtures/aquatic/fish.yml
-README
-Manifest
-LICENSE
-lib/has_many_polymorphs.rb
-lib/has_many_polymorphs/support_methods.rb
-lib/has_many_polymorphs/reflection.rb
-lib/has_many_polymorphs/rake_task_redefine_task.rb
-lib/has_many_polymorphs/dependencies.rb
-lib/has_many_polymorphs/debugging_tools.rb
-lib/has_many_polymorphs/configuration.rb
-lib/has_many_polymorphs/class_methods.rb
-lib/has_many_polymorphs/base.rb
-lib/has_many_polymorphs/autoload.rb
-lib/has_many_polymorphs/association.rb
-init.rb
-generators/tagging/templates/tags.yml
-generators/tagging/templates/taggings.yml
-generators/tagging/templates/tagging_test.rb
-generators/tagging/templates/tagging_extensions.rb
-generators/tagging/templates/tagging.rb
-generators/tagging/templates/tag_test.rb
-generators/tagging/templates/tag.rb
-generators/tagging/templates/migration.rb
-generators/tagging/tagging_generator.rb
 CHANGELOG
+examples/hmph.rb
+generators/commenting/commenting_generator.rb
+generators/commenting/templates/comment.rb
+generators/commenting/templates/comment_test.rb
+generators/commenting/templates/commenting.rb
+generators/commenting/templates/commenting_extensions.rb
+generators/commenting/templates/commenting_test.rb
+generators/commenting/templates/commentings.yml
+generators/commenting/templates/comments.yml
+generators/commenting/templates/migration.rb
+generators/tagging/tagging_generator.rb
+generators/tagging/templates/migration.rb
+generators/tagging/templates/tag.rb
+generators/tagging/templates/tag_test.rb
+generators/tagging/templates/tagging.rb
+generators/tagging/templates/tagging_extensions.rb
+generators/tagging/templates/tagging_test.rb
+generators/tagging/templates/taggings.yml
+generators/tagging/templates/tags.yml
+init.rb
+lib/has_many_polymorphs/association.rb
+lib/has_many_polymorphs/autoload.rb
+lib/has_many_polymorphs/base.rb
+lib/has_many_polymorphs/class_methods.rb
+lib/has_many_polymorphs/configuration.rb
+lib/has_many_polymorphs/debugging_tools.rb
+lib/has_many_polymorphs/dependencies.rb
+lib/has_many_polymorphs/rake_task_redefine_task.rb
+lib/has_many_polymorphs/reflection.rb
+lib/has_many_polymorphs/support_methods.rb
+lib/has_many_polymorphs.rb
+LICENSE
+Manifest
+README
+test/fixtures/bow_wows.yml
+test/fixtures/cats.yml
+test/fixtures/eaters_foodstuffs.yml
+test/fixtures/fish.yml
+test/fixtures/frogs.yml
+test/fixtures/keep_your_enemies_close.yml
+test/fixtures/little_whale_pupils.yml
+test/fixtures/people.yml
+test/fixtures/petfoods.yml
+test/fixtures/whales.yml
+test/fixtures/wild_boars.yml
+test/integration/app/app/controllers/addresses_controller.rb
+test/integration/app/app/controllers/application.rb
+test/integration/app/app/controllers/sellers_controller.rb
+test/integration/app/app/controllers/states_controller.rb
+test/integration/app/app/controllers/users_controller.rb
+test/integration/app/app/helpers/addresses_helper.rb
+test/integration/app/app/helpers/application_helper.rb
+test/integration/app/app/helpers/sellers_helper.rb
+test/integration/app/app/helpers/states_helper.rb
+test/integration/app/app/helpers/users_helper.rb
+test/integration/app/app/models/address.rb
+test/integration/app/app/models/citation.rb
+test/integration/app/app/models/citations_item.rb
+test/integration/app/app/models/seller.rb
+test/integration/app/app/models/state.rb
+test/integration/app/app/models/user.rb
+test/integration/app/app/views/addresses/edit.html.erb
+test/integration/app/app/views/addresses/index.html.erb
+test/integration/app/app/views/addresses/new.html.erb
+test/integration/app/app/views/addresses/show.html.erb
+test/integration/app/app/views/layouts/addresses.html.erb
+test/integration/app/app/views/layouts/sellers.html.erb
+test/integration/app/app/views/layouts/states.html.erb
+test/integration/app/app/views/layouts/users.html.erb
+test/integration/app/app/views/sellers/edit.html.erb
+test/integration/app/app/views/sellers/index.html.erb
+test/integration/app/app/views/sellers/new.html.erb
+test/integration/app/app/views/sellers/show.html.erb
+test/integration/app/app/views/states/edit.html.erb
+test/integration/app/app/views/states/index.html.erb
+test/integration/app/app/views/states/new.html.erb
+test/integration/app/app/views/states/show.html.erb
+test/integration/app/app/views/users/edit.html.erb
+test/integration/app/app/views/users/index.html.erb
+test/integration/app/app/views/users/new.html.erb
+test/integration/app/app/views/users/show.html.erb
+test/integration/app/config/boot.rb
+test/integration/app/config/database.yml
+test/integration/app/config/environment.rb
+test/integration/app/config/environments/development.rb
+test/integration/app/config/environments/production.rb
+test/integration/app/config/environments/test.rb
+test/integration/app/config/locomotive.yml
+test/integration/app/config/routes.rb
+test/integration/app/config/ultrasphinx/default.base
+test/integration/app/config/ultrasphinx/development.conf.canonical
+test/integration/app/db/migrate/001_create_users.rb
+test/integration/app/db/migrate/002_create_sellers.rb
+test/integration/app/db/migrate/003_create_addresses.rb
+test/integration/app/db/migrate/004_create_states.rb
+test/integration/app/db/migrate/005_add_capitalization_to_seller.rb
+test/integration/app/db/migrate/006_add_deleted_to_user.rb
+test/integration/app/db/migrate/007_add_lat_and_long_to_address.rb
+test/integration/app/db/migrate/008_create_citations.rb
+test/integration/app/db/migrate/009_create_citations_items.rb
+test/integration/app/db/schema.rb
+test/integration/app/doc/README_FOR_APP
+test/integration/app/generated_models/aquatic_fish.rb
+test/integration/app/generated_models/aquatic_pupils_whale.rb
+test/integration/app/generated_models/aquatic_whale.rb
+test/integration/app/generated_models/beautiful_fight_relationship.rb
+test/integration/app/generated_models/citation.rb
+test/integration/app/generated_models/citations_item.rb
+test/integration/app/generated_models/dog.rb
+test/integration/app/generated_models/eaters_foodstuff.rb
+test/integration/app/generated_models/frog.rb
+test/integration/app/generated_models/kitten.rb
+test/integration/app/generated_models/parentship.rb
+test/integration/app/generated_models/person.rb
+test/integration/app/generated_models/petfood.rb
+test/integration/app/generated_models/polymorph_test_some_model.rb
+test/integration/app/generated_models/seller.rb
+test/integration/app/generated_models/tabby.rb
+test/integration/app/generated_models/user.rb
+test/integration/app/generated_models/wild_boar.rb
+test/integration/app/generators/commenting_generator_test.rb
+test/integration/app/public/404.html
+test/integration/app/public/500.html
+test/integration/app/public/dispatch.cgi
+test/integration/app/public/dispatch.fcgi
+test/integration/app/public/dispatch.rb
+test/integration/app/public/favicon.ico
+test/integration/app/public/images/rails.png
+test/integration/app/public/index.html
+test/integration/app/public/javascripts/application.js
+test/integration/app/public/javascripts/controls.js
+test/integration/app/public/javascripts/dragdrop.js
+test/integration/app/public/javascripts/effects.js
+test/integration/app/public/javascripts/prototype.js
+test/integration/app/public/robots.txt
+test/integration/app/public/stylesheets/scaffold.css
+test/integration/app/Rakefile
+test/integration/app/README
+test/integration/app/script/about
+test/integration/app/script/breakpointer
+test/integration/app/script/console
+test/integration/app/script/destroy
+test/integration/app/script/generate
+test/integration/app/script/performance/benchmarker
+test/integration/app/script/performance/profiler
+test/integration/app/script/plugin
+test/integration/app/script/process/inspector
+test/integration/app/script/process/reaper
+test/integration/app/script/process/spawner
+test/integration/app/script/runner
+test/integration/app/script/server
+test/integration/app/test/fixtures/addresses.yml
+test/integration/app/test/fixtures/citations.yml
+test/integration/app/test/fixtures/citations_items.yml
+test/integration/app/test/fixtures/sellers.yml
+test/integration/app/test/fixtures/states.yml
+test/integration/app/test/fixtures/users.yml
+test/integration/app/test/functional/addresses_controller_test.rb
+test/integration/app/test/functional/sellers_controller_test.rb
+test/integration/app/test/functional/states_controller_test.rb
+test/integration/app/test/functional/users_controller_test.rb
+test/integration/app/test/test_helper.rb
+test/integration/app/test/unit/address_test.rb
+test/integration/app/test/unit/citation_test.rb
+test/integration/app/test/unit/citations_item_test.rb
+test/integration/app/test/unit/seller_test.rb
+test/integration/app/test/unit/state_test.rb
+test/integration/app/test/unit/user_test.rb
+test/models/aquatic/fish.rb
+test/models/aquatic/pupils_whale.rb
+test/models/aquatic/whale.rb
+test/models/beautiful_fight_relationship.rb
+test/models/canine.rb
+test/models/cat.rb
+test/models/dog.rb
+test/models/eaters_foodstuff.rb
+test/models/frog.rb
+test/models/kitten.rb
+test/models/parentship.rb
+test/models/person.rb
+test/models/petfood.rb
+test/models/tabby.rb
+test/models/wild_boar.rb
+test/modules/extension_module.rb
+test/modules/other_extension_module.rb
+test/schema.rb
+test/setup.rb
+test/test_all.rb
+test/test_helper.rb
+test/unit/polymorph_test.rb
+TODO

data/TODO

@@ -1,4 +1,5 @@
 
+* Does :namespace key definitely work with doubles?
 * Migration examples in docs
 * Controller for tagging generator
 * Tag cloud method

data/examples/hmph.rb

@@ -0,0 +1,69 @@
+require 'camping'
+require 'has_many_polymorphs'
+
+Camping.goes :Hmph
+
+module Hmph::Models
+  class GuestsKennel < Base
+    belongs_to :kennel
+    belongs_to :guest, :polymorphic => true
+  end
+
+  class Dog < Base
+  end
+
+  class Cat < Base
+  end
+
+  class Bird < Base
+  end
+  
+  class Kennel < Base
+    has_many_polymorphs :guests, 
+      :from => [:dogs, :cats, :birds],
+      :through => :guests_kennels,
+      :namespace => :"hmph/models/"      
+  end  
+
+  class InitialSchema < V 1.0
+    def self.up
+      create_table :hmph_kennels do |t|
+        t.column :created_at, :datetime
+        t.column :modified_at, :datetime
+        t.column :name, :string, :default => 'Anonymous Kennel'
+      end
+
+      create_table :hmph_guests_kennels do |t|
+        t.column :guest_id, :integer
+        t.column :guest_type, :string
+        t.column :kennel_id, :integer
+      end
+
+      create_table :hmph_dogs do |t|
+        t.column :name, :string, :default => 'Fido'
+      end
+
+      create_table :hmph_cats do |t|
+        t.column :name, :string, :default => 'Morris'
+      end
+
+      create_table :hmph_birds do |t|
+        t.column :name, :string, :default => 'Polly'
+      end
+    end
+
+    def self.down
+      drop_table :hmph_kennels
+      drop_table :hmph_guests_kennels
+      drop_table :hmph_dogs
+      drop_table :hmph_cats
+      drop_table :hmph_birds
+    end
+  end
+end
+
+module Hmph::Controllers
+end
+
+module Hmph::Views
+end

data/generators/commenting/commenting_generator.rb

@@ -0,0 +1,94 @@
+
+class CommentingGenerator < Rails::Generator::NamedBase
+  default_options :skip_migration => false
+  default_options :self_referential => false
+  attr_reader :parent_association_name
+  attr_reader :commentable_models
+
+  def initialize(runtime_args, runtime_options = {})
+    @parent_association_name = (runtime_args.include?("--self-referential") ? "commenter" : "comment")
+    @commentable_models = runtime_args.reject{|opt| opt =~ /^--/}.map do |commentable|
+      ":" + commentable.underscore.pluralize
+    end
+    @commentable_models += [":comments"] if runtime_args.include?("--self-referential") 
+    @commentable_models.uniq!
+        
+    verify @commentable_models
+    hacks     
+    runtime_args.unshift("placeholder")
+    super
+  end
+  
+  def verify models
+    puts "** Warning: only one commentable model specified; tests may not run properly." if models.size < 2
+    models.each do |model|
+      model = model[1..-1].classify
+      next if model == "Comment" # 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
+    end
+  end
+  
+  def hacks    
+    # add the extension require in environment.rb
+    phrase = "require 'commenting_extensions'"
+    filename = "#{RAILS_ROOT}/config/environment.rb"
+    unless (open(filename) do |file|
+      file.grep(/#{Regexp.escape phrase}/).any?
+    end)
+      open(filename, 'a+') do |file|
+        file.puts "\n" + phrase + "\n"
+      end
+    end
+  end
+  
+  def manifest
+    record do |m|
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path)
+      m.directory File.join('test/fixtures', class_path)
+      m.directory File.join('lib')
+
+      m.template 'comment.rb', File.join('app/models', class_path, "comment.rb")
+      m.template 'comment_test.rb', File.join('test/unit', class_path, "comment_test.rb")
+      m.template 'comments.yml', File.join('test/fixtures', class_path, "comments.yml")
+      
+      m.template 'commenting.rb', File.join('app/models', class_path, "commenting.rb")
+      m.template 'commenting_test.rb', File.join('test/unit', class_path, "commenting_test.rb")
+      m.template 'commentings.yml', File.join('test/fixtures', class_path, "commentings.yml")
+      
+      m.template 'commenting_extensions.rb', File.join('lib', 'commenting_extensions.rb')
+
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate',
+          :migration_file_name => "create_comments_and_commentings"
+      end
+      
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} generate commenting [CommentableModelA CommentableModelB ...]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on("--self-referential",
+             "Allow comments to comment themselves.") { |v| options[:self_referential] = v }
+    end
+    
+    # Useful for generating tests/fixtures
+    def model_one
+      commentable_models[0][1..-1].classify
+    end
+    
+    def model_two
+      commentable_models[1][1..-1].classify rescue model_one
+    end
+end

data/generators/commenting/templates/comment.rb

@@ -0,0 +1,33 @@
+
+# The Comment model. This model is automatically generated and added to your app if you run the commenting generator.
+
+class Comment < ActiveRecord::Base
+
+  # If database speed becomes an issue, you could remove these validations and rescue the ActiveRecord database constraint errors instead.
+  validates_presence_of :name, :email, :body
+  validates_format_of   :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+
+  after_validation :prepend_url
+  
+  # Set up the polymorphic relationship.
+  has_many_polymorphs :commentables, 
+    :from => [<%= commentable_models.join(", ") %>], 
+    :through => :commentings, 
+    :dependent => :destroy,
+<% if options[:self_referential] -%>    :as => :<%= parent_association_name -%>,
+<% end -%>
+    :parent_extend => proc {
+    }
+    
+  # Tag::Error class. Raised by ActiveRecord::Base::TaggingExtensions if something goes wrong.
+  class Error < StandardError
+  end
+
+  protected
+  def prepend_url
+    return if self[:url].blank?
+    if self[:url] !~ /^http(s):\/\//i
+      self.url = 'http://' + self[:url]
+    end
+  end
+end