postal_address 0.0.5 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2499c8eb67851e9f520f4617be1237950cd8d1f1
-  data.tar.gz: 9ad9cb07b425aa9bb65953658811e292b8283ec9
+  metadata.gz: d917f51e33a1a55dcb4b1223df2626b3df0b5ec5
+  data.tar.gz: 19521b23dd055ac878ed78e1e719c3bc927ca911
 SHA512:
-  metadata.gz: 1cc7ca58f44d13de08c8965b43b276a5c01ed95ab1b9e5838132b359bff4eb432128fa06a08e43863e78b0a2963276f6f133a0f477a68f4a517f898ddcb8a173
-  data.tar.gz: fccf1064bc4ad2348a1ae747d56d22c1872fe4e06201343055b02f856d4d8d2da976d4d1c6c955f1a6a797099364efeaf75d89fba1734217f8588a154dc29f93
+  metadata.gz: 7fb11ea6efacab7cd36459679d643a52ed350ff34f3d3da9dde0cd432cfee89278c9592eed0127aab2d23a2d6c0a3c257080929a60cb5f98ea92e6fdc1235bee
+  data.tar.gz: 835d1c41d90324bd5b167f1bda981561b3f87048dc73aa6d8482251390c5c74a235a0f85a0bcac3b897d18a907c380fb8022bf599dd0a3eaf0a329ae2dd30baa

data/README.md

@@ -29,14 +29,14 @@ Or install it yourself as:
       country_code: 'us'
     }
 
-    PostalAddress.new(address).to_s
+    Postal::Address.new(address).to_s
      
     Tobias Füncke
     101 Broadway
     New York City NY 10002
     United States of America
       
-    PostalAddress.new(address).to_html
+    Postal::Address.new(address).to_html
     
     <p itemscope itemtype="http://schema.org/PostalAddress">
       <span itemprop="name">Tobias Füncke</span>
@@ -53,9 +53,9 @@ Or install it yourself as:
     
 Set a home country (country names are not display for those addresses)
 
-    PostalAddress.home_country = 'us'
+    Postal.home_country = 'us'
     
-    p = PostalAddress.new(address)
+    p = Postal::Address.new(address)
     p.to_html(tag: 'section', itemprop: 'address')
 
     <section itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">
@@ -67,6 +67,14 @@ Set a home country (country names are not display for those addresses)
       <span itemprop="addressRegion">NY</span>
       <span itemprop="postalCode">10002</span>
     </section>
+    
+    
+Standalone AddressFormatter usage:
+
+    Postal::AddressFormatter::Text.new(address).render
+    
+    Postal::AddressFormatter::HTML.new(address).render(tag: 'section', itemprop: 'address')
+
 
 ## Contributing
 

data/data/address_formats.yml

@@ -1,3 +1,6 @@
+# http://www.addressdoctor.com/en/countries-data/address-formats.html
+
+
 --- 
 ae: "%{recipient}\n%{street}\n%{zip} %{city}\n%{country}"
 ar: "%{recipient}\n%{street}\n%{zip} %{city}\n%{state}\n%{country}"

data/lib/postal_address.rb

@@ -1,17 +1,37 @@
+require "yaml"
 require "postal_address/version"
-require "postal_address/class_methods"
-require "postal_address/instance_methods"
+require "postal_address/address"
+require "postal_address/formatters/text"
+require "postal_address/formatters/html"
 
-class PostalAddress
-  extend ClassMethods
-  include InstanceMethods
+module Postal
+  class << self
+    attr_reader :home_country
+    
+    def home_country=(code)
+      @home_country = sanitize(code)
+    end
+    
+    def home_country?(code)
+      home_country == code
+    end
+
+    def sanitize(code)
+      code && code.to_s.downcase
+    end
+    
+    def address_formats
+      @address_formats ||= load_yaml('address_formats')
+    end
   
