codice-fiscale 0.0.9 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e072ece1130ef8f44d55c4cc5302a5f75e5a9e7
-  data.tar.gz: 0bf6f20346f36a33672630176c8da7bcc260320c
+SHA256:
+  metadata.gz: 89e95f933b63caed0471e5f122e8c75edec7103d60c60ffe7ec94cbba683406a
+  data.tar.gz: 37f446137438d2d3ff95d7d559b2a0f860bd03e557fa6da60ae37efcaef51185
 SHA512:
-  metadata.gz: 552e467c8f707cbfac1204f653a2fcef45ab2e3bcdc40c52cc15aeeccbf0a20010da084922cd68befb0aaf59dc75d2f2f16a6fef5e3be07a2890da2e380ffacd
-  data.tar.gz: c97c3375af51451728abea74762ea1c87836be9a7dc9c488ca8374c297daea8cff02126aef9a6985f60fef610835ae3e496b00c7fb875da46dc360f209eeb9af
+  metadata.gz: e98eaa75284471bd9b3cbd1828dc3ba12c724121b75c998188850433817aab1e69e898e7232230a0f6bfed96be469c0dd087631fe1fa441ac2392776b0b9b872
+  data.tar.gz: e7a39273e69faa6dcdc3291971775d40372e0abd18b8418dc986a0f831fccf21b215728bb630a09329a4b765215f4db0301a46e5af535c950cc97798913bd130

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head

data/Guardfile

@@ -1,33 +1,70 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard_options = {
-  :all_after_pass => false,
-  :all_on_start => false,
-  :bundler => true,
-  :notification => true,
-  :keep_failed => false,
-  :cli => "-c -f doc"
-}
-
-guard('rspec', guard_options) do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara request specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, :cmd => "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(:view_extensions => %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
 
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
 end
-

data/README.md

@@ -1,10 +1,26 @@
-# Codice fiscale
+[![Gem Version](https://badge.fury.io/rb/codice-fiscale.svg)](https://badge.fury.io/rb/codice-fiscale)
+[![Build Status](https://travis-ci.org/topac/codice_fiscale.svg?branch=master)](https://travis-ci.org/topac/codice_fiscale)
 
-A ruby gem to support the calculation of the italian fiscal code ("Cofice fiscale"), 
-that is an ID assigned to each italian citizen by the "Agenzia delle entrate".
+# Codice Fiscale (Italian Tax ID)
 
-To calculate the fiscal code you need the following information: name, surname, 
-gender, birthdate and the birthplace. Read more on [wikipedia](http://en.wikipedia.org/wiki/Italian_fiscal_code_card).
+A Ruby gem that calculates the *Codice Fiscale* (Italian Tax ID).
+
+The *Codice Fiscale* is an identifier unique to each person that is used when dealing with Italian government offices or for private concerns and is formulated using a combination of the person’s name, place and date of birth.  Usually it is attributed by the Office of Income Revenue (*Agenzia delle Entrate*) through local tax offices.
+
+The code is 16 characters long and includes both letters and numbers, for e.g: `RSSMRA90A01H501W` (taken from [this sample card](https://i.imgur.com/UVXKDX8.png)). Read more on [wikipedia](http://en.wikipedia.org/wiki/Italian_fiscal_code_card) or [here](https://itamcap.com/italian-tax-id).
+
+
+## Installation
+
+**WARNING:** The gem name on rubygems.org is "codice-fiscale" not "codice_fiscale"
+
+Add this line to your application's Gemfile:
+```ruby
+    source 'https://rubygems.org'
+    gem 'codice-fiscale'
+```
+
+And then execute the `bundle install` command.
 
 ## Usage
 
@@ -13,18 +29,18 @@ gender, birthdate and the birthplace. Read more on [wikipedia](http://en.wikiped
 
   CodiceFiscale.calculate(
     :name          => 'Mario',
-    :surname       => 'Rossi', 
+    :surname       => 'Rossi',
     :gender        => :male,
     :birthdate     => Date.new(1987, 1, 1),
-    :province_code => 'LC', 
-    :city_name     => 'Abbadia Lariana'
+    :province_code => 'MI',
+    :city_name     => 'Milano'
   )
-  #=> RSSMRA87A01A005V
+  # => RSSMRA87A01F205E
 ```
 
-## City codes (Codici catastali)
-As explained above, one of the information required to calculate the fiscal code is the birthplace.  
-If a person was born outside Italy, only the italian name of the county is required.  
+## City codes (Codici Catastali)
+As explained above, one of the information required to calculate the tax ID is the birthplace.  
+If a person was born outside Italy, only the italian name of the country is required.  
 For example, an italian citizen born in France:
 
 ```ruby
@@ -35,49 +51,42 @@ For example, an italian citizen born in France:
     :birthdate    => Date.new(1987, 1, 1), 
     :country_name => 'Francia'
   )
+  # => RSSMRA87A01Z110I
 ```
 
-If a person was born in Italy you have to specify the *code* of the province and the *name* of the city. These informations are actually contained in an XLS 
-document downloaded from [istat.it](http://www.istat.it/it/archivio/6789), converted to CSV and shipped with this gem.
+If a person was born in Italy you have to specify the *code* of the province and the *name* of the city. These informations are actually contained in a CSV 
+document downloaded from [istat.it](http://www.istat.it/it/archivio/6789), converted and shipped with this gem.
+
 
 **But what if you have your own table with all those codes?**
 
-In this case, you can add a custom block that fetches the codes from your tables/files:
+In this case, you can add a custom block that fetches the codes from your database:
 
 
 *config/initializers/codice_fiscale_initializer.rb*:
 
 ```ruby
-  # Fetching the codes using ActiveRecord:
-
   CodiceFiscale.config.country_code do |country_name|
-    Country.find_by_name(country_name).code
+    # Place your code here, for e.g.:
+    YourCountryActiveRecordModel.find_by_name(country_name).code
+    # So that given for e.g. country_name="Denmark" the returned code must be "Z107"
+    # Checkout the file ./lib/codice_fiscale/codes/country_codes.csv
   end
 
   CodiceFiscale.config.city_code do |city_name, province_code|
-    City.in_italy.find_by_province_and_city(province_code, city_name).code
+    # Place your code here, for e.g.:
+    YourCityActiveRecordModel.find_by_province_and_city(province_code, city_name).code
+    # So that given for e.g. city_name="Fiumicino", province_code="RM" the returned code must be "M297"
+    # Checkout the file ./lib/codice_fiscale/codes/city_codes.csv
   end
 ```
 
-## Installation
-
-I'm currently supporting only **ruby 1.9+**
-
-**Note:** The gem name on rubygems.org is "codice-fiscale" not "codice_fiscale"
-
-Add this line to your application's Gemfile:
-
-    gem 'codice-fiscale'
-
-And then execute:
-
-    $ bundle
 
 ## Testing
 
-I'm using RSpec + guard (+ growl for notifications)
+    $ bundle exec rspec
 
-    $ bundle exec guard
+This gem is tested with all ruby versions starting from 1.9.3.
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,6 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+task :default => :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/codice_fiscale.gemspec

@@ -3,10 +3,10 @@ require File.expand_path('../lib/codice_fiscale/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["topac"]
-  gem.email         = ["dani.m.mobile@gmail.com"]
-  gem.description   = %q{Calculate the italian fiscal code}
-  gem.summary       = %q{Calculate the italian fiscal code}
-  gem.homepage      = "https://github.com/daniele-m/codice_fiscale"
+  gem.email         = ["topac@users.noreply.github.com"]
+  gem.description   = %q{Calculate the Italian Tax ID (Codice Fiscale)}
+  gem.summary       = %q{Calculate the Italian Tax ID (Codice Fiscale)}
+  gem.homepage      = "https://github.com/topac/codice_fiscale"
   gem.platform      = Gem::Platform::RUBY
 
   gem.files         = `git ls-files`.split($\)
@@ -16,11 +16,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CodiceFiscale::VERSION
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'
-  # The growl app must be separately downloaded and installed
-  gem.add_development_dependency 'growl'
 
   gem.add_dependency 'activesupport'
   gem.add_dependency 'activemodel'