addressable_record 1.0.0 → 1.0.1

data/History.txt

@@ -0,0 +1,8 @@
+== 1.0.1 2010-01-01
+
+* Added a join method for specifying output formats a different way than to_s.
+
+
+== 1.0.0 2009-12-30
+
+* Initial release.

data/Rakefile

@@ -6,7 +6,7 @@ begin
   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.description = %Q{Encapsulates the composed of pattern for addresses into any easy to use library.  Provides convenience methods for formatting, parsing, etc.}
     gem.email = "jason@lookforwardenterprises.com"
     gem.homepage = "http://github.com/midas/addressable_record"
     gem.authors = ["C. Jason Harrelson (midas)"]

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/addressable_record.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{addressable_record}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   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.date = %q{2010-01-01}
+  s.description = %q{Encapsulates the composed of pattern for addresses into any easy to use library.  Provides convenience methods for formatting, parsing, etc.}
   s.email = %q{jason@lookforwardenterprises.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "History.txt",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

data/lib/addressable_record.rb

@@ -4,7 +4,7 @@ require 'addressable_record/address'
 require 'addressable_record/active_record_extesions'
 
 module AddressableRecord
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end
 
 ActiveRecord::Base.send( :include, AddressableRecord::ActiveRecordExtensions ) if defined?( ActiveRecord::Base )

data/lib/addressable_record/address.rb

@@ -79,6 +79,30 @@ module AddressableRecord
       @pattern_map.each { |pat, replacement| to_return = to_return.gsub( pat, replacement ) }
       to_return.strip
     end
+    
+    # Outputs the parts of teh address delimited by specified delimiter(s).
+    #
+    # *parameters*
+    # opts:: Can be a string that is the delimiter or an an options hash.
+    #
+    # *options*
+    # delimiter:: The string to delimit the address with.
+    # street_delimiter:: An additional delimiter to use only on the street fields.
+    # country:: Outputs the country when true, otherwise no country is output (defaults to false).
+    #
+    def join( opts )
+      if opts.is_a?( Hash )
+        options = opts
+        options[:street_delimiter] ||= options[:delimiter]
+      elsif opts.is_a?( String )
+        options = {}
+        options[:street_delimiter] = options[:delimiter] = opts
+        options[:country] = false
+      end
+      
+      to_return = "#{self.street( options[:street_delimiter] )}#{options[:delimiter]}#{self.city}, #{self.state_or_province} #{self.zip_code}"
+      return options[:country] ? to_return + "#{options[:delimiter]}#{self.country}" : to_return
+    end
 
     protected
 

data/spec/addressable_record/address_parsing_shared_spec.rb

@@ -28,4 +28,24 @@ shared_examples_for "The address 123 Jones Street, Suite 540, Atlanta, GA, 33333
   it "should agree that the country is United States" do
     @address.country.should eql( 'United States' )
   end
+  
+  it "should join the address correctly given a string delimiter argument" do
+    @address.join( '<br/>' ).should eql( '123 Jones Street<br/>Suite 540<br/>Atlanta, GA 33333-1111' )
+  end
+  
+  it "should join the address correctly given a delimiter option" do
+    @address.join( :delimiter => '<br/>' ).should eql( '123 Jones Street<br/>Suite 540<br/>Atlanta, GA 33333-1111' )
+  end
+  
+  it "should join the address correctly given a delimiter and street_delimiter option" do
+    @address.join( :delimiter => '<br/>', :street_delimiter => '###' ).should eql( '123 Jones Street###Suite 540<br/>Atlanta, GA 33333-1111' )
+  end
+  
+  it "should join the address correctly given a delimiter and country option" do
+    @address.join( :delimiter => '<br/>', :country => true ).should eql( '123 Jones Street<br/>Suite 540<br/>Atlanta, GA 33333-1111<br/>United States' )
+  end
+  
+  it "should join the address correctly given a delimiter and street_delimiter option" do
+    @address.join( :delimiter => '<br/>', :street_delimiter => '###', :country => true ).should eql( '123 Jones Street###Suite 540<br/>Atlanta, GA 33333-1111<br/>United States' )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: addressable_record
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - C. Jason Harrelson (midas)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-31 00:00:00 -06:00
+date: 2010-01-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
       - !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.
+description: Encapsulates the composed of pattern for addresses into any easy to use library.  Provides convenience methods for formatting, parsing, etc.
 email: jason@lookforwardenterprises.com
 executables: []
 
@@ -54,6 +54,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- History.txt
 - LICENSE
 - README.rdoc
 - Rakefile