-  # define the postal address attributes and aliases for easier assignment
-  attribute :recipient,    itemprop: 'name'
-  attribute :street,       itemprop: 'streetAddress',   alias: [:street_address]
-  attribute :zip,          itemprop: 'postalCode',      alias: [:zip_code, :postal_code, :postcode]
-  attribute :state,        itemprop: 'addressRegion',   alias: [:region, :province, :territory, :administrative_area_level_1]
-  attribute :city,         itemprop: 'addressLocality', alias: [:locality]
-  attribute :country_code, itemprop: 'addressCountry',  alias: [:country_id], writer: false
-  attribute :country,      itemprop: 'addressCountry',  writer: false, reader: false
+    def country_names
+      @country_names ||= load_yaml('country_names')
+    end
+    
+    private
+    
+    def load_yaml(filename)
+      YAML.load_file(File.expand_path("../data/#{filename}.yml", File.dirname(__FILE__)))
+    end
+  end
 end

data/lib/postal_address/address.rb

@@ -0,0 +1,41 @@
+module Postal
+  class Address
+    Fields = [:recipient, :street, :zip, :state, :city, :country, :country_code]
+  
+    attr_accessor *Fields
+  
+    def initialize(attrs={})
+      attrs.each do |attr, value|
+        self.public_send("#{attr}=", value) if self.respond_to?("#{attr}=")
+      end if attrs
+    end
+    
+    def country_code=(code)
+      @country_code = Postal.sanitize(code)
+    end
+    
+    def country
+      @country ||= Postal.country_names[country_code]
+    end
+
+    def to_h
+      attributes
+    end
+    
+    def to_s
+      AddressFormatter::Text.new(attributes).render
+    end
+        
+    def to_html(params={})
+      AddressFormatter::HTML.new(attributes).render(params)
+    end
+    
+    private
+    
+    def attributes
+      Fields.each_with_object({}) do |key, hash| 
+        hash[key] = public_send(key)
+      end
+    end
+  end
+end

data/lib/postal_address/formatters/html.rb

@@ -0,0 +1,32 @@
+module Postal
+  module AddressFormatter
+    class HTML < Text
+      Schema   = 'http://schema.org/PostalAddress'
+      ItemProp = {
+        recipient: 'name',
+        street:    'streetAddress',
+        zip:       'postalCode',
+        state:     'addressRegion',
+        city:      'addressLocality',
+        country:   'addressCountry'
+      }
+
+      def render(params={})
+        content_tag((params.delete(:tag) || :p), super.gsub("\n", "<br>"), params.merge(itemscope: nil, itemtype: Schema))
+      end
+
+      private
+
+      def address_data
+        super.each_with_object({}) do |(key, value), hash|
+          hash[key] = content_tag(:span, value, itemprop: ItemProp[key])
+        end
+      end
+
+      def content_tag(tag, content='', attributes={})
+        attrs = attributes.map {|k,v| k.to_s + (v ? "=\"#{v}\"" : '') }.unshift('').join(' ')
+        "<#{tag}#{attrs}>#{content}</#{tag}>"
+      end
+    end
+  end
+end

data/lib/postal_address/formatters/text.rb

@@ -0,0 +1,25 @@
+module Postal
+  module AddressFormatter
+    class Text
+      # expects any hash with the fields names of address
+      def initialize(address)
+        @address = address
+      end
+  
+      def render(params={})
+        (address_format % address_data).strip
+      end
+
+      private
+  
+      def address_data
+        @address[:country] = nil if Postal.home_country?(@address[:country_code])
+        @address
+      end
+
+      def address_format
+        Postal.address_formats[@address[:country_code]] || Postal.address_formats[@address[:state] ? 'us' : 'de']
+      end
+    end
+  end
+end

data/lib/postal_address/version.rb

@@ -1,3 +1,3 @@
 class PostalAddress
-  VERSION = "0.0.5"
+  VERSION = "0.1.1"
 end

data/postal_address.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", '~> 4.7.0'
+  spec.add_development_dependency "turn"
   spec.add_development_dependency "virtus"
 end

data/spec/postal_address_spec.rb

@@ -3,32 +3,32 @@ require 'spec_helper'
 
 describe PostalAddress do
   it "should load the formats" do
-    PostalAddress.formats.wont_be :empty?
-    PostalAddress.formats.must_be_kind_of Hash
+    Postal.address_formats.wont_be :empty?
+    Postal.address_formats.must_be_kind_of Hash
   end
   
   it "should load the country_name" do
