itax_code 0.1.3 → 0.1.4

data/lib/itax_code/data/countries.csv

@@ -0,0 +1,277 @@
+"code","province","name"
+"Z100","EE","ALBANIA"
+"Z101","EE","ANDORRA"
+"Z102","EE","AUSTRIA"
+"Z103","EE","BELGIO"
+"Z104","EE","BULGARIA"
+"Z105","EE","CECOSLOVACCHIA"
+"Z106","EE","CITTA DEL VATICANO / VATICANO"
+"Z107","EE","DANIMARCA"
+"Z108","EE","FAER OER"
+"Z109","EE","FINLANDIA"
+"Z110","EE","FRANCIA"
+"Z111","EE","GERMANIA REP. DEMOCRATICA"
+"Z112","EE","GERMANIA REP. FEDERALE / GERMANIA"
+"Z113","EE","GIBILTERRA"
+"Z114","EE","GRAN BRETAGNA"
+"Z115","EE","GRECIA"
+"Z116","EE","IRLANDA"
+"Z117","EE","ISLANDA"
+"Z118","EE","IUGOSLAVIA"
+"Z119","EE","LIECHTENSTEIN"
+"Z120","EE","LUSSEMBURGO"
+"Z121","EE","MALTA"
+"Z122","EE","MAN"
+"Z123","EE","MONACO"
+"Z124","EE","NORMANNE"
+"Z125","EE","NORVEGIA"
+"Z126","EE","PAESI BASSI"
+"Z127","EE","POLONIA"
+"Z128","EE","PORTOGALLO"
+"Z129","EE","ROMANIA"
+"Z130","EE","SAN MARINO"
+"Z131","EE","SPAGNA"
+"Z132","EE","SVEZIA"
+"Z133","EE","SVIZZERA"
+"Z134","EE","UNGHERIA"
+"Z135","EE","URSS"
+"Z136","EE","GEORGIA"
+"Z137","EE","ARMENIA"
+"Z138","EE","UCRAINA"
+"Z139","EE","BIELORUSSIA"
+"Z140","EE","MOLDAVIA"
+"Z141","EE","AZERBAIDJAN"
+"Z142","EE","KIRGHIZISTAN"
+"Z143","EE","UZBEKISTAN"
+"Z144","EE","ESTONIA"
+"Z145","EE","LETTONIA"
+"Z146","EE","LITUANIA"
+"Z147","EE","TAGIKISTAN"
+"Z148","EE","MACEDONIA"
+"Z149","EE","CROAZIA"
+"Z150","EE","SLOVENIA"
+"Z151","EE","TURKEMENISTAN"
+"Z152","EE","KAZAKISTAN"
+"Z153","EE","BOSNIA ED ERZEGOVINA / BOSNIA ERZEGOVINA"
+"Z154","EE","RUSSIA / FEDERAZIONE RUSSA"
+"Z155","EE","REPUBBLICA SLOVACCA"
+"Z156","EE","REPUBBLICA CECA"
+"Z200","EE","AFGHANISTAN"
+"Z201","EE","ARABIA MERIDIONALE"
+"Z202","EE","PROTETTORATO DELLA ARABIA MERIDIONALE"
+"Z203","EE","ARABIA SAUDITA"
+"Z204","EE","BAHREIN"
+"Z205","EE","BHUTAN"
+"Z206","EE","BIRMANIA"
+"Z207","EE","BRUNEI"
+"Z208","EE","CAMBOGIA"
+"Z209","EE","SRI LANKA"
+"Z210","EE","CINA REPUBBLICA POPOLARE / CINA / CHINA"
+"Z211","EE","CIPRO"
+"Z212","EE","COCOS"
+"Z213","EE","REPUBBLICA DI COREA"
+"Z214","EE","COREA REPUBBLICA POPOLARE"
+"Z215","EE","EMIRATI ARABI UNITI"
+"Z216","EE","FILIPPINE"
+"Z217","EE","CINA REPUBBLICA NAZIONALE"
+"Z218","EE","TERRITORIO DI GAZA"
+"Z219","EE","GIAPPONE"
+"Z220","EE","GIORDANIA"
+"Z221","EE","HONG KONG"
+"Z222","EE","INDIA"
+"Z223","EE","INDONESIA"
+"Z224","EE","IRAN"
+"Z225","EE","IRAQ"
+"Z226","EE","ISRAELE"
+"Z227","EE","KUWAIT"
+"Z228","EE","LAOS"
+"Z229","EE","LIBANO"
+"Z230","EE","MALESIA"
+"Z231","EE","MACAO"
+"Z232","EE","MALDIVE"
+"Z233","EE","MONGOLIA REP. POPOLARE"
+"Z234","EE","NEPAL"
+"Z235","EE","OMAN"
+"Z236","EE","PAKISTAN"
+"Z237","EE","QATAR"
+"Z238","EE","RYUKYU"
+"Z239","EE","SIKKIM"
+"Z240","EE","SIRIA"
+"Z241","EE","THAILANDIA"
+"Z242","EE","TIMOR"
+"Z243","EE","TURCHIA"
+"Z244","EE","VIETNAM DEL SUD"
+"Z245","EE","VIETNAM DEL NORD"
+"Z246","EE","YEMEN"
+"Z247","EE","MALAYSIA"
+"Z248","EE","SINGAPORE"
+"Z249","EE","BANGLADESH"
+"Z250","EE","YEMEN REP. DEM. POPOLARE"
+"Z251","EE","VIETNAM"
+"Z300","EE","NAMIBIA"
+"Z301","EE","ALGERIA"
+"Z302","EE","ANGOLA"
+"Z303","EE","BASUTOLAND SUD AFRICA BRITANNICO"
+"Z304","EE","BECIUANIA SUD AFRICA BRITANNICO"
+"Z305","EE","BURUNDI"
+"Z306","EE","CAMERUN"
+"Z307","EE","CAPO VERDE"
+"Z308","EE","IMPERO CENTROAFRICANO"
+"Z309","EE","CIAD"
+"Z310","EE","COMORE"
+"Z311","EE","CONGO REPUBBLICA POPOLARE"
+"Z312","EE","ZAIRE"
+"Z313","EE","COSTA D'AVORIO"
+"Z314","EE","BENIN"
+"Z315","EE","ETIOPIA"
+"Z316","EE","GABON"
+"Z317","EE","GAMBIA"
+"Z318","EE","GHANA"
+"Z319","EE","GUINEA"
+"Z320","EE","GUINEA BISSAU"
+"Z321","EE","GUINEA EQUATORIALE"
+"Z322","EE","KENYA"
+"Z323","EE","IFNI"
+"Z324","EE","LA REUNION"
+"Z325","EE","LIBERIA"
+"Z326","EE","LIBIA"
+"Z327","EE","MADAGASCAR"
+"Z328","EE","MALAWI"
+"Z329","EE","MALI"
+"Z330","EE","MAROCCO"
+"Z331","EE","MAURITANIA"
+"Z332","EE","MAURIZIO"
+"Z333","EE","MOZAMBICO"
+"Z334","EE","NIGER"
+"Z335","EE","NIGERIA"
+"Z336","EE","EGITTO"
+"Z337","EE","ZIMBABWE"
+"Z338","EE","RUANDA"
+"Z339","EE","SAHARA SPAGNOLO"
+"Z340","EE","SANT ELENA"
+"Z341","EE","PRINCIPE"
+"Z342","EE","SEICELLE"
+"Z343","EE","SENEGAL"
+"Z344","EE","SIERRA LEONE"
+"Z345","EE","SOMALIA"
+"Z346","EE","SOMALIA FRANCESE"
+"Z347","EE","REPUBBLICA SUDAFRICANA"
+"Z348","EE","SUDAN"
+"Z349","EE","SWAZILAND"
+"Z350","EE","TANGANICA"
+"Z351","EE","TOGO"
+"Z352","EE","TUNISIA"
+"Z353","EE","UGANDA"
+"Z354","EE","BURKINA FASO"
+"Z355","EE","ZAMBIA"
+"Z356","EE","ZANZIBAR"
+"Z357","EE","TANZANIA"
+"Z358","EE","BOTSWANA"
+"Z359","EE","LESOTHO"
+"Z360","EE","MAYOTTE"
+"Z361","EE","GIBUTI"
+"Z362","EE","SAHARA MERIDIONALE"
+"Z363","EE","SAHARA SETTENTRIONALE"
+"Z364","EE","BOPHUTHATSWANA"
+"Z365","EE","TRANSKEI"
+"Z366","EE","VENDA"
+"Z367","EE","CISKEI"
+"Z368","EE","ERITREA"
+"Z400","EE","BERMUDE"
+"Z401","EE","CANADA"
+"Z402","EE","GROENLANDIA"
+"Z403","EE","SAINT PIERRE ET MIQUELON"
+"Z404","EE","STATI UNITI D'AMERICA"
+"Z500","EE","ANTILLE BRITANNICHE"
+"Z501","EE","ANTILLE OLANDESI"
+"Z502","EE","BAHAMA"
+"Z503","EE","COSTA RICA"
+"Z504","EE","CUBA"
+"Z505","EE","REPUBBLICA DOMINICANA"
+"Z506","EE","EL SALVADOR"
+"Z507","EE","GIAMAICA"
+"Z508","EE","GUADALUPA"
+"Z509","EE","GUATEMALA"
+"Z510","EE","HAITI"
+"Z511","EE","HONDURAS"
+"Z512","EE","BELIZE"
+"Z513","EE","MARTINICA"
+"Z514","EE","MESSICO"
+"Z515","EE","NICARAGUA"
+"Z516","EE","PANAMA"
+"Z517","EE","PANAMA ZONA DEL CANALE"
+"Z518","EE","PUERTO RICO"
+"Z519","EE","TURKS"
+"Z520","EE","ISOLE VERGINI"
+"Z522","EE","BARBADOS"
+"Z523","EE","ANTILLE BRITANNICHE"
+"Z524","EE","GRENADA"
+"Z525","EE","ISOLE VERGINI BRITANNICHE "
+"Z526","EE","DOMINICA"
+"Z527","EE","SAINT LUCIA"
+"Z528","EE","SAINT VINCENT E GRENADINE"
+"Z529","EE","ISOLA ANGUILLA"
+"Z530","EE","ISOLE CAYMAN"
+"Z531","EE","MONTSERRAT"
+"Z532","EE","ANTIGUE E BARBUDA"
+"Z533","EE","SAINT KITTS E NEVIS"
+"Z600","EE","ARGENTINA"
+"Z601","EE","BOLIVIA"
+"Z602","EE","BRASILE"
+"Z603","EE","CILE"
+"Z604","EE","COLOMBIA"
+"Z605","EE","ECUADOR"
+"Z606","EE","REPUBBLICA DELLA GUAYANA"
+"Z607","EE","GUAYANA FRANCESE"
+"Z608","EE","SURINAME"
+"Z609","EE","MALVINE"
+"Z610","EE","PARAGUAY"
+"Z611","EE","PERU"
+"Z612","EE","TRINIDAD E TOBAGO"
+"Z613","EE","URUGUAY"
+"Z614","EE","VENEZUELA"
+"Z700","EE","AUSTRALIA"
+"Z701","EE","CAROLINE"
+"Z702","EE","CHRISTMAS"
+"Z703","EE","COOK"
+"Z704","EE","FIGI O VITI"
+"Z705","EE","ELLICE"
+"Z706","EE","GUAM"
+"Z707","EE","IRIAN OCCIDENTALE"
+"Z708","EE","MACQUARIE"
+"Z709","EE","MARCUS"
+"Z710","EE","MARIANNE"
+"Z711","EE","MARSHALL"
+"Z712","EE","MIDWAY"
+"Z713","EE","NAURU"
+"Z714","EE","SAVAGE"
+"Z715","EE","NORFOLK"
+"Z716","EE","NUOVA CALEDONIA"
+"Z717","EE","NUOVE EBRIDI"
+"Z718","EE","NUOVA GUINEA"
+"Z719","EE","NUOVA ZELANDA"
+"Z720","EE","PAPUASIA"
+"Z721","EE","PASQUA"
+"Z722","EE","PITCAIRN"
+"Z723","EE","POLINESIA"
+"Z724","EE","SALOMONE"
+"Z725","EE","SAMOA AMERICANE"
+"Z726","EE","SAMOA OCCIDENTALI"
+"Z727","EE","TOKELAU"
+"Z728","EE","TONGA O DEGLI AMICI"
+"Z729","EE","WALLIS"
+"Z730","EE","PAPUA NUOVA GUINEA"
+"Z731","EE","KIRIBATI"
+"Z732","EE","TUVALU"
+"Z733","EE","VANUATU"
+"Z734","EE","PALAU REPUBBLICA"
+"Z735","EE","MICRONESIA STATI FEDERALI / MICRONESIA"
+"Z800","EE","DIPENDENZE CANADESI"
+"Z801","EE","DIPENDENZE NORVEGESI"
+"Z802","EE","DIPENDENZE SOVIETICHE"
+"Z900","EE","DIPENDENZE AUSTRALIANE"
+"Z901","EE","DIPENDENZE BRITANNICHE"
+"Z902","EE","DIPENDENZE FRANCESI"
+"Z903","EE","DIPENDENZE NEOZELANDESI"
+"Z905","EE","DIPENDENZE NORVEGESI"
+"Z906","EE","DIPENDENZE SUDAFRICANE"

data/lib/itax_code/encoder.rb

@@ -1,6 +1,5 @@
 module ItaxCode
-  ##
-  # This class handles the tax code generation logic.
+  # Handles the tax code generation logic.
   #
   # @param [String]       surname    The user first name
   # @param [String]       name       The user last name
@@ -9,7 +8,6 @@ module ItaxCode
   # @param [String]       birthplace The user birthplace
   #
   # @example
-  #
   #   ItaxCode::Encoder.new(
   #     surname: "Rossi",
   #     name: "Matteo",
@@ -19,33 +17,29 @@ module ItaxCode
   #   ).encode
   #
   # @return [String] The encoded tax code
-
   class Encoder
     class MissingDataError < StandardError; end
 
     def initialize(data = {}, utils = Utils.new)
       @surname    = data[:surname]
       @name       = data[:name]
-      @gender     = data[:gender].try :upcase
-      @birthdate  = parsed_date data[:birthdate]
+      @gender     = data[:gender]&.upcase
+      @birthdate  = Date.parse(data[:birthdate].to_s)
       @birthplace = data[:birthplace]
+      @utils      = utils
 
       instance_variables.each do |ivar|
         next if instance_variable_get(ivar).present?
 
         raise MissingDataError, "missing #{ivar} value"
       end
-
-      @utils = utils
     end
 
