postal_address 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2adb655210bf5988140022ca184b5e956a32f1c
-  data.tar.gz: c123706c063eec3009944f574e90ac7205bc44e3
+  metadata.gz: f32866bfaa46d951c32b91d92188bc0bf59b12ea
+  data.tar.gz: 27bcd0cff098480e72fd8111318bb4848131ce72
 SHA512:
-  metadata.gz: 3fbafa9585c991310586ee1136afd494f601924b44afb1da34cd3175785f2722199992d703c8885d93743681401698a1f1f47c26021eb32a8974aff26ba2f5ba
-  data.tar.gz: 0e0696d0f64664cf9e10b1b578e07365d577ddfcecb3fc4fbe41a9f27936eb32eb86332b89ca1109f7e48796a381a7e8547de35c2428102e1b05d7214bf988bb
+  metadata.gz: f84883c634e3d01eae501d0155a5ce12886a8ff2dfb63fd8dc6a784e9f93a08861d10ca01bec9da88e4414eb8fcaf5b16b97cb15dceba2f1c37407df2135d21e
+  data.tar.gz: 5823c60c68513d2a3dd17402b4042c8008183dd7a0ff6ffb04ecb6ccea87bf2ab4ec88375d377393cdcff70dc82a28be10555083976d6a88fc7945efacace734

data/lib/postal_address.rb

@@ -1,72 +1,17 @@
 require "postal_address/version"
-require "yaml"
+require "postal_address/class_methods"
+require "postal_address/instance_methods"
 
 class PostalAddress
-  class << self
-    attr_reader :home_country
-    
-    def home_country=(code)
-      @home_country = code && code.to_s.downcase
-    end
-        
-    def formats
-      @formats ||= YAML.load_file("data/address_formats.yml")
-    end
+  extend ClassMethods
+  include InstanceMethods
   
-    def country_names
-      @country_names ||= YAML.load_file("data/country_names.yml")
-    end
-    
-    private
-    
-    def attribute(name, *aliases)
-      attr_accessor name
-      aliases.each { |a| define_attribute_alias(a, name) }
-    end
-    
-    def define_attribute_alias(new_name, original)
-      alias_method new_name, original
-      alias_method :"#{new_name}=", :"#{original}="
-    end
-  end
-
   # define the postal address attributes and aliases for easier assignment
-  attribute :recipient
-  attribute :street,       :street_address
-  attribute :zip,          :zip_code, :postal_code, :postcode
-  attribute :state,        :region, :province, :territory, :administrative_area_level_1
-  attribute :city,         :locality
-  attribute :country_code, :country_id   # expects ISO 3166 Alpha 2 codes
-
-  def initialize(attributes={})
-    attributes.each do |attr, value|
-      self.public_send("#{attr}=", value) if self.respond_to?("#{attr}=")
-    end if attributes
-  end
-
-  def to_s
-    (format % to_h).strip
-  end
-
-  def to_h
-    { :recipient=>recipient, :street=>street, :zip=>zip, :city=>city, :state=>state, :country=>country }
-  end
-  
-  def country_code=(code)
-    @country_code = code && code.to_s.downcase
-  end
-  
-  def country
-     self.class.country_names[country_code] unless in_home_country?
-  end
-
-  private
-  
-  def format
-    self.class.formats[country_code] || self.class.formats[state ? 'us' : 'de']
-  end
-  
-  def in_home_country?
-    self.class.home_country == country_code
-  end
-end
+  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
+end

data/lib/postal_address/class_methods.rb

@@ -0,0 +1,36 @@
+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 ||= YAML.load_file("data/address_formats.yml")
+    end
+    
+    def country_names
+      @country_names ||= YAML.load_file("data/country_names.yml")
+    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
+  end
+end

data/lib/postal_address/instance_methods.rb

@@ -0,0 +1,58 @@
+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) || :div), 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
+
+    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 in_home_country?
+      self.class.home_country == country_code
+    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

data/lib/postal_address/version.rb

@@ -1,3 +1,3 @@
 class PostalAddress
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/postal_address_spec.rb

@@ -41,7 +41,7 @@ describe PostalAddress do
     it "should respond to to_h" do
       r = address.to_h
       r.must_be_kind_of Hash
-      r.keys.length.must_equal 6
+      r.keys.length.must_equal 7
     end
     
     it "should format to US format" do
@@ -83,26 +83,34 @@ describe PostalAddress do
     
     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.must_respond_to :"#{alias_name}="
-        address.send(alias_name).must_equal address.state
+        #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.must_respond_to :"#{alias_name}="
-        address.send(alias_name).must_equal address.city
+        #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.must_respond_to :"#{alias_name}="
-        address.send(alias_name).must_equal address.zip
+        #address.send(alias_name).must_equal address.zip
       end
     end
+    
+    it "should return html" do
+      address.to_html.must_equal "<div 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></div>"
+    end
+    
+    it "should return custom html" do
+      address.to_html(tag: :section, itemprop: 'address').must_equal "<section itemprop=\"address\" 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></section>"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postal_address
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Melchert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,8 @@ 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/version.rb
 - postal_address.gemspec
 - spec/postal_address_spec.rb