iso3166-countries 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46e129b041dd58cbe003f7694c78a819ee87e6a396681983923e8fd8e8e3cac5
-  data.tar.gz: 5ee8cd4791a63ea349711f4e7e69acfa8254ce927499dfa5b3ed721df97e047b
+  metadata.gz: bf772607ef96550a4e456ecf46054f72d1cb6a4ddfac309bcaeeb9f74ea3aaa0
+  data.tar.gz: 6fd6d587489ce026068d44cce3a2fdb1d0c7866302c56eadfd09ef53333375f3
 SHA512:
-  metadata.gz: 74899457a19bdda95e2c9f229f3194913d97aee03d8296e387a062ef5a862c6fa4c4598a77f0c1e30957ed56ed029050026c31a454644cb1249e501ba1af2c53
-  data.tar.gz: 40b7778efb0fe2e8af3eb8adbd29a8bc962c31f352dc6e3b8462bf9a4d3f871b6a3b16b6674881eb93d8b8e47f1acfc9dd7ac9a01a60bf5fc878f14308b5da57
+  metadata.gz: 566bd4ea26485099aba48eaeffdcb37919699df5e936d6cd8f63ba496599c5599b35bf24de41838aff4afead4925c78f36d5880ebf6793ad821345af03673383
+  data.tar.gz: 4705de403670ffa1843aceec38aeaaa2529515b87aba736bbe31f860626d39696f95109baa41f2af0243e2e91fd96632b1d025bcb9d8981124bd93c7268a131b

data/.github/workflows/main.yml

@@ -15,5 +15,5 @@ jobs:
       run: |
         gem install bundler -v 2.2.11
         bundle install
-        bundle exec rake spec
+        RUBYOPT='--enable-frozen-string-literal' bundle exec rake spec
         bundle exec rake standard

data/.gitignore

@@ -11,3 +11,5 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+scripts

data/README.md

@@ -1,8 +1,6 @@
-# Iso3166::Countries
+# ISO3166::Countries
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/iso3166/countries`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is heavily inspired by [hexorx/countries](https://github.com/hexorx/countries). Due to lack of maintenance of the original gem, we decided to make our own gem based on iso.org data.
 
 ## Installation
 
@@ -22,7 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem is shipped with sample data that includes ISO3166 data for 3 countries(BR, CH and NZ). In order to access all countries data, you must purchase the XML data file from [iso.org](https://www.iso.org/).
+
+```ruby
+ISO3166::Countries.data_path = "path/to/data/file.xml"
+country = ISO3166::Country.new("BR")
+=> #<ISO3166::Country:0x00007f9253226d88 @code="BR" ...
+country.alpha2
+=> "BR"
+country.alpha3
+=> "BRA"
+country.name
+=> "Brazil" # English name
+country.number
+=> "076"
+country.in_eu?
+=> false
+country.currency_code
+=> "BRL"
+
+ISO3166::Country.find_by(alpha2: "BR")
+=> #<ISO3166::Country:0x00007f9253226d88 @code="BR" ...
+ISO3166::Country.find_by(alpha3: "BRA")
+=> #<ISO3166::Country:0x00007f9253226d88 @code="BR" ...
+ISO3166::Country.all_names_with_codes
+=> [["Brazil", "BR"], ["Switzerland", "CH"], ["New Zealand", "NZ"], ["Netherlands (the)", "NL"]]
+ISO3166::Country.all
+=> [#<ISO3166::Country:0x00007f9253226d88 @code="BR" ...
+
+ISO3166::Country.find_by(alpha2: "BR") == ISO3166::Country["BR"]
+=> true
+```
 
 ## Development
 
@@ -32,7 +60,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iso3166-countries.
+Bug reports and pull requests are welcome on GitHub at https://github.com/viaeurope/iso3166-countries.
 
 ## License
 

data/data/README.md

@@ -0,0 +1,9 @@
+## Sample Data
+
+Sample data is downloaded from [iso.org](https://www.iso.org/) that's available for free.
+It currently includes data for the following countries:
+* BR - Brazil
+* CH - the Swiss Confederation
+* NZ - New Zealand
+
+Sample data is used for testing and trying the gem. Full data must be purchased from [iso.org](https://www.iso.org/).

data/data/extended.yml

@@ -0,0 +1,579 @@
+AD:
+  currency_code: EUR
+AE:
+  currency_code: AED
+AF:
+  currency_code: AFN
+AG:
+  currency_code: XCD
+AI:
+  currency_code: XCD
+AL:
+  currency_code: ALL
+AM:
+  currency_code: AMD
+AO:
+  currency_code: AOA
+AQ:
+  currency_code:
+AR:
+  currency_code: ARS
+AS:
+  currency_code: USD
+AT:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+AU:
+  currency_code: AUD
+AW:
+  currency_code: AWG
+AX:
+  currency_code: EUR
+AZ:
+  currency_code: AZN
+BA:
+  currency_code: BAM
+BB:
+  currency_code: BBD
+BD:
+  currency_code: BDT
+BE:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+BF:
+  currency_code: XOF
+BG:
+  eu_member: true
+  currency_code: BGN
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+BH:
+  currency_code: BHD
+BI:
+  currency_code: BIF
+BJ:
+  currency_code: XOF
+BL:
+  currency_code: EUR
+BM:
+  currency_code: BMD
+BN:
+  currency_code: BND
+BO:
+  currency_code: BOB
+BQ:
+  currency_code: USD
+BR:
+  currency_code: BRL
+BS:
+  currency_code: BSD
+BT:
+  currency_code: INR
+BV:
+  currency_code: NOK
+BW:
+  currency_code: BWP
+BY:
+  currency_code: BYN
+BZ:
+  currency_code: BZD
+CA:
+  currency_code: CAD
+CC:
+  currency_code: AUD
+CD:
+  currency_code: CDF
+CF:
+  currency_code: XAF
+CG:
+  currency_code: XAF
+CH:
+  currency_code: CHF
+CI:
+  currency_code: XOF
+CK:
+  currency_code: NZD
+CL:
+  currency_code: CLP
+CM:
+  currency_code: XAF
+CN:
+  currency_code: CNY
+CO:
+  currency_code: COP
+CR:
+  currency_code: CRC
+CU:
+  currency_code: CUP
+CV:
+  currency_code: CVE
+CW:
+  currency_code: ANG
+CX:
+  currency_code: AUD
+CY:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+CZ:
+  eu_member: true
+  currency_code: CZK
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A[1234567]\d{4}\z/'
+DE:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+DJ:
+  currency_code: DJF
+DK:
+  eu_member: true
+  currency_code: DKK
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+DM:
+  currency_code: XCD
+DO:
+  currency_code: DOP
+DZ:
+  currency_code: DZD
+EC:
+  currency_code: USD
+EE:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+EG:
+  currency_code: EGP
+EH:
+  currency_code: MAD
+ER:
+  currency_code: ERN
+ES:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+ET:
+  currency_code: ETB
+FI:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+FJ:
+  currency_code: FJD
+FK:
+  currency_code: FKP
+FM:
+  currency_code: USD
+FO:
+  currency_code: DKK
+FR:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+GA:
+  currency_code: XAF
+GB:
+  currency_code: GBP
+GD:
+  currency_code: XCD
+GE:
+  currency_code: GEL
+GF:
+  currency_code: EUR
+GG:
+  currency_code: GBP
+GH:
+  currency_code: GHS
+GI:
+  currency_code: GIP
+GL:
+  currency_code: DKK
+GM:
+  currency_code: GMD
+GN:
+  currency_code: GNF
+GP:
+  currency_code: EUR
+GQ:
+  currency_code: XAF
+GR:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+GS:
+  currency_code:
+GT:
+  currency_code: GTQ
+GU:
+  currency_code: USD
+GW:
+  currency_code: XOF
+GY:
+  currency_code: GYD
+HK:
+  currency_code: HKD
+HM:
+  currency_code: AUD
+HN:
+  currency_code: HNL
+HR:
+  eu_member: true
+  currency_code: HRK
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+HT:
+  currency_code: HTG
+HU:
+  eu_member: true
+  currency_code: HUF
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+ID:
+  currency_code: IDR
+IE:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: ANAnAnAnAnAn
+  postal_code_regexp: !ruby/regexp '/\A([AC-FHKNPRTV-Y]\d{2}|D6W)[0-9AC-FHKNPRTV-Y]{4}\z/'
+IL:
+  currency_code: ILS
+IM:
+  currency_code: GBP
+IN:
+  currency_code: INR
+IO:
+  currency_code: USD
+IQ:
+  currency_code: IQD
+IR:
+  currency_code: IRR
+IS:
+  currency_code: ISK
+IT:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+JE:
+  currency_code: GBP
+JM:
+  currency_code: JMD
+JO:
+  currency_code: JOD
+JP:
+  currency_code: JPY
+KE:
+  currency_code: KES
+KG:
+  currency_code: KGS
+KH:
+  currency_code: KHR
+KI:
+  currency_code: AUD
+KM:
+  currency_code: KMF
+KN:
+  currency_code: XCD
+KP:
+  currency_code: KPW
+KR:
+  currency_code: KRW
+KW:
+  currency_code: KWD
+KY:
+  currency_code: KYD
+KZ:
+  currency_code: KZT
+LA:
+  currency_code: LAK
+LB:
+  currency_code: LBP
+LC:
+  currency_code: XCD
+LI:
+  currency_code: CHF
+LK:
+  currency_code: LKR
+LR:
+  currency_code: LRD
+LS:
+  currency_code: LSL
+LT:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+LU:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+LV:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+LY:
+  currency_code: LYD
+MA:
+  currency_code: MAD
+MC:
+  currency_code: EUR
+MD:
+  currency_code: MDL
+ME:
+  currency_code: EUR
+MF:
+  currency_code: EUR
+MG:
+  currency_code: MGA
+MH:
+  currency_code: USD
+MK:
+  currency_code: MKD
+ML:
+  currency_code: XOF
+MM:
+  currency_code: MMK
+MN:
+  currency_code: MNT
+MO:
+  currency_code: MOP
+MP:
+  currency_code: USD
+MQ:
+  currency_code: EUR
+MR:
+  currency_code: MRU
+MS:
+  currency_code: XCD
+MT:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: AAANNNN
+  postal_code_regexp: !ruby/regexp '/^[A-Z]{3}\d{4}$/'
+MU:
+  currency_code: MUR
+MV:
+  currency_code: MVR
+MW:
+  currency_code: MWK
+MX:
+  currency_code: MXN
+MY:
+  currency_code: MYR
+MZ:
+  currency_code: MZN
+NA:
+  currency_code: NAD
+NC:
+  currency_code: XPF
+NE:
+  currency_code: XOF
+NF:
+  currency_code: AUD
+NG:
+  currency_code: NGN
+NI:
+  currency_code: NIO
+NL:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: "NNNNAA, NNNN AA"
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\s?[A-Z]{2}\z/'
+'NO':
+  currency_code: NOK
+NP:
+  currency_code: NPR
+NR:
+  currency_code: AUD
+NU:
+  currency_code: NZD
+NZ:
+  currency_code: NZD
+OM:
+  currency_code: OMR
+PA:
+  currency_code: PAB
+PE:
+  currency_code: PEN
+PF:
+  currency_code: XPF
+PG:
+  currency_code: PGK
+PH:
+  currency_code: PHP
+PK:
+  currency_code: PKR
+PL:
+  eu_member: true
+  currency_code: PLN
+  postal_code_format: "NN-NNN, NNNNN"
+  postal_code_regexp: !ruby/regexp '/\A\d{2}-?\d{3}\z/'
+PM:
+  currency_code: EUR
+PN:
+  currency_code: NZD
+PR:
+  currency_code: USD
+PS:
+  currency_code:
+PT:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: "NNNN-NNN, NNNNNNN"
+  postal_code_regexp: !ruby/regexp '/\A\d{4}(-?\d{3})?\z/'
+PW:
+  currency_code: USD
+PY:
+  currency_code: PYG
+QA:
+  currency_code: QAR
+RE:
+  currency_code: EUR
+RO:
+  eu_member: true
+  currency_code: RON
+  postal_code_format: NNNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{6}\z/'
+RS:
+  currency_code: RSD
+RU:
+  currency_code: RUB
+RW:
+  currency_code: RWF
+SA:
+  currency_code: SAR
+SB:
+  currency_code: SBD
+SC:
+  currency_code: SCR
+SD:
+  currency_code: SDG
+SE:
+  eu_member: true
+  currency_code: SEK
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{5}\z/'
+SG:
+  currency_code: SGD
+SH:
+  currency_code: SHP
+SI:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNN
+  postal_code_regexp: !ruby/regexp '/\A\d{4}\z/'
+SJ:
+  currency_code: NOK
+SK:
+  eu_member: true
+  currency_code: EUR
+  postal_code_format: NNNNN
+  postal_code_regexp: !ruby/regexp '/\A[089]\d{4}\z/'
+SL:
+  currency_code: SLL
+SM:
+  currency_code: EUR
+SN:
+  currency_code: XOF
+SO:
+  currency_code: SOS
+SR:
+  currency_code: SRD
+SS:
+  currency_code: SSP
+ST:
+  currency_code: STN
+SV:
+  currency_code: SVC
+SX:
+  currency_code: ANG
+SY:
+  currency_code: SYP
+SZ:
+  currency_code: SZL
+TC:
+  currency_code: USD
+TD:
+  currency_code: XAF
+TF:
+  currency_code: EUR
+TG:
+  currency_code: XOF
+TH:
+  currency_code: THB
+TJ:
+  currency_code: TJS
+TK:
+  currency_code: NZD
+TL:
+  currency_code: USD
+TM:
+  currency_code: TMT
+TN:
+  currency_code: TND
+TO:
+  currency_code: TOP
+TR:
+  currency_code: TRY
+TT:
+  currency_code: TTD
+TV:
+  currency_code: AUD
+TW:
+  currency_code: TWD
+TZ:
+  currency_code: TZS
+UA:
+  currency_code: UAH
+UG:
+  currency_code: UGX
+UM:
+  currency_code: USD
+US:
+  currency_code: USD
+UY:
+  currency_code: UYU
+UZ:
+  currency_code: UZS
+VA:
+  currency_code: EUR
+VC:
+  currency_code: XCD
+VE:
+  currency_code: VES
+VG:
+  currency_code: USD
+VI:
+  currency_code: USD
+VN:
+  currency_code: VND
+VU:
+  currency_code: VUV
+WF:
+  currency_code: XPF
+WS:
+  currency_code: WST
+YE:
+  currency_code: YER
+YT:
+  currency_code: EUR
+ZA:
+  currency_code: ZAR
+ZM:
+  currency_code: ZMW
+ZW:
+  currency_code: ZWL