municipitaly2 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dca402b216021d704b0236e8f9da370c16a021a6ee5222f3a5b5214dbc537ef1
+  data.tar.gz: 24277826ee362bcf0415676db661a7fc191b26626a7072d94c2714b2651cb742
+SHA512:
+  metadata.gz: 6368a804a89aca144204370b882e31f97966f9dd847bdcb7b726b378fb47e0845dd9f361ecd85ad3376827fd13e28b00f5e01d1fa459b8ef22b8af8e505321b7
+  data.tar.gz: 4ea4e8b653bb6aafac143d97540607c2b009f777506539de4a18ff702a6216d380451992c4f25e067a159d596276d0b853e192f736b7f78bd084f1716aa94d8c

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/
+*.gem
+
+/tools/data/*
+!/tools/data/.keep
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  UseCache: false
+  DefaultFormatter: progress
+  DisplayStyleGuide: true
+  DisplayCopNames: false
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'municipitaly2.gemspec'
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/municipitaly2/search.rb'
+
+Metrics/ParameterLists:
+  Max: 10
+
+Style/ClassVars:
+  Exclude:
+    - 'lib/municipitaly2/data.rb'
+
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/municipitaly2/search.rb'
+    

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+os: linux
+language: ruby
+rvm:
+  - 3.3.0
+before_install: gem install bundler -v 2.5.11
+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,51 @@
+# 🗄 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).
+
+## [2.0.0] - 2024-07-25
+
+### Changed
+
+- Renamed the fork to `municipitaly2`
+- Bumped version to 2.0.0
+
+## [0.5.0] - 2024-06-20 (forked by yupswing)
+
+### Added
+
+- Fixed search provinces or municipalities with diacritics
+- Updated database 27-05-2024 (population data as 2021)\
+- Municipalities `latitude`, `longitude` and `area` (km2)
+
+## [0.4.0] - 2020-11-18
+
+### Added
+
+- Search province by its name: `Municipitaly::Search.province_from_name('a province')`
+
+## [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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at natydev@localhost. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fitbark.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    municipitaly2 (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    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.1)
+      racc
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      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)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    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)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.5.11)
+  municipitaly2!
+  rake (~> 13.2.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.64.1)
+  simplecov (~> 0.22.0)
+
+BUNDLED WITH
+   2.5.11

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 NatyDev
+Copyright (c) 2024 Simone Cingano (yupswing)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,231 @@
+# 🇮🇹 Municipitaly2
+
+[![Gem Version](https://badge.fury.io/rb/municipitaly2.svg)](https://badge.fury.io/rb/municipitaly2)
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'municipitaly2', git: 'https://github.com/yupswing/municipitaly2.git', branch: 'master'
+```
+
+And then execute:
+
+    $ bundle
+
+## 👁 Scenic
+
+These entities are present, subpoints are data attributes:
+
+- **Zone** - NUTS 1 (it: _Zona/Ripartizione geografica_)
+  - name
+  - code (it: _codice zona_)
+- **Region** - NUTS 2 (it: _Regione_)
+  - name
+  - ISTAT code (it: _codice istat_)
+- **Province** - NUTS 3 (it: _Provincia_)
+  - name
+  - ISTAT code (it: _codice istat_)
+  - acronym (it: _sigla_)
+- **Municipality** (it: _Comune_)
+  - name
+  - name_alt (alternative name)
+  - name_full (composite of name + name_alt if present)
+  - ISTAT code (it: _codice istat_)
+  - cadastrial code (it: _codice catastale_)
+  - postal code(s) (it: _codice/i postale/i_)
+  - population
+  - area (square km)
+  - latitude
+  - longitude
+
+## 🛠 Usage and examples
+
+The **Municipitaly2::Search** is the principal class used to search entities.  
+Returned data are stored in 4 different types of entity models:
+
+- **Municipitaly2::Zone**
+- **Municipitaly2::Region**
+- **Municipitaly2::Province**
+- **Municipitaly2::Municipality**
+
+Retrieve all zones (return an array of `Municipitaly2::Zone` objects):
+
+```ruby
+# inside an irb or rails console:
+require 'municipitaly2'
+
+zones = Municipitaly2::Zone.all
+# => [#<Municipitaly2::Zone:0x0000...]
+```
+
+pick a random zone:
+
+```ruby
+zone = zones.sample
+# => #<Municipitaly2::Zone:0x00007fb8390b9f48 @name="Centro", @code="3">
+```
+
+retrive data zone:
+
+```ruby
+zone.name
+# => "Centro"
+
+zone.code
+# => "3"
+```
+
+all regions belongs to a zone (return an array of `Municipitaly2::Region` objects):
+
+```ruby
+zone.regions
+# => [#<Municipitaly2::Region:0x00007fb83883c550...]
+```
+
+and so for other entities:
+
+```ruby
+zone.provinces
+# => [#<Municipitaly2::Province:0x00007fb83a1478...]
+
+zone.municipalities
+# => [#<Municipitaly2::Municipality:0x00007fb83a...]
+```
+
+### 🔎 Search
+
+**Municipitaly2::Search** is the most useful and interesting class: with that you can search single or multiple entities by the name, code or other attributes.
+
+Search municipalities **from its name**: is case insensitive and can be partial (it returns an Array):
+
+```ruby
+municipalities = Municipitaly2::Search.municipalities_from_name('ricco')
+# => [#<Municipitaly2::Municipality:0x00007d6f8c10e428
+#       @area=26.2065,
+#       @cadastrial_code="I640",
+#       @latitude=44.5078406,
+#       @longitude=8.936045,
+#       @name="Serra Riccò",
+#       @partial_istat="058",
+#       @population=7615,
+#       @postal_codes=["16010"],
+#       @province_istat="010">,
+#     #<Municipitaly2::Municipality:0x00007d6f8c106048
+#       @area=37.7634,
+#       @cadastrial_code="H275",
+#       @latitude=44.1555442,
+#       @longitude=9.7634234,
+#       @name="Riccò del Golfo di Spezia",
+#       @partial_istat="023",
+#       @population=3615,
+#       @postal_codes=["19020"],
+#       @province_istat="011">,
+#     #<Municipitaly2::Municipality:0x00007d6f8c233a38
+#       @area=20.3924,
+#       @cadastrial_code="B031",
+#       @latitude=45.5328242,
+#       @longitude=11.9685041,
+#       @name="Borgoricco",
+#       @partial_istat="013",
+#       @population=8906,
+#       @postal_codes=["35010"],
+#       @province_istat="028">]
+
+municipality = municipalities.first
+# => #<Municipitaly2::Municipality:0x00007fb83918483..>
+
+municipality.name
+# => "Serra Riccò"
+
+municipality.postal_codes
+# => ["16010"]
+```
+
+from an entity object is possible to retrieve other parent objects and its attributes:
+
+```ruby
+municipality.province_name
+# => "Padova"
+
+municipality.province_acronym
+# => "PD"
+
+municipality.province
+# => #<Municipitaly2::Province:0x00007fb83a12701...>
+
+municipality.region_name
+# => "Veneto"
+
+municipality.region
+# => #<Municipitaly2::Region:0x00007fb83883cf28...>
+
+municipality.zone
+# => #<Municipitaly2::Zone:0x00007fb8390bb938...>
+```
+
+or retrieve nested entities:
+
+```ruby
+padua = municipality.province
+# => #<Municipitaly2::Province:0x00007fb83a127010...>
+
+padua.municipalities
+# => [#<Municipitaly2::Municipality:0x00007fb83915b730...]
+```
+
+Search municipalities **from a single postal code**:
+
+```ruby
+municipalities = Municipitaly2::Search.municipalities_from_postal_code('50145')
+# => [#<Municipitaly2::Municipality:0x00007fb83a295938 @province_istat="048", @name="Firenze"...]
+
+florence = municipalities.first
+# => #<Municipitaly2::Municipality:0x00007fb83a295938...>
+
+florence.postal_codes
+#  => ["50121", "50122", "50123", "50124", "50125", "50126", "50127", "50128", "50129", "50130", "50131", "50132", "50133", "50134", "50135", "50136", "50137", "50138", "50139", "50140", "50141", "50142", "50143", "50144", "50145"]
+```
+
+Complete list of available class and instance methods are documented inside code, is suggested to use `rdoc`, read at next point.
+
+### 📖 Rdoc
+
+Clone locally this repository and run
+`bundle exec rdoc` to produce complete documentation inside your local directory.
+
+## 🗄 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/yupswing/municipitaly2. 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.
+
+If you want to contribute keep these guidelines in mind:
+
+- Despite is an Italy focused gem, I accept only PR, issues and messages **in English** lang.
+- Code must be well formatted and **offences free**, use the provided `rubocop` gem.
+- Use the same **coding conventions** as the rest of the project.
+- Code must be **tested** (with rspec).
+- Write code according to **SOLID** Principles.
+
+Steps to submit your code:
+
+1. Fork the repo.
+2. Open your feature/namespaced branch
+3. Commit your code following Github guidelines.
+4. Make a PR with an exhaustive description.
+
+## 📃 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Data sources
+
+- [Database dei comuni italiani by Garda Informatica](https://www.gardainformatica.it/database-comuni-italiani) (MIT Licence)
+- [Dati censimento 2021 - Ministero dell'Interno](https://dait.interno.gov.it/territorio-e-autonomie-locali/sut/elenco_cens_var_comuni_italiani.php) (Public)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'municipitaly2'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/municipitaly2/data.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Municipitaly2
+  # Define collection
+  class Data
+    @@zones = []
+    @@regions = []
+    @@provinces = []
+    @@municipalities = []
+
+    def zones
+      if @@zones.empty?
+        CSV.foreach(find_csv('zones.csv'), headers: true) do |row|
+          @@zones << Zone.new(name: row[0], code: row[1])
+        end
+      end
+      @@zones
+    end
+
+    def regions
+      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], partial_iso3166: row[3])
+        end
+      end
+      @@regions
+    end
+
+    def provinces
+      if @@provinces.empty?
+        CSV.foreach(find_csv('provinces.csv'), headers: true) do |row|
+          @@provinces << Province.new(region_istat: row[0], name: row[1],
+                                      istat: row[2], acronym: row[3])
+        end
+      end
+      @@provinces
+    end
+
+    def municipalities
+      if @@municipalities.empty?
+        CSV.foreach(find_csv('municipalities.csv'), headers: true) do |row|
+          @@municipalities <<
+            Municipality.new(province_istat: row[0],
+                             name: row[1], name_alt: row[2], partial_istat: row[3],
+                             cadastrial_code: row[4], postal_codes: row[5],
+                             population: row[6], area: row[7],
+                             latitude: row[8], longitude: row[9])
+        end
+      end
+      @@municipalities
+    end
+
+    def find_csv(file)
+      File.expand_path(File.join(File.dirname(__FILE__),
+                                 "../../vendor/data/#{file}"))
+    end
+  end
+end

data/lib/municipitaly2/data_caller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Municipitaly2
+  # shared module to use Municipitaly2::Data instance
+  module DataCaller
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # class methods
+    module ClassMethods
+      def data
+        Data.new
+      end
+    end
+
+    private
+
+    def data
+      @data ||= Data.new
+    end
+  end
+end