polymorphic_identity 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,5 +1,9 @@
 *SVN*
 
+*0.0.4* (May 5th, 2008)
+
+* Updated documentation
+
 *0.0.3* (September 26th, 2007)
 
 * Move test fixtures out of the test application root directory

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2007 Aaron Pfeifer & Neil Abraham
+Copyright (c) 2006-2008 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -5,25 +5,21 @@ based on the class names of those associations.
 
 == Resources
 
-API
-
-* http://api.pluginaweek.org/polymorphic_identity
-
 Wiki
 
 * http://wiki.pluginaweek.org/Polymorphic_Identity
 
-Announcement
+API
 
-* http://www.pluginaweek.org/2007/02/12/12-models-seek-damages-for-identity-theft
+* http://api.pluginaweek.org/polymorphic_identity
 
-Source
+Development
 
-* http://svn.pluginaweek.org/trunk/plugins/active_record/associations/polymorphic_identity
+* http://dev.pluginaweek.org/browser/trunk/polymorphic_identity
 
-Development
+Source
 
-* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/associations/polymorphic_identity
+* http://svn.pluginaweek.org/trunk/polymorphic_identity
 
 == Description
 
@@ -82,4 +78,4 @@ Before you can run any tests, the following gem must be installed:
 
 == Dependencies
 
-This plugin does not depend on the presence of any other plugin.
+None.

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'polymorphic_identity'
-PKG_VERSION        = '0.0.3'
+PKG_VERSION        = '0.0.4'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 
@@ -39,8 +39,8 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc        = true
   s.test_files      = Dir['test/**/*_test.rb']
   
-  s.author          = 'Aaron Pfeifer, Neil Abraham'
-  s.email           = 'info@pluginaweek.org'
+  s.author          = 'Aaron Pfeifer'
+  s.email           = 'aaron@pluginaweek.org'
   s.homepage        = 'http://www.pluginaweek.org'
 end
   
@@ -52,12 +52,12 @@ end
 
 desc 'Publish the beta gem'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('pluginaweek@pluginaweek.org', '/home/pluginaweek/gems.pluginaweek.org/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
 end
 
 desc 'Publish the API documentation'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'

data/lib/polymorphic_identity.rb

@@ -39,19 +39,19 @@ module PluginAWeek
     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] && read_attribute(reflection.options[:foreign_type]) == foreign_type_value
+      # 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
-      
-      reflection ? reflection.name : nil
-    end
   end
 end
 
 ActiveRecord::Base.class_eval do
   include PluginAWeek::PolymorphicIdentity
-end
+end

data/test/app_root/app/models/article.rb

@@ -1,4 +1,5 @@
 class Article < ActiveRecord::Base
-  has_many  :comments,
-              :as => :commentable
-end
+  belongs_to  :author
+  has_many    :comments,
+                :as => :commentable
+end

data/test/app_root/app/models/author.rb

@@ -1,4 +1,6 @@
 class Author < ActiveRecord::Base
+  has_many  :articles
+  has_many  :pages
   has_many  :comments,
               :as => :commenter
-end
+end

data/test/app_root/app/models/page.rb

@@ -1,4 +1,5 @@
 class Page < ActiveRecord::Base
-  has_many  :comments,
-              :as => :commentable
-end
+  belongs_to  :author
+  has_many    :comments,
+                :as => :commentable
+end

data/test/app_root/db/migrate/001_create_authors.rb

@@ -1,11 +1,11 @@
 class CreateAuthors < ActiveRecord::Migration
   def self.up
     create_table :authors do |t|
-      t.column :name, :string
+      t.string :name
     end
   end
   
   def self.down
     drop_table :authors
   end
-end
+end

data/test/app_root/db/migrate/002_create_articles.rb

@@ -1,12 +1,12 @@
 class CreateArticles < ActiveRecord::Migration
   def self.up
     create_table :articles do |t|
-      t.column :author_id,  :integer
-      t.column :content,    :text
+      t.integer :author_id
+      t.text :content
     end
   end
   
   def self.down
     drop_table :articles
   end
-end
+end

data/test/app_root/db/migrate/003_create_pages.rb

@@ -1,12 +1,12 @@
 class CreatePages < ActiveRecord::Migration
   def self.up
     create_table :pages do |t|
-      t.column :author_id,  :integer
-      t.column :content,    :text
+      t.integer :author_id
+      t.text :content
     end
   end
   
   def self.down
     drop_table :pages
   end
-end
+end

data/test/app_root/db/migrate/004_create_users.rb

@@ -1,11 +1,11 @@
 class CreateUsers < ActiveRecord::Migration
   def self.up
     create_table :users do |t|
-      t.column :name, :string
+      t.string :name
     end
   end
   
   def self.down
     drop_table :users
   end
-end
+end

data/test/app_root/db/migrate/005_create_comments.rb

@@ -1,14 +1,14 @@
 class CreateComments < ActiveRecord::Migration
   def self.up
     create_table :comments do |t|
-      t.column :commentable_id,   :integer
-      t.column :commentable_type, :string
-      t.column :commenter_id,     :string
-      t.column :commenter_type,   :string
+      t.integer :commentable_id
+      t.string :commentable_type
+      t.string :commenter_id
+      t.string :commenter_type
     end
   end
   
   def self.down
     drop_table :comments
   end
-end
+end

data/test/factory.rb

@@ -0,0 +1,56 @@
+module Factory
+  # Build actions for the class
+  def self.build(klass, &block)
+    name = klass.to_s.underscore
+    define_method("#{name}_attributes", block)
+    
+    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
+  end
+  
+  build Article do |attributes|
+    attributes[:author] = create_author unless attributes.include?(:author)
+    attributes.reverse_merge!(
+      :content => 'Thanks for visiting my blog!'
+    )
+  end
+  
+  build Author do |attributes|
+    attributes.reverse_merge!(
+      :name => 'John Smith'
+    )
+  end
+  
+  build Comment do |attributes|
+    attributes[:commentable] = create_article unless attributes.include?(:commentable)
+    attributes[:commenter] = create_user unless attributes.include?(:commenter)
+  end
+  
+  build Page do |attributes|
+    attributes[:author] = create_author unless attributes.include?(:author)
+    attributes.reverse_merge!(
+      :content => 'Some information about me...'
+    )
+  end
+  
+  build User do |attributes|
+    attributes.reverse_merge!(
+      :name => 'Mr. Bean'
+    )
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,13 @@
 # Load the plugin testing framework
