worldly 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b84b6615e26e6486618cbbdc1596cfea9a9550bf
-  data.tar.gz: 32d3894a330baced5aaefc58c3ee054e75e1f0ea
+  metadata.gz: bb1f6102b4a99fa4c0b05b542f7bdb0e2afe7a17
+  data.tar.gz: fe728dee0952adb4573df76edbbc3ffbb622f3d7
 SHA512:
-  metadata.gz: 10d069ed2dd4c0ba8824e475f00e6e3d90a6c3748c7480536d46d554d581792e505e17fbcee97b2175fb178c05e5f9117f121302189cf39107c3b85dd8f05e99
-  data.tar.gz: 9e8e958ff63ff055140c0793adf181afc231d0b5cea9261690ca52cdeb4dda4a9efcd31cc921aa6b47e238cd56a8f24ea0bd59cf5358263e63ab0db620d3967b
+  metadata.gz: 552cc4c1e6e6fad5b7be5f546314b51f3a41dca1fdf7033c785099453c64c4206486fe3f58df60bc4bc6c5ef832e412118d766006f82dbb221c982cb306885bc
+  data.tar.gz: 0e51f4894c1d5ff91870df8e7e5a65bdc61336e3e7a8a616f1ecc42a6ac3030d3a642daefe05cd55a1c802d9cfb081dacb72ca9edf003cbf3f2bc6914143f62f

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+= Version 0.1.9 - 2016-07-26
+  * Improvement: Added to_display method
 = Version 0.1.8 - 2016-01-20
   * Improvement: Address line 3 not accepted
 = Version 0.1.7 - 2015-04-09

data/README.md

@@ -108,6 +108,16 @@ To have the address formatted correctly for mailing use to_print(attributes, sen
   country.to_print({address1: '12 hey St', region:'NSW', postcode: '2000' }, 'AU')
   => "12 hey St\nNSW 2000"
 ```
+
+There is also a to_display method which ignores certain address formatting rules:
+
+```
+  country.to_print({address1: '12 hey St', address2: '', postcode: '2000', city: 'Newtown', state:'NSW'})
+  => "12 hey St\nNEWTOWN 2000\nAustralia"
+  country.to_display({address1: '12 hey St', address2: '', postcode: '2000', city: 'Newtown', state:'NSW'})
+  => "12 hey St\nNewtown 2000\nAustralia"
+```
+
 ## Contributing
 
 If you find a country with mission regions, or a country missing address formatting information you can create a issue ticket with corrections.

data/lib/worldly/country.rb

@@ -51,6 +51,24 @@ module Worldly
       .strip
     end
 
+    # Generate an address for printing based on the countries address format.
+    # attributes = {address1: '12 hey St', address2: '', locality:'Homeville', postcode: 'AHZ 312' }
+    # sending country = 'AU'. If added the country name will be excluded from address
+    def to_display(attributes, sending_country=nil)
+      # don't add country if sending from country
+      unless sending_country.to_s.upcase == @code
+        attributes.merge!({ country: name})
+      end
+      print = address_format.dup
+      all_fields.each do |f|
+        print.gsub!("{{#{f}}}", format_values(f, attributes[f].to_s, ignore_rules: ['upcase']) )
+      end
+      print.squeeze(' ')
+      .gsub(/\A\s+\n|\n\s+|\s+\n\s+\Z/, "\n")
+      .squeeze("\n")
+      .strip
+    end
+
     def has_field?(f)
       fields.key?(f)
     end
@@ -127,13 +145,18 @@ module Worldly
     # Format a value e.g :region, 'NY'
     # apply any formatting rules
     #  - if rule fullname included change the region to it's full name - New York
-    def format_values(field, value)
+    # options = ignore_rules: ['upcase']
+    def format_values(field, value, options={})
       value = value.dup
       value.to_s.strip!
       if !fields.key?(field) || fields[field][:format].nil?
         return value
       end
       rules = fields[field][:format].dup
+      # ignore rules
+      if options[:ignore_rules]
+        rules = rules - options[:ignore_rules]
+      end
       # use fullname rather than abbreviated
       # fullname rule must be applied first!
       if rules.delete('fullname') && regions[value]

data/lib/worldly/version.rb

@@ -1,3 +1,3 @@
 module Worldly
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worldly
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Daniel Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler