codice-fiscale 0.0.4 → 0.0.5

data/README.md

@@ -11,7 +11,7 @@ gender, birthdate and the birthplace. Read more on [wikipedia](http://en.wikiped
 ```ruby
   require 'codice_fiscale'
 
-  CodiceFiscale.calculate 'mario', 'rossi', :male, Date.new(1987, 1, 1), 'italia', 'lc', 'Abbadia Lariana'
+  CodiceFiscale.calculate :name => 'Mario', :surname => 'Rossi', :gender => :male, :birthdate => Date.new(1987, 1, 1), :province_code => 'LC', :city_name => 'Abbadia Lariana'
 
   # RSSMRA87A01A005V
 ```
@@ -22,8 +22,9 @@ If a person was born outside Italy, only the italian name of the county is requi
 For example, an italian citizen born in France:
 
 ```ruby
-  CodiceFiscale.calculate 'mario', 'rossi', :male, Date.new(1987, 1, 1), 'francia'
+  CodiceFiscale.calculate :name => 'Mario', :surname => 'Rossi', :gender => :male, :birthdate => Date.new(1987, 1, 1), :country_name => 'Francia'
 ```
+
 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 [agenziaterritorio.it](http://www.agenziaterritorio.it/?id=721), converted to CSV and shipped with this gem.
 

data/lib/codice_fiscale.rb

@@ -9,20 +9,31 @@ require 'codice_fiscale/configuration'
 module CodiceFiscale
   extend self
 
-  def calculate name, surname, gender, birthdate, country_name, province_code = nil, city_name = nil
-    code = birthplace_part country_name, city_name, province_code
-    return nil unless code
-    code = surname_part(surname) + name_part(name) + birthdate_part(birthdate, gender) + code
+  def calculate params
+    validate_calculate_params params
+    code = birthplace_part (params[:country_name] || Codes::ITALY), params[:city_name], params[:province_code]
+    raise "Missing city/country code. Mispelled?" unless code
+    code = surname_part(params[:surname]) + name_part(params[:name]) + birthdate_part(params[:birthdate], params[:gender]) + code
     code + check_character(code)
   end
 
+  def validate_calculate_params params
+    [:name, :surname, :gender, :birthdate].each do |param_name|
+      raise "Missing #{param_name} parameter" unless params[param_name]
+    end
+    raise "Invalid birthdate: #{params[:birthdate]}" unless params[:birthdate].respond_to? :year
+    unless Codes::GENDERS.include? params[:gender]
+      raise "Invalid gender. Possible values are #{Codes::GENDERS}"
+    end
+  end
+
 
   # Methods to generate each part of the code
 
   def surname_part surname
     surname.upcase!
     code = first_three_consonants surname
-    code << first_three_vocals(surname)
+    code << first_three_vowels(surname)
     truncate_and_right_pad_with_three_x code
   end
 
@@ -31,7 +42,7 @@ module CodiceFiscale
     consonants_of_name = consonants name
     return consonants_of_name[0]+consonants_of_name[2..3] if consonants_of_name.size >= 4
     code = first_three_consonants name
-    code << first_three_vocals(name)
+    code << first_three_vowels(name)
     truncate_and_right_pad_with_three_x code
   end
 
@@ -53,7 +64,7 @@ module CodiceFiscale
   end
 
   def birthplace_part country_name, city_name = nil, province_code = nil
-    if %w[italia italy].include?(country_name.downcase.strip)
+    if Codes.italy? country_name
       city_code city_name, province_code
     else
       country_code country_name
@@ -87,8 +98,8 @@ module CodiceFiscale
     intersects(string, Alphabet.consonants)[0..2]
   end
 
-  def first_three_vocals string
-    intersects(string, Alphabet.vocals)[0..2]
+  def first_three_vowels string
+    intersects(string, Alphabet.vowels)[0..2]
   end
 
   def truncate_and_right_pad_with_three_x string

data/lib/codice_fiscale/alphabet.rb

@@ -2,16 +2,16 @@ module CodiceFiscale
   module Alphabet
     extend self
 
-    def vocals
+    def vowels
       %w[A E I O U]
     end
 
     def consonants
-      letters - vocals
+      letters - vowels
     end
 
     def letters
-      %w[A B C D E F G H I J K L M N O P Q R S T U V W X Y Z]
+      ('A'..'Z').to_a
     end
   end
 end

data/lib/codice_fiscale/codes.rb

@@ -2,13 +2,26 @@ module CodiceFiscale
   module Codes
     extend self
 
+    ITALY = 'Italia'
+
+    MONTH_CODES = %w[A B C D E H L M P R S T]
+
+    ODD_CODES = {'0' => 1, '1' => 0, '2' => 5, '3' => 7, '4' => 9, '5' => 13, '6' => 15, '7' => 17, '8' => 19, '9' => 21, 'A' => 1, 'B' => 0,
+                 'C' => 5, 'D' => 7, 'E' => 9, 'F' => 13, 'G' => 15, 'H' => 17, 'I' => 19, 'J' => 21, 'K' => 2, 'L' => 4, 'M' => 18, 'N' => 20,
+                 'O' => 11, 'P' => 3, 'Q' => 6, 'R' => 8, 'S' => 12, 'T' => 14, 'U' => 16, 'V' => 10, 'W' => 22, 'X' => 25, 'Y' => 24, 'Z' => 23}
+
+    EVEN_CODES = {'0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5, '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'A' => 0, 'B' => 1,
+                  'C' => 2, 'D' => 3, 'E' => 4, 'F' => 5, 'G' => 6, 'H' => 7, 'I' => 8, 'J' => 9, 'K' => 10, 'L' => 11, 'M' => 12, 'N' => 13,
+                  'O' => 14, 'P' => 15, 'Q' => 16, 'R' => 17, 'S' => 18, 'T' => 19, 'U' => 20, 'V' => 21, 'W' => 22, 'X' => 23, 'Y' => 24, 'Z' => 25}
+
+    GENDERS = [:male, :female]
+
     def config
       CodiceFiscale.config
     end
 
     def month_letter month_number
-      decode = %w[A B C D E H L M P R S T]
-      month_number <= 0 ? nil : decode[month_number-1]
+      month_number <= 0 ? nil : MONTH_CODES[month_number-1]
     end
 
     def city city_name, province_code
@@ -28,22 +41,19 @@ module CodiceFiscale
     end
 
     def odd_character character
-      decode = {'0' => 1, '1' => 0, '2' => 5, '3' => 7, '4' => 9, '5' => 13, '6' => 15, '7' => 17, '8' => 19, '9' => 21, 'A' => 1, 'B' => 0,
-      'C' => 5, 'D' => 7, 'E' => 9, 'F' => 13, 'G' => 15, 'H' => 17, 'I' => 19, 'J' => 21, 'K' => 2, 'L' => 4, 'M' => 18, 'N' => 20,
-      'O' => 11, 'P' => 3, 'Q' => 6, 'R' => 8, 'S' => 12, 'T' => 14, 'U' => 16, 'V' => 10, 'W' => 22, 'X' => 25, 'Y' => 24, 'Z' => 23}
-      decode[character.upcase]
+      ODD_CODES[character.upcase]
     end
 
     def even_character character
-      decode = {'0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5, '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'A' => 0, 'B' => 1,
-        'C' => 2, 'D' => 3, 'E' => 4, 'F' => 5, 'G' => 6, 'H' => 7, 'I' => 8, 'J' => 9, 'K' => 10, 'L' => 11, 'M' => 12, 'N' => 13,
-        'O' => 14, 'P' => 15, 'Q' => 16, 'R' => 17, 'S' => 18, 'T' => 19, 'U' => 20, 'V' => 21, 'W' => 22, 'X' => 23, 'Y' => 24, 'Z' => 25}
-      decode[character.upcase]
+      EVEN_CODES[character.upcase]
     end
 
     def check_character number
-      decode = %w[A B C D E F G H I J K L M N O P Q R S T U V W X Y Z]
-      decode[number]
+      Alphabet.letters[number]
+    end
+
+    def italy? country_name
+      ITALY.casecmp(country_name.strip) == 0
     end
   end
 end

data/lib/codice_fiscale/version.rb

@@ -1,3 +1,3 @@
 module CodiceFiscale
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/lib/codice_fiscale_spec.rb

@@ -168,15 +168,47 @@ describe CodiceFiscale do
   describe '#calculate' do
     context 'italian citizen' do
       it 'return the expected code' do
-        params = ['mario', 'rossi', :male, Date.new(1987, 1, 1), 'italia', 'lc', 'Abbadia Lariana']
-        subject.calculate(*params).should == 'RSSMRA87A01A005V'
+        params = {:name => 'mario', :surname => 'rossi', :gender => :male, :birthdate => Date.new(1987, 1, 1),
+                  :province_code => 'lc', :city_name => 'Abbadia Lariana'}
+        subject.calculate(params).should == 'RSSMRA87A01A005V'
       end
     end
 
     context 'return the expected code' do
       it 'work' do
-        params = ['mario', 'rossi', :male, Date.new(1987, 1, 1), 'Albania']
-        subject.calculate(*params).should == 'RSSMRA87A01Z100H'
+        params = {:name => 'mario', :surname => 'rossi', :gender => :male, :birthdate => Date.new(1987, 1, 1), :country_name => 'Albania'}
+        subject.calculate(params).should == 'RSSMRA87A01Z100H'
+      end
+    end
+  end
+
+  describe '#validate_calculate_params' do
+    let(:mandatory_params) { {:name => 'mario', :surname => 'rossi', :gender => :male, :birthdate => Date.new(1987, 1, 1)} }
+
+    context 'All mandatory params are correct' do
+      it 'do not raise any arror' do
+        lambda { subject.validate_calculate_params(mandatory_params) }.should_not raise_error
+      end
+    end
+
+    context 'A mandatory parameter is missing' do
+      it 'raise an error' do
+        without_name = mandatory_params.reject {|p| p == :name }
+        lambda { subject.validate_calculate_params(without_name) }.should raise_error
+      end
+    end
+
+    context 'Gender is invalid' do
+      it 'raise an error' do
+        params = mandatory_params.merge :gender => :lol
+        lambda { subject.validate_calculate_params(params) }.should raise_error
+      end
+    end
+
+    context 'Birthdate is invalid' do
+      it 'raise an error' do
+        params = mandatory_params.merge :birthdate => '2000/01/01'
+        lambda { subject.validate_calculate_params(params) }.should raise_error
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codice-fiscale
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors: