addressable_record 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Harrelson (midas)
+
+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,144 @@
+= addressable_record
+
+http://github.com/midas/addressable_record
+
+
+== DESCRIPTION
+
+Encapsulates the composed of pattern for addresses into any easy to use library.
+
+
+== FEATURES
+
+* Store an address in multiple database fields, but load it as a AddressableRecord::Address object.
+* Parse virtually any formatting an address can be represented with.
+* Use 1 or more street address parts with no limit.
+* Overrides #to_s with format strings to control output.
+* Pre-defined named format strings to control output.
+* Migration generator to generate a migration file containing the correct fields to hold the address data.
+
+
+== REQUIREMENTS
+
+* geographer >= 1.1.1
+* active_record >= 2.3
+
+
+== INSTALL
+
+  gem sources -a http://gemcutter.org
+  sudo gem install addressable_record
+
+
+== INSTALL FOR RAILS
+
+Add to environment file:
+
+  config.gem "addressable_record", :version => '1.0.0', :source => 'http://gemcutter.org'
+
+Run:
+
+  sudo rake:gems:install
+
+
+== USAGE
+
+Generate a migration to add the necessary field to the database:
+
+  script/generate addressable_record_migration {file_name} {table_name} {field_name}
+  script/generate addressable_record_migration users_have_home_address users home_address
+
+Will yield:
+
+  class UsersHaveHomeAddress < ActiveRecord::Migration
+    def self.up
+      add_column :users, :home_address_raw_street, :string, :limit => 255
+      add_column :users, :home_address_city, :string, :limit => 50
+      add_column :users, :home_address_state_or_province, :string, :limit => 50
+      add_column :users, :home_address_raw_zip_code, :string, :limit => 9
+      add_column :users, :home_address_country, :string, :limit => 75
+    end
+
+    def self.down
+      remove_column :users, :home_address_raw_street
+      remove_column :users, :home_address_city
+      remove_column :users, :home_address_state_or_province
+      remove_column :users, :home_address_raw_zip_code
+      remove_column :users, :home_address_country
+    end
+  end
+
+Call the macro in an ActiveRecord descendant:
+
+  class User < ActiveRecord::Base
+    address :home_address
+  end
+
+Set the field equal to something:
+
+  @user.home_address = AddressableRecord::Address.new( :raw_street => '123 Jones Street###Suite 540', :city => 'Atlanta',
+                         :state_or_province => 'GA', :raw_zip_code => '333331111', :country => 'United States' )
+
+or (with identical results):
+
+  @user.home_address = ['123 Jones Street', 'Suite 540', 'Atlanta', 'GA', '33333-1111']
+
+Reference the raw database fields:
+
+  @user.home_address_raw_street                             # => 123 Jones Street###Suite 540
+  @user.home_address_city                                   # => Atlanta
+  @user.home_address_state_or_province                      # => GA
+  @user.home_address_raw_zip_code                           # => 333331111
+  @user.home_address_country                                # => United States
+
+Reference the sub parts of the field:
+
+  @user.home_address.streets.first                          # => 123 Jones Street
+  @user.home_address.streets.join( ', ' )                   # => 123 Jones Street, Suite 540
+  @user.home_address.streets[1]                             # => Suite 540
+  @user.home_address.street                                 # => 123 Jones Street, Suite 540
+  @user.home_address.city                                   # => Atlanta
+  @user.home_address.state_or_province                      # => GA
+  @user.home_address.state                                  # => GA
+  @user.home_address.province                               # => GA
+  @user.home_address.zip_code                               # => 33333-1111
+  @user.home_address.country                                # => United States
+
+Use formats to control the output:
+
+  @user.home_address.to_s( '%s' )                           # => 123 Jones Street, Suite 540
+  @user.home_address.to_s( '%c' )                           # => Atlanta
+  @user.home_address.to_s( '%S' )                           # => GA
+  @user.home_address.to_s( '%z' )                           # => 33333-1111
+  @user.home_address.to_s( '%C' )                           # => United States
+  @user.home_address.to_s( '%c %S' )                        # => Atlanta GA
+
+Use pre-defined named formats to control the output:
+
+  @user.home_address.to_s( :us_long )                       # => 123 Jones Street, Suite 540, Atlanta GA, 33333-1111, United States
+  @user.home_address.to_s( :us )                            # => 123 Jones Street, Suite 540, Atlanta GA, 33333-1111
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Copyright
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "addressable_record"
+    gem.summary = %Q{Encapsulates the composed of pattern for addresses into any easy to use library.}
+    gem.description = %Q{Encapsulates the composed of pattern for addresses into any easy to use library.  Provides conveniencce methods for formatting, parsing, etc.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/addressable_record"
+    gem.authors = ["C. Jason Harrelson (midas)"]
+    gem.add_dependency "geographer", ">= 1.1.1"
+    gem.add_dependency "activerecord", ">= 2.3"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "addressable_record #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/addressable_record.gemspec

@@ -0,0 +1,74 @@
+# 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{addressable_record}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["C. Jason Harrelson (midas)"]
+  s.date = %q{2009-12-31}
+  s.description = %q{Encapsulates the composed of pattern for addresses into any easy to use library.  Provides conveniencce methods for formatting, parsing, etc.}
+  s.email = %q{jason@lookforwardenterprises.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "addressable_record.gemspec",
+     "lib/addressable_record.rb",
+     "lib/addressable_record/active_record_extesions.rb",
+     "lib/addressable_record/address.rb",
+     "lib/addressable_record/states.rb",
+     "rails_generators/addressable_record_migration_generator/addressable_record_migration_generator.rb",
+     "rails_generators/addressable_record_migration_generator/templates/migration.rb",
+     "script/console",
+     "script/environment.rb",
+     "script/seed.rb",
+     "spec/addressable_record/address_parsing_shared_spec.rb",
+     "spec/addressable_record/address_spec.rb",
+     "spec/addressable_record_spec.rb",
+     "spec/database.yml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/midas/addressable_record}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Encapsulates the composed of pattern for addresses into any easy to use library.}
+  s.test_files = [
+    "spec/addressable_record/address_parsing_shared_spec.rb",
+     "spec/addressable_record/address_spec.rb",
+     "spec/addressable_record_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<geographer>, [">= 1.1.1"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<geographer>, [">= 1.1.1"])
+      s.add_dependency(%q<activerecord>, [">= 2.3"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<geographer>, [">= 1.1.1"])
+    s.add_dependency(%q<activerecord>, [">= 2.3"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/addressable_record/active_record_extesions.rb

@@ -0,0 +1,33 @@
+module AddressableRecord
+  module ActiveRecordExtensions
+    def self.included( base )
+      base.extend ActsMethods
+    end
+
+    module ActsMethods
+      def address( *args )
+        unless included_modules.include? InstanceMethods
+          self.class_eval { extend ClassMethods }
+          include InstanceMethods
+        end
+        initialize_compositions( args )
+      end
+
+      alias_method :addresses, :address
+    end
+
+    module ClassMethods
+      def initialize_compositions( attrs )
+        attrs.each do |attr|
+          composed_of attr, :class_name => 'AddressableRecord::Address', :converter => :convert, :allow_nil => true, 
+            :mapping => [["#{attr}_raw_street", 'raw_street'], ["#{attr}_city", 'city'], ["#{attr}_state_or_province", 'state_or_province'], ["#{attr}_raw_zip_code", 'raw_zip_code'], ["#{attr}_country", 'country']],
+            :constructor => Proc.new { |raw_street, city, state_or_province, raw_zip_code, country| AddressableRecord::Address.new( :raw_street => raw_street, :city => city, :state_or_province => state_or_province, :raw_zip_code => raw_zip_code, :country => country ) }
+        end
+      end
+    end
+
+    module InstanceMethods
+
+    end
+  end
+end

data/lib/addressable_record/address.rb

@@ -0,0 +1,127 @@
+require File.dirname(__FILE__) + '/states'
+
+module AddressableRecord
+  class Address
+    attr_reader :raw_street, :streets, :city, :state_or_province, :zip_code, :country
+
+    @@street_delimiter ||= '###'
+    @@zip_code_delimiter ||= '-'
+    @@patterns ||= {
+            :us_long => "%s, %c %S, %z, %C",
+            :us => "%s, %c %S, %z"
+    }
+
+    def initialize( attrs )
+      raise 'Initilaizer argument must be an attributes hash.' unless attrs.is_a?( Hash )
+      @city, @state_or_province, @country = attrs[:city], attrs[:state_or_province], attrs[:country]
+
+      @streets = AddressableRecord::Address.parse_street( attrs[:raw_street] || '' )
+      raw_zip = (attrs[:raw_zip_code] || '')
+      @zip_code = raw_zip.size == 5 ? @raw_zip_code : raw_zip.gsub( /(\d{5})(\d{4})/, "\\1#{@@zip_code_delimiter}\\2" )
+
+      @pattern_map = {
+              '%s' => @streets.join( ', ' ) || "",
+              '%1' => @streets[0] || "",
+              '%2' => @streets[1] || "",
+              '%3' => @streets[2] || "",
+              '%4' => @streets[3] || "",
+              '%5' => @streets[4] || "",
+              '%c' => @city || "",
+              '%S' => @state_or_province || "",
+              '%z' => @zip_code || "",
+              '%C' => @country || ""
+      }
+
+      self.freeze
+    end
+
+    def self.street_delimiter
+      @@street_delimiter
+    end
+
+    def state
+      @state_or_province
+    end
+
+    def province
+      @state_or_province
+    end
+
+    def street( delimiter=', ' )
+      return @streets.nil? ? '' : @streets.join( delimiter ) 
+    end
+
+    def self.parse( address )
+      raise "Cannot convert #{address.class.to_s.downcase} to an AddressableRecord::Address" unless [Array].include?( address.class )
+      self.send( :"parse_#{address.class.to_s.downcase}", address )
+    end
+
+    def self.convert( address ) #:nodoc:
+      parse( address )
+    end
+
+    def self.parse_street( street ) #:nodoc:
+      return street.split( @@street_delimiter )
+    end
+
+    # Outputs a address based on pattern provided.
+    #
+    # Symbols:
+    #   %s - street
+    #   %c - city
+    #   %S - state
+    #   %z - zip code
+    #   %C - country
+    #
+    def to_s( pattern=nil )
+      to_return = pattern.is_a?( Symbol ) ? @@patterns[pattern] : pattern
+      to_return = @@patterns[:us] if to_return.nil? || to_return.empty?
+      @pattern_map.each { |pat, replacement| to_return = to_return.gsub( pat, replacement ) }
+      to_return.strip
+    end
+
+    protected
+
+    def raw_street #:nodoc:
+      return @streets.nil? ? '' : @streets.join( @@street_delimiter ) #@streets.join( @@street_delimiter )
+    end
+
+    def raw_zip_code #:nodoc:
+      return @zip_code.nil? ? '' : @zip_code.gsub( /#{@@zip_code_delimiter}/, '' )
+    end
+
+    class << self
+      private
+
+      def parse_array( address_elements ) #:nodoc:
+        state_pos = find_state_position( address_elements )
+        raise 'Cannot parse address array.  Failed to find a state.' if state_pos.nil?
+        raise 'Cannot parse address array.  No zip code found.' unless address_elements.size >= (state_pos + 1)
+        state = States.by_abbreviation.has_key?( address_elements[state_pos] ) ? address_elements[state_pos] : States.by_name[address_elements[state_pos]]
+        zip_code = address_elements[state_pos+1].gsub( /#{@@zip_code_delimiter}/, '' )
+        country = address_elements.size >= (state_pos + 3) ? address_elements[state_pos+2] : 'United States'
+        city = address_elements[state_pos-1]
+        streets = []
+        (0..state_pos-2).each { |i| streets << address_elements[i] }
+        street = streets.join( @@street_delimiter )
+        return AddressableRecord::Address.new( :raw_street => street, :city => city, :state_or_province => state, :raw_zip_code => zip_code, :country => country )
+      end
+
+      def find_state_position( address_elements )
+        # Look for state abbreviation
+        possible_abbreviation_positions = find_possible_state_abbrev_positions( address_elements )
+        state_index = possible_abbreviation_positions.detect { |i| States.by_abbreviation.has_key?( address_elements[i] ) }
+        return state_index unless state_index.nil?
+
+        # Look for state name
+        (0..address_elements.size-1).detect { |i| States.by_name.has_key?( address_elements[i] ) }
+      end
+
+      def find_possible_state_abbrev_positions( address_array )
+        positions = []
+        address_array.each_with_index { |str, i| positions << i if str.size == 2 }
+        positions
+      end
+    end
+  end
+end

data/lib/addressable_record/states.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'geographer'
+
+module AddressableRecord
+  class States
+    include Geographer::Us::States
+  end
+end

data/lib/addressable_record.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'addressable_record/address'
+require 'addressable_record/active_record_extesions'
+
+module AddressableRecord
+  VERSION = '1.0.0'
+end
+
+ActiveRecord::Base.send( :include, AddressableRecord::ActiveRecordExtensions ) if defined?( ActiveRecord::Base )

data/rails_generators/addressable_record_migration_generator/addressable_record_migration_generator.rb

@@ -0,0 +1,21 @@
+class AddressableRecordMigrationGenerator < Rails::Generator::NamedBase
+  def initialize( runtime_args, runtime_options={} )
+    super
+    @stamp = DateTime.now.utc.strftime( "%Y%m%d%H%M%S" )
+    parse_args( args )
+  end
+
+  def manifest
+    record do |m|
+      m.directory "db/migrate"
+      m.template  "migration.rb", "db/migrate/#{@stamp}_#{name}.rb", :assigns => { :table => @table, :field => @field }
+    end
+  end
+
+  private
+
+  def parse_args( args )
+    @table = args[0]
+    @field = args[1]
+  end
+end

data/rails_generators/addressable_record_migration_generator/templates/migration.rb

@@ -0,0 +1,17 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table %>, :<%= field %>_raw_street, :string, :limit => 255
+    add_column :<%= table %>, :<%= field %>_city, :string, :limit => 50
+    add_column :<%= table %>, :<%= field %>_state_or_province, :string, :limit => 50
+    add_column :<%= table %>, :<%= field %>_raw_zip_code, :string, :limit => 9
+    add_column :<%= table %>, :<%= field %>_country, :string, :limit => 75
+  end
+
+  def self.down
+    remove_column :<%= table %>, :<%= field %>_raw_street
+    remove_column :<%= table %>, :<%= field %>_city
+    remove_column :<%= table %>, :<%= field %>_state_or_province
+    remove_column :<%= table %>, :<%= field %>_raw_zip_code
+    remove_column :<%= table %>, :<%= field %>_country
+  end
+end

data/script/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r 'rubygems' -r 'active_record' -r 'binary_search/pure' -r 'geographer' -r '#{File.dirname(__FILE__) + '/../lib/addressable_record.rb'}' -r '#{File.dirname(__FILE__) + '/environment'}' -r '#{File.dirname(__FILE__) + '/seed'}'"
+
+puts "Loading addressable_record gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/environment.rb

@@ -0,0 +1,43 @@
+ActiveRecord::Base.configurations = YAML::load( IO.read( File.dirname(__FILE__) + '/../spec/database.yml' ) )
+ActiveRecord::Base.establish_connection( 'test' )
+
+ActiveRecord::Schema.define :version => 1 do
+  create_table "users", :force => true do |t|
+    t.string   "name",       :limit => 50
+    t.string   "address_street", :limit => 255
+    t.string   "address_city", :limit => 50
+    t.string   "address_state_or_province", :limit => 50
+    t.string   "address_zip_code", :limit => 9
+    t.string   "address_country", :limit => 50
+  end
+
+  create_table "people", :force => true do |t|
+    t.string   "name",       :limit => 50
+  end
+
+  create_table "contact_addresses", :force => true do |t|
+    t.integer  :person_id
+    t.string   :location, :default => 'unknown', :null => false
+    t.string   "address_raw_street", :limit => 255
+    t.string   "address_city", :limit => 50
+    t.string   "address_state_or_province", :limit => 50
+    t.string   "address_raw_zip_code", :limit => 9
+    t.string   "address_country", :limit => 50
+  end
+end
+
+class User < ActiveRecord::Base
+  address :address
+end
+
+class Person < ActiveRecord::Base
+  has_many :contact_addresses
+end
+
+class ContactAddress < ActiveRecord::Base
+  address :address
+  belongs_to :person
+end
+
+ADDRESS_ATTRIBUTES = {:raw_street => '123 Jones Street###Suite 540', :city => 'Atlanta', :state_or_province => 'GA',
+  :raw_zip_code => '312347890', :country => 'United States' }

data/script/seed.rb

@@ -0,0 +1,3 @@
+@person = Person.create( :name => 'John Smith' )
+@person.contact_addresses.build( :address => AddressableRecord::Address.new( ADDRESS_ATTRIBUTES ) )
+@person.save!

data/spec/addressable_record/address_parsing_shared_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path( File.dirname(__FILE__) + '/../spec_helper' )
+
+shared_examples_for "The address 123 Jones Street, Suite 540, Atlanta, GA, 33333-1111, United States" do
+  it "should be an AddressableRecord::Address" do
+    @address.is_a?( AddressableRecord::Address ).should be_true
+  end
+
+  it "should agree that the size of streets is 2" do
+    @address.streets.size.should eql( 2 )
+  end
+
+  it "should agree that the street address is 123 Jones Street, Suite 540" do
+    @address.street.should eql( '123 Jones Street, Suite 540' )
+  end
+
+  it "should agree that the city is Atlanta" do
+    @address.city.should eql( 'Atlanta' )
+  end
+
+  it "should agree that the state is GA" do
+    @address.state.should eql( 'GA' )
+  end
+
+  it "should agree that the zip_code is 33333-1111" do
+    @address.zip_code.should eql( '33333-1111' )
+  end
+
+  it "should agree that the country is United States" do
+    @address.country.should eql( 'United States' )
+  end
+end

data/spec/addressable_record/address_spec.rb

@@ -0,0 +1,151 @@
+require File.expand_path( File.dirname(__FILE__) + '/../spec_helper' )
+require File.expand_path( File.dirname(__FILE__) + '/address_parsing_shared_spec' )
+
+describe "AddressableRecord::Address" do
+  before :each do
+    @address_attributes = ADDRESS_ATTRIBUTES
+    @klass = AddressableRecord::Address
+    @instance = AddressableRecord::Address.new( @address_attributes )
+  end
+  
+  it "should agree that the raw_street is correct" do
+    @instance.send( :raw_street ).should eql( @address_attributes[:raw_street] )
+  end
+  
+  it "should agree that the city is correct" do
+    @instance.city.should eql( @address_attributes[:city] )
+  end
+  
+  it "should agree that the state_or_province is correct" do
+    @instance.state_or_province.should eql( @address_attributes[:state_or_province] )
+  end
+  
+  it "should agree that the raw_zip_code is correct" do
+    @instance.send( :raw_zip_code ).should eql( @address_attributes[:raw_zip_code] )
+  end
+  
+  it "should agree that the country is correct" do
+    @instance.country.should eql( @address_attributes[:country] )
+  end
+  
+  it "should agree that the streets array is the correct size" do
+    @instance.streets.size.should eql( 2 )
+  end
+  
+  it "should agree that the default call to \#street is correct" do
+    @instance.street.should eql( @address_attributes[:raw_street].split( AddressableRecord::Address.street_delimiter ).join( ', ' ) )
+  end
+  
+  it "should agree that the call to \#street with a pattern of '\\n' is correct" do
+    @instance.street( '\n' ).should eql( @address_attributes[:raw_street].split( AddressableRecord::Address.street_delimiter ).join( '\n' ) )
+  end
+  
+  it "should agree that the zip code is correct" do
+    @instance.zip_code.should eql( "#{@address_attributes[:raw_zip_code][0..4]}-#{@address_attributes[:raw_zip_code][5..9]}")
+  end
+  
+  it "should agree that the state is the state_or_province" do
+    @instance.state.should eql( @instance.state_or_province )
+  end
+  
+  it "should agree that the province is the state_or_province" do
+    @instance.province.should eql( @instance.state_or_province )
+  end
+  
+  it "should be able to find the position of a state abbreviation in an array" do
+    @klass.send( :find_state_position, ['123 Jones St.', 'Atlanta', 'GA', '33333', ] ).should eql( 2 )
+  end
+
+  it "should be able to find the position of a state name in an array" do
+    @klass.send( :find_state_position, ['123 Jones St.', 'Atlanta', 'Georgia', '33333', ] ).should eql( 2 )
+  end
+
+  it "should return nil if an address array does not have a state in it" do
+    @klass.send( :find_state_position, ['123 Jones St.', 'Atlanta', '33333' ] ).should be_nil
+  end
+
+  describe "when parsing an array of address elements" do
+    before :each do
+      @address_elements_without_country = ['123 Jones Street', 'Suite 540', 'Atlanta', 'GA', '33333-1111']
+    end
+
+    describe "with a country" do
+      before :each do
+        @address = @klass.parse( @address_elements_without_country + ['United States'] )
+      end
+
+      it_should_behave_like "The address 123 Jones Street, Suite 540, Atlanta, GA, 33333-1111, United States"
+    end
+
+    describe "without a country" do
+      before :each do
+        @address = @klass.parse( @address_elements_without_country )
+      end
+
+      it_should_behave_like "The address 123 Jones Street, Suite 540, Atlanta, GA, 33333-1111, United States"
+    end
+
+    describe "with a spelled out state name" do
+      before :each do
+        @address_elements_without_country[@address_elements_without_country.index( 'GA' )] = 'Georgia'
+        @address = @klass.parse( @address_elements_without_country )
+      end
+
+      it_should_behave_like "The address 123 Jones Street, Suite 540, Atlanta, GA, 33333-1111, United States"
+    end
+
+    describe "when printing out a formatted string" do
+      before :each do
+        @address = @klass.parse( @address_elements_without_country )
+      end
+      
+      it "should obey the :us format correctly" do
+        @address.to_s( :us ).should eql( '123 Jones Street, Suite 540, Atlanta GA, 33333-1111' )
+      end
+
+      it "should obey the :us_long format correctly" do
+        @address.to_s( :us_long ).should eql( '123 Jones Street, Suite 540, Atlanta GA, 33333-1111, United States' )
+      end
+
+      it "should obey the %s format correctly" do
+        @address.to_s( '%s' ).should eql( '123 Jones Street, Suite 540' )
+      end
+
+      it "should obey the %1 format correctly" do
+        @address.to_s( '%1' ).should eql( '123 Jones Street' )
+      end
+
+      it "should obey the %2 format correctly" do
+        @address.to_s( '%2' ).should eql( 'Suite 540' )
+      end
+
+      it "should obey the %3 format correctly" do
+        @address.to_s( '%3' ).should eql( '' )
+      end
+
+      it "should obey the %4 format correctly" do
+        @address.to_s( '%4' ).should eql( '' )
+      end
+
+      it "should obey the %5 format correctly" do
+        @address.to_s( '%5' ).should eql( '' )
+      end
+
+      it "should obey the %c format correctly" do
+        @address.to_s( '%c' ).should eql( 'Atlanta' )
+      end
+
+      it "should obey the %S format correctly" do
+        @address.to_s( '%S' ).should eql( 'GA' )
+      end
+
+      it "should obey the %z format correctly" do
+        @address.to_s( '%z' ).should eql( '33333-1111' )
+      end
+
+      it "should obey the %C format correctly" do
+        @address.to_s( '%C' ).should eql( 'United States' )
+      end
+    end
+  end
+end

data/spec/addressable_record_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AddressableRecord" do
+  describe "having ActiveRecord extensions" do
+    it "should respond to address" do
+      ActiveRecord::Base.respond_to?( :address ).should be_true
+    end
+
+    it "should respond to addresses" do
+      ActiveRecord::Base.respond_to?( :addresses ).should be_true
+    end
+  end
+  
+  describe "having models descending from ActiveRecord" do
+    before :each do
+      @address_attributes = ADDRESS_ATTRIBUTES
+      @user = User.new( :name => 'John Smith', :address => AddressableRecord::Address.new( @address_attributes ) )
+      @user.save!
+    end
+    
+    it "should respond to home_address" do
+      @user.respond_to?( :address ).should be_true
+    end
+    
+    it "should be an AddressableRecord::Address" do
+      @user.address.is_a?( AddressableRecord::Address ).should be_true
+    end
+
+    it "should agree that the size of streets is 2" do
+      @user.address.streets.size.should eql( 2 )
+    end
+
+    it "should agree that the street address is 123 Jones Street, Suite 540" do
+      @user.address.street.should eql( '123 Jones Street, Suite 540' )
+    end
+
+    it "should agree that the city is Atlanta" do
+      @user.address.city.should eql( 'Atlanta' )
+    end
+
+    it "should agree that the state is GA" do
+      @user.address.state.should eql( 'GA' )
+    end
+
+    it "should agree that the zip_code is 31234-7890" do
+      @user.address.zip_code.should eql( '31234-7890' )
+    end
+
+    it "should agree that the country is United States" do
+      @user.address.country.should eql( 'United States' )
+    end
+  end
+  
+  describe "when used through an association" do
+    before :each do
+      @address_attributes = ADDRESS_ATTRIBUTES
+      @person = Person.new( :name => 'John Smith' )
+      @person.save!
+    end
+    
+    describe "creating through the association" do
+      before :each do
+        @address = AddressableRecord::Address.new( @address_attributes )
+        @person.contact_addresses.build( :address => @address )
+        @person.save!
+      end
+
+      it "should agree that the address street is 123 Jones Street, Suite 540" do
+        @address.street.should eql( '123 Jones Street, Suite 540' )
+      end
+
+      it "should agree that the associated street is 123 Jones Street, Suite 540" do
+        @person.contact_addresses.first.address.street.should eql( '123 Jones Street, Suite 540' )
+      end
+
+      it "should agree that the address city is Atlanta" do
+        @address.city.should eql( 'Atlanta' )
+      end
+
+      it "should agree that the associated street is Atlanta" do
+        @person.contact_addresses.first.address.city.should eql( 'Atlanta' )
+      end
+
+      it "should agree that the address state is GA" do
+        @address.state.should eql( 'GA' )
+      end
+
+      it "should agree that the associated state is GA" do
+        @person.contact_addresses.first.address.state.should eql( 'GA' )
+      end
+
+      it "should agree that the address zip code is 31234-7890" do
+        @address.zip_code.should eql( '31234-7890' )
+      end
+
+      it "should agree that the associated zip code is 31234-7890" do
+        @person.contact_addresses.first.address.zip_code.should eql( '31234-7890' )
+      end
+
+      it "should agree that the address country is United States" do
+        @address.country.should eql( 'United States' )
+      end
+
+      it "should agree that the associated country is United States" do
+        @person.contact_addresses.first.address.country.should eql( 'United States' )
+      end
+    end
+  end
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  :adapter: sqlite3
+  :database: ":memory:"

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'addressable_record'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+require File.dirname(__FILE__) + '/../script/environment'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: addressable_record
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- C. Jason Harrelson (midas)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-31 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: geographer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.3"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Encapsulates the composed of pattern for addresses into any easy to use library.  Provides conveniencce methods for formatting, parsing, etc.
+email: jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- addressable_record.gemspec
+- lib/addressable_record.rb
+- lib/addressable_record/active_record_extesions.rb
+- lib/addressable_record/address.rb
+- lib/addressable_record/states.rb
+- rails_generators/addressable_record_migration_generator/addressable_record_migration_generator.rb
+- rails_generators/addressable_record_migration_generator/templates/migration.rb
+- script/console
+- script/environment.rb
+- script/seed.rb
+- spec/addressable_record/address_parsing_shared_spec.rb
+- spec/addressable_record/address_spec.rb
+- spec/addressable_record_spec.rb
+- spec/database.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/midas/addressable_record
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Encapsulates the composed of pattern for addresses into any easy to use library.
+test_files: 
+- spec/addressable_record/address_parsing_shared_spec.rb
+- spec/addressable_record/address_spec.rb
+- spec/addressable_record_spec.rb
+- spec/spec_helper.rb