municipitaly 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bd44f85892a6fa5dc71682ef37b0fac7cc69c72c3d68680d86e1032ff0ad6b2
+  data.tar.gz: c15283a9165bf95b82f5437c92e2d4b44542343263ad53e4851bba02dc572b9f
+SHA512:
+  metadata.gz: 50f2d6867d566d86df52e738f498d7712c7b568e18ac9dfe00b1e7853bd18e1f0b9440848b790b89aa95c268c8d85514a6a0a1820b029a229cdfd86e2741faf8
+  data.tar.gz: b1bdc4317696449c0aa11b64fcf4dcfab8f457c7c0ad13a1e9b9eb56ea8cec9f53851e833946d08f6a117dcfe5694ee8aeafbaeac6c2cf7ed3d95a8387c28969

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'municipitaly.gemspec'
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+
+Metrics/ParameterLists:
+  Max: 10
+
+Style/ClassVars:
+  Exclude:
+    - 'lib/municipitaly/data.rb'
+
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/municipitaly/search.rb'
+    

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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,51 @@
+PATH
+  remote: .
+  specs:
+    municipitaly (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  municipitaly!
+  rake (~> 13.0.1)
+  rspec (~> 3.9)
+  rubocop (~> 0.77)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 NatyDev
+
+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,188 @@
+
+# 🇮🇹 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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'municipitaly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install municipitaly
+
+## 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
+    * ISTAT code (it: *codice istat*)
+    * cadastrial code (it: *codice catastale*)
+    * postal code(s) (it: *codice/i postale/i*)
+    * population
+
+
+## Usage and examples
+
+
+The **Municipitaly::Search** is the principal class used to search entities.  
+Returned data are stored in 4 different types of entity models:
+
+- **Municipitaly::Zone**
+- **Municipitaly::Region**
+- **Municipitaly::Province**
+- **Municipitaly::Municipality**
+
+Retrieve all zones (return an array of `Municipitaly::Zone` objects):
+
+```ruby
+zones = Municipitaly::Zone.all
+# => [#<Municipitaly::Zone:0x0000...] 
+```
+pick a random zone:
+
+```ruby
+zone = zones.sample
+# => #<Municipitaly::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 `Municipitaly::Region` objects):
+
+```ruby
+zone.regions
+# => [#<Municipitaly::Region:0x00007fb83883c550...]
+```
+
+and so for other entities:
+
+```ruby
+zone.provinces
+# => [#<Municipitaly::Province:0x00007fb83a1478...]
+
+zone.municipalities
+# => [#<Municipitaly::Municipality:0x00007fb83a...]
+```
+
+### 🔎 Search
+
+**Municipitaly::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 = Municipitaly::Search.municipalities_from_name('ricco')
+# => [#<Municipitaly::Municipality:0x00007fb839184838 @province_istat="028", @name="Borgoricco", @partial_istat="013", @cadastrial_code="B031", @postal_codes=["35010"], @population=8478>] 
+
+municipality = municipalities.first
+# => #<Municipitaly::Municipality:0x00007fb83918483..>
+
+municipality.name
+# => "Borgoricco"
+
+municipality.postal_codes
+# => ["35010"]
+```
+
+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
+# => #<Municipitaly::Province:0x00007fb83a12701...>
+
+municipality.region_name
+# => "Veneto"
+
+municipality.region
+# => #<Municipitaly::Region:0x00007fb83883cf28...>
+
+municipality.zone
+# => #<Municipitaly::Zone:0x00007fb8390bb938...>
+```
+
+or retrieve nested entities:
+
+```ruby
+padua = municipality.province
+# => #<Municipitaly::Province:0x00007fb83a127010...>
+
+padua.municipalities
+# => [#<Municipitaly::Municipality:0x00007fb83915b730...]
+```
+
+Search municipalities **from a single postal code**:
+
+```ruby
+municipalities = Municipitaly::Search.municipalities_from_postal_code('50145')
+# => [#<Municipitaly::Municipality:0x00007fb83a295938 @province_istat="048", @name="Firenze"...]
+
+florence = municipalities.first
+# => #<Municipitaly::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.
+
+## 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.
+
+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. Oper 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/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 'municipitaly'
+
+# 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/municipitaly/data.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Municipitaly
+  # Define collection
+  class Data
+    @@zones = []
+    @@regions = []
+    @@provinces = []
+    @@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])
+        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])
+        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], partial_istat: row[2],
+                             cadastrial_code: row[3], postal_codes: row[4],
+                             population: row[5])
+        end
+      end
+      @@municipalities
+    end
+
+    def find_csv(file)
+      File.expand_path(File.join(File.dirname(__FILE__),
+        "../../vendor/data/#{file}"))
+    end
+  end
+end

data/lib/municipitaly/data_caller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Municipitaly
+  # shared module to use Municipitaly::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

data/lib/municipitaly/municipality.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Municipitaly
+  # Define data structure for a Municipality
+  class Municipality
+    extend Forwardable
+    include DataCaller
+    include RegionDelegator
+    include ZoneDelegator
+
+    def initialize(province_istat:, name:, partial_istat:,
+                   cadastrial_code:, postal_codes:, population:) # :nodoc:
+      @province_istat = province_istat
+      @name = name
+      @partial_istat = partial_istat
+      @cadastrial_code = cadastrial_code
+      @postal_codes = postal_codes.split(' ')
+      @population = population.to_i
+    end
+
+    # <b>istat code</b> relative to parent province (String)
+    attr_reader :province_istat
+
+    # <b>name</b> of municipality (String)
+    attr_reader :name
+
+    attr_reader :partial_istat # :nodoc:
+
+    # <b>cadastrial code</b> of municipality (String)
+    attr_reader :cadastrial_code
+
+    # an Array of one or more postal code (as String)
+    attr_reader :postal_codes
+
+    # total <b>population</b> of municipality (Integer)
+    attr_reader :population
+
+    def_delegator :province, :acronym, :province_acronym
+    def_delegator :province, :name, :province_name
+    def_delegator :province, :region_istat, :region_istat
+
+    # returns an array of all +Municipitaly::Municipality+ objects.
+    def self.all
+      data.municipalities
+    end
+
+    # returns <b>istat code</b> for current municipality.
+    def istat
+      province_istat + partial_istat
+    end
+
+    # returns +Municipitaly::Province+ object for current municipality.
+    def province
+      @province ||= Search.province_from_istat(province_istat)
+    end
+  end
+end

data/lib/municipitaly/province.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Municipitaly
+  # Define data structure for a Province
+  class Province
+    extend Forwardable
+    include DataCaller
+    include RegionDelegator
+    include ZoneDelegator
+
+    def initialize(region_istat:, name:, istat:, acronym:)
+      @region_istat = region_istat
+      @name = name
+      @istat = istat
+      @acronym = acronym
+    end
+
+    attr_reader :region_istat, :name, :istat, :acronym
+
+    # returns an array of all +Municipitaly::Province+ objects.
+    def self.all
+      data.provinces
+    end
+
+    # returns an array of all +Municipitaly::Municipality+ objects belongs
+    # to current province.
+    def municipalities
+      @municipalities ||= Search.municipalities_from_province_istat(istat)
+    end
+  end
+end

data/lib/municipitaly/region.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Municipitaly
+  # Define data structure for a Region
+  class Region
+    include DataCaller
+    include ZoneDelegator
+
+    def initialize(zone_code:, name:, istat:)
+      @zone_code = zone_code
+      @name = name
+      @istat = istat
+    end
+
+    attr_reader :zone_code, :name, :istat
+
+    # returns an array of all +Municipitaly::Region+ objects.
+    def self.all
+      data.regions
+    end
+
+    # returns an array of all +Municipitaly::Province+ objects belongs
+    # to current region.
+    def provinces
+      @provinces ||= Search.provinces_from_region_istat(istat)
+    end
+
+    # returns an array of all +Municipitaly::Municipality+ objects belongs
+    # to current region.
+    def municipalities
+      @municipalities ||= Search.municipalities_from_region_istat(istat)
+    end
+  end
+end

data/lib/municipitaly/region_delegator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Municipitaly
+  # shared module to delegate Region istance and its methods
+  module RegionDelegator
+    extend Forwardable
+
+    def_delegator :region, :name, :region_name
+    def_delegator :region, :zone_code, :zone_code
+
+    def region
+      @region ||= Search.region_from_istat(region_istat)
+    end
+  end
+end