itax_code 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f79a865df5d202807046608d8b774ae21b05426d6418815884ff808cae75d79f
-  data.tar.gz: fee682091af5907dce1ef0ac32ddc16fb44cba9956e1c04534ba1505750e2c5f
+  metadata.gz: 902aaf958bf3e07384e9bb4cb59d060e1fb3a423d9c58929dad97f22d53f3305
+  data.tar.gz: 3fb7d7f218364c447cce5dd5cb3b557abc743e487484a40025358d6e29b7d53d
 SHA512:
-  metadata.gz: 1f4552edfa936dd8224abccd20861236bcc51311d84342e4e9b0516f7b73b0fc7496a957cd5957ead747f6f44885ada49ea38fbfbf96d8444f252472e1eecc73
-  data.tar.gz: 27ae449fc19eef5d2f30e0ca7e581837683ec2353e8003798f40ba23a05b0efa9a6f0d498c1f6927d7e7b0042a85e8940a3f09bfbb6ef8359d011bfc0ea20f97
+  metadata.gz: 9b3ec757113b83dd49b70314f8b8fc4a1518bead2c8a6c304b6a4c5d642439a81348f367e9b71914cf3f2f109d017d3b1e10b2576ecb967f5f201c5d2968cb80
+  data.tar.gz: 2ed3dc5aeec37b4ccd42882352fb3f1cde6b15c9a7727f3e76cb3687c38d67f44993ae928665ded670f6cc22feb5b047d150112a80ad505989fb56c8506c4255

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.3
+
+- Add ability to encode and decode foreign countries tax codes
+- Add custom exception to Parser and Encoder classes
+
+---
+
 # 0.1.1
 
 - Add credits to README.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    itax_code (0.1.2)
+    itax_code (0.1.3)
       activesupport
       rake
 
@@ -22,14 +22,14 @@ GEM
       concurrent-ruby (~> 1.0)
     minitest (5.14.2)
     mocha (1.11.2)
-    parallel (1.20.0)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.8.2)
     rexml (3.2.4)
-    rubocop (1.3.1)
+    rubocop (1.4.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)

data/README.md

@@ -26,11 +26,11 @@ Or install it yourself as:
 ### Encode
 
 ```ruby
-ItaxCode.generate(
+ItaxCode.encode(
   surname: "Rossi",
   name: "Mario",
-  gender: "M",           # can be M or F
-  birthdate: "1980-1-1", # can be String, Time, Date or DateTime
+  gender: "M",           # "M" or "F"
+  birthdate: "1980-1-1", # String, Time, Date or DateTime
   birthplace: "Milano"
 )
 ```