-    PostalAddress.country_names.wont_be :empty?
-    PostalAddress.country_names.must_be_kind_of Hash
+    Postal.country_names.wont_be :empty?
+    Postal.country_names.must_be_kind_of Hash
   end
   
   it "should read/write home country" do
-    PostalAddress.home_country = 'de'
-    PostalAddress.home_country.must_equal 'de'    
+    Postal.home_country = 'de'
+    Postal.home_country.must_equal 'de'    
   end
   
   it "should read/write home country and convert to string and lower case" do
-    PostalAddress.home_country = :DE
-    PostalAddress.home_country.must_equal 'de'
+    Postal.home_country = :DE
+    Postal.home_country.must_equal 'de'
   end
 
   describe "Instance" do
     before {
-      PostalAddress.home_country = nil
+      Postal.home_country = nil
     }
      
     let(:address) do
-      PostalAddress.new({
+      Postal::Address.new({
         recipient: 'Tobias Füncke', 
         street: '101 Broadway', 
         city: 'New York City', 
@@ -61,12 +61,12 @@ describe PostalAddress do
     end
     
     it "should not print the country if in home country" do
-      PostalAddress.home_country = 'us'
+      Postal.home_country = 'us'
       address.to_s.must_equal "Tobias Füncke\n101 Broadway\nNew York City NY 10002"
     end
     
     it "should print the country if not in home country" do
-      PostalAddress.home_country = 'de'
+      Postal.home_country = 'de'
       address.to_s.must_equal "Tobias Füncke\n101 Broadway\nNew York City NY 10002\nUnited States of America"
     end
     
@@ -81,29 +81,29 @@ describe PostalAddress do
       address.to_s.must_equal "Tobias Füncke\n101 Broadway\n10002 New York City"
     end
     
-    it "should respond to state aliases" do
-      [:region, :province, :territory, :administrative_area_level_1].each do |alias_name|
-        #address.must_respond_to alias_name
-        address.must_respond_to :"#{alias_name}="
-        #address.send(alias_name).must_equal address.state
-      end
-    end
-    
-    it "should respond to city aliases" do
-      [:locality].each do |alias_name|
-        #address.must_respond_to alias_name
-        address.must_respond_to :"#{alias_name}="
-        #address.send(alias_name).must_equal address.city
-      end
-    end
+    # it "should respond to state aliases" do
+    #   [:region, :province, :territory, :administrative_area_level_1].each do |alias_name|
+    #     #address.must_respond_to alias_name
+    #     address.must_respond_to :"#{alias_name}="
+    #     #address.send(alias_name).must_equal address.state
+    #   end
+    # end
     
-    it "should respond to zip aliases" do
-      [:zip_code, :postal_code, :postcode].each do |alias_name|
-        #address.must_respond_to alias_name
-        address.must_respond_to :"#{alias_name}="
-        #address.send(alias_name).must_equal address.zip
-      end
-    end
+    # it "should respond to city aliases" do
+    #   [:locality].each do |alias_name|
+    #     #address.must_respond_to alias_name
+    #     address.must_respond_to :"#{alias_name}="
+    #     #address.send(alias_name).must_equal address.city
+    #   end
+    # end
+    # 
+    # it "should respond to zip aliases" do
+    #   [:zip_code, :postal_code, :postcode].each do |alias_name|
+    #     #address.must_respond_to alias_name
+    #     address.must_respond_to :"#{alias_name}="
+    #     #address.send(alias_name).must_equal address.zip
+    #   end
+    # end
     
     it "should return html" do
       address.to_html.must_equal "<p itemscope itemtype=\"http://schema.org/PostalAddress\"><span itemprop=\"name\">Tobias Füncke</span><br><span itemprop=\"streetAddress\">101 Broadway</span><br><span itemprop=\"addressLocality\">New York City</span> <span itemprop=\"addressRegion\">NY</span> <span itemprop=\"postalCode\">10002</span><br><span itemprop=\"addressCountry\">United States of America</span></p>"

data/spec/spec_helper.rb

@@ -4,4 +4,6 @@ require 'bundler/setup'
 
 require 'minitest/autorun'
 require 'minitest/spec'
+require 'turn/autorun'
+
 require 'postal_address'

data/spec/virtus_integration_spec.rb

@@ -14,7 +14,7 @@ class Address
   attribute :geolocation,  Array
   
   def postal_address
-    PostalAddress.new(self.attributes).to_s
+    Postal::Address.new(self.attributes).to_s
   end
 end
 
@@ -33,7 +33,7 @@ describe Address do
   }
   
   it "should work" do
-    PostalAddress.home_country = 'us'
+    Postal.home_country = 'us'
     address.postal_address.must_equal "Tobias Füncke\n101 Broadway\nNew York City NY 10002"
   end
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: postal_address
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
 platform: ruby
 authors:
 - Kevin Melchert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: International postal address formatting
@@ -73,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,8 +96,9 @@ files:
 - data/address_formats.yml
 - data/country_names.yml
 - lib/postal_address.rb
-- lib/postal_address/class_methods.rb
-- lib/postal_address/instance_methods.rb
+- lib/postal_address/address.rb
+- lib/postal_address/formatters/html.rb
+- lib/postal_address/formatters/text.rb
 - lib/postal_address/version.rb
 - postal_address.gemspec
 - spec/postal_address_spec.rb
@@ -99,17 +114,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: International postal address formatting
@@ -117,4 +132,3 @@ test_files:
 - spec/postal_address_spec.rb
 - spec/spec_helper.rb
 - spec/virtus_integration_spec.rb
-has_rdoc: 

data/lib/postal_address/class_methods.rb

@@ -1,40 +0,0 @@
-require "yaml"
-
-class PostalAddress
-  module ClassMethods
-    attr_reader :home_country
-    
-    def home_country=(code)
-      @home_country = code && code.to_s.downcase
-    end
-    
-    def formats
-      @formats ||= load_yaml('address_formats')
-    end
-    
-    def country_names
-      @country_names ||= load_yaml('country_names')
-    end
-    
-    def attributes
-      @attributes ||= {}
-    end
-
-    private
-
-    def attribute(name, params={})
-      attributes[name] = params
-      attr_reader name unless params[:reader] === false
-      attr_writer name unless params[:writer] === false
-      alias_attribute_writer(name, Array(params[:alias])) if params[:alias]
-    end
-    
-    def alias_attribute_writer(original, aliases)
-      aliases.each { |name| alias_method :"#{name}=", :"#{original}=" }
-    end
-    
-    def load_yaml(filename)
-      YAML.load_file(File.join(File.dirname(__FILE__), "..", "..", "data", "#{filename}.yml"))
-    end
-  end
-end

data/lib/postal_address/instance_methods.rb

@@ -1,58 +0,0 @@
-class PostalAddress
-  module InstanceMethods
-    def initialize(params={})
-      params.each do |attr, value|
-        self.public_send("#{attr}=", value) if self.respond_to?("#{attr}=")
-      end if params
-    end
-
-    def to_h
-      attributes
-    end
-
-    def to_s
-      format(attributes)
-    end
-
-    def to_html(params={})
-      address = format(attributes(:html)).gsub("\n", "<br>")
-      content_tag((params.delete(:tag) || :p), address, params.merge(itemscope: nil, itemtype: 'http://schema.org/PostalAddress'))
-    end
-
-    def country_code=(code)
-      @country_code = code && code.to_s.downcase
-    end
-
-    def country
-      @country = self.class.country_names[country_code] unless in_home_country?
-    end
-    
-    def in_home_country?
-      self.class.home_country == country_code
-    end
-
-    private
-
-    def format(hash)
-      (address_format % hash).strip
-    end
-
-    def address_format
-      self.class.formats[country_code] || self.class.formats[state ? 'us' : 'de']
-    end
-
-    def attributes(html=false)
-      self.class.attributes.inject({}) do |hash, (key, attribute)|
-        value = public_send(key)
-        value = value && content_tag(:span, value, itemprop: attribute[:itemprop]) if html
-        hash[key] = value
-        hash
-      end
-    end
-
-    def content_tag(tag, content='', attributes={})
-      attrs = attributes.map {|k,v| k.to_s + (v ? "=\"#{v}\"" : '') }.unshift('').join(' ')
-      "<#{tag}#{attrs}>#{content}</#{tag}>"
-    end
-  end
-end