carmen 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e77f874e0aac2a2bc20290314c17eed4d98bf2a5
-  data.tar.gz: 1a02b8b80ca40664be6bbcba785ad2681c650aaf
+  metadata.gz: 94a18311304a0f479c340bbf7a39c9820113cc8d
+  data.tar.gz: 3f49ab0339f4f11db9827327fc7be9029d2e1b91
 SHA512:
-  metadata.gz: 963a3723a464151cb7e458f4806eae7ba4bd2b8847b80e4364e9a5584c3d64e8c78a80784d91102bec6439749a0a93eada48e13cb1ce50f24fe18bd3b400d533
-  data.tar.gz: 63fbbb3a85418079a0be0670fae6b267e5964fc37a39db20e0165e415f3e6aaab220fe8d83e759f63dee5ab51fdf466ee84c4e041887f641aa35f545a4d04b8f
+  metadata.gz: 3d0a740660bfa609a18d4afa356a68a4b76f9d92b11587152f82d18c21821ae10582693c58e2818acfe8ae648e79ad41257fd89ce2cb0b4c23abc39f38c77483
+  data.tar.gz: 6f6e4b875d2914de66c0fe4ae32b7ba32b045f7a5916baa0d66c1d375c5c78adfcbdf3fb6ed98c4023f841f90a6f09242b8438106fa729b4884b6d16d731e10f

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-### 1.0.2
+### master (unreleased)
+
+### 1.1.0 (November 7, 2017)
+* [#231](https://github.com/carmen-ruby/carmen/pull/231) Base ISO data has been updated for the first time since October 25, 2014
+* [#233](https://github.com/carmen-ruby/carmen/pull/233) Revert removing Puerto Rico as a country code
+* [#217](https://github.com/carmen-ruby/carmen/pull/217) Add serializer friendly `to_hash` for `Country` and `Region` ([@zarelit](https://github.com/zarelit))
+* [#137](https://github.com/carmen-ruby/carmen/pull/137) Add country search by numeric code ([@Envek](https://github.com/Envek))
+* [#200](https://github.com/carmen-ruby/carmen/pull/200) Add municipalities of Mexico ([@jdsampayo](https://github.com/jdsampayo))
+* [#193](https://github.com/carmen-ruby/carmen/pull/193) Allow filtering subregions by type ([@aldesantis](https://github.com/aldesantis))
+* [#180](https://github.com/carmen-ruby/carmen/pull/180) `Region#subregions` returns freezed array ([@j15e](https://github.com/j15e))
+* [#177](https://github.com/carmen-ruby/carmen/pull/177) Always return a `RegionCollection` from `Region#load_subregions` ([@codeodor](https://github.com/codeodor))
+* Various geographic data updates by [Carmen contributors](https://github.com/carmen-ruby/carmen/graphs/contributors). Thank you!
+
+### 1.0.2 (March 13, 2015)
 * Replace use of UnicodeUtils with ActiveSupport (eikes)
 * Update data from upstream sources.
 * Fix spelling errors for French subregions (hugolantaume)
@@ -9,7 +22,7 @@
 * Fixed the name of Vietnam.
 * Add local files for Bangla language (tauhidul35)
 
-### 1.0.1
+### 1.0.1 (March 06, 2014)
 * Avoid raising an exception when calling Querying#coded with a nil code
 * Fix a bug where adding additional data paths caused an error when looking up localized names in the base locale data (seangaffney)
 * Add Country#numeric_code (stevenharman)

data/README.md

@@ -1,24 +1,18 @@
-# NOT ACTIVELY MAINTAINED
+# Carmen
 
-I haven't time in over a year to properly support this project.
-
-# Carmen- A repository of geographic regions for Ruby
+> A repository of geographic regions for Ruby
 
 [![Build Status](https://secure.travis-ci.org/jim/carmen.png?branch=master)](http://travis-ci.org/jim/carmen)
 
-Carmen 1.0.0 is now out, after more than a year in beta.  This release is a rewrite of the library, separating out the geographic components from the Rails-specific view helpers. If you are using Carmen with Rails, you should check out the [carmen-rails](http://github.com/jim/carmen-rails) library.
+Carmen features the following:
 
-The [0.2.x branch](https://github.com/jim/carmen/tree/0.2.x) contains the previous
-version of Carmen should you need it for some reason.
+* Clean API
+* Complete countries & regions data from the iso-codes Debian package
+* A sane approach to internationalization
 
-**Carmen now requires Ruby 1.9.3 The [ruby-18 branch](https://github.com/jim/carmen/tree/ruby-18) contains the
-last stable version of Carmen that will run on Ruby 1.8.x.
+## Ruby on Rails
 
-Carmen 1.0 features the following:
-
-* A new, cleaner API
-* More complete data via the iso-codes Debian package (idea borrowed from [here](https://github.com/pluginaweek/has_addresses))
-* A sane approach to internationalization
+If you are using Carmen with Rails, you should check out the [carmen-rails](http://github.com/jim/carmen-rails) library.
 
 # How to Use Carmen
 
@@ -39,12 +33,39 @@ A Country object has some attributes that may be useful:
     us.alpha_3_code
     => 'USA'
 
+    us.numeric_code
+    => '840'
+
     us.code # alias for alpha_2_code
     => 'US'
 
     us.official_name
     => "United States of America"
 
+You can use separate finder methods for searching by each attribute (recommended):
+
+    gb = Country.alpha_2_coded('GB')
+    => <#Carmen::Country name="United Kingdom">
+
+    ru = Country.alpha_3_coded('RUS')
+    => <#Carmen::Country name="Russian Federation">
+
+    ad = Country.numeric_coded('020') # Note a string here! Alias: numerically_coded
+    => <#Carmen::Country name="Andorra">
+
+__NOTICE:__ Please note, that in `numeric_coded` you should pass a 3-symbol zero padded string. Be aware of the fact, that Ruby interprets integers with leading zero as octal number (`020 == 16 # => true`).
+
+You can query country by any code in single method (not recommended, and will be deprecated):
+
+    us = Country.coded('US')
+    => <#Carmen::Country name="United States">
+
+    us = Country.coded('USA')
+    => <#Carmen::Country name="United States">
+
+    us = Country.coded('840') # Note a string here
+    => <#Carmen::Country name="United States">
+
 A `Country` (and its subregions) can contain subregions. In the US these are states, but other countries have other types of regions:
 
     us.subregions?
@@ -59,6 +80,11 @@ similarly to a `Country` to find, for instance, a specific state:
     illinois = us.subregions.coded('IL')
     => <#Carmen::Region "Illinois">
 
+You can also find all subregions with a specific type:
+
+    states = us.subregions.typed('state')
+    => [<#Carmen::Region name="Alaska" type="state">, <#Carmen::Region name="Alabama" type="state">, ...]
+
 Subregions support a smaller set of attributes than countries:
 
     illinois.name

data/iso_data/base/world/az/nx.yml

@@ -1,12 +1,12 @@
 ---
-- code: NV
-  type: municipality
 - code: BAB
   type: rayon
 - code: CUL
   type: rayon
 - code: KAN
   type: rayon
+- code: NV
+  type: municipality
 - code: ORD
   type: rayon
 - code: SAD

data/iso_data/base/world/ba/bih.yml

@@ -1,21 +1,21 @@
 ---
-- code: '05'
+- code: '01'
   type: canton
-- code: '07'
+- code: '02'
   type: canton
-- code: '10'
+- code: '03'
   type: canton
-- code: 09
+- code: '04'
   type: canton
-- code: '02'
+- code: '05'
   type: canton
 - code: '06'
   type: canton
-- code: '03'
-  type: canton
-- code: '01'
+- code: '07'
   type: canton
 - code: 08
   type: canton
-- code: '04'
+- code: 09
+  type: canton
+- code: '10'
   type: canton

data/iso_data/base/world/bd/a.yml

@@ -7,7 +7,7 @@
   type: district
 - code: '25'
   type: district
-- code: '51'
-  type: district
 - code: '50'
   type: district
+- code: '51'
+  type: district

data/iso_data/base/world/bd/b.yml

@@ -3,12 +3,12 @@
   type: district
 - code: '04'
   type: district
+- code: 08
+  type: district
 - code: 09
   type: district
 - code: '10'
   type: district
-- code: 08
-  type: district
 - code: '11'
   type: district
 - code: '16'

data/iso_data/base/world/bd/c.yml

@@ -3,33 +3,33 @@
   type: district
 - code: '15'
   type: district
-- code: '18'
-  type: district
 - code: '17'
   type: district
+- code: '18'
+  type: district
 - code: '21'
   type: district
 - code: '26'
   type: district
-- code: '36'
-  type: district
 - code: '33'
   type: district
+- code: '34'
+  type: district
 - code: '35'
   type: district
-- code: '34'
+- code: '36'
   type: district
 - code: '40'
   type: district
-- code: '42'
-  type: district
 - code: '41'
   type: district
-- code: '53'
+- code: '42'
   type: district
-- code: '62'
+- code: '53'
   type: district
 - code: '57'
   type: district
+- code: '62'
+  type: district
 - code: '63'
   type: district

data/iso_data/base/world/bd/e.yml

@@ -3,12 +3,12 @@
   type: district
 - code: '24'
   type: district
-- code: '48'
-  type: district
 - code: '44'
   type: district
 - code: '45'
   type: district
+- code: '48'
+  type: district
 - code: '49'
   type: district
 - code: '54'

data/iso_data/base/world/bd/g.yml

@@ -3,7 +3,7 @@
   type: district
 - code: '38'
   type: district
-- code: '61'
-  type: district
 - code: '60'
   type: district
+- code: '61'
+  type: district

data/iso_data/base/world/be/vlg.yml

@@ -1,11 +1,11 @@
 ---
 - code: VAN
   type: province
+- code: VBR
+  type: province
 - code: VLI
   type: province
 - code: VOV
   type: province
-- code: VBR
-  type: province
 - code: VWV
   type: province

data/iso_data/base/world/bf/06.yml

@@ -1,9 +1,9 @@
 ---
 - code: BLK
   type: province
-- code: SNG
-  type: province
 - code: SIS
   type: province
+- code: SNG
+  type: province
 - code: ZIR
   type: province

data/iso_data/base/world/cv/s.yml

@@ -1,6 +1,12 @@
 ---
 - code: BR
   type: municipality
+- code: CA
+  type: municipality
+- code: CF
+  type: municipality
+- code: CR
+  type: municipality
 - code: MA
   type: municipality
 - code: MO
@@ -9,20 +15,14 @@
   type: municipality
 - code: RS
   type: municipality
-- code: CA
-  type: municipality
-- code: CF
-  type: municipality
-- code: CR
-  type: municipality
 - code: SD
   type: municipality
 - code: SF
   type: municipality
-- code: SO
-  type: municipality
 - code: SM
   type: municipality
+- code: SO
+  type: municipality
 - code: SS
   type: municipality
 - code: TA

data/iso_data/base/world/cz.yml

@@ -1,29 +1,29 @@
 ---
-- code: JC
+- code: '10'
+  type: capital city
+- code: '20'
   type: region
-- code: JM
+- code: '31'
   type: region
-- code: KA
+- code: '32'
   type: region
-- code: KR
+- code: '41'
   type: region
-- code: LI
+- code: '42'
   type: region
-- code: MO
+- code: '51'
   type: region
-- code: OL
+- code: '52'
   type: region
-- code: PA
+- code: '53'
   type: region
-- code: PL
+- code: '63'
   type: region
-- code: PR
+- code: '64'
   type: region
-- code: ST
+- code: '71'
   type: region
-- code: US
+- code: '72'
   type: region
-- code: VY
-  type: region
-- code: ZL
+- code: '80'
   type: region

data/iso_data/base/world/cz/{pr.yml → 10.yml}

@@ -17,15 +17,29 @@
   type: district
 - code: '109'
   type: district
-- code: 10A
+- code: '110'
   type: district
-- code: 10B
+- code: '111'
   type: district
-- code: 10C
+- code: '112'
   type: district
-- code: 10D
+- code: '113'
   type: district
-- code: 10E
+- code: '114'
   type: district
-- code: 10F
+- code: '115'
+  type: district
+- code: '116'
+  type: district
+- code: '117'
+  type: district
+- code: '118'
+  type: district
+- code: '119'
+  type: district
+- code: '120'
+  type: district
+- code: '121'
+  type: district
+- code: '122'
   type: district

data/iso_data/base/world/cz/{pl.yml → 32.yml}

@@ -3,10 +3,10 @@
   type: district
 - code: '322'
   type: district
-- code: '324'
-  type: district
 - code: '323'
   type: district
+- code: '324'
+  type: district
 - code: '325'
   type: district
 - code: '326'

data/iso_data/base/world/cz/{vy.yml → 63.yml}

@@ -1,11 +1,11 @@
 ---
-- code: '611'
+- code: '631'
   type: district
-- code: '612'
+- code: '632'
   type: district
-- code: '613'
+- code: '633'
   type: district
-- code: '614'
+- code: '634'
   type: district
-- code: '615'
+- code: '635'
   type: district