-$:.unshift("#{File.dirname(__FILE__)}/../../../../test/plugin_test_helper/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
 require 'rubygems'
 require 'plugin_test_helper'
 
-ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")
+
+# Mixin the factory helper
+require File.expand_path("#{File.dirname(__FILE__)}/factory")
+class Test::Unit::TestCase #:nodoc:
+  include Factory
+end

data/test/unit/polymorphic_identity_test.rb

@@ -1,62 +1,63 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class PolymorphicIdentityTest < Test::Unit::TestCase
-  fixtures :authors, :articles, :pages, :users, :comments
+  def setup
+    @comment = Comment.new
+    @comment.commenter_type = 'Article'
+  end
   
   def test_should_find_polymorphic_association_name_for_valid_symbolized_association
-    c = Comment.new
-    c.commenter_type = 'Article'
-    assert_equal :commenter, c.send(:find_polymorphic_association_name, :article)
+    assert_equal :commenter, @comment.send(:find_polymorphic_association_name, :article)
   end
   
   def test_should_find_polymorphic_association_name_for_valid_stringified_association
-    c = Comment.new
-    c.commenter_type = 'Article'
-    assert_equal :commenter, c.send(:find_polymorphic_association_name, 'article')
+    assert_equal :commenter, @comment.send(:find_polymorphic_association_name, 'article')
   end
   
   def test_should_not_find_polymorphic_association_name_for_invalid_association
-    c = Comment.new
-    c.commenter_type = 'Article'
-    assert_equal nil, c.send(:find_polymorphic_association_name, 'page')
+    assert_equal nil, @comment.send(:find_polymorphic_association_name, 'page')
+  end
+end
+
+class PolymorphicAssociationWithNoValueTest < Test::Unit::TestCase
+  def setup
+    @comment = create_comment(:commentable => nil, :commenter => nil)
   end
   
-  def test_should_not_respond_to_polymorhic_association_name_if_association_is_nil
-    ([Comment.new] + Comment.find(:all)).each do |c|
-      c.commentable = nil if c.commentable
-      c.commenter = nil if c.commenter
-      
-      assert !c.respond_to?(:article)
-      assert !c.respond_to?(:page)
-      assert !c.respond_to?(:author)
-      assert !c.respond_to?(:user)
-    end
+  def test_should_not_respond_to_polymorphic_association_name
+    assert !@comment.respond_to?(:article)
+    assert !@comment.respond_to?(:page)
+    assert !@comment.respond_to?(:author)
+    assert !@comment.respond_to?(:user)
+  end
+end
+
+class PolymorphicAssociationsWithValueTest < Test::Unit::TestCase
+  def setup
+    @author = create_author
+    @article = create_article(:author => @author)
+    @comment = create_comment(:commentable => @article, :commenter => @author)
   end
   
   def test_should_respond_to_polymorphic_association_name_if_association_exists
-    c = comments(:article_test_author_john_doe)
-    assert c.respond_to?(:article)
-    assert c.respond_to?(:author)
-    assert_equal articles(:test), c.article
-    assert_equal authors(:john_doe), c.author
-    
-    c = comments(:page_about_user_anonymous)
-    assert c.respond_to?(:page)
-    assert c.respond_to?(:user)
-    assert_equal pages(:about), c.page
-    assert_equal users(:anonymous), c.user
+    assert @comment.respond_to?(:article)
+    assert @comment.respond_to?(:author)
+    assert_equal @article, @comment.article
+    assert_equal @author, @comment.author
   end
   
   def test_should_update_response_when_changing_polymorphic_association
-    c = comments(:article_test_author_john_doe)
-    c.commentable = pages(:about)
-    c.commenter = users(:anonymous)
+    page = create_page
+    user = create_user
+    
+    @comment.commentable = page
+    @comment.commenter = user
     
-    assert !c.respond_to?(:article)
-    assert !c.respond_to?(:author)
-    assert c.respond_to?(:page)
-    assert c.respond_to?(:user)
-    assert_equal pages(:about), c.page
-    assert_equal users(:anonymous), c.user
+    assert !@comment.respond_to?(:article)
+    assert !@comment.respond_to?(:author)
+    assert @comment.respond_to?(:page)
+    assert @comment.respond_to?(:user)
+    assert_equal page, @comment.page
+    assert_equal user, @comment.user
   end
 end

metadata

@@ -1,75 +1,77 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: polymorphic_identity
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-09-26 00:00:00 -04:00
-summary: Dynamically generates aliases for polymorphic associations based on their class names
-require_paths: 
-- lib
-email: info@pluginaweek.org
-homepage: http://www.pluginaweek.org
-rubyforge_project: 
-description: 
-autorequire: polymorphic_identity
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.0.4
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
-- Aaron Pfeifer, Neil Abraham
+- Aaron Pfeifer
+autorequire: polymorphic_identity
+bindir: bin
+cert_chain: []
+
+date: 2008-05-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - lib/polymorphic_identity.rb
-- test/test_helper.rb
-- test/fixtures
+- test/factory.rb
 - test/app_root
-- test/unit
-- test/fixtures/users.yml
-- test/fixtures/authors.yml
-- test/fixtures/articles.yml
-- test/fixtures/comments.yml
-- test/fixtures/pages.yml
-- test/app_root/app
 - test/app_root/db
-- test/app_root/app/models
-- test/app_root/app/models/author.rb
-- test/app_root/app/models/article.rb
-- test/app_root/app/models/user.rb
-- test/app_root/app/models/page.rb
-- test/app_root/app/models/comment.rb
 - test/app_root/db/migrate
-- test/app_root/db/migrate/004_create_users.rb
-- 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/001_create_authors.rb
+- test/app_root/db/migrate/005_create_comments.rb
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/user.rb
+- test/app_root/app/models/page.rb
+- test/app_root/app/models/article.rb
+- test/app_root/app/models/author.rb
+- test/app_root/app/models/comment.rb
+- test/test_helper.rb
+- test/unit
 - test/unit/polymorphic_identity_test.rb
 - CHANGELOG
 - init.rb
 - MIT-LICENSE
 - Rakefile
 - README
-test_files: 
-- test/unit/polymorphic_identity_test.rb
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: Dynamically generates aliases for polymorphic associations based on their class names
+test_files: 
+- test/unit/polymorphic_identity_test.rb

data/test/fixtures/articles.yml

@@ -1,9 +0,0 @@
-test:
-  id: 1
-  author_id: 1
-  content: This is a test of the Emergency Broadcast System. If this had been an actual emergency...
-  
-welcome:
-  id: 2
-  author_id: 2
-  content: Welcome!

data/test/fixtures/authors.yml

@@ -1,7 +0,0 @@
-john_doe:
-  id: 1
-  name: John Doe
-  
-jane_doe:
-  id: 2
-  name: Jane Doe

data/test/fixtures/comments.yml

@@ -1,25 +0,0 @@
-<%
-id = 0
-[
-  [:article, :test, 1],
-  [:article, :welcome, 2],
-  [:page, :about, 1],
-  [:page, :projects, 2]
-].each do |commentable_type, commentable_name, commentable_id|
-  [
-    [:author, :john_doe, 1],
-    [:author, :jane_doe, 2],
-    [:user, :anonymous, 1],
-    [:user, :registered, 2]
-  ].each do |commenter_type, commenter_name, commenter_id|
-%>
-<%= commentable_type %>_<%= commentable_name %>_<%= commenter_type %>_<%= commenter_name %>:
-  id: <%= id += 1 %>
-  commentable_id: <%= commentable_id %>
-  commentable_type: <%= commentable_type.to_s.camelize %>
-  commenter_id: <%= commenter_id %>
-  commenter_type: <%= commenter_type.to_s.camelize %>
-<%
-  end
-end
-%>

data/test/fixtures/pages.yml

@@ -1,9 +0,0 @@
-about:
-  id: 1
-  author_id: 1
-  content: A little section about us
-  
-projects:
-  id: 2
-  author_id: 2
-  content: A little section about the projects we do

data/test/fixtures/users.yml

@@ -1,7 +0,0 @@
-anonymous:
-  id: 1
-  name: Anonymous
-  
-registered:
-  id: 2
-  name: Registered