municipitaly2 2.0.3 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 119733e32f643897b995092012e46df76c7046a8d2da5538f1c498c7b8a9b807
-  data.tar.gz: 5a5ee1883bcbf6376c351ece7d7c1fb3b628a9da110bd4a77eacd41d6189d440
+  metadata.gz: b5f242aa4e86895e37a07b2dd7448cc6a63affa93019ce88653ccdfb720d464b
+  data.tar.gz: 1a841723aa37345e8010651fb284818e18baa83b04c599a9f043d97ed647e146
 SHA512:
-  metadata.gz: 639974c60b4f5f0f67a571427292cda0af2c77453572bb91ac67ee680d858ad59174a145e791fac6138d66b94af9c768b77a2ab95a139f91814234cea180d5b1
-  data.tar.gz: 9c9d2151e3c427894d00d0820e40bf5749e0c02b4f5a8b527841b38fc4c1bb206cc7895f67eaf0f109f14f0c20e429ae66a51ff5f8143f01bab2c7b057a0a7b4
+  metadata.gz: 973a9d71498055176f540226b3a00ccc70d914ad80965f02348740cb370f02855a0f765657ef9d4f2d75989d10e5eac9a59788a63577a0baa195899037ae5d7c
+  data.tar.gz: 4b7a3a72913d9dd9657f06db6966e4d358586b787b0a50a558e3f044f96e9df688362fb85d1b2762f7d3bc1c629e2dfdc0d552c44d7bedb9d5831c482ddff7cf

data/CHANGELOG.md

@@ -5,9 +5,23 @@ 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).
 
+## [2.0.5] - 2026-11-05
+
+- Updated database
+- Province changes: Sardinia was reorganized, so Sassari (`090`), Nuoro (`091`), Cagliari (`092`), Oristano (`095`) and Sud Sardegna (`111`) have new istat codes in the range `112`-`119` (e.g. Alghero is now `112001`, it was `090003`)
+- Municipality changes: Castegnero and Nanto merged into Castegnero Nanto, Lirio merged into Montalto Pavese, Murisengo is now Murisengo Monferrato, Vallecrosia is now Vallecrosia al mare, Tripi is now Tripi - Abakainon
+- Updated gems
+- Improved tool/generate.rb (use `-u` to update sources and `-g` to generate data)
+
+## [2.0.4] - 2025-09-09
+
+- Updated database
+- Updated gems
+- Improved search municipalities results order
+
 ## [2.0.3] - 2024-12-17
 
-- Search region by its name: `Municipitaly::Search.province_from_name('a province')`
+- Search region by its name: `Municipitaly::Search.region_from_name('a region')`
 - Fixed and tested specs
 
 ## [2.0.2] - 2024-12-13

data/Gemfile

@@ -4,3 +4,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fitbark.gemspec
 gemspec
+
+gem 'bundler', '~> 4.0'
+gem 'rake', '~> 13.4'
+gem 'rspec', '~> 3.13'
+gem 'rubocop', '~> 1.92'
+gem 'simplecov', '~> 1.3'

data/Gemfile.lock

@@ -1,75 +1,99 @@
 PATH
   remote: .
   specs:
-    municipitaly2 (2.0.3)
+    municipitaly2 (2.0.5)
       csv (>= 3.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    csv (3.3.1)
-    diff-lcs (1.5.1)
-    docile (1.4.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    ast (2.4.3)
+    csv (3.3.7)
+    diff-lcs (1.6.2)
+    json (3.1.0)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    parallel (2.3.0)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
+    prism (1.9.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.2)
-      strscan
-    rspec (3.13.0)
+    rake (13.4.2)
+    regexp_parser (2.13.1)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.64.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
+    rspec-support (3.13.7)
+    rubocop (1.92.2)
+      json (>= 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.11.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
     ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
+    simplecov (1.3.2)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
 
 PLATFORMS
   ruby
   x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.5.11)
+  bundler (~> 4.0)
   municipitaly2!
-  rake (~> 13.2.1)
+  rake (~> 13.4)
   rspec (~> 3.13)
-  rubocop (~> 1.64.1)
-  simplecov (~> 0.22.0)
+  rubocop (~> 1.92)
+  simplecov (~> 1.3)
+
+CHECKSUMS
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  bundler (4.0.23) sha256=407ba8a1d928f412847f819aa5f8b6aef7c59fb51feb517112af8a165487287b
+  csv (3.3.7) sha256=15a3f16f6628da8664d455eb634e7f22031bcf53044923caf56975109e71b9f8
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  json (3.1.0) sha256=3ce7ccf8fde58960177a3a756c31f292a4c1e1dedee884547096a5b0604e3bd8
+  language_server-protocol (3.17.0.6) sha256=5ef2c0c138f8267e1bc631d3328347d354f96724b0af22f2c79516120443b7f0
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  municipitaly2 (2.0.5)
+  parallel (2.3.0) sha256=f75a3e904101ce6a1ccb6b8dc800cbafd42166d83330192438dcf29395167a6f
+  parser (3.3.13.0) sha256=e02f9b63c2fe05b0c68f692ba4df89b3cb113b663964f75d988fbebfd6c3deca
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  regexp_parser (2.13.1) sha256=5aedb6b7c35688f51e86eef17a15374dfd287c83f4ca644b2c5f3ec50a33b44b
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  rubocop (1.92.2) sha256=14fb31eed143a0dc6f78186c550c1715e81cd38f59d05d1165050e445c1f5382
+  rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  simplecov (1.3.2) sha256=2a22ec1759f1b8db60881a2e038758956fc69ef93ed669be0bde0678de6d0e85
+  unicode-display_width (3.3.0) sha256=4b7aa66a4b11db50f6f7e98411215cd0dd10eaecb665d36eec5bcacb3fa0b613
+  unicode-emoji (4.3.0) sha256=11c02fa73290378c066bb0562cd4c87d8e1b706fbbe0059ca12746a4244de8ce
 
 BUNDLED WITH
-   2.5.11
+  4.0.23

data/README.md

@@ -7,13 +7,19 @@ This gem provide various data about 🇮🇹 Italian subdivisions and municipali
 ## ℹ️️ Informations
 
 This gem is a continuation of [Municipitaly by natydev](https://github.com/natydev/municipitaly).
-Database is updated up to May 2024 and there are improvements to search.
+Database is updated up to November 2026 and there are improvements to search.
 Thanks to natydev for the brilliant project.
 
 ## 💾 Installation
 
 Add this line to your application's Gemfile:
 
+```ruby
+gem 'municipitaly2'
+```
+
+or if you want to use directly from the git repo:
+
 ```ruby
 gem 'municipitaly2', git: 'https://github.com/yupswing/municipitaly2.git', branch: 'master'
 ```
@@ -248,9 +254,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Update database
 
-Check the `tools` folder.
-The tool is rought but it gets the job done. Hopefully I will improve it in the future.
-
-### Generate vendor/data/municipalities.csv
-Update links in `tools/generate.rb` (and/or data in `tools/data/istat*`) and execute
-`./tools/generate.rb`
+Check the beginning of the `tools/generate.rb` file to update the sources. Then execute
+`./tools/generate.rb -u -g` (`-u` downloads the sources, `-g` generates the data; run it without arguments for help).

data/lib/municipitaly2/search.rb

@@ -16,11 +16,17 @@ module Municipitaly2
     include DataCaller
 
     CLASS_METHODS = %i[zone_from_code
-                       region_from_name 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
+                       region_from_name
+                       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
                        municipalities_from_postal_code
                        municipalities_from_province_istat
                        municipalities_from_region_istat
@@ -118,8 +124,9 @@ module Municipitaly2
     # example usage:
     #   province = Search.province_from_acronym('MI')
     def province_from_acronym # :doc:
+      acronym = term.strip.upcase
       data.provinces.find do |p|
-        p.acronym == term
+        p.acronym == acronym
       end
     end
 
@@ -151,6 +158,9 @@ module Municipitaly2
     # 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).
+    # Matches are sorted by relevance: exact matches first, then starting with the
+    # term, then words starting with the term, then other matches. Within each
+    # group, matches are sorted by population (descending) and then by name.
     #
     # example usage:
     #   municipalities = Search.municipalities_from_name('monte')
@@ -161,14 +171,15 @@ module Municipitaly2
 
       return [] if term_set.size < 3
 
-      regexp = if greedy
-                 Regexp.new(term_set, true)
-               else
-                 Regexp.new("^#{term_set}$", true)
-               end
-      data.municipalities.select do |m|
-        Municipitaly2.sanitize_term(m.name) =~ regexp || (m.name_alt && Municipitaly2.sanitize_term(m.name_alt) =~ regexp)
-      end
+      # regex per match "greedy" e per match esatto
+      exact_re = Regexp.new("^#{term_set}$", true)
+      search_re = greedy ? Regexp.new(term_set, true) : exact_re
+
+      # search results
+      matches = filter(data.municipalities, search_re: search_re)
+
+      # sorts results by relevance
+      matches.sort_by { |match| rank(match, term: term_set, exact_re: exact_re, greedy: greedy) }
     end
 
     # returns a +Municipitaly2::Municipality+ object from a <b>cadastrial
@@ -244,5 +255,39 @@ module Municipitaly2
         istats.include? m.province_istat
       end
     end
+
+    # filters municipalities/provinces (name, name_alt required)
+    def filter(list, search_re:)
+      list.select do |item|
+        name_s = Municipitaly2.sanitize_term(item.name)
+        alt_s = item.name_alt && Municipitaly2.sanitize_term(item.name_alt)
+        (name_s =~ search_re) || (alt_s && alt_s =~ search_re)
+      end
+    end
+
+    # rank municipalities/provinces (name, name_alt, population required)
+    def rank(match, term:, exact_re:, greedy: true)
+      name_s = Municipitaly2.sanitize_term(match.name)
+      alt_s = match.name_alt && Municipitaly2.sanitize_term(match.name_alt)
+      names_s = [name_s, alt_s].compact
+
+      exact_match = names_s.any? { |n| n =~ exact_re }
+      any_word_starts = names_s.any? { |n| n.split.any? { |w| w.start_with?(term) } }
+
+      # Order: 0 = exact, 2 = any word starts, 3 = contains
+      priority = if !greedy || exact_match
+                   0 # Exact match
+                 # Disabled because it causes problems in some cases, like putting San Giuliano Milanese after Milazzo
+                 #  elsif names_s.any? { |s| s.start_with?(q) }
+                 #    1 # Starts with the term
+                 elsif any_word_starts
+                   2 # Any word starts with the term
+                 else
+                   3 # Other (match inside any word)
+                 end
+
+      # Priority, population (desc), name (asc)
+      [priority, -match.population.to_i, name_s]
+    end
   end
 end

data/lib/municipitaly2/version.rb

@@ -2,5 +2,5 @@
 
 module Municipitaly2
   # :nodoc:
-  VERSION = '2.0.3'
+  VERSION = '2.0.5'
 end

data/lib/municipitaly2.rb

@@ -24,6 +24,6 @@ module Municipitaly2
   # example usage:
   #   sanitized_term = Search.sanitize_term('Forlì Cesena')
   def self.sanitize_term(term) # :doc:
-    term.strip.downcase.tr('àâçèéêìòôù', 'aaceeeioou').gsub(/[^a-z]/, '')
+    term.strip.downcase.tr('àâçèéêìòôù', 'aaceeeioou').gsub(/[^a-z ]/, '')
   end
 end

data/municipitaly2.gemspec

@@ -32,11 +32,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.5.11'
-  spec.add_development_dependency 'rake', '~> 13.2.1'
-  spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'rubocop', '~> 1.64.1'
-  spec.add_development_dependency 'simplecov', '~> 0.22.0'
-
+  # keep >= to avoid conflicts
   spec.add_dependency 'csv', '>= 3.3.0' # removed from stdlib in Ruby 3.4
 end