@@ -39,6 +39,39 @@ ItaxCode.generate(
 
 ```ruby
 ItaxCode.decode("RSSMRA80A01F205X")
+
+# Output
+#
+# {
+#   code: "RSSMRA80A01F205X",
+#   gender: "M",
+#   birthdate: "1980-1-1",
+#   birthplace: {
+#     code: "F205",
+#     province: "MI",
+#     name: "MILANO"
+#   },
+#   omocodes: %w[
+#     RSSMRA80A01F205X
+#     RSSMRA80A01F20RS
+#     RSSMRA80A01F2LRD
+#     RSSMRA80A01FNLRS
+#     RSSMRA80A0MFNLRK
+#     RSSMRA80ALMFNLRV
+#     RSSMRA8LALMFNLRG
+#     RSSMRAULALMFNLRD
+#   ],
+#   raw: {
+#     surname: "RSS",
+#     name: "MRA",
+#     birthdate: "80A01",
+#     birthdate_year: "80",
+#     birthdate_month: "A",
+#     birthdate_day: "01",
+#     birthplace: "F205",
+#     cin: "X"
+#   }
+# }
 ```
 
 ### Validate
@@ -80,5 +113,5 @@ chat rooms and mailing lists is expected to follow the [code of conduct](https:/
 
 ## Credits
 
-I took my cue from [python-codicefiscale](https://github.com/fabiocaccamo/python-codicefiscale) repo,
-coded by [Fabio Caccamo](https://github.com/fabiocaccamo) to write ItaxCode Gem.
+I took insipiration from [python-codicefiscale](https://github.com/fabiocaccamo/python-codicefiscale)
+repository, coded by [Fabio Caccamo](https://github.com/fabiocaccamo).

data/lib/itax_code.rb

@@ -8,11 +8,11 @@ require "itax_code/validator"
 module ItaxCode
   class << self
     ##
-    # This method encodes citizen tax code
+    # This method encodes user tax code.
     #
     # @example
     #
-    #   ItaxCode.generate({
+    #   ItaxCode.encode({
     #     surname:    [String]
     #     name:       [String]
     #     gender:     [String]
@@ -20,7 +20,7 @@ module ItaxCode
     #     birthplace: [String]
     #   })
     #
-    # @param [Hash] data The citizen data attributes
+    # @param [Hash] data The user data attributes
     #
     # @return [String]
 
@@ -29,13 +29,13 @@ module ItaxCode
     end
 
     ##
-    # This method decodes tax code in its components
+    # This method decodes tax code in its components.
     #
     # @example
     #
     #   ItaxCode.decode("CCCFBA85D03L219P")
     #
-    # @param [String] tax_code The citizen tax code
+    # @param [String] tax_code The user tax code
     #
     # @return [Hash]
 
@@ -45,7 +45,7 @@ module ItaxCode
 
     ##
     # This method check given tax code validity
-    # against new one generated by citizen informations
+    # against new one encoded from user informations.
     #
     # @example
     #

data/lib/itax_code/encoder.rb

@@ -2,11 +2,11 @@ module ItaxCode
   ##
   # This class handles the tax code generation logic.
   #
-  # @param [String]       surname    The citizen first name
-  # @param [String]       name       The citizen last name
-  # @param [String]       gender     The citizen gender
-  # @param [String, Date] birthdate  The citizen birthdate
-  # @param [String]       birthplace The citizen birthplace
+  # @param [String]       surname    The user first name
+  # @param [String]       name       The user last name
+  # @param [String]       gender     The user gender
+  # @param [String, Date] birthdate  The user birthdate
+  # @param [String]       birthplace The user birthplace
   #
   # @example
   #
@@ -21,13 +21,22 @@ module ItaxCode
   # @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]
       @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
 
     ##
@@ -81,10 +90,16 @@ module ItaxCode
         "#{year}#{month}#{day}"
       end
 
-      def encode_birthplace
-        utils.municipalities.find do |m|
+      def encode_birthplace(src = utils.municipalities, exit: false)
+        place = src.find do |m|
           utils.slugged(m["name"]) == utils.slugged(birthplace)
-        end.try(:[], "code")
+        end
+
+        code = place.try(:[], "code")
+        return code if code.present?
+        return      if exit
+
+        encode_birthplace utils.countries, exit: true
       end
 
       def parsed_date(date)

data/lib/itax_code/parser.rb

@@ -1,6 +1,6 @@
 module ItaxCode
   ##
-  # This class handles the parsing logic for TaxCode module.
+  # This class handles the parsing logic.
   #
   # @param [String] tax_code
   #
@@ -11,9 +11,14 @@ module ItaxCode
   # @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
 
     ##
@@ -74,13 +79,22 @@ module ItaxCode
         end
       end
 
-      def decode_birthplace
-        places = utils.municipalities
-                      .select { |m| m["code"] == municipality_code }
+      def decode_birthplace(src = utils.municipalities, exit: false)
+        places = src.select do |m|
+          m["code"] == municipality_code
+        end
+
         place = places.find { |m| !m["name"].include? "soppresso" }
-        place = (place.presence || places.last).deep_symbolize_keys
-        place[:name] = place[:name].gsub(" (soppresso)", "")
-        place
+        place = place.presence || places.last
+
+        if place.nil?
+          return if exit
+
+          decode_birthplace utils.countries, exit: true
+        else
+          place["name"] = place["name"].gsub(" (soppresso)", "")
+          place.deep_symbolize_keys
+        end
       end
 
       def municipality_code

data/lib/itax_code/utils.rb

@@ -103,10 +103,10 @@ module ItaxCode
       )
     end
 
-    # def countries
-    #   @countries ||= JSON.parse(
-    #     File.read("#{__dir__}/data/countries.json")
-    #   )
-    # end
+    def countries
+      @countries ||= JSON.parse(
+        File.read("#{__dir__}/data/countries.json")
+      )
+    end
   end
 end

data/lib/itax_code/validator.rb

@@ -1,8 +1,8 @@
 module ItaxCode
   ##
-  # This class holds the TaxCode validation logic.
+  # This class holds the validation logic.
   #
-  # @param [Hash] data The citizen input data
+  # @param [Hash] data The user input data
 
   class Validator
     LENGTH = 16
@@ -14,7 +14,7 @@ module ItaxCode
     class << self
       ##
       # This method checks tax code standard length
-      # against citizen and business fical code standards.
+      # against user and business fical code standards.
       #
       # @param [String] code The tax code
       #

data/lib/itax_code/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itax_code
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Matteo Rossi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-21 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport