worldly 0.1.8 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b84b6615e26e6486618cbbdc1596cfea9a9550bf
-  data.tar.gz: 32d3894a330baced5aaefc58c3ee054e75e1f0ea
+SHA256:
+  metadata.gz: b0c64f1e5bac5a7a89daa04c4b85268c3061235c001cb1c1e6264bc6c4dfc681
+  data.tar.gz: 11df37ac6026dd7ae33b38afa8022536f6f05fc510789d416c54adafb13a0383
 SHA512:
-  metadata.gz: 10d069ed2dd4c0ba8824e475f00e6e3d90a6c3748c7480536d46d554d581792e505e17fbcee97b2175fb178c05e5f9117f121302189cf39107c3b85dd8f05e99
-  data.tar.gz: 9e8e958ff63ff055140c0793adf181afc231d0b5cea9261690ca52cdeb4dda4a9efcd31cc921aa6b47e238cd56a8f24ea0bd59cf5358263e63ab0db620d3967b
+  metadata.gz: 55a8dd109241ca226cb61dc56f1b4e82066939abb14f63f5692abb47ca6031f9a35f067cb3105b247ecc31ef8007873b58c9f4dded49b257f3a8752dcc5219d7
+  data.tar.gz: 89deda2187e34cdc143617312a05c5e57eb9d058fd9215fc679f170eaa3bfc6a3e330ff861dbd0716a7210e578b0fef7919ba482657774af37e3fd00f87d30e4

data/CHANGELOG.md

@@ -1,5 +1,17 @@
+= Version 1.0.2 - 2017-11-08
+  * Fix: NZ suburb optional.
+= Version 1.0.1 - 2017-04-05
+  * Fix: Samoa address format fixed by removing region.
+= Version 1.0.0 - 2017-04-05
+  * Change: Removed Locality
+  * Change: Updated some country formats
+
+= 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
   * Fix: format_values method - dup value to ensure original data not changed
 

data/README.md

@@ -52,7 +52,7 @@ Retrieve a country using it's country code
   country.alpha3 => AUS
   country.country_code => 61
 ```
-Worldly uses the address fields locality, city, region & postcode. Address1, Address2 and Country are implied and hence not added. A call to country.fields will return the fields not implied that the country address uses.
+Worldly uses the address fields city, region & postcode. Address1, Address2 and Country are implied and hence not added. A call to country.fields will return the fields not implied that the country address uses.
 ```
   country.fields => {:city=>{:label=>"City", :format=>["upcase"], :required=>true}, :region=>{:label=>"State", :format=>["upcase"], :required=>true}, :postcode=>{:label=>"Post Code", :required=>true}}
 ```
@@ -67,7 +67,6 @@ Each field notes the following details:
 Field Methods
 ```
   country.has_field?(:city) => true
-  country.has_field?(:locality) => false
   country.required_fields => {:city=>{:label=>"City", :format=>["upcase"], :required=>true}, :region=>{:label=>"State", :format=>["upcase"], :required=>true}, :postcode=>{:label=>"Post Code", :required=>true}}
 ```
 To retrieve all fields including address1, address2 & country use
@@ -108,6 +107,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/data/countries.yml

@@ -8,7 +8,7 @@ AD:
     city:
       label: City
     postcode:
-      label: 'Post Code'
+      label: 'Postcode'
   address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{postcode}} {{city}}\n{{country}}"
 AE:
   name: United Arab Emirates
@@ -82,8 +82,8 @@ AR:
     postcode:
       label: 'Post Code'
     region:
-      label: Province
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{postcode}} {{city}}\n{{country}}"
+      label: State
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{postcode}} {{city}}\n{{state}}\n{{country}}"
 AS:
   name: American Samoa
   alpha2: AS
@@ -218,15 +218,13 @@ BR:
   alpha3: BRA
   country_code: '55'
   fields:
-    locality:
-      name: Suburb
     city:
       label: City
     region:
       label: State
     postcode:
       label: 'Post Code'
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{city}} {{region}}\n{{postcode}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}} {{region}}\n{{postcode}}\n{{country}}"
 BS:
   name: Bahamas
   alpha2: BS
@@ -339,9 +337,6 @@ CN:
   alpha3: CHN
   country_code: '86'
   fields:
-    locality:
-      label: Suburb
-      required: false
     city:
       label: City
       required: false
@@ -351,7 +346,7 @@ CN:
         - upcase
     region:
       label: Province
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}} {{city}}\n{{postcode}} {{region}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{postcode}} {{region}}\n{{country}}"
 CO:
   name: Colombia
   alpha2: CO
@@ -438,9 +433,6 @@ EG:
   alpha3: EGY
   country_code: '20'
   fields:
-    locality:
-      label: District
-      required: false
     city:
       label: City
       format:
@@ -448,7 +440,7 @@ EG:
     postcode:
       label: 'Post Code'
       required: false
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{city}}\n{{postcode}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{postcode}}\n{{country}}"
 EH:
   name: Western Sahara
   alpha2: EH
@@ -510,18 +502,18 @@ GB:
   alpha3: GBR
   country_code: '44'
   fields:
-    locality:
-      label: 'Town'
-      required: false
     city:
       label: 'City'
       format:
         - upcase
+    region:
+      label: 'County'
+      required: false
     postcode:
       label: 'Post Code'
       format:
         - upcase
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{city}}\n{{postcode}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{county}}\n{{postcode}}\n{{country}}"
 GD:
   name: Grenada
   alpha2: GD
@@ -653,14 +645,11 @@ ID:
   alpha3: IDN
   country_code: '62'
   fields:
-    locality:
-      label: Suburb
-      required: false
     city:
       label: City
     postcode:
       label: 'Post Code'
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{city}} {{postcode}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}} {{postcode}}\n{{country}}"
 IE:
   name: Ireland
   alpha2: IE
@@ -907,14 +896,11 @@ MK:
   alpha3: MKD
   country_code: '389'
   fields:
-    locality:
-      label: Suburb
-      required: false
     city:
       label: City
     postcode:
       label: 'Post Code'
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{postcode}} {{city}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{postcode}} {{city}}\n{{country}}"
 ML:
   name: Mali
   alpha2: ML
@@ -1061,14 +1047,14 @@ NZ:
   alpha3: NZL
   country_code: '64'
   fields:
-    locality:
+    city:
       label: Suburb
       required: false
-    city:
-      label: City
+    region:
+      label: Town/City
     postcode:
       label: 'Post Code'
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{city}} {{postcode}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{region}} {{postcode}}\n{{country}}"
 OM:
   name: Oman
   alpha2: OM
@@ -1135,14 +1121,11 @@ PT:
   alpha3: PRT
   country_code: '351'
   fields:
-    locality:
-      label: Village
-      required: false
     city:
       label: City
     postcode:
       label: 'Post Code'
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{postcode}} {{city}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{postcode}} {{city}}\n{{country}}"
 PW:
   name: Palau
   alpha2: PW
@@ -1480,7 +1463,7 @@ WS:
       label: City
       format:
         - upcase
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{region}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{country}}"
 YE:
   name: Yemen
   alpha2: YE
@@ -1497,16 +1480,12 @@ ZA:
   alpha3: ZAF
   country_code: '27'
   fields:
-    locality:
-      label: Suburb
-      format:
-        - upcase
     city:
       label: City
     region:
       label: Province
       required: false
-  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{locality}}\n{{city}}\n{{region}}\n{postcode}}\n{{country}}"
+  address_format: "{{address1}}\n{{address2}}\n{{address3}}\n{{city}}\n{{region}}\n{postcode}}\n{{country}}"
 ZM:
   name: Zambia
   alpha2: ZM

data/lib/worldly/country.rb

@@ -34,7 +34,7 @@ module Worldly
     end
 
     # Generate an address for printing based on the countries address format.
-    # attributes = {address1: '12 hey St', address2: '', locality:'Homeville', postcode: 'AHZ 312' }
+    # attributes = {address1: '12 hey St', address2: '', city: 'Homeville', postcode: 'AHZ 312' }
     # sending country = 'AU'. If added the country name will be excluded from address
     def to_print(attributes, sending_country=nil)
       # don't add country if sending from country
@@ -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: '', city: '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 = "1.0.3"
 end

data/worldly.gemspec

@@ -6,7 +6,7 @@ require 'worldly/version'
 Gem::Specification.new do |spec|
   spec.name          = "worldly"
   spec.version       = Worldly::VERSION
-  spec.authors       = ["Daniel Lewis"]
+  spec.authors       = ["Adventist Media"]
   spec.email         = ["webmaster@adventistmedia.org.au"]
   spec.summary       = %q{Country address formatting and telephone information}
   spec.description   = %q{Get country address formatting rules and local fields for forms. }
@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", ">= 2.1.0"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: worldly
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.3
 platform: ruby
 authors:
-- Daniel Lewis
-autorequire: 
+- Adventist Media
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +70,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,9 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Country address formatting and telephone information
 test_files: []