address_composer 1.0.1 → 2.0.0

data/lib/address_composer.rb

@@ -1,14 +1,30 @@
 require "address_composer/version"
 require "yaml"
 require "mustache"
+require "uri"
 
 class AddressComposer
   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"))
+  Templates = YAML.safe_load(IO.read(File.join(GEM_ROOT, "address-formatting", "conf", "countries", "worldwide.yaml")), aliases: true)
   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(GEM_ROOT, "address-formatting", "conf", "state_codes.yaml"))
-  CountyCodes = YAML.load_file(File.join(GEM_ROOT, "address-formatting", "conf", "county_codes.yaml"))
+  StateCodes = YAML.safe_load(IO.read(File.join(GEM_ROOT, "address-formatting", "conf", "state_codes.yaml")), aliases: true)
+  CountyCodes = YAML.safe_load(IO.read(File.join(GEM_ROOT, "address-formatting", "conf", "county_codes.yaml")), aliases: true)
+  CountryToLanguage = begin
+                        c2l = YAML.safe_load(IO.read(File.join(GEM_ROOT, "address-formatting", "conf", "country2lang.yaml")), aliases: true)
+                        c2l.transform_values! do |v|
+                          v.split(",")
+                        end
+                        c2l.freeze
+                      end
+  Abbreviations = begin
+                    abbr = {}
+                    Dir.each_child(File.join(GEM_ROOT, "address-formatting", "conf", "abbreviations")) do |file|
+                      country_code, = file.split(".", 2)
+                      abbr[country_code] = YAML.safe_load(IO.read(File.join(GEM_ROOT, "address-formatting", "conf", "abbreviations", file)), aliases: true)
+                    end
+                    abbr.freeze
+                  end
 
   class Template < Mustache
     def first
@@ -26,6 +42,7 @@ class AddressComposer
 
   def initialize(components)
     self.components = components.dup
+    @should_abbreviate = self.components.delete("should_abbreviate") || false
 
     normalize_components
   end
@@ -38,24 +55,32 @@ class AddressComposer
       result = components.values.join(" ")
     end
 
+    clean(result)
+  end
+
+  private
+
+  attr_reader :should_abbreviate
+
+  def clean(result)
     # Remove duplicated spaces
     result = result.squeeze(" ")
 
     # Remove duplicated returns and add one at the end
-    result = result.split("\n").uniq.join("\n") + "\n"
+    result = "#{result.split("\n").uniq.join("\n")}\n"
+
+    result.gsub!(/,\s*,/, ",") # multiple commas to one
 
     # Remove spaces and commas before and after return
     result = result.gsub(/[,|\s]*\n[\s|,]*/, "\n")
 
     # Remove duplicated consecutive words
-    result = result.gsub(/([[:alnum:]]+,)\s+\1/, '\1') # remove duplicates
+    result = result.gsub(/([[:alnum:]]+),\s+\1/, '\1') # remove duplicates
 
     # Remove trailing non-word characters
     result.sub(/^[,|\s|-]*/, "")
   end
 
-  private
-
   def template
     @template ||= if (components.keys & %w[road postcode]).empty?
                     formatting_rule["fallback_template"] || Templates["default"]["fallback_template"]
@@ -95,6 +120,24 @@ class AddressComposer
     apply_formatting_rules
     apply_aliases
     normalize_aliases
+    abbreviate if should_abbreviate
+  end
+
+  def abbreviate
+    langs = CountryToLanguage[components["country_code"]]
+    return unless langs
+
+    langs.each do |lang|
+      next unless Abbreviations[lang]
+
+      Abbreviations[lang].each_key do |abbrev_component|
+        next unless components[abbrev_component]
+
+        Abbreviations[lang][abbrev_component].each do |k, v|
+          components[abbrev_component].sub!(/(^|\s)#{k}\b/, "\\1#{v}")
+        end
+      end
+    end
   end
 
   def fix_countries
@@ -146,8 +189,25 @@ class AddressComposer
     end
   end
 
+  SMALL_DISTRICT_COUNTRIES = [
+    'BR',
+    'CR',
+    'ES',
+    'NI',
+    'PY',
+    'RO',
+    'TG',
+    'TM',
+    'XK',
+  ].freeze
+
   def apply_aliases
+    sdc = SMALL_DISTRICT_COUNTRIES.include?(components['country_code'])
+    district = components['district']
+    components['state_district'] = district if district && !sdc
+
     components.keys.each do |key|
+      next if !sdc && key == 'district'
       component = ComponentsList.detect { |member| member["aliases"].to_a.include?(key) }
       components[component["name"]] ||= components[key] if component
     end
@@ -159,16 +219,34 @@ class AddressComposer
     end.join(" ")
   end
 
+  def get_county_code(county, country_code)
+    # TODO what if county is actually the countyCode?
+    upcase_county = county.upcase
+    pair = CountyCodes[country_code]&.find do |_, value|
+      if value.respond_to?(:upcase)
+        value.upcase == upcase_county
+      else
+        value.values.any? { |val| val.upcase == upcase_county }
+      end
+    end
+    pair&.first
+  end
+
   def normalize_aliases
-    state_group = [components["state"], components["state_code"]].compact
-    state_code, state = StateCodes[@use_country || components["country_code"].upcase]&.select { |k, v| ([k, v] & state_group).any? }.to_a.flatten
+    state_group = [components["state"]&.upcase, components["state_code"]&.upcase].compact
+    state_code, state = StateCodes[@use_country || components["country_code"].upcase]&.select do |k, v|
+      if v.is_a? Hash
+        ([k&.upcase, v.values.map(&:upcase)] & state_group).any?
+      else
+        ([k&.upcase, v&.upcase] & state_group).any?
+      end
+    end.to_a.flatten
     components["state_code"] = state_code unless state_code.nil?
     components["state"] = state unless state.nil?
 
-    county_group = [components["county"], components["county_code"]].compact
-    county_code, county = CountyCodes[components["country_code"].upcase]&.select { |k, v| ([k, v] & county_group).any? }.to_a.flatten
-    components["county"] = county unless county.nil?
-    components["county_code"] = county_code unless county_code.nil?
+    if components["county"] && !components["county_code"]
+      components["county_code"] = get_county_code(components["county"], components["country_code"])
+    end
 
     if components["postcode"]&.include?(";")
       components.delete("postcode")
@@ -187,7 +265,7 @@ class AddressComposer
     self.components = components.reject { |_, v| v.nil? || v.empty? }
 
     # Remove components with URL
-    components.delete_if { |_, v| v.match?(URI::DEFAULT_PARSER.make_regexp) }
+    components.delete_if { |_, v| v.respond_to?(:match?) && v.match?(URI::DEFAULT_PARSER.make_regexp) }
   end
 
   def replace(replaces)

metadata

@@ -1,99 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: address_composer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Alejandro Arrufat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reline
+  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: irb
+  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: fiddle
+  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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '0'
 description: Address Composer formats address components using worldwide regions formatting
   templates
 email:
@@ -107,13 +149,12 @@ files:
 - ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- address-formatting/.travis.yml
+- address-formatting/.github/workflows/ci.yml
 - address-formatting/LICENSE.txt
 - address-formatting/README.md
 - address-formatting/SECURITY.md
@@ -129,6 +170,7 @@ files:
 - address-formatting/conf/abbreviations/eu.yaml
 - address-formatting/conf/abbreviations/fi.yaml
 - address-formatting/conf/abbreviations/fr.yaml
+- address-formatting/conf/abbreviations/gl.yaml
 - address-formatting/conf/abbreviations/hu.yaml
 - address-formatting/conf/abbreviations/it.yaml
 - address-formatting/conf/abbreviations/nl.yaml
@@ -137,18 +179,23 @@ files:
 - 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/sl.yaml
+- address-formatting/conf/abbreviations/sv.yaml
 - address-formatting/conf/abbreviations/tr.yaml
 - address-formatting/conf/abbreviations/uk.yaml
-- address-formatting/conf/abbreviations/vn.yaml
+- address-formatting/conf/abbreviations/vi.yaml
 - address-formatting/conf/components.yaml
 - address-formatting/conf/countries/worldwide.yaml
 - address-formatting/conf/country2lang.yaml
 - address-formatting/conf/country_codes.yaml
 - address-formatting/conf/county_codes.yaml
 - address-formatting/conf/state_codes.yaml
+- address-formatting/cpanfile
 - address-formatting/opencage_logo_300_150.png
+- address-formatting/testcases/abbreviations/de.yaml
+- address-formatting/testcases/abbreviations/en.yaml
+- address-formatting/testcases/abbreviations/fr.yaml
 - address-formatting/testcases/countries/ad.yaml
 - address-formatting/testcases/countries/ae.yaml
 - address-formatting/testcases/countries/af.yaml
@@ -393,6 +440,8 @@ files:
 - address-formatting/testcases/countries/vu.yaml
 - address-formatting/testcases/countries/wf.yaml
 - address-formatting/testcases/countries/ws.yaml
+- address-formatting/testcases/countries/xc.yaml
+- address-formatting/testcases/countries/xk.yaml
 - address-formatting/testcases/countries/ye.yaml
 - address-formatting/testcases/countries/yt.yaml
 - address-formatting/testcases/countries/za.yaml
@@ -421,14 +470,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.0.1
 signing_key:
 specification_version: 4
 summary: Universal international address composer in Ruby

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 1.17.2

data/address-formatting/.travis.yml

@@ -1,12 +0,0 @@
-language: perl
-perl:
-- '5.30'
-env: PERL_CPANM_OPT="--notest --force --skip-satisfied"
-install:
-- cpanm File::Find::Rule~0.34
-- cpanm Geo::Address::Formatter
-script:
-- bin/run_tests.t
-notifications:
-  slack:
-    secure: M7U87fLJ7oXOPjFDBASOwhNZXqRoYsTYtPxVbAHlQfS1at38IfK7/6rWdf7yNUPCV0JqfRCsR7frWQNncR9BbjtYSoDFywY/IcdVMoOl3haZJqXbA/LfGgI9ZIBAx5nBUlZkBaaq/RhXoKlNbZ89p6zq3qyvsUIgmUSkNTGejRU=