polymorphic_identity 0.0.5 → 0.1.0

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,29 +1,29 @@
-*SVN*
+== master
 
-*0.0.5* (June 22nd, 2008)
+== 0.1.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+
+== 0.0.5 / 2008-06-22
 
 * Remove log files from gems
 
-*0.0.4* (May 5th, 2008)
+== 0.0.4 / 2008-05-05
 
 * Updated documentation
 
-*0.0.3* (September 26th, 2007)
+== 0.0.3 / 2007-09-26
 
 * Move test fixtures out of the test application root directory
-
 * Remove gem dependency on activerecord
 
-*0.0.2* (August 5th, 2007)
+== 0.0.2 / 2007-08-05
 
 * Add api documentation
-
 * Fix Rakefile syntax errors
-
 * Refactor tests
-
 * Use the plugin_test_helper plugin for helping create a Rails environment
 
-*0.0.1* (February 12th, 2007)
+== 0.0.1 / 2007-02-12
 
 * Initial release

data/{README → README.rdoc}

@@ -5,21 +5,21 @@ based on the class names of those associations.
 
 == Resources
 
-Wiki
-
-* http://wiki.pluginaweek.org/Polymorphic_Identity
-
 API
 
 * http://api.pluginaweek.org/polymorphic_identity
 
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13285-polymorphic_identity
+
 Development
 
-* http://dev.pluginaweek.org/browser/trunk/polymorphic_identity
+* http://github.com/pluginaweek/polymorphic_identity
 
 Source
 
-* http://svn.pluginaweek.org/trunk/polymorphic_identity
+* git://github.com/pluginaweek/polymorphic_identity.git
 
 == Description
 
@@ -32,10 +32,10 @@ polymorphic assocation looks like the following:
                  :polymorphic => true
   end
 
-When getting the taggable record, you would normally have to called
-+tag.taggable+.  However, if you know that the taggable record is just an
+When getting the taggable record, you would normally have to call
+<tt>tag.taggable</tt>.  However, if you know that the taggable record is just an
 instance of the Article model, then it would feel more comfortable if you could
-just called +tag.article+.  polymoprhic_identity makes this possible by
+just call <tt>tag.article</tt>.  polymoprhic_identity makes this possible by
 dynamically checking the name of the polymorphic record's class and creating
 methods that allow you to access the polymorphic association based on that
 class name.
@@ -60,21 +60,16 @@ class name.
                :as => :commenter
   end
   
-  >> c = Comment.find(1)
-  => #<Tag:0xb784d32c @attributes={"id"=>"1", "commentable_type"=>"Article", "commentable_id"=>"1", "commenter_type"=>"User", "commenter_id"=>"1"}>
-  >> c.commentable
-  => #<Article:0xb779d5a8 @attributes={"id"=>"1"}>
-  >> c.article
-  => #<Article:0xb779d5a8 @attributes={"id"=>"1"}>
-  >> c.commenter
-  => #<User:0xb775d764 @attributes={"id"=>"1"}>
-  >> c.user
-  => #<User:0xb775d764 @attributes={"id"=>"1"}>
+  c = Comment.find(1)   # => #<Tag id: 1, commentable_id: 1, commentable_type: "Article", commenter_id: 1, commenter_type: "User"}>
+  c.commentable         # => #<Article id: 1>
+  c.article             # => #<Article id: 1>
+  c.commenter           # => #<User id: 1>
+  c.user                # => #<User id: 1>
 
 == Testing
 
 Before you can run any tests, the following gem must be installed:
-* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
 To run against a specific version of Rails:
 

data/Rakefile