-    ##
-    # This method calculates the tax code.
+    # Computes the tax code from its components.
     #
     # @return [String] The calculated tax code
-
     def encode
-      code = encode_surname
+      code  = encode_surname
       code += encode_name
       code += encode_birthdate
       code += encode_birthplace
@@ -55,29 +49,23 @@ module ItaxCode
 
     private
 
-      attr_accessor :surname,
-                    :name,
-                    :gender,
-                    :birthdate,
-                    :birthplace,
-                    :utils
+      attr_accessor :surname, :name, :gender, :birthdate, :birthplace, :utils
 
       def encode_surname
-        str        = utils.slugged(surname).chars
-        consonants = utils.extract_consonants str
-        vowels     = utils.extract_vowels str
+        chars      = utils.slugged(surname).chars
+        consonants = utils.extract_consonants chars
+        vowels     = utils.extract_vowels chars
         "#{consonants[0..2]}#{vowels[0..2]}XXX"[0..2].upcase
       end
 
       def encode_name
-        str        = utils.slugged(name).chars
-        consonants = utils.extract_consonants str
-        vowels     = utils.extract_vowels str
+        chars      = utils.slugged(name).chars
+        consonants = utils.extract_consonants chars
+        vowels     = utils.extract_vowels chars
 
         if consonants.length > 3
-          arr = consonants.dup.chars
-          arr.delete_at 1
-          consonants = arr.join
+          consonants =
+            consonants.chars.values_at(0, 2..consonants.chars.size).join
         end
 
         "#{consonants[0..2]}#{vowels[0..2]}XXX"[0..2].upcase
@@ -90,23 +78,15 @@ module ItaxCode
         "#{year}#{month}#{day}"
       end
 
-      def encode_birthplace(src = utils.municipalities, exit: false)
-        place = src.find do |m|
-          utils.slugged(m["name"]) == utils.slugged(birthplace)
+      def encode_birthplace(src = utils.cities, exit: false)
+        place = src.find do |item|
+          utils.slugged(birthplace) == utils.slugged(item["name"])
         end
 
         code = place.try(:[], "code")
         return code if code.present?
-        return      if exit
 
-        encode_birthplace utils.countries, exit: true
-      end
-
-      def parsed_date(date)
-        case date.class.name
-        when "Date", "Time", "DateTime" then date
-        else Date.parse(date)
-        end
+        exit || encode_birthplace(utils.countries, exit: true)
       end
   end
 end

data/lib/itax_code/omocode.rb

@@ -0,0 +1,36 @@
+module ItaxCode
+  class Omocode
+    attr_reader :tax_code, :utils
+
+    # Creates a new instance for a given tax_code.
+    #
+    # @param [String] tax_code
+    # @param [Utils]  utils
+    def initialize(tax_code, utils = Utils.new)
+      @tax_code = tax_code
+      @utils    = utils
+    end
+
+    # Computes the omocodes from a given tax_code.
+    #
+    # @return [Array]
+    def list
+      chars = tax_code[0..14].chars
+      (omocodes(:decode, chars) + omocodes(:encode, chars)).uniq
+    end
+
+    private
+
+      def omocodes(action, chars)
+        utils.omocodia_subs_indexes.reverse.map do |i|
+          chars[i] = utils.public_send("omocodia_#{action}".to_sym, chars[i])
+          omocode(chars)
+        end
+      end
+
+      def omocode(chars)
+        code = chars.join
+        code + utils.encode_cin(code)
+      end
+  end
+end

data/lib/itax_code/parser.rb

@@ -1,6 +1,7 @@
+require "itax_code/omocode"
+
 module ItaxCode
-  ##
-  # This class handles the parsing logic.
+  # Handles the parsing logic.
   #
   # @param [String] tax_code
   #
@@ -9,23 +10,20 @@ module ItaxCode
   #   ItaxCode::Parser.new("RSSMRA70A01L726S").decode
   #
   # @return [Hash]
-
   class Parser
     class NoTaxCodeError      < StandardError; end
     class InvalidTaxCodeError < StandardError; end
 
     def initialize(tax_code, utils = Utils.new)
+      @tax_code = tax_code&.upcase
       @utils    = utils
-      @tax_code = (tax_code || "").upcase
       raise NoTaxCodeError if @tax_code.blank?
       raise InvalidTaxCodeError unless Validator.standard_length?(@tax_code)
     end
 
-    ##
-    # This method decodes the tax code.
+    # Decodes the tax code into its components.
     #
     # @return [Hash]
-
     def decode
       year        = decode_year
       month       = utils.months.find_index(raw[:birthdate_month]) + 1
@@ -37,7 +35,7 @@ module ItaxCode
         gender: gender,
         birthdate: [year, month, day].join("-"),
         birthplace: birthplace,
-        omocodes: omocodes,
+        omocodes: Omocode.new(tax_code).list,
         raw: raw
       }
     end
@@ -79,50 +77,21 @@ module ItaxCode
         end
       end
 
-      def decode_birthplace(src = utils.municipalities, exit: false)
-        places = src.select do |m|
-          m["code"] == municipality_code
+      def decode_birthplace(src = utils.cities, exit: false)
+        place = src.find do |item|
+          item["code"] == city_code && !item["name"].include?("soppresso")
         end
 
-        place = places.find { |m| !m["name"].include? "soppresso" }
-        place = place.presence || places.last
-
         if place.nil?
-          return if exit
-
-          decode_birthplace utils.countries, exit: true
+          exit ? return : decode_birthplace(utils.countries, exit: true)
         else
           place["name"] = place["name"].gsub(" (soppresso)", "")
-          place.deep_symbolize_keys
+          place.to_h.deep_symbolize_keys
         end
       end
 
-      def municipality_code
+      def city_code
         raw[:birthplace][0] + utils.omocodia_decode(raw[:birthplace][1..-1])
       end
-
-      def omocodes
-        code_chars = tax_code[0..14].chars
-        codes = []
-
-        utils.omocodia_subs_indexes.reverse_each do |i|
-          code_chars[i] = utils.omocodia_decode(code_chars[i])
-        end
-
-        code = code_chars.join
-        code_cin = utils.encode_cin(code)
-        code += code_cin
-        codes.push(code)
-
-        utils.omocodia_subs_indexes.reverse_each do |i|
-          code_chars[i] = utils.omocodia_encode(code_chars[i])
-          code = code_chars.join
-          code_cin = utils.encode_cin(code)
-          code += code_cin
-          codes.push(code)
-        end
-
-        codes
-      end
   end
 end

data/lib/itax_code/utils.rb

@@ -1,3 +1,5 @@
+require "csv"
+
 module ItaxCode
   class Utils
     def regex
@@ -97,16 +99,12 @@ module ItaxCode
       cin_remainders[tot % 26]
     end
 
-    def municipalities
-      @municipalities ||= JSON.parse(
-        File.read("#{__dir__}/data/municipalities.json")
-      )
+    def cities
+      CSV.foreach("#{__dir__}/data/cities.csv", headers: true)
     end
 
     def countries
-      @countries ||= JSON.parse(
-        File.read("#{__dir__}/data/countries.json")
-      )
+      CSV.foreach("#{__dir__}/data/countries.csv", headers: true)
     end
   end
 end

data/lib/itax_code/validator.rb

@@ -1,9 +1,7 @@
 module ItaxCode
-  ##
-  # This class holds the validation logic.
+  # Handles the validation logic.
   #
   # @param [Hash] data The user input data
-
   class Validator
     LENGTH = 16
 
@@ -12,27 +10,22 @@ module ItaxCode
     end
 
     class << self
-      ##
-      # This method checks tax code standard length
-      # against user and business fical code standards.
+      # Checks the tax code standard length against user
+      # and business fical code standards.
       #
       # @param [String] code The tax code
       #
       # @return [true, false]
-
       def standard_length?(code)
         code.length == LENGTH
       end
     end
 
-    ##
-    # This method check pre calculated tax code validity
-    # against newly encoded tax code.
+    # Checks pre computed tax code validity against newly encoded tax code.
     #
-    # @param [String] tax_code The pre calculated tax code
+    # @param [String] tax_code The pre computed tax code
     #
     # @return [true, false]
-
     def valid?(tax_code)
       encoded[0..10] == tax_code[0..10]
     end

data/lib/itax_code/version.rb

@@ -1,3 +1,3 @@
 module ItaxCode
-  VERSION = "0.1.3".freeze
+  VERSION = "0.1.4".freeze
 end