municipitaly 0.0.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be1c36e7a1dad85d624b795a4d2c38a4a75d4289a42f1f3ee761641f62a06c7f
-  data.tar.gz: 321ca54451a996bbe0164f267be770d5de0f60882d9a4ca79a659016e18fcff6
+  metadata.gz: 26f1c4257bc23d718063571b6e657fbe2f11f185b8ed775ebf0128566b7745df
+  data.tar.gz: daf9b8965948388dca2e974439a9ece990384a62653b34f9acc4653579283d1d
 SHA512:
-  metadata.gz: 5451db5babc9842f826ef39249386f93bbe93e90744291a395eb25923b64edc6b7b03c0a0daac76e0543699a1572d5c71273e0ddf1b127b9dd6d44ff6ee132c3
-  data.tar.gz: 818d5b215a467dc93ddd3a70fb8c2095ea720c338ca1e0d1131de4d3d6217ee9ee21008ebfaece13f4642617240791109fc42c8942cd50c151e1e54dbdf4054f
+  metadata.gz: 06fc7301a8c9c7f729abe3df1f79290e3a5c60d5796b52c5173102277bfee1426883025f6ed7e949214d622bccd1dacd4bd431121a515c0424073321e4b37a57
+  data.tar.gz: 81f2574978a33918404560ca7ef47e12463d331a7e2394b0734f5dd9b0f511aa53848a0ca02ecc112c303565d1531fad4bb9922e02b033916a42617f045b1677

data/.rubocop.yml

@@ -4,6 +4,9 @@ Metrics/BlockLength:
     - 'municipitaly.gemspec'
     - 'lib/**/*.rb'
     - 'spec/**/*.rb'
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/municipitaly/search.rb'
 
 Metrics/ParameterLists:
   Max: 10

data/.travis.yml

@@ -1,7 +1,14 @@
 ---
-sudo: false
+os: linux
 language: ruby
-cache: bundler
 rvm:
   - 2.6.5
 before_install: gem install bundler -v 2.1.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --debug --exit-code $TRAVIS_TEST_RESULT --prefix /home/travis/build/natydev/municipitaly --coverage-input-type simplecov

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# 🗄 Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0] - 2020-02-27
+
+### Added
+
+- ISO 3166-2 code in region object `#iso3166_2` or alias `#iso3166`
+
+## [0.2.0] - 2020-02-24
+
+### Added
+
+- ISO 3166-2 code in province object `#iso3166_2` or alias `#iso3166`
+
+
+## [0.1.0] - 2020-02-13
+
+### Changed
+
+- Update municipalities data according to latest ISTAT changes (jan 2020)
+
+
+## [0.0.3] - 2020-02-10
+
+### Added
+
+- The optional parameter *greedy* in `Municipitaly::Search.municipalities_from_name`

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    municipitaly (0.0.1)
+    municipitaly (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
+    docile (1.3.2)
     jaro_winkler (1.5.4)
+    json (2.3.0)
     parallel (1.19.1)
     parser (2.6.5.0)
       ast (~> 2.4.0)
@@ -35,6 +37,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     unicode-display_width (1.6.0)
 
 PLATFORMS
@@ -46,6 +53,7 @@ DEPENDENCIES
   rake (~> 13.0.1)
   rspec (~> 3.9)
   rubocop (~> 0.77)
+  simplecov (~> 0.17.1)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,9 +1,14 @@
 
 # 🇮🇹 Municipitaly
 
+[![Build Status](https://travis-ci.org/natydev/municipitaly.png?branch=master)](https://travis-ci.org/natydev/municipitaly)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/07a4926100e3df1cdd72/test_coverage)](https://codeclimate.com/github/natydev/municipitaly/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/07a4926100e3df1cdd72/maintainability)](https://codeclimate.com/github/natydev/municipitaly/maintainability)
+[![Gem Version](https://badge.fury.io/rb/municipitaly.svg)](https://badge.fury.io/rb/municipitaly)
+
 This gem provide various data about 🇮🇹 Italian subdivisions and municipalities. As well the entire updated list of provinces, regions and municipalities names, it provide useful codes (📯 postal code(s), 🌐 [ISTAT](https://www.istat.it/en/) codes, cadastrial code, population, ...).
 
-## Installation
+## 💾 Installation
 
 Add this line to your application's Gemfile:
 
@@ -19,7 +24,7 @@ Or install it yourself as:
 
     $ gem install municipitaly
 
-## Scenic
+## 👁 Scenic
 
 These entities are present, subpoints are data attributes:
 
@@ -41,7 +46,7 @@ These entities are present, subpoints are data attributes:
     * population
 
 
-## Usage and examples
+## 🛠 Usage and examples
 
 
 The **Municipitaly::Search** is the principal class used to search entities.  
@@ -55,6 +60,9 @@ Returned data are stored in 4 different types of entity models:
 Retrieve all zones (return an array of `Municipitaly::Zone` objects):
 
 ```ruby
+# inside an irb or rails console:
+require 'municipitaly'
+
 zones = Municipitaly::Zone.all
 # => [#<Municipitaly::Zone:0x0000...] 
 ```
@@ -69,6 +77,7 @@ retrive data zone:
 ```ruby
 zone.name
 # => "Centro"
+
 zone.code
 # => "3" 
 ```
@@ -163,7 +172,11 @@ Complete list of available class and instance methods are documented inside code
 Clone locally this repository and run
 `bundle exec rdoc` to produce complete documentation inside your local directory.
 
-## Contributing
+## 🗄 Changelog
+
+Complete list in [this section](CHANGELOG.md)
+
+## 🤝 Contributing
 
 Fells free to improve or suggest new features/ideas.
 Bug reports and pull requests are welcome on GitHub at https://github.com/natydev/municipitaly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -179,10 +192,10 @@ If you want to contribute keep these guidelines in mind:
 Steps to submit your code:
 
 1. Fork the repo.
-2. Oper your feature/namespaced branch
+2. Open your feature/namespaced branch
 3. Commit your code following Github guidelines.
 4. Make a PR with an exhaustive description.
 
-## License
+## 📃 License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/municipitaly/data.rb

@@ -9,7 +9,6 @@ module Municipitaly
     @@municipalities = []
 
     def zones
-      puts find_csv('zones.csv')
       if @@zones.empty?
         CSV.foreach(find_csv('zones.csv'), headers: true) do |row|
           @@zones << Zone.new(name: row[0], code: row[1])
@@ -22,7 +21,7 @@ module Municipitaly
       if @@regions.empty?
         CSV.foreach(find_csv('regions.csv'), headers: true) do |row|
           @@regions << Region.new(zone_code: row[0], name: row[1],
-                                  istat: row[2])
+                                  istat: row[2], partial_iso3166: row[3])
         end
       end
       @@regions
@@ -53,7 +52,7 @@ module Municipitaly
 
     def find_csv(file)
       File.expand_path(File.join(File.dirname(__FILE__),
-        "../../vendor/data/#{file}"))
+                                 "../../vendor/data/#{file}"))
     end
   end
 end

data/lib/municipitaly/province.rb

@@ -27,5 +27,12 @@ module Municipitaly
     def municipalities
       @municipalities ||= Search.municipalities_from_province_istat(istat)
     end
+
+    # returns ISO 3166-2 code for current province.
+    def iso3166_2
+      "IT-#{acronym}"
+    end
+
+    alias iso3166 iso3166_2
   end
 end

data/lib/municipitaly/region.rb

@@ -6,13 +6,14 @@ module Municipitaly
     include DataCaller
     include ZoneDelegator
 
-    def initialize(zone_code:, name:, istat:)
+    def initialize(zone_code:, name:, istat:, partial_iso3166:)
       @zone_code = zone_code
       @name = name
       @istat = istat
+      @partial_iso3166 = partial_iso3166
     end
 
-    attr_reader :zone_code, :name, :istat
+    attr_reader :zone_code, :name, :istat, :partial_iso3166
 
     # returns an array of all +Municipitaly::Region+ objects.
     def self.all
@@ -30,5 +31,12 @@ module Municipitaly
     def municipalities
       @municipalities ||= Search.municipalities_from_region_istat(istat)
     end
+
+    # returns ISO 3166-2 code for current province.
+    def iso3166_2
+      "IT-#{partial_iso3166}"
+    end
+
+    alias iso3166 iso3166_2
   end
 end

data/lib/municipitaly/search.rb

@@ -15,8 +15,8 @@ module Municipitaly
   class Search
     include DataCaller
 
-    CLASS_METHODS = %i[zone_from_code region_from_istat
-                       regions_from_zone_code province_from_istat
+    CLASS_METHODS = %i[zone_from_code region_from_istat regions_from_zone_code
+                       province_from_name province_from_istat
                        province_from_acronym provinces_from_region_istat
                        provinces_from_zone_code municipalities_from_name
                        municipality_from_cadastrial municipality_from_istat
@@ -26,15 +26,16 @@ module Municipitaly
                        municipalities_from_zone_code].freeze # :nodoc:
 
     CLASS_METHODS.each do |method|
-      define_singleton_method method do |message|
-        Search.new(message).send(method)
+      define_singleton_method method do |message, opts = {}|
+        Search.new(message, opts).send(method)
       end
     end # :nodoc:
 
-    attr_accessor :term # :nodoc:
+    attr_accessor :term, :opts # :nodoc:
 
-    def initialize(term) # :nodoc:
+    def initialize(term, opts = {}) # :nodoc:
       @term = term.to_s.strip
+      @opts = opts
     end
 
     protected
@@ -70,6 +71,19 @@ module Municipitaly
       end
     end
 
+    # returns a +Municipitaly::Province+ object from a <b>province name</b>
+    # term
+    #
+    # example usage:
+    #   province = Search.province_from_name('Paler')
+    def province_from_name # :doc:
+      data.provinces.find do |p|
+        name_set = p.name.downcase.gsub(/[^a-z]/, '')
+        term_set = term.downcase.gsub(/[^a-z]/, '')
+        name_set =~ Regexp.new(term_set) && term_set.size > 3
+      end
+    end
+
     # returns a +Municipitaly::Province+ object from a <b>province istat</b>
     # term
     #
@@ -118,12 +132,21 @@ module Municipitaly
     # returns an array of +Municipitaly::Municipality+ objects from a
     # <b>municipality name</b> term.
     # Term can be a partial string and is case insensitive.
+    # The optional parameter +greedy+ [boolean] permit to serch exact term
+    # name (if false) or partial word (true by default).
     #
     # example usage:
     #   municipalities = Search.municipalities_from_name('monte')
+    #   municipalities = Search.municipalities_from_name('monte', greedy: false)
     def municipalities_from_name # :doc:
+      greedy = opts.fetch(:greedy, true)
+      regexp = if greedy
+                 Regexp.new(term, true)
+               else
+                 Regexp.new("^#{term}$", true)
+               end
       data.municipalities.select do |m|
-        m.name =~ Regexp.new(term, true)
+        m.name =~ regexp
       end
     end
 

data/lib/municipitaly/version.rb

@@ -2,5 +2,5 @@
 
 module Municipitaly
   # :nodoc:
-  VERSION = '0.0.2'
+  VERSION = '0.4.0'
 end

data/municipitaly.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Municipitaly'
   spec.description   = 'Codes (postal, istat, cadastrian, ...) about Italian ' \
-                       'subdivisions and municipalities'
+                       'subdivisions and municipalities in Italy [city, cities]'
   spec.homepage      = 'https://github.com/natydev/municipitaly'
   spec.license       = 'MIT'
   spec.metadata = {
@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0.1'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.77'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
 end

data/vendor/data/municipalities.csv

@@ -887,7 +887,7 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 006,Casasco,041,B941,15050,124
 006,Cassine,043,C027,15016,3048
 006,Cassinelle,044,C030,15070,937
-006,Castellania,045,C137,15051,91
+006,Castellania Coppi,045,C137,15051,91
 006,Castellar Guidobono,046,C142,15050,427
 006,Castellazzo Bormida,047,C148,15073,4566
 006,Castelletto d'Erro,048,C156,15010,150
@@ -2235,7 +2235,7 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 017,Prevalle,155,H055,25080,6816
 017,Provaglio d'Iseo,156,H078,25050,7136
 017,Provaglio Val Sabbia,157,H077,25070,966
-017,Puegnago sul Garda,158,H086,25080,3263
+017,Puegnago del Garda,158,H086,25080,3263
 017,Quinzano d'Oglio,159,H140,25027,6390
 017,Remedello,160,H230,25010,3387
 017,Rezzato,161,H256,25086,12933
@@ -2779,9 +2779,7 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Borgo Valsugana,022,B006,38051,6826
 022,Brentonico,025,B153,38060,3882
 022,Bresimo,026,B158,38020,254
-022,Brez,027,B165,38021,706
 022,Caderzone Terme,029,B335,38080,669
-022,Cagnò,030,B360,38028,360
 022,Calceranica al Lago,032,B389,38050,1305
 022,Caldes,033,B400,38022,1090
 022,Caldonazzo,034,B404,38052,3340
@@ -2791,11 +2789,9 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Canal San Bovo,038,B577,38050,1592
 022,Canazei,039,B579,38032,1907
 022,Capriana,040,B697,38030,605
-022,Carano,041,B723,38033,1073
 022,Carisolo,042,B783,38080,984
 022,Carzano,043,B856,38050,505
 022,Castel Condino,045,C183,38082,238
-022,Castelfondo,046,C103,38020,632
 022,Castello-Molina di Fiemme,047,C189,38030,2267
 022,Castello Tesino,048,C194,38053,1315
 022,Castelnuovo,049,C216,38050,1035
@@ -2809,20 +2805,16 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Cis,060,C727,38020,309
 022,Civezzano,061,C756,38045,3904
 022,Cles,062,C794,38023,6769
-022,Cloz,063,C797,38020,729
 022,Commezzadura,064,C931,38020,993
 022,Croviana,068,D188,38027,693
-022,Daiano,070,D243,38030,692
 022,Dambel,071,D246,38010,435
 022,Denno,074,D273,38010,1252
 022,Drena,078,D365,38074,551
 022,Dro,079,D371,38074,4566
-022,Faedo,080,D457,38010,610
 022,Fai della Paganella,081,D468,38010,898
 022,Fiavè,083,D565,38075,1098
 022,Fierozzo,085,D573,38050,481
 022,Folgaria,087,D651,38064,3130
-022,Fondo,088,D663,38013,1435
 022,Fornace,089,D714,38040,1321
 022,Frassilongo,090,D775,38050,321
 022,Garniga Terme,091,D928,38060,381
@@ -2838,7 +2830,6 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Lona-Lases,108,E664,38040,876
 022,Luserna,109,E757,38040,279
 022,Malé,110,E850,38027,2135
-022,Malosco,111,E866,38013,445
 022,Massimeno,112,F045,38086,124
 022,Mazzin,113,F068,38030,494
 022,Mezzana,114,F168,38020,884
@@ -2866,9 +2857,7 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Pomarolo,144,G808,38060,2355
 022,Predazzo,147,H018,38037,4531
 022,Rabbi,150,H146,38020,1400
-022,Revò,152,H254,38028,1265
 022,Riva del Garda,153,H330,38066,15838
-022,Romallo,154,H506,38028,604
 022,Romeno,155,H517,38010,1374
 022,Roncegno Terme,156,H528,38050,2814
 022,Ronchi Valsugana,157,H532,38050,421
@@ -2879,7 +2868,7 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Rumo,163,H639,38020,822
 022,Sagron Mis,164,H666,38050,183
 022,Samone,165,H754,38059,544
-022,San Michele all'Adige,167,I042,38010,2911
+022,San Michele all'Adige,167,I042,38010,3521
 022,Sant'Orsola Terme,168,I354,38050,1073
 022,Sanzeno,169,I411,38010,928
 022,Sarnonico,170,I439,38011,749
@@ -2908,7 +2897,6 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Trento,205,L378,38121 38122 38123,114198
 022,Valfloriana,209,L575,38040,530
 022,Vallarsa,210,L588,38060,1343
-022,Varena,211,L678,38030,845
 022,Vermiglio,213,L769,38029,1869
 022,Vignola-Falesina,216,L886,38057,162
 022,Villa Lagarina,222,L957,38060,3692
@@ -2938,6 +2926,9 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 022,Ville d'Anaunia,249,M363,38019,4902
 022,San Giovanni di Fassa,250,M390,38036,3345
 022,Terre d'Adige,251,M407,38097,3011
+022,Borgo d'Anaunia,252,M429,38013 38020,2512
+022,Novella,253,M430,38021 38028 38020,3664
+022,Ville di Fiemme,254,M431,38033 38030,2610
 023,Affi,001,A061,37010,2297
 023,Albaredo d'Adige,002,A137,37041,5232
 023,Angiari,003,A292,37050,2164
@@ -7380,7 +7371,7 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 097,Barzago,005,A683,23890,2577
 097,Barzanò,006,A686,23891,5171
 097,Barzio,007,A687,23816,1297
-097,Bellano,008,A745,23822,3264
+097,Bellano,008,A745,23822,3583
 097,Bosisio Parini,009,B081,23842,3504
 097,Brivio,010,B194,23883,4686
 097,Bulciago,011,B261,23892,2948
@@ -7452,7 +7443,6 @@ province_istat,name,partial_istat,cadastrial_code,postal_codes,population
 097,Valgreghentino,082,L581,23857,3410
 097,Valmadrera,083,L634,23868,11612
 097,Varenna,084,L680,23829,765
-097,Vendrogno,085,L731,23838,319
 097,Vercurago,086,L751,23808,2833
 097,Viganò,090,L866,23897,2012
 097,Verderio,091,M337,23879,5659

data/vendor/data/regions.csv

@@ -1,21 +1,21 @@
-zone_code,name,istat
-1,Piemonte,01
-1,Valle d'Aosta/Vallée d'Aoste,02
-1,Liguria,07
-1,Lombardia,03
-2,Trentino-Alto Adige/Südtirol,04
-2,Veneto,05
-2,Friuli-Venezia Giulia,06
-2,Emilia-Romagna,08
-3,Marche,11
-3,Toscana,09
-3,Umbria,10
-3,Lazio,12
-4,Campania,15
-4,Abruzzo,13
-4,Molise,14
-4,Puglia,16
-4,Basilicata,17
-4,Calabria,18
-5,Sicilia,19
-5,Sardegna,20
+zone_code,name,istat,partial_iso3166
+1,Piemonte,01,21
+1,Valle d'Aosta/Vallée d'Aoste,02,23
+1,Liguria,07,42
+1,Lombardia,03,25
+2,Trentino-Alto Adige/Südtirol,04,32
+2,Veneto,05,34
+2,Friuli-Venezia Giulia,06,36
+2,Emilia-Romagna,08,45
+3,Marche,11,57
+3,Toscana,09,52
+3,Umbria,10,55
+3,Lazio,12,62
+4,Campania,15,72
+4,Abruzzo,13,65
+4,Molise,14,67
+4,Puglia,16,75
+4,Basilicata,17,77
+4,Calabria,18,78
+5,Sicilia,19,82
+5,Sardegna,20,88

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: municipitaly
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.4.0
 platform: ruby
 authors:
 - NatyDev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.77'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
 description: Codes (postal, istat, cadastrian, ...) about Italian subdivisions and
-  municipalities
+  municipalities in Italy [city, cities]
 email:
 - natydev@aol.com
 executables: []
@@ -78,6 +92,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock