jm81-dm-address 0.3.0 → 0.4.0

data/.gitignore

@@ -5,3 +5,6 @@ rdoc
 pkg
 .project
 .loadpath
+*qt_temp*
+*~
+*.gem

data/Rakefile

@@ -4,18 +4,21 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "dm-address"
-    gem.summary = %Q{TODO}
+    gem.name = "jm81-dm-address"
+    gem.summary = %Q{Add address related fields to a DataMapper model}
+    gem.description = <<EOF
+Add address fields to a DataMapper model. This includes optional validations,
+and additional DM types for ZipCode and PhoneNumber.
+EOF
     gem.email = "jmorgan@morgancreative.net"
     gem.homepage = "http://github.com/jm81/dm-address"
     gem.authors = ["Jared Morgan"]
-    gem.add_dependency('extlib')
-    gem.add_dependency('dm-core')
-    gem.add_dependency('dm-types')
-    gem.add_dependency('dm-validations')
+    gem.add_dependency('dm-core', '>= 0.10.0')
+    gem.add_dependency('dm-types', '>= 0.10.0')
+    gem.add_dependency('dm-validations', '>= 0.10.0')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
-
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/{dm-address.gemspec → jm81-dm-address.gemspec}

@@ -1,12 +1,18 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{dm-address}
-  s.version = "0.3.0"
+  s.name = %q{jm81-dm-address}
+  s.version = "0.4.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-28}
+  s.date = %q{2009-11-29}
+  s.description = %q{Add address fields to a DataMapper model. This includes optional validations,
+and additional DM types for ZipCode and PhoneNumber.
+}
   s.email = %q{jmorgan@morgancreative.net}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,10 +25,11 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "dm-address.gemspec",
+     "jm81-dm-address.gemspec",
      "lib/dm-address.rb",
      "lib/dm-address/phone_number.rb",
      "lib/dm-address/polymorphic.rb",
+     "lib/dm-address/preferred.rb",
      "lib/dm-address/us.rb",
      "lib/dm-address/zip_code.rb",
      "lib/dm-types/phone_number.rb",
@@ -31,6 +38,8 @@ Gem::Specification.new do |s|
      "lib/dm-validations/formats/zip_code.rb",
      "spec/dm-address/phone_number_spec.rb",
      "spec/dm-address/polymorphic_spec.rb",
+     "spec/dm-address/preferred_spec.rb",
+     "spec/dm-address/samples.rb",
      "spec/dm-address/us_spec.rb",
      "spec/dm-address/zip_code_spec.rb",
      "spec/dm-address_spec.rb",
@@ -41,17 +50,19 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jm81/dm-address}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
-  s.summary = %q{TODO}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Add address related fields to a DataMapper model}
   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/spec_helper.rb",
      "spec/dm-address_spec.rb",
      "spec/dm-types/phone_number_spec.rb",
      "spec/dm-types/zip_code_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/dm-address/us_spec.rb",
+     "spec/dm-address/preferred_spec.rb",
+     "spec/dm-address/polymorphic_spec.rb",
+     "spec/dm-address/samples.rb",
+     "spec/dm-address/phone_number_spec.rb",
+     "spec/dm-address/zip_code_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -59,20 +70,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<extlib>, [">= 0"])
-      s.add_runtime_dependency(%q<dm-core>, [">= 0"])
-      s.add_runtime_dependency(%q<dm-types>, [">= 0"])
-      s.add_runtime_dependency(%q<dm-validations>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<dm-types>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<dm-validations>, [">= 0.10.0"])
     else
-      s.add_dependency(%q<extlib>, [">= 0"])
-      s.add_dependency(%q<dm-core>, [">= 0"])
-      s.add_dependency(%q<dm-types>, [">= 0"])
-      s.add_dependency(%q<dm-validations>, [">= 0"])
+      s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_dependency(%q<dm-types>, [">= 0.10.0"])
+      s.add_dependency(%q<dm-validations>, [">= 0.10.0"])
     end
   else
-    s.add_dependency(%q<extlib>, [">= 0"])
-    s.add_dependency(%q<dm-core>, [">= 0"])
-    s.add_dependency(%q<dm-types>, [">= 0"])
-    s.add_dependency(%q<dm-validations>, [">= 0"])
+    s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+    s.add_dependency(%q<dm-types>, [">= 0.10.0"])
+    s.add_dependency(%q<dm-validations>, [">= 0.10.0"])
   end
 end
+

data/lib/dm-address.rb

@@ -3,12 +3,14 @@ require 'dm-types'
 require 'dm-validations'
 
 # Require dm-address files
-%w{ phone_number zip_code polymorphic us }.each do |file|
-  require File.dirname(__FILE__) + '/dm-address/' + file
+%w{ phone_number zip_code polymorphic preferred us }.each do |file|
+  require 'dm-address/' + file
 end
 
 module DataMapper
   module Address
+    VERSION = '0.4.0'
+    
     DEFAULTS = {
       :phone_format => PhoneNumber::DEFAULT_FORMAT.dup,
       :include_country => false,
@@ -32,10 +34,10 @@ end
 
 # Require dm-types files
 %w{ phone_number zip_code }.each do |file|
-  require File.dirname(__FILE__) + '/dm-types/' + file
+  require 'dm-types/' + file
 end
 
 # Require dm-validations/formats files
 %w{ phone_number zip_code }.each do |file|
-  require File.dirname(__FILE__) + '/dm-validations/formats/' + file
+  require 'dm-validations/formats/' + file
 end

data/lib/dm-address/preferred.rb

@@ -0,0 +1,53 @@
+module DataMapper
+  module Address
+    # Helper for determining a Preferred (or default address) for something, for
+    # example a billing address, where multiple addresses belong to record.
+    #
+    # Adds the following Class method when included:
+    # 
+    #     preferred_address(+method_name+)
+    #
+    # This will create an Integer property: +{method_name}_id+ and add an
+    # instance method +method_name+.
+    # 
+    # For example:
+    #
+    #     class Person
+    #       include DataMapper::Resource
+    #       include DataMapper::Address::Preferred
+    #       has n, :addresses
+    #       preferred_address :default_billing
+    #     end
+    #     
+    #     p = Person.new
+    #     p.default_billing_id = Address.last.id
+    #     p.default_billing # => Address.last
+    #     
+    # If +{method_name}_id+ is not set, the self.addresses.first is returned.
+    module Preferred
+      class << self
+        def included(klass)
+          klass.extend(ClassMethods)
+        end
+      end # class << self
+      
+      module ClassMethods
+        
+        # Setup a preferred address, including +{method_name}_id property
+        #
+        # ==== Parameters
+        # method_name<~to_s>::
+        #   Name of method used to access the preferred address.
+        def preferred_address(method_name)
+          property("#{method_name}_id".to_sym, Integer)
+          
+          define_method(method_name) do
+            self.addresses.get(attribute_get("#{method_name}_id")) ||
+            self.addresses.first
+          end
+        end
+      end # module ClassMethods
+      
+    end # module Preferred
+  end # module Address
+end # module DataMapper

data/lib/dm-address/us.rb

@@ -38,7 +38,7 @@ module DataMapper
             [:created_at, DateTime],
             [:updated_at, DateTime]
           ].each do |args|
-            unless self.properties.has_property?(args[0])
+            unless self.properties.named?(args[0])
               args[0] = "#{options[:prefix]}#{args[0]}" if options[:prefix]
               args[2] ||= {}
               args[2][:nullable] = !reqs.include?(args[0])

data/spec/dm-address/phone_number_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe DataMapper::Address::PhoneNumber do
   before(:all) do

data/spec/dm-address/polymorphic_spec.rb

@@ -1,31 +1,5 @@
-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
+require 'spec_helper'
+require 'dm-address/samples'
 
 describe DataMapper::Address::Polymorphic do
   before(:each) do

data/spec/dm-address/preferred_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'dm-address/samples'
+
+describe DataMapper::Address::Preferred 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!
+    
+    @address1 = @klass.create(:street => '123 Lane Ave.',
+      :addressable_class => @parent_class.name,
+      :addressable_id => @parent.id
+    )
+    
+    @address2 = @klass.create(:street => '123 Lane Ave.',
+      :addressable_class => @parent_class.name,
+      :addressable_id => @parent.id
+    )
+    
+    @parent.update("shipping_id" => @address2.id)
+  end
+  
+  it 'should be based on #{@preferred_name}_id' do
+    address = @parent.shipping
+    address.should_not be_nil
+    address.id.should == @parent.shipping_id
+  end
+  
+  it 'must belong to the parent record' do
+    @parent.should_not be_nil # Sanity check
+    @parent.shipping.addressable.should == @parent
+  end
+  
+  it 'should default to first available' do
+    @parent.update(:shipping_id => nil)
+    @parent.shipping.should == @address1
+  end
+  
+  it 'should be nil if none available' do
+    @address1.update(:addressable_id => (@parent.id + 1))
+    @address2.update(:addressable_class => "#{@parent_class.name}Other")
+    @parent.shipping.should be_nil
+  end
+end

data/spec/dm-address/samples.rb

@@ -0,0 +1,33 @@
+DataMapper.setup(:default, 'sqlite3::memory:')
+require 'dm-timestamps' # Only needed to make #created_at and #updated_at auto-update
+
+module DataMapper::Address::Spec
+  class US
+    include DataMapper::Resource
+    include DataMapper::Address::US
+    address_properties
+  end
+
+  class Polymorphed
+    include DataMapper::Resource
+    include DataMapper::Address::Polymorphic
+    property :id, Serial
+    property :street, String
+  end
+  
+  class Person
+    include DataMapper::Resource
+    include DataMapper::Address::Preferred
+    
+    property :id, Serial
+    has n, :addresses, :model => 'DataMapper::Address::Spec::Polymorphed',
+           :child_key => [:addressable_id], 
+           DataMapper::Address::Spec::Polymorphed.addressable_class =>
+               'DataMapper::Address::Spec::Person'
+    
+    property :name, String
+    preferred_address :shipping
+  end
+end
+
+DataMapper.auto_migrate!

data/spec/dm-address/us_spec.rb

@@ -1,17 +1,5 @@
-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 US
-    include DataMapper::Resource
-    include DataMapper::Address::US
-    address_properties
-  end
-  
-  US.auto_migrate!
-end
+require 'spec_helper'
+require 'dm-address/samples'
 
 describe DataMapper::Address::US do
   before(:each) do
@@ -32,14 +20,14 @@ describe DataMapper::Address::US do
     @address = @klass.new(@attrs)
   end
   
-  def should_validate(field, *values)
+  def assert_validate(field, *values)
     values.each do |v|
       @address.__send__("#{field}=", v)
       @address.should be_valid
     end
   end
   
-  def should_not_validate(field, *values)
+  def assert_not_validate(field, *values)
     values.each do |v|
       @address.__send__("#{field}=", v)
       @address.should_not be_valid
@@ -51,38 +39,38 @@ describe DataMapper::Address::US do
   end
   
   describe '#name' do
-    it 'should note be required' do
-      should_validate(:name, '', nil)
+    it 'should not be required' do
+      assert_validate(:name, '', nil)
     end
   end
   
   describe '#street' do
     it 'should be required' do
-      should_not_validate(:street, '', nil)
+      assert_not_validate(:street, '', nil)
     end
   end
   
   describe '#city' do
     it 'should be required' do
-      should_not_validate(:city, '', nil)
+      assert_not_validate(:city, '', nil)
     end
   end
   
   describe '#state' do
     it 'should be required' do
-      should_not_validate(:state, '', nil)
+      assert_not_validate(:state, '', nil)
     end
   end
   
   describe '#postal_code' do
     it 'should be required' do
-      should_not_validate(:postal_code, '', nil)
+      assert_not_validate(:postal_code, '', nil)
     end
     
     it 'should be 5 or 9 characters' do
-      should_not_validate(:postal_code, '1234', '123456', '12345678', '1234567890')
-      should_not_validate(:postal_code, '12345-678') # would be valid if dashes weren't stripped
-      should_validate(:postal_code, '12345', '123456789', '12345-6789')
+      assert_not_validate(:postal_code, '1234', '123456', '12345678', '1234567890')
+      assert_not_validate(:postal_code, '12345-678') # would be valid if dashes weren't stripped
+      assert_validate(:postal_code, '12345', '123456789', '12345-6789')
     end
   end
   
@@ -114,7 +102,7 @@ describe DataMapper::Address::US do
   
   describe '#country' do
     it 'should be required' do
-      should_not_validate(:country, '', nil)
+      assert_not_validate(:country, '', nil)
     end
     
     it 'should default to USA' do
@@ -124,13 +112,13 @@ describe DataMapper::Address::US do
   
   describe '#phone' do
     it 'should not be required' do
-      should_validate(:phone, '', nil)
+      assert_validate(:phone, '', nil)
     end
     
     it 'should be 10 characters' do
-      should_not_validate(:phone, '123456789', '12345678900')
-      should_not_validate(:phone, '123-456-89')
-      should_validate(:phone, '1234567890')
+      assert_not_validate(:phone, '123456789', '12345678900')
+      assert_not_validate(:phone, '123-456-89')
+      assert_validate(:phone, '1234567890')
     end
   end
   
@@ -229,7 +217,7 @@ describe DataMapper::Address::US do
         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
+        klass.properties.named?(:addressable_class).should be_true
       end
       
       it 'should not include Polymorphic module if nil' do
@@ -237,7 +225,7 @@ describe DataMapper::Address::US do
         klass.__send__(:include, DataMapper::Resource)
         klass.__send__(:include, DataMapper::Address::US)
         klass.address_properties
-        klass.properties.has_property?(:addressable_class).should be_false
+        klass.properties.named?(:addressable_class).should be_false
       end
     end
   end

data/spec/dm-address/zip_code_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe DataMapper::Address::ZipCode do
   before(:all) do

data/spec/dm-address_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe DataMapper::Address do
   describe ".config" do

data/spec/dm-types/phone_number_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe DataMapper::Types::PhoneNumber do
 

data/spec/dm-types/zip_code_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe DataMapper::Types::ZipCode do
 

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
+require 'rubygems'
 require 'spec'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'dm-address'
 
 Spec::Runner.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jm81-dm-address
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jared Morgan
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-28 00:00:00 -07:00
+date: 2009-11-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: extlib
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
   type: :runtime
@@ -30,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.10.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: dm-types
@@ -40,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.10.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: dm-validations
@@ -50,9 +40,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.10.0
     version: 
-description: 
+description: |
+  Add address fields to a DataMapper model. This includes optional validations,
+  and additional DM types for ZipCode and PhoneNumber.
+
 email: jmorgan@morgancreative.net
 executables: []
 
@@ -68,10 +61,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- dm-address.gemspec
+- jm81-dm-address.gemspec
 - lib/dm-address.rb
 - lib/dm-address/phone_number.rb
 - lib/dm-address/polymorphic.rb
+- lib/dm-address/preferred.rb
 - lib/dm-address/us.rb
 - lib/dm-address/zip_code.rb
 - lib/dm-types/phone_number.rb
@@ -80,15 +74,18 @@ files:
 - lib/dm-validations/formats/zip_code.rb
 - spec/dm-address/phone_number_spec.rb
 - spec/dm-address/polymorphic_spec.rb
+- spec/dm-address/preferred_spec.rb
+- spec/dm-address/samples.rb
 - spec/dm-address/us_spec.rb
 - spec/dm-address/zip_code_spec.rb
 - spec/dm-address_spec.rb
 - spec/dm-types/phone_number_spec.rb
 - spec/dm-types/zip_code_spec.rb
 - spec/spec_helper.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/jm81/dm-address
-licenses: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -112,13 +109,15 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: TODO
+summary: Add address related fields to a DataMapper model
 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/spec_helper.rb
 - spec/dm-address_spec.rb
 - spec/dm-types/phone_number_spec.rb
 - spec/dm-types/zip_code_spec.rb
-- spec/spec_helper.rb
+- spec/dm-address/us_spec.rb
+- spec/dm-address/preferred_spec.rb
+- spec/dm-address/polymorphic_spec.rb
+- spec/dm-address/samples.rb
+- spec/dm-address/phone_number_spec.rb
+- spec/dm-address/zip_code_spec.rb