jm81-dm-address 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/dm-address.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-address}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jared Morgan"]
-  s.date = %q{2009-07-22}
+  s.date = %q{2009-07-28}
   s.email = %q{jmorgan@morgancreative.net}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
      "dm-address.gemspec",
      "lib/dm-address.rb",
      "lib/dm-address/phone_number.rb",
+     "lib/dm-address/polymorphic.rb",
      "lib/dm-address/us.rb",
      "lib/dm-address/zip_code.rb",
      "lib/dm-types/phone_number.rb",
@@ -29,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/dm-validations/formats/phone_number.rb",
      "lib/dm-validations/formats/zip_code.rb",
      "spec/dm-address/phone_number_spec.rb",
+     "spec/dm-address/polymorphic_spec.rb",
      "spec/dm-address/us_spec.rb",
      "spec/dm-address/zip_code_spec.rb",
      "spec/dm-address_spec.rb",
@@ -43,6 +45,7 @@ Gem::Specification.new do |s|
   s.summary = %q{TODO}
   s.test_files = [
     "spec/dm-address/phone_number_spec.rb",
+     "spec/dm-address/polymorphic_spec.rb",
      "spec/dm-address/us_spec.rb",
      "spec/dm-address/zip_code_spec.rb",
      "spec/dm-address_spec.rb",

data/lib/dm-address.rb

@@ -3,7 +3,7 @@ require 'dm-types'
 require 'dm-validations'
 
 # Require dm-address files
-%w{ phone_number zip_code us }.each do |file|
+%w{ phone_number zip_code polymorphic us }.each do |file|
   require File.dirname(__FILE__) + '/dm-address/' + file
 end
 

data/lib/dm-address/polymorphic.rb

@@ -0,0 +1,41 @@
+module DataMapper
+  module Address
+    # Add fields to an Address class (such as one that includes Address::US)
+    # to allow for roughly polymorphic associations, belonging to other classes.
+    # (See http://pastie.org/214893). Including this module adds two properties:
+    # +addressable_class+ and +addressable_id+, and one method, +addressable+,
+    # for accessing the parent record.
+    # 
+    # To use (in Address class):
+    # 
+    #     include DataMapper::Address::Polymorphic
+    #
+    # In parent class, something along the lines of:
+    #
+    #     has n, :addresses, :class_name => 'Address',
+    #            :child_key => [:addressable_id], 
+    #            Address.addressable_class => 'ParentModel'
+    module Polymorphic
+      class << self
+        # Add :addressable_class and :addressable_id properties
+        def included(klass)
+          klass.__send__(:property, :addressable_class, String)
+          klass.__send__(:property, :addressable_id, Integer)
+        end
+      end # class << self
+     
+      
+      # Return the addressable (that is, parent) record.
+      def addressable
+        parent_class_name = attribute_get(:addressable_class)
+        # Remove a trailing method reference
+        parent_split = parent_class_name.to_s.split('#')
+        parent_class_name = parent_split[0..-2].join('#') if parent_split.length > 1
+        return nil if parent_class_name.blank?
+        parent_class = Object.full_const_get(parent_class_name)
+        parent_class.get(attribute_get(:addressable_id))
+      end
+      
+    end # module Polymorphic
+  end # module Address
+end # module DataMapper

data/lib/dm-address/us.rb

@@ -45,6 +45,10 @@ module DataMapper
               self.property(*args)
             end
           end
+          
+          if options[:polymorphic]
+            include(DataMapper::Address::Polymorphic)
+          end
         end
       end # module ClassMethods
       

data/spec/dm-address/polymorphic_spec.rb

@@ -0,0 +1,99 @@
+require File.join( File.dirname(__FILE__), '..', "spec_helper" )
+
+DataMapper.setup(:default, 'sqlite3::memory:')
+require 'dm-timestamps' # Only needed to make #created_at and #updated_at auto-update
+
+module DataMapper::Address::Spec
+  class Polymorphed
+    include DataMapper::Resource
+    include DataMapper::Address::Polymorphic
+    property :id, Serial
+    property :street, String
+  end
+  
+  class Person
+    include DataMapper::Resource
+    
+    property :id, Serial
+    has n, :addresses, :class_name => 'DataMapper::Address::Spec::Polymorphed',
+           :child_key => [:addressable_id], 
+           DataMapper::Address::Spec::Polymorphed.addressable_class =>
+               'DataMapper::Address::Spec::Person'
+    
+    property :name, String
+  end
+  
+  Polymorphed.auto_migrate!
+  Person.auto_migrate!
+end
+
+describe DataMapper::Address::Polymorphic do
+  before(:each) do
+    @parent_class = DataMapper::Address::Spec::Person
+    @parent_class.all.destroy!
+    @parent = @parent_class.create(:name => 'Jane Doe')
+    
+    @klass = DataMapper::Address::Spec::Polymorphed
+    @klass.all.destroy!
+    @address = @klass.create(:street => '123 Lane Ave.',
+      :addressable_class => 'DataMapper::Address::Spec::Person',
+      :addressable_id => @parent.id
+    )
+  end
+  
+  it 'should be valid' do
+    # Sanity check only
+    @parent.should be_valid
+    @address.should be_valid
+  end
+  
+  describe '#addressable' do
+    it 'should return the parent' do
+      @address.addressable.should == @parent
+    end
+    
+    it 'should error if the class is unknown' do
+      @address.addressable_class = 'DataMapper::Address::Spec::NoClass'
+      lambda { @address.addressable }.should raise_error(NameError)
+    end
+    
+    it 'should be nil if the id does not return a record' do
+      @address.addressable_id = 0
+      @address.addressable.should be_nil
+    end
+    
+    it 'should remove a method identifier when determining class name' do
+      @address.addressable_class = 'DataMapper::Address::Spec::Person#address'
+      @address.addressable.should == @parent
+    end
+  end
+  
+  describe 'parent#addresses' do
+    it 'should retrieve all addresses for this class/id' do
+      address2 = @klass.create(:street => '123 Lane Ave.',
+        :addressable_class => 'DataMapper::Address::Spec::Person',
+        :addressable_id => @parent.id
+      )
+      
+      @parent.addresses.should == [@address, address2]
+    end
+    
+    it 'should not retrieve addresses for other classes' do
+      address2 = @klass.create(:street => '123 Lane Ave.',
+        :addressable_class => 'DataMapper::Address::Spec::NoClass',
+        :addressable_id => @parent.id
+      )
+      
+      @parent.addresses.should == [@address]
+    end
+  
+    it 'should not retrieve addresses for other id' do
+      address2 = @klass.create(:street => '123 Lane Ave.',
+        :addressable_class => 'DataMapper::Address::Spec::Person',
+        :addressable_id => 0
+      )
+      
+      @parent.addresses.should == [@address]
+    end
+  end
+end

data/spec/dm-address/us_spec.rb

@@ -221,4 +221,24 @@ describe DataMapper::Address::US do
       @address.updated_at.should be_kind_of(DateTime)
     end
   end
+  
+  describe '#address_properties' do
+    describe ':polymorphic option' do
+      it 'should include Polymorphic module if true' do
+        klass = Class.new
+        klass.__send__(:include, DataMapper::Resource)
+        klass.__send__(:include, DataMapper::Address::US)
+        klass.address_properties(:polymorphic => true)
+        klass.properties.has_property?(:addressable_class).should be_true
+      end
+      
+      it 'should not include Polymorphic module if nil' do
+        klass = Class.new
+        klass.__send__(:include, DataMapper::Resource)
+        klass.__send__(:include, DataMapper::Address::US)
+        klass.address_properties
+        klass.properties.has_property?(:addressable_class).should be_false
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jm81-dm-address
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jared Morgan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-22 00:00:00 -07:00
+date: 2009-07-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ files:
 - dm-address.gemspec
 - lib/dm-address.rb
 - lib/dm-address/phone_number.rb
+- lib/dm-address/polymorphic.rb
 - lib/dm-address/us.rb
 - lib/dm-address/zip_code.rb
 - lib/dm-types/phone_number.rb
@@ -78,6 +79,7 @@ files:
 - lib/dm-validations/formats/phone_number.rb
 - lib/dm-validations/formats/zip_code.rb
 - spec/dm-address/phone_number_spec.rb
+- spec/dm-address/polymorphic_spec.rb
 - spec/dm-address/us_spec.rb
 - spec/dm-address/zip_code_spec.rb
 - spec/dm-address_spec.rb
@@ -86,6 +88,7 @@ files:
 - spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/jm81/dm-address
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -106,12 +109,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: TODO
 test_files: 
 - spec/dm-address/phone_number_spec.rb
+- spec/dm-address/polymorphic_spec.rb
 - spec/dm-address/us_spec.rb
 - spec/dm-address/zip_code_spec.rb
 - spec/dm-address_spec.rb