pluginaweek-polymorphic_identity 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,29 @@
+== master
+
+== 0.1.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+
+== 0.0.5 / 2008-06-22
+
+* Remove log files from gems
+
+== 0.0.4 / 2008-05-05
+
+* Updated documentation
+
+== 0.0.3 / 2007-09-26
+
+* Move test fixtures out of the test application root directory
+* Remove gem dependency on activerecord
+
+== 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 / 2007-02-12
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2009 Aaron Pfeifer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,76 @@
+= polymorphic_identity
+
++polymorphic_identity+ dynamically generates aliases for polymorphic associations
+based on the class names of those associations.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/polymorphic_identity
+
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13285-polymorphic_identity
+
+Development
+
+* http://github.com/pluginaweek/polymorphic_identity
+
+Source
+
+* git://github.com/pluginaweek/polymorphic_identity.git
+
+== Description
+
+Polymorphic associations are not very descriptive when it comes to easily
+knowing the type of model your interacting with.  For example, a typical
+polymorphic assocation looks like the following:
+
+  class Tag < ActiveRecord::Base
+    belongs_to :taggable, :polymorphic => true
+  end
+
+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 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.
+
+== Usage
+
+=== Example
+
+  class Comment < ActiveRecord::Base
+    belongs_to :commentable, :polymorphic => true
+    belongs_to :commenter, :polymorphic => true
+  end
+  
+  class Article < ActiveRecord::Base
+    has_many :comments, :as => :commentable
+  end
+  
+  class User < ActiveRecord::Base
+    has_many :comments, :as => :commenter
+  end
+  
+  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://github.com/pluginaweek/plugin_test_helper]
+
+To run against a specific version of Rails:
+
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
+
+== Dependencies
+
+* Rails 2.0 or later

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+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 ActiveRecord associations based on their class names'
+  s.description       = s.summary
+  
+  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 #{spec.name} plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = spec.test_files
+  t.verbose = true
+end
+
+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    = spec.name
+  rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
+end
+
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem.'
+task :pgem => [:package] do
+  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.'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pgem, :pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new.configure
+  ruby_forge.login
+  
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'polymorphic_identity'

data/lib/polymorphic_identity.rb

@@ -0,0 +1,52 @@
+# 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
+  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
+  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 PolymorphicIdentity
+end

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

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

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

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

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

@@ -0,0 +1,4 @@
+class Comment < ActiveRecord::Base
+  belongs_to  :commentable, :polymorphic => true
+  belongs_to  :commenter, :polymorphic => true
+end

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

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

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

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many  :comments, :as => :commenter
+end

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      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

data/test/factory.rb

@@ -0,0 +1,66 @@
+module Factory
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
+    
+    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|
+    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

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

data/test/unit/polymorphic_identity_test.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class PolymorphicIdentityTest < ActiveSupport::TestCase
+  def setup
+    @comment = Comment.new
+    @comment.commenter_type = 'Article'
+  end
+  
+  def test_should_find_polymorphic_association_name_for_valid_symbolized_association
+    assert_equal :commenter, @comment.send(:find_polymorphic_association_name, :article)
+  end
+  
+  def test_should_find_polymorphic_association_name_for_valid_stringified_association
+    assert_equal :commenter, @comment.send(:find_polymorphic_association_name, 'article')
+  end
+  
+  def test_should_not_find_polymorphic_association_name_for_invalid_association
+    assert_equal nil, @comment.send(:find_polymorphic_association_name, 'page')
+  end
+end
+
+class PolymorphicAssociationWithNoValueTest < ActiveSupport::TestCase
+  def setup
+    @comment = create_comment(:commentable => nil, :commenter => nil)
+  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 < ActiveSupport::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
+    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
+    page = create_page
+    user = create_user
+    
+    @comment.commentable = page
+    @comment.commenter = 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

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pluginaweek-polymorphic_identity
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Dynamically generates aliases for polymorphic ActiveRecord associations based on their class names
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/polymorphic_identity.rb
+- test/unit
+- test/unit/polymorphic_identity_test.rb
+- test/factory.rb
+- test/app_root
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/comment.rb
+- test/app_root/app/models/page.rb
+- test/app_root/app/models/user.rb
+- test/app_root/app/models/author.rb
+- test/app_root/app/models/article.rb
+- test/app_root/db
+- test/app_root/db/migrate
+- test/app_root/db/migrate/005_create_comments.rb
+- test/app_root/db/migrate/004_create_users.rb
+- test/app_root/db/migrate/001_create_authors.rb
+- test/app_root/db/migrate/002_create_articles.rb
+- test/app_root/db/migrate/003_create_pages.rb
+- test/test_helper.rb
+- CHANGELOG.rdoc
+- init.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
+rdoc_options: []
+
+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: []
+
+rubyforge_project: pluginaweek
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Dynamically generates aliases for polymorphic ActiveRecord associations based on their class names
+test_files: 
+- test/unit/polymorphic_identity_test.rb