address_composer 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c044946e2cf8967b36aa267c126579b5bcbf4e529abed3a121bac815265fb6f
-  data.tar.gz: 4849d192a1073e378624714e536e964846aff9e9297fc5a32ea96238e5abdbc0
+  metadata.gz: e248820d945fb5dcea60dc9ac1f25252345709c80f3d7dfcde6874573f522473
+  data.tar.gz: ccebf64be28ed5bd201c321f8e875385e950a510fa9aa4f55f438bb1e95c52be
 SHA512:
-  metadata.gz: 105c406cc5cf4f269ab44a07ebb31ed7f5db74705f38f0f3379dd23c1331cd86c873dd00f5846a608e221fef402f97a55c9a5320af92d8af61fe8dfa7d06abbb
-  data.tar.gz: eab56b159a893271e8815c2f4bc2d3ce3686cda249e6376e18fcafe444c08ef5831a10aba4e16ee220b0228de24fb62f2fd140895cd857b660f08137907c9784
+  metadata.gz: 6f5533a2a9390874594328d74bac15793dae3be01a419e2cbd9bf6ce6e4ee83e39f2dce405efd6dd29d2b19e25cfc8795f751c675d55457cc354cd9f577a8941
+  data.tar.gz: e851627c55c2b11ce9ff0dc2d8adb8a95d1a2101b2b2030e4ad911aeb1f74d72b354b385df1d790874c063d623b71233f8d89427cda124713b5124e8951ed8a9

data/.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
   rspec:
     strategy:
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
+        ruby: [2.6, 2.7, 3.0, 3.1, 3.2, 3.3, 3.4]
 
     runs-on: ubuntu-latest
 

data/.gitmodules

@@ -1,3 +1,4 @@
 [submodule "address-formatting"]
 	path = address-formatting
 	url = https://github.com/OpenCageData/address-formatting.git
+	branch = master

data/.rubocop.yml

@@ -1,21 +1,9 @@
 AllCops:
-  TargetRubyVersion: 2.4.5
+  TargetRubyVersion: 2.6
   Exclude:
     - "vendor/**/*"
     - "db/schema.rb"
   UseCache: false
-Rails:
-  Enabled: false
-Rails/UnknownEnv:
-  Environments:
-    - beta
-    - development
-    - ephemeral
-    - production
-    - qa
-    - sandbox
-    - simulator
-    - test
 Style/DateTime:
   Enabled: true
 Style/AsciiComments:
@@ -71,11 +59,11 @@ Naming/PredicateName:
   - is_
   - has_
   - have_
-  NamePrefixBlacklist:
+  ForbiddenPrefixes:
   - is_
   Exclude:
   - spec/**/*
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   # Parameter names may be equal to or greater than this value
   MinNameLength: 3
   AllowNamesEndingInNumbers: true
@@ -256,7 +244,7 @@ Style/WhenThen:
 Lint/EachWithObjectArgument:
   Description: Check for immutable argument given to each_with_object.
   Enabled: true
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Description: Don't suppress exception.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
   Enabled: false
@@ -270,10 +258,6 @@ Style/Lambda:
   Description: Use the new lambda literal syntax for single-line blocks.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#lambda-multi-line
   Enabled: false
-Rails/HttpPositionalArguments:
-  Enabled: false
-Rails/SkipsModelValidations:
-  Enabled: false
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 Style/ClassAndModuleChildren:

data/Gemfile.lock

@@ -1,49 +1,74 @@
 PATH
   remote: .
   specs:
-    address_composer (1.0.1)
-      mustache (~> 1.1)
+    address_composer (2.0.0)
+      mustache
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    method_source (1.0.0)
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    fiddle (1.1.6)
+    io-console (0.8.0)
+    irb (1.6.3)
+      reline (>= 0.3.0)
+    json (2.7.6)
     mustache (1.1.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.8.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    ostruct (0.6.1)
+    parallel (1.24.0)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rexml (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
-  ruby
-  x86_64-darwin-20
+  x86_64-darwin-24
+  x86_64-linux
 
 DEPENDENCIES
   address_composer!
-  bundler (~> 2.2)
-  pry (~> 0.14)
-  pry-byebug (~> 3.8)
-  rake (~> 13.0)
-  rspec (~> 3.10)
+  bundler
+  fiddle
+  irb
+  ostruct
+  rake
+  reline
+  rspec
+  rubocop
 
 BUNDLED WITH
-   2.2.22
+   2.4.22

data/README.md

@@ -46,6 +46,32 @@ Palo Alto, CA 94303
 United States of America
 ```
 
+You can also control whether the output should be abbreviated or not by passing `should_abbreviate`:
+
+```ruby
+require "address_composer"
+
+address_components = {
+  "house_number" => 301,
+  "road" => "Hamilton Avenue",
+  "neighbourhood" => "Crescent Park",
+  "city" => "Palo Alto",
+  "postcode" => 94303,
+  "county" => "Santa Clara County",
+  "state" => "California",
+  "country" => "United States of America",
+  "country_code" => "US",
+  "should_abbreviate" => true
+}
+
+puts AddressComposer.compose(address_components)
+
+301 Hamilton Ave
+Palo Alto, CA 94303
+United States of America
+
+```
+
 ## Development
 
 After checking out the repo, run `git submodule init` and `git submodule update` to fetch all the data from the submodule project and check out the mapped commit.

data/address-formatting/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI Tests
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '11 22 2 * *'
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    name: Address-Formatting
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up perl
+        uses: shogo82148/actions-setup-perl@v1
+        with:
+          perl-version: '5.38'
+          install-modules-with: cpanm
+
+      - name: Tests
+        run: bin/run_tests.t

data/address-formatting/README.md

@@ -6,8 +6,7 @@ This project contains templates and test cases for address formats used in terri
 
 ### Build Status
 
-[![Build Status](https://travis-ci.com/OpenCageData/address-formatting.svg?branch=master)](https://travis-ci.com/OpenCageData/address-formatting)
-[![Twitter Follow](https://img.shields.io/twitter/follow/OpenCage?label=Follow%20OpenCage&style=social)](https://twitter.com/opencage)
+[![Build Status](https://github.com/OpenCageData/address-formatting/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenCageData/address-formatting/actions/workflows/ci.yml)
 
 ### An example:
 
@@ -32,7 +31,7 @@ we want to write logic to compile an address in the format consumers expect
 
 ### Why would you want to do this?
 
-The intended use case is database or geocoding systems (forward, reverse, autocomplete) where we know both the country of the address and the language of the user/reader. The address is displayed to a consumer (for example in an app) and not used to print on an envelope for actual postal delivery. We use it to format output from the [OpenCage Geocoder](https://opencagedata.com).
+The intended use case is database or geocoding systems (forward, reverse, autocomplete) where we know both the country of the address and the language of the user/reader. The address is displayed to a consumer (for example in an app) and not used to print on an envelope for actual postal delivery. We use it to format output from the [OpenCage Geocoding API](https://opencagedata.com/api).
 
 ### Which addresses are we talking about?
 
@@ -53,15 +52,17 @@ Our goal with this repository is a series of (programming) language independent
 
 There are open-source implementations in
 
+  * [Android library](https://github.com/woheller69/AndroidAddressFormatter)
   * [Elixir](https://github.com/dkuku/ex_address_formatting)
   * [Go](https://github.com/timonmasberg/address-formatter)
   * [Java](https://github.com/placemarkt/address-formatter-java)
   * [Javascript](https://github.com/fragaria/address-formatter)
+  * [Kotlin](https://github.com/bettermile/address-formatter-kotlin)
   * [Perl](https://metacpan.org/release/Geo-Address-Formatter)
   * [PHP](https://github.com/predicthq/address-formatter-php)
-  * [Python](https://github.com/dunkelstern/international_address_formatter)
+  * [Python](https://github.com/pudo/addressformatting/tree/master)
   * [Ruby](https://github.com/mirubiri/address_composer)
-  * [Rust](https://github.com/CanalTP/address-formatter-rs)
+  * [Rust (No Longer Maintained)](https://github.com/antoine-de/address-formatter-rs)
   * [Scala](https://github.com/ben-willis/address-formatter)
 
 We would love more language implementations. The more people who use the templates, the more likely bugs will be reported. 
@@ -69,11 +70,11 @@ If you write a processor, please submit a pull request adding it to the list. Th
 
 ### International coverage
 
-As of `Sun 17 Feb 2019` coverage is:
+As of March 2024 coverage is:
 
-    We are aware of 248 territories
-    We have tests for 248 (100%) territories
-    We have rules for 248 (100%) territories
+    We are aware of 251 territories
+    We have at least one test for 251 (100%) territories
+    We have rules for 251 (100%) territories
     0 (0%) territories have neither rules nor tests
     
 This output is generated by `bin/coverage.pl`    
@@ -95,8 +96,7 @@ The files are in [YAML](http://yaml.org/) format. The templates are written in [
       * find an addressed location (house, business, etc) in your
         target territory in OpenStreetMap
       * get the coordinates (lat, long) of the location
-      * put the coordinates into the [OpenCage Geocoder demo
-        page](https://opencagedata.com/demo)
+      * put the coordinates into the [OpenCage Geocoding API demo page](https://opencagedata.com/demo)
       * look at the resulting JSON in the *Raw Response* tab
 
 2. edit `conf/countries/worldwide.yaml`
@@ -137,6 +137,10 @@ We welcome your pull requests. Together we can address the world!
 
 This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details
 
+### Additional resources
+
+If you are working with addresses you may need [lists of random addresses/postcodes/coordinates](https://opencagedata.com/tools/address-lists) (either in general or for specific countries) for testing.
+
 ### Further reading on the challenge of address
 
 Here's [our blog post anouncing this project](https://blog.opencagedata.com/post/99059889253/good-looking-addresses-solving-the-berlin-berlin) and the motivations behind it.
@@ -153,8 +157,10 @@ If all this convinces you that address are evil, please check out [what3words](h
 
 <a href="https://opencagedata.com"><img src="opencage_logo_300_150.png"></a>
 
-We run the [OpenCage Geocoder](https://opencagedata.com). Learn more [about us](https://opencagedata.com/about). 
+We run a worldwide [geocoding API](https://opencagedata.com/api) and [geosearch](https://opencagedata.com/geosearch) service based on open data. 
+Learn more [about us](https://opencagedata.com/about). 
+
+We also organize [Geomob](https://thegeomob.com), a series of regular meetups for location based service creators, where we do our best to highlight geoinnovation. If you like geo stuff, you will probably enjoy [the Geomob podcast](https://thegeomob.com/podcast/).
 
-We also run [Geomob](https://thegeomob.com), a series of regular meetups for location based service creators, where we do our best to highlight geoinnovation. If you like geo stuff, you will probably enjoy [the Geomob podcast](https://thegeomob.com/podcast/).
 
 

data/address-formatting/bin/coverage.pl

@@ -24,7 +24,7 @@ if ($help) {
     exit(0);
 }
 
-# get the list of countries
+# get the list of countries (ISO codes)
 my %countries;
 my $country_file = dirname(__FILE__) . "/../conf/country_codes.yaml";
 open my $FH, "<:encoding(UTF-8)", $country_file or die "unable to open $country_file $!";
@@ -33,6 +33,9 @@ while (my $line = <$FH>){
     if ($line =~ m/^(\w\w): \# (.*)$/){
         $countries{$1} = $2;
     }
+    elsif ($line =~ m/^"(\w\w)": \# (.*)$/){  # deal with "NO" quoting in yaml
+        $countries{$1} = $2;
+    }
 }
 close $FH;
 my $total_countries = scalar(keys %countries); 
@@ -50,10 +53,13 @@ foreach my $f (sort @files){
     $f =~ s/\.yaml//;
     $f = uc($f);
     $test_countries{$f} = 1;
+    if (!defined($countries{$f})){
+        print STDERR "have a test for $f but it is not a known territory\n";
+    }
 }
 my $test_countries = scalar(keys %test_countries);
 my $test_perc = int(100 * $test_countries / $total_countries );
-print "We have tests for " .  $test_countries . ' ('
+print "We have at least one test for " .  $test_countries . ' ('
     . $test_perc . '%) territories' .  "\n";
 if ($details){
     print "We need tests for:\n";

data/address-formatting/bin/run_tests.t

@@ -1,8 +1,7 @@
 #!/usr/bin/env perl
-
-# copy of
-# https://github.com/OpenCageData/perl-Geo-Address-Formatter/blob/master/t/unit/countries.t
-# and runs in travis-CI (see .travis.yml)
+#
+# run by Github Actions, see .github/workflows/ci.yml
+#
 
 use strict;
 use lib 'perl/lib/perl5';
@@ -21,6 +20,20 @@ binmode $builder->output,         ":utf8";
 binmode $builder->failure_output, ":utf8";
 binmode $builder->todo_output,    ":utf8";
 
+{
+    # Some YAML parsers croak on duplicate keys. By default the Perl parser
+    # doesn't. Here we make sure we didn't overlook any duplicate keys.
+    $YAML::XS::ForbidDuplicateKeys = 1;
+
+    my @a_conf_files = File::Find::Rule->file()
+                                     ->name( '*.yaml' )
+                                     ->in( dirname(__FILE__) . '/../conf/' );
+
+    foreach my $conf_file (@a_conf_files) {
+        lives_ok { LoadFile($conf_file) } "parsing file $conf_file";
+    }
+}
+
 
 my $path = dirname(__FILE__) . '/../testcases';
 
@@ -35,16 +48,29 @@ my $conf_path = dirname(__FILE__) . '/../conf';
 my $GAF = $CLASS->new( conf_path => $conf_path );
 
 sub _one_testcase {
-    my $country    = shift;
-    my $rh_testcase = shift;
+    my $country = shift;
+    my $rh_test = shift;
+    my $abbrv   = shift || 0;
+
+    my $formatted;
+    if ($abbrv){
+        $formatted = $GAF->format_address($rh_test->{components}, {abbreviate => 1});
+    }
+    else {
+        $formatted = $GAF->format_address($rh_test->{components});
+    }
     is(
-        $GAF->format_address($rh_testcase->{components}),
-        $rh_testcase->{expected},
-        $country . ' - ' . $rh_testcase->{description}
+        $formatted,
+        $rh_test->{expected},
+        $country . ' - ' . $rh_test->{description}
     );
 }
 
 foreach my $filename (@files){
+    my $abbrv = 0;
+    if ($filename =~ m/abbreviations/){
+        $abbrv = 1;
+    }
     my $country = basename($filename);
     $country =~ s/\.\w+$//; # us.yaml => us
 
@@ -54,7 +80,7 @@ foreach my $filename (@files){
     } "parsing file $filename";
 
     foreach my $rh_testcase (@a_testcases){
-        _one_testcase($country, $rh_testcase);
+        _one_testcase($country, $rh_testcase, $abbrv);
     }
 }
 

data/address-formatting/conf/abbreviations/ca.yaml

@@ -1,4 +1,21 @@
 road:
+     Autopista: Auto
+     Avinguda: Av
+     Baixada: Bda
+     Baixos: Bxs
+     Carretera: Ctra
      Carrer de: C
+     Monestir: Mtir
+     Parada: Par
+     Passatge: Ptge
+     Passeig: Pg
+     Plaça: Pl
+     Porta: Pta
      Rambla: Rbla
-     
+     Sagrada: Sgda
+     Sagrat: Sgt
+     Sant: St
+     Santa: Sta
+     Travessera: Trav
+     Travessia: Trv
+     via: v

data/address-formatting/conf/abbreviations/cs.yaml

@@ -2,6 +2,3 @@ road:
      Ulice: Ul
      Třída: Tř
      Náměstí: Nám
-
-
-     

data/address-formatting/conf/abbreviations/da.yaml

@@ -7,7 +7,7 @@ road:
      Sankt: Skt
      Store: St
      Søndre: Sdr
-     Sønder: Sdr     
+     Sønder: Sdr
      Vester: V
      Vestre: V
      Øster: Ø

data/address-formatting/conf/abbreviations/en.yaml

@@ -1,4 +1,8 @@
 country:
+     Central African Republic: CAR
+     Democratic Republic of Congo: DRC
+     New Zealand: NZ
+     United Arab Emitrates: UAE
      United Kingdom: UK
      United States of America: USA
      United States Virgin Islands: USVI
@@ -18,7 +22,9 @@ road:
      Freeway: Fwy
      Grove: Gr
      Highway: HWY
-     Mountain: Mtn  
+     Junior: Jr
+     Lane: Ln
+     Mountain: Mtn
      Northeast: NE
      Northwest: NW
      Place: Pl

data/address-formatting/conf/abbreviations/es.yaml

@@ -1,25 +1,43 @@
 road:
+     Alameda: Alam
+     Arboleda: Arb
+     Arroyo: Arry
      Avenida: Avda
+     Bloque: Blq
      Calle de: C
+     Camino: Cno
      Carrera: Cra
      Carrero: Cro
+     Cinturón: Cint
      Colonia: Col
+     Diagonal: Diag
+     Doctor: Dr
+     Doctora: Dra
      Estación: Estcn
      Gran Vía: GV
+     Jardín: Jdín
+     Malecón: Malec
      Mercado: Merc
-     Plaza: Pl
+     Mirador: Mrdor
+     Nuestra Señora: Ntra Sra
+     Palacio: Pala
      Parque: Pque
+     Pasadizo: Pzo
      Pasaje: Psje
      Paseo: Po
+     Plaza: Pl
      Pueblo: Pblo
      Puente: Pnte
      Puerta: Pta
-     Puerto: Pto     
+     Puerto: Pto
      Rambla: Rbla
      Ronda: Rda
      Rotonda: Rtda
      San: S
-     Sector: Sect
      Santa: Sta
+     Santo: Sto
+     Santas: Stas
+     Santos: Stos
+     Sector: Sect
      Viaducto: Vcto
 

data/address-formatting/conf/abbreviations/et.yaml

@@ -4,6 +4,3 @@ road:
      Raudtee: rdt
      Raudteejaam: rdtj
      Tänav: tn
-
-
-     

data/address-formatting/conf/abbreviations/eu.yaml

@@ -2,4 +2,3 @@ road:
      Kalea: K
      Errepidea: Err
      Etorbidea: Etorb
-     

data/address-formatting/conf/abbreviations/fi.yaml

@@ -14,6 +14,3 @@ road:
      tienhaara: th
      tori: tr
      väylä: vlä
-
-
-     

data/address-formatting/conf/abbreviations/fr.yaml

@@ -4,7 +4,7 @@ road:
      Boulevard: Boul
      Cours: Crs
      Place: Pl
-     Rue: r
+     Rue: R
      Saint: St
      Sainte: Ste
      Zone industrielle: Z.I

data/address-formatting/conf/abbreviations/gl.yaml

@@ -0,0 +1,14 @@
+road:
+     Avenida: Avda
+     Doutor: Dr
+     Doutora: Dra
+     Edificio: Edif
+     Estrada: Estda
+     Rúa: R/
+     San: S
+     Santa: Sta
+     Santo: Sto
+     Santas: Stas
+     Santos: Stos
+     Señora: Sra
+     Urbanización: Urb

data/address-formatting/conf/abbreviations/it.yaml

@@ -16,7 +16,7 @@ road:
      Salizada: S.da
      San: S.
      Santa: S.
-     Santo: S.     
+     Santo: S.
      Santissima: SS.ma
      Santissime: SS.me
      Santissimi: SS.mi

data/address-formatting/conf/abbreviations/nl.yaml

@@ -1,19 +1,31 @@
 road:
+     Broeder: Br
      Burgemeester: Burg
+     Commandant: Cmdt
      Docter: Dr
      Dokter: Dr
      Gebroeders: Gebr
      Generaal: Gen
      Gracht: Gr
+     Ingenieur: Ir
+     Jonkheer: Jhr
      Kardinaal: Kard
      Kolonel: Kol
+     Koning: Kon
+     Koningin: Kon
      Kort: K
      Korte: Kte
      Laan: ln
      Lange: L
+     Luitenant: Luit
      Markt: mkt
+     Mejuffrouw: Mej
+     Mevrouw: Mevr
      Minister: Min
      Monseigneur: Mgr
+     Noordzijde: NZ
+     Onze-Lieve-Vrouw: OLV
+     Oostzijde: OZ
      Pastoor: Past
      Prins: Pr
      Prinses: Pr
@@ -21,6 +33,11 @@ road:
      Sint: St
      Straat: str
      Van: v
+     Van der: vd
+     Van den: vd
+     Verlengde: Verl
      Vrouwe: Vr
      Weg: wg
+     Westzijde: WZ
+     Zuidzijde: ZZ
      Zuster: Zr

data/address-formatting/conf/abbreviations/no.yaml

@@ -10,7 +10,3 @@ road:
      vegen: v
      vei: v
      veien: v
-
-
-
-