@@ -3,46 +3,54 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
-PKG_NAME           = 'polymorphic_identity'
-PKG_VERSION        = '0.0.5'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'pluginaweek'
-
-desc 'Default: run unit tests.'
+spec = Gem::Specification.new do |s|
+  s.name              = 'polymorphic_identity'
+  s.version           = '0.1.0'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Dynamically generates aliases for polymorphic associations based on their class names'
+  
+  s.files             = FileList['{lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) - FileList['test/app_root/{log,log/*,script,script/*}']
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
 task :default => :test
 
-desc 'Test the polymorphic_identity plugin.'
+desc "Test the #{spec.name} plugin."
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = spec.test_files
   t.verbose = true
 end
 
-desc 'Generate documentation for the polymorphic_identity plugin.'
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'PolymorphicIdentity'
+  rdoc.title    = spec.name
   rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = PKG_NAME
-  s.version         = PKG_VERSION
-  s.platform        = Gem::Platform::RUBY
-  s.summary         = 'Dynamically generates aliases for polymorphic associations based on their class names'
-  
-  s.files           = FileList['{lib,test}/**/*'].to_a - FileList['test/app_root/log/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
-  s.require_path    = 'lib'
-  s.autorequire     = 'polymorphic_identity'
-  s.has_rdoc        = true
-  s.test_files      = Dir['test/**/*_test.rb']
-  
-  s.author          = 'Aaron Pfeifer'
-  s.email           = 'aaron@pluginaweek.org'
-  s.homepage        = 'http://www.pluginaweek.org'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
 end
   
 Rake::GemPackageTask.new(spec) do |p|
@@ -51,14 +59,14 @@ Rake::GemPackageTask.new(spec) do |p|
   p.need_zip = true
 end
 
-desc 'Publish the beta gem'
+desc 'Publish the beta gem.'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
 end
 
-desc 'Publish the API documentation'
+desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
@@ -71,10 +79,10 @@ task :release => [:gem, :package] do
   ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
-  %w( gem tgz zip ).each do |ext|
-    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
     puts "Releasing #{File.basename(file)}..."
     
-    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
   end
 end

data/lib/polymorphic_identity.rb

@@ -1,57 +1,52 @@
-module PluginAWeek
-  # Adds dynamic attributes for polymorphic associations based on the name of
-  # the class for the polymorphic record.  For example,
-  # 
-  #   class Tag < ActiveRecord::Base
-  #     belongs_to :taggable, :polymorphic => true
-  #   end
-  #   
-  #   class Article < ActiveRecord::Base
-  #     has_many :tags, :as => :taggable
-  #   end
-  #   
-  #   >> t = Tag.find(1)
-  #   => #<Tag:0xb784d32c @attributes={"id"=>"1", "taggable_type"=>"Article", "taggable_id"=>"1"}>
-  #   >> t.taggable
-  #   => #<Article:0xb779d5a8 @attributes={"id"=>"1"}>
-  #   >> t.article
-  #   => #<Article:0xb779d5a8 @attributes={"id"=>"1"}>
-  module PolymorphicIdentity
-    def self.included(base) #:nodoc:
-      base.class_eval do
-        alias_method_chain :method_missing, :polymorphic_identity
-        alias_method_chain :respond_to?, :polymorphic_identity
-      end
-    end
-    
-    def method_missing_with_polymorphic_identity(method_id, *args, &block) #:nodoc:
-      if association_name = find_polymorphic_association_name(method_id)
-        send(association_name, *args, &block)
-      else
-        method_missing_without_polymorphic_identity(method_id, *args, &block)
-      end
+# Adds dynamic attributes for polymorphic associations based on the name of
+# the class for the polymorphic record.  For example,
+# 
+#   class Tag < ActiveRecord::Base
+#     belongs_to :taggable, :polymorphic => true
+#   end
+#   
+#   class Article < ActiveRecord::Base
+#     has_many :tags, :as => :taggable
+#   end
+#   
+#   t = Tag.find(1)   # => #<Tag id: 1, taggable_id: 1, taggable_type: "Article">
+#   t.taggable        # => #<Article id: 1>
+#   t.article         # => #<Article id: 1>
+module PolymorphicIdentity
+  def self.included(base) #:nodoc:
+    base.class_eval do
+      alias_method_chain :method_missing, :polymorphic_identity
+      alias_method_chain :respond_to?, :polymorphic_identity
     end
-    
-    # True if a polymorphic association can be found whose foreign type is set
-    # to the name of the method
-    def respond_to_with_polymorphic_identity?(method, include_priv = false) #:nodoc:
-      respond_to_without_polymorphic_identity?(method, include_priv) || !find_polymorphic_association_name(method).nil?
+  end
+  
+  def method_missing_with_polymorphic_identity(method_id, *args, &block) #:nodoc:
+    if association_name = find_polymorphic_association_name(method_id)
+      send(association_name, *args, &block)
+    else
+      method_missing_without_polymorphic_identity(method_id, *args, &block)
     end
-    
-    private
-      # Finds the name of the polymorphic association whose foreign type is set to
-      # the value specified.
-      def find_polymorphic_association_name(foreign_type_value)
-        foreign_type_value = foreign_type_value.to_s.camelize
-        reflection = self.class.reflections.values.find do |reflection|
-          reflection.options[:polymorphic] && self[reflection.options[:foreign_type]] == foreign_type_value
-        end
-        
-        reflection ? reflection.name : nil
-      end
   end
+  
+  # True if a polymorphic association can be found whose foreign type is set
+  # to the name of the method
+  def respond_to_with_polymorphic_identity?(method, include_priv = false) #:nodoc:
+    respond_to_without_polymorphic_identity?(method, include_priv) || !find_polymorphic_association_name(method).nil?
+  end
+  
+  private
+    # Finds the name of the polymorphic association whose foreign type is set to
+    # the value specified.
+    def find_polymorphic_association_name(foreign_type_value)
+      foreign_type_value = foreign_type_value.to_s.camelize
+      reflection = self.class.reflections.values.find do |reflection|
+        reflection.options[:polymorphic] && self[reflection.options[:foreign_type]] == foreign_type_value
+      end
+      
+      reflection ? reflection.name : nil
+    end
 end
 
 ActiveRecord::Base.class_eval do
-  include PluginAWeek::PolymorphicIdentity
+  include PolymorphicIdentity
 end

data/test/factory.rb

@@ -1,26 +1,36 @@
 module Factory
-  # Build actions for the class
-  def self.build(klass, &block)
-    name = klass.to_s.underscore
-    define_method("#{name}_attributes", block)
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
     
-    module_eval <<-end_eval
-      def valid_#{name}_attributes(attributes = {})
-        #{name}_attributes(attributes)
-        attributes
-      end
-      
-      def new_#{name}(attributes = {})
-        #{klass}.new(valid_#{name}_attributes(attributes))
-      end
-      
-      def create_#{name}(*args)
-        record = new_#{name}(*args)
-        record.save!
-        record.reload
-        record
-      end
-    end_eval
+    define_method("#{name}_attributes", block)
+    define_method("valid_#{name}_attributes") {|*args| valid_attributes_for(model, *args)}
+    define_method("new_#{name}")              {|*args| new_record(model, *args)}
+    define_method("create_#{name}")           {|*args| create_record(model, *args)}
+  end
+  
+  # Get valid attributes for the model
+  def valid_attributes_for(model, attributes = {})
+    name = model.to_s.underscore
+    send("#{name}_attributes", attributes)
+    attributes.stringify_keys!
+    attributes
+  end
+  
+  # Build an unsaved record
+  def new_record(model, *args)
+    attributes = valid_attributes_for(model, *args)
+    record = model.new(attributes)
+    attributes.each {|attr, value| record.send("#{attr}=", value) if model.accessible_attributes && !model.accessible_attributes.include?(attr) || model.protected_attributes && model.protected_attributes.include?(attr)}
+    record
+  end
+  
+  # Build and save/reload a record
+  def create_record(model, *args)
+    record = new_record(model, *args)
+    record.save!
+    record.reload
+    record
   end
   
   build Article do |attributes|

data/test/test_helper.rb

@@ -8,6 +8,6 @@ ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
 
 # Mixin the factory helper
 require File.expand_path("#{File.dirname(__FILE__)}/factory")
-class Test::Unit::TestCase #:nodoc:
+Test::Unit::TestCase.class_eval do
   include Factory
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: polymorphic_identity
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
-autorequire: polymorphic_identity
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-06-22 00:00:00 -04:00
+date: 2008-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -23,31 +23,30 @@ extra_rdoc_files: []
 
 files: 
 - lib/polymorphic_identity.rb
+- test/factory.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/polymorphic_identity_test.rb
 - test/app_root
-- test/app_root/app
-- test/app_root/app/models
-- test/app_root/app/models/page.rb
-- test/app_root/app/models/author.rb
-- test/app_root/app/models/article.rb
-- test/app_root/app/models/comment.rb
-- test/app_root/app/models/user.rb
 - test/app_root/db
 - test/app_root/db/migrate
-- test/app_root/db/migrate/005_create_comments.rb
-- test/app_root/db/migrate/002_create_articles.rb
-- test/app_root/db/migrate/003_create_pages.rb
 - test/app_root/db/migrate/004_create_users.rb
+- test/app_root/db/migrate/005_create_comments.rb
 - test/app_root/db/migrate/001_create_authors.rb
-- test/app_root/log
-- test/test_helper.rb
-- test/factory.rb
-- test/unit
-- test/unit/polymorphic_identity_test.rb
-- CHANGELOG
+- test/app_root/db/migrate/003_create_pages.rb
+- test/app_root/db/migrate/002_create_articles.rb
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/article.rb
+- test/app_root/app/models/author.rb
+- test/app_root/app/models/user.rb
+- test/app_root/app/models/comment.rb
+- test/app_root/app/models/page.rb
+- CHANGELOG.rdoc
 - init.rb
-- MIT-LICENSE
+- LICENSE
 - Rakefile
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
 post_install_message: 
@@ -69,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.1.1
+rubyforge_project: pluginaweek
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Dynamically generates aliases for polymorphic associations based on their class names