address_composer 0.1.2.pre → 1.0.0

data/address-formatting/testcases/countries/hm.yaml

@@ -7,6 +7,7 @@ components:
         country_code: hm
         island: Heard Island
 expected:  |
+    Heard Island
     Heard Island and McDonald Islands
     Australia
 

data/address-formatting/testcases/countries/ie.yaml

@@ -28,7 +28,6 @@ components:
 expected:  |
     Kilkenny
     Ireland
-
 ---
 # Friar's Hill - 52.54593995, -6.95706874120767
 description: Friar's Hill, Graiguenamanagh
@@ -44,7 +43,28 @@ expected:  |
     Graiguenamanagh
     County Kilkenny
     Ireland
-
+---
+# 53.3388,-6.2691
+description: condense "Dublin, County Dublin"
+components:
+    city: Dublin
+    city_district: Wood Quay A ED
+    continent: Europe
+    country: Ireland
+    country_code: ie
+    county: County Dublin
+    county_code: D
+    library: The National Archives
+    postcode: D02 TD99
+    road: Bishop Street
+    state: Leinster
+    state_code: L
+expected:  |
+    The National Archives
+    Bishop Street
+    Wood Quay A ED
+    Dublin
+    Ireland
 ---
 # 52.6726,-8.6407
 description: remove "The Metropolitan District of"
@@ -63,5 +83,27 @@ expected:  |
     Shelbourne Road
     Farranshone
     Limerick
-    County Limerick
     Ireland
+---
+# 53.49137,-10.02117
+description: no "Electoral Division"
+components:
+    city_district: Clifden Electoral Division
+    continent: Europe
+    country: Ireland
+    country_code: ie
+    county: County Galway
+    county_code: G
+    guest_house: Connemara Country Lodge
+    region: Conamara Municipal District
+    road: N59
+    state: Connacht
+    state_code: C
+    town: Clifden
+expected:  |
+    Connemara Country Lodge
+    N59
+    Clifden
+    County Galway
+    Ireland
+    

data/address-formatting/testcases/countries/im.yaml

@@ -13,7 +13,8 @@ components:
 expected:  |
     3FM
     45 Victoria Street
-    Douglas IM1 2AY
+    Douglas
+    IM1 2AY
     Isle of Man
 
 

data/address-formatting/testcases/countries/je.yaml

@@ -11,5 +11,6 @@ components:
         town: Saint Helier
 expected:  |
     5 Le Geyt Street
-    Saint Helier JE2 4TN
+    Saint Helier
+    JE2 4TN
     Jersey, Channel Islands

data/address-formatting/testcases/countries/no.yaml

@@ -16,3 +16,20 @@ expected:  |
     Åkebergveien 28
     0650 Oslo
     Norway
+---
+description: house in village with postal_city
+components:
+    country: Norge
+    country_code: "no"
+    county: Viken
+    house_number: 33
+    neighbourhood: Belset
+    postal_city: Rykkinn
+    postcode: 1349
+    road: Grindstuveien
+    suburb: Angerst
+    village: Ringvoll
+expected:  |
+    Grindstuveien 33
+    1349 Rykkinn
+    Norge

data/address-formatting/testcases/countries/pt.yaml

@@ -14,3 +14,25 @@ expected:  |
     Avenida Conselheiro Barjona de Freitas 11
     1500-203 Lisbon
     Portugal
+---
+# Guest house in the Azores
+description: 37.74851,-25.60450
+components:
+    archipelago: Azores
+    city: Ponta Delgada
+    city_district: Rosto do Cão (Livramento)
+    country: Portugal
+    country_code: pt
+    guest_house: Casa Do Populo
+    house_number: 1015
+    neighbourhood: Livramento
+    postcode: 9500-614
+    road: Rua Padre Domingos da Silva Costay
+    state_district: São Miguel
+expected:  |
+    Casa Do Populo
+    Rua Padre Domingos da Silva Costay 1015
+    9500-614 Ponta Delgada
+    Azores
+    Portugal
+

data/address-formatting/testcases/countries/ru.yaml

@@ -20,3 +20,33 @@ expected:  |
     Санкт-Петербург
     Российская Федерация
     190000
+---
+description: village 55.8931701, 63.7019487
+components:
+    city : Батуринский сельсовет
+    country : Россия
+    country_code : ru
+    county : Шадринский район
+    hamlet : Камчатка
+    state : Курганская область
+expected:  |
+    Камчатка
+    Батуринский сельсовет
+    Шадринский район
+    Россия
+---
+# island
+description: use island name
+components:
+    city : Малиновараккское сельское поселение
+    country : Россия
+    country_code : ru
+    county : Лоухский район
+    island : Ярославль
+    state : Республика Карелия
+expected:  |
+    Ярославль
+    Малиновараккское сельское поселение
+    Лоухский район
+    Россия
+

data/address-formatting/testcases/countries/sg.yaml

@@ -1,5 +1,5 @@
 ---
-description: Chinatown Singapore
+description: SG no postcode
 components:
     country: Singapore
     country_code: SG
@@ -24,3 +24,20 @@ expected:  |
     16 Sandilands Road
     Singapore 546080
     Singapore
+---
+description: no city, 1.30585,103.78158
+components:
+    country: Singapore
+    country_code: sg
+    county: Southwest
+    house_number: 26
+    postcode: 130026
+    residential: Dover Gardens
+    road: Dover Crescent
+    suburb: Queenstown
+expected:  |
+    26 Dover Crescent, Dover Gardens
+    Singapore 130026
+    Singapore
+
+

data/address-formatting/testcases/countries/sh.yaml

@@ -26,7 +26,8 @@ components:
         state: Tristan da Cunha
 expected:  |
     Prince Philip Hall
-    Edinburgh of the Seven Seas TDCU 1ZZ
+    Edinburgh of the Seven Seas
+    TDCU 1ZZ
     Tristan da Cunha
     United Kingdom
 

data/address-formatting/testcases/countries/ug.yaml

@@ -18,6 +18,19 @@ expected:  |
     6/6A Kampala Road
     Kampala
     Uganda
+---
+description: subcounty
+components:
+    country: Uganda
+    country_code: ug
+    state: Arua
+    subcounty: Ayivuni
+expected:  |
+    Ayivuni
+    Arua
+    Uganda
+
+
 
 
 

data/address-formatting/testcases/countries/um.yaml

@@ -6,7 +6,7 @@ components:
         country_code: um
         island: Wake Island
 expected:  |
-    Wake Island, UM
+    Wake Island, US Minor Outlying Islands
     United States of America
 
 

data/address-formatting/testcases/countries/us.yaml

@@ -75,7 +75,7 @@ components:
     county: Santa Clara County
     state: California
 expected:  |
-    Palo Alto, CA
+    Palo Alto, California
     United States of America
 ---
 description: NY, NY
@@ -85,7 +85,7 @@ components:
     country_code: US
     state: New York
 expected:  |
-    New York, NY
+    New York, New York
     United States of America
 ---    
 description: house number in New York, no city
@@ -183,3 +183,70 @@ expected:  |
     Dronningens Gade
     Charlotte Amalie, VI 00803
     United States of America
+#
+# state_district
+---
+description: state_district
+components:
+        country: United States of America
+        country_code: us
+        state: New York
+        state_district: New York
+expected:  |
+    New York, New York
+    United States of America
+---
+description: just state
+components:
+        country: United States of America
+        country_code: us
+        state: New York
+expected:  |
+    New York
+    United States of America
+#
+# municipality
+---
+description: municipality
+components:
+    country: United States of America
+    country_code: us
+    county: Saginaw County
+    municipality: Taymouth Township
+    state: Michigan
+    village: Burt
+expected:  |
+    Burt
+    Taymouth Township, Michigan
+    United States of America
+#
+# village
+---
+description: village
+components:
+    country: United States of America
+    country_code:  us
+    county: Costilla County
+    postcode: "08113"
+    state: Colorado
+    village:  Fort Garland
+expected:  |
+    Fort Garland
+    Costilla County, CO 08113
+    United States of America
+#
+# hamlet
+---
+description: hamlet
+components:
+    city: Homestead
+    country: United States of America
+    country_code:  us
+    county: Miami-Dade County
+    hamlet: Homestead Trailer Park
+    postcode: 33030
+    state: Florida
+expected:  |
+    Homestead Trailer Park
+    Homestead, FL 33030
+    United States of America

data/address-formatting/testcases/other/xx.yaml

@@ -0,0 +1,28 @@
+# Dummy test country to check that we fall back to the defaults
+---
+description: generic format
+components:
+    city: City
+    country: Null Island
+    country_code: XX
+    county: County
+    house_number: 123
+    postcode: PCPCPC
+    road: Main Street
+    state: State
+    suburb: The Hood
+expected:  |
+    Main Street 123
+    PCPCPC City
+    Null Island
+---
+description: generic fallback
+components:
+    city: City
+    country: Null Island
+    country_code: XX
+    state: State
+expected:  |
+    City
+    State
+    Null Island

data/address_composer.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "mustache", "~> 1.1"
 
-  gem.add_development_dependency "bundler", "~> 1.17"
-  gem.add_development_dependency "pry", "~> 0.13"
-  gem.add_development_dependency "pry-byebug", "~> 3.9"
+  gem.add_development_dependency "bundler", "~> 2.2"
+  gem.add_development_dependency "pry", "~> 0.14"
+  gem.add_development_dependency "pry-byebug", "~> 3.8"
   gem.add_development_dependency "rake", "~> 13.0"
-  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "rspec", "~> 3.10"
 end

data/lib/address_composer.rb

@@ -1,13 +1,14 @@
 require "address_composer/version"
-require "YAML"
+require "yaml"
 require "mustache"
 
 class AddressComposer
-  Templates = YAML.load_file(File.join("address-formatting/conf/countries/worldwide.yaml"))
-  ComponentsList = Psych.load_stream(File.read("address-formatting/conf/components.yaml"))
+  GEM_ROOT = Gem::Specification.find_by_name("address_composer").gem_dir
+  Templates = YAML.load_file(File.join(GEM_ROOT, "address-formatting", "conf", "countries", "worldwide.yaml"))
+  ComponentsList = Psych.load_stream(File.read(File.join(GEM_ROOT,"address-formatting", "conf","components.yaml")))
   AllComponents = ComponentsList.map { |h| h["name"] } + ComponentsList.flat_map { |h| h["aliases"] }.compact
-  StateCodes = YAML.load_file(File.join("address-formatting/conf/state_codes.yaml"))
-  CountyCodes = YAML.load_file(File.open("address-formatting/conf/county_codes.yaml"))
+  StateCodes = YAML.load_file(File.join(GEM_ROOT, "address-formatting", "conf", "state_codes.yaml"))
+  CountyCodes = YAML.load_file(File.join(GEM_ROOT, "address-formatting", "conf", "county_codes.yaml"))
 
   class Template < Mustache
     def first
@@ -24,12 +25,12 @@ class AddressComposer
   attr_accessor :components
 
   def initialize(components)
-    self.components = components
-  end
+    self.components = components.dup
 
-  def compose
     normalize_components
+  end
 
+  def compose
     if components["country_code"]
       result = Template.render(template, components).squeeze("\n").lstrip.gsub(/\s*\n\s*/, "\n")
       result = post_format_replace(result)
@@ -154,7 +155,7 @@ class AddressComposer
     unknown_components = components.keys - AllComponents
 
     components["attention"] = unknown_components.map do |unknown|
-      components[unknown]
+      components.delete(unknown)
     end.join(" ")
   end
 

data/lib/address_composer/version.rb

@@ -1,3 +1,3 @@
 class AddressComposer
-  VERSION = "0.1.2.pre".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: address_composer
 version: !ruby/object:Gem::Version
-  version: 0.1.2.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Alejandro Arrufat
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 description: Address Composer formats address components using worldwide regions formatting
   templates
 email:
@@ -102,11 +102,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -116,12 +116,13 @@ files:
 - address-formatting/.travis.yml
 - address-formatting/LICENSE.txt
 - address-formatting/README.md
+- address-formatting/SECURITY.md
 - address-formatting/bin/coverage.pl
 - address-formatting/bin/run_tests.t
 - address-formatting/conf/abbreviations/ca.yaml
 - address-formatting/conf/abbreviations/cs.yaml
+- address-formatting/conf/abbreviations/da.yaml
 - address-formatting/conf/abbreviations/de.yaml
-- address-formatting/conf/abbreviations/dk.yaml
 - address-formatting/conf/abbreviations/en.yaml
 - address-formatting/conf/abbreviations/es.yaml
 - address-formatting/conf/abbreviations/et.yaml
@@ -131,12 +132,16 @@ files:
 - address-formatting/conf/abbreviations/hu.yaml
 - address-formatting/conf/abbreviations/it.yaml
 - address-formatting/conf/abbreviations/nl.yaml
+- address-formatting/conf/abbreviations/no.yaml
+- address-formatting/conf/abbreviations/pl.yaml
 - address-formatting/conf/abbreviations/pt.yaml
 - address-formatting/conf/abbreviations/ro.yaml
+- address-formatting/conf/abbreviations/ru.yaml
 - address-formatting/conf/abbreviations/se.yaml
 - address-formatting/conf/abbreviations/sk.yaml
 - address-formatting/conf/abbreviations/tr.yaml
 - address-formatting/conf/abbreviations/uk.yaml
+- address-formatting/conf/abbreviations/vn.yaml
 - address-formatting/conf/components.yaml
 - address-formatting/conf/countries/worldwide.yaml
 - address-formatting/conf/country2lang.yaml
@@ -394,6 +399,7 @@ files:
 - address-formatting/testcases/countries/zm.yaml
 - address-formatting/testcases/countries/zw.yaml
 - address-formatting/testcases/other/null.yaml
+- address-formatting/testcases/other/xx.yaml
 - address_composer.gemspec
 - bin/console
 - bin/setup
@@ -407,7 +413,7 @@ metadata:
   documentation_uri: https://github.com/mirubiri/address_composer/README.md
   homepage_uri: https://github.com/mirubiri/address_composer
   source_code_uri: https://github.com/mirubiri/address_composer
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -418,13 +424,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Universal international address composer in Ruby
 test_files: []