itax_code 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef915bc679fc9d2e15a5935b64e4c31cab6b638d0dc077d25f1f3ba7ab2859ef
-  data.tar.gz: 5c4ad64f192cae5530e5a434984539b9f5c0e27ad771d4bbd461118151ba5472
+  metadata.gz: a38d68de9f4fc5be15da055a5166c402adbe71d67b9e73213875e28c83b17db6
+  data.tar.gz: 7e27421ed321f9f6a8b8d0ec2ba38d005a81414401d5fbfbaa434c6a17e8d40d
 SHA512:
-  metadata.gz: 0f80f432773b74fe19d74312c249279204681f211ab73bdaf60bde1c4a4fac1eace749a2bfaae75a38cf692e08b42f88723d27de9e9b29da81580980e9a79039
-  data.tar.gz: c0758b8d0fc862dd67e5a50842c17723368cbcc7a9e987c3e9d2683e992f55fb346cc6bc2e87374069304f247d1d0e24917c5eb0eee8b9d67b665444f79c0984
+  metadata.gz: 724473a7faa374ac886a4a65cf37fe0168e4f1de0e318be0155f42b525d4ee74252c60a474e5db794c2879792f82f9c912ea2d7385b3a5724ac4d042e08d5362
+  data.tar.gz: 7af13a9eb19e9e3558bf83072448d561b86e964a61e3c4444638b6c7ceb938a4c84232b95ec74386f10358c8f205cd4a99b54bc9e6f14152b72d87ace7635bfa

data/.rubocop.yml

@@ -11,6 +11,9 @@ AllCops:
 Bundler/OrderedGems:
   Enabled: false
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/EmptyLineBetweenDefs:
   Enabled: true
   AllowAdjacentOneLineDefs: true
@@ -34,6 +37,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Enabled: true
   Exclude:
+    - 'lib/itax_code/utils.rb'
     - 'test/**/*'
 
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [1.0.0](https://github.com/matteoredz/itax-code/compare/v0.4.1...v1.0.0) (2023-08-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* allow empty or partial data argument in ItaxCode.valid? ([#26](https://github.com/matteoredz/itax-code/issues/26))
+* raise InvalidControlInternalNumberError on cin mismatch ([#25](https://github.com/matteoredz/itax-code/issues/25))
+
+### Features
+
+* allow empty or partial data argument in ItaxCode.valid? ([#26](https://github.com/matteoredz/itax-code/issues/26)) ([d02da6d](https://github.com/matteoredz/itax-code/commit/d02da6d17a4c04e1a5e07d7dd9d9d966479346bd))
+
+
+### Bug Fixes
+
+* compute omocodes from the original one ([#22](https://github.com/matteoredz/itax-code/issues/22)) ([b8a963f](https://github.com/matteoredz/itax-code/commit/b8a963faba2c46e1d23c0dc643a257aabd648dd9))
+* raise InvalidControlInternalNumberError on cin mismatch ([#25](https://github.com/matteoredz/itax-code/issues/25)) ([121cbca](https://github.com/matteoredz/itax-code/commit/121cbcaf75788c99bee4ffd7a997d07783a7fc15))
+
+## [0.4.1](https://github.com/matteoredz/itax-code/compare/v0.4.0...v0.4.1) (2023-08-08)
+
+
+### Bug Fixes
+
+* disable MFA as it breaks the CI ([#20](https://github.com/matteoredz/itax-code/issues/20)) ([7c9568e](https://github.com/matteoredz/itax-code/commit/7c9568e66618e324d4da137ddc6d0680b6900daa))
+
 ## [0.4.0](https://github.com/matteoredz/itax-code/compare/v0.3.0...v0.4.0) (2023-08-08)
 
 

data/README.md

@@ -54,11 +54,131 @@ ItaxCode.decode("RSSMRA80A01F205X")
 #   omocodes: %w[
 #     RSSMRA80A01F205X
 #     RSSMRA80A01F20RS
+#     RSSMRA80A01F2L5I
+#     RSSMRA80A01FN05M
+#     RSSMRA80A0MF205P
+#     RSSMRA80AL1F205I
+#     RSSMRA8LA01F205I
+#     RSSMRAU0A01F205U
 #     RSSMRA80A01F2LRD
+#     RSSMRA80A01FN0RH
+#     RSSMRA80A0MF20RK
+#     RSSMRA80AL1F20RD
+#     RSSMRA8LA01F20RD
+#     RSSMRAU0A01F20RP
+#     RSSMRA80A01FNL5X
+#     RSSMRA80A0MF2L5A
+#     RSSMRA80AL1F2L5T
+#     RSSMRA8LA01F2L5T
+#     RSSMRAU0A01F2L5F
+#     RSSMRA80A0MFN05E
+#     RSSMRA80AL1FN05X
+#     RSSMRA8LA01FN05X
+#     RSSMRAU0A01FN05J
+#     RSSMRA80ALMF205A
+#     RSSMRA8LA0MF205A
+#     RSSMRAU0A0MF205M
+#     RSSMRA8LAL1F205T
+#     RSSMRAU0AL1F205F
+#     RSSMRAULA01F205F
 #     RSSMRA80A01FNLRS
+#     RSSMRA80A0MF2LRV
+#     RSSMRA80AL1F2LRO
+#     RSSMRA8LA01F2LRO
+#     RSSMRAU0A01F2LRA
+#     RSSMRA80A0MFN0RZ
+#     RSSMRA80AL1FN0RS
+#     RSSMRA8LA01FN0RS
+#     RSSMRAU0A01FN0RE
+#     RSSMRA80ALMF20RV
+#     RSSMRA8LA0MF20RV
+#     RSSMRAU0A0MF20RH
+#     RSSMRA8LAL1F20RO
+#     RSSMRAU0AL1F20RA
+#     RSSMRAULA01F20RA
+#     RSSMRA80A0MFNL5P
+#     RSSMRA80AL1FNL5I
+#     RSSMRA8LA01FNL5I
+#     RSSMRAU0A01FNL5U
+#     RSSMRA80ALMF2L5L
+#     RSSMRA8LA0MF2L5L
+#     RSSMRAU0A0MF2L5X
+#     RSSMRA8LAL1F2L5E
+#     RSSMRAU0AL1F2L5Q
+#     RSSMRAULA01F2L5Q
+#     RSSMRA80ALMFN05P
+#     RSSMRA8LA0MFN05P
+#     RSSMRAU0A0MFN05B
+#     RSSMRA8LAL1FN05I
+#     RSSMRAU0AL1FN05U
+#     RSSMRAULA01FN05U
+#     RSSMRA8LALMF205L
+#     RSSMRAU0ALMF205X
+#     RSSMRAULA0MF205X
+#     RSSMRAULAL1F205Q
 #     RSSMRA80A0MFNLRK
+#     RSSMRA80AL1FNLRD
+#     RSSMRA8LA01FNLRD
+#     RSSMRAU0A01FNLRP
+#     RSSMRA80ALMF2LRG
+#     RSSMRA8LA0MF2LRG
+#     RSSMRAU0A0MF2LRS
+#     RSSMRA8LAL1F2LRZ
+#     RSSMRAU0AL1F2LRL
+#     RSSMRAULA01F2LRL
+#     RSSMRA80ALMFN0RK
+#     RSSMRA8LA0MFN0RK
+#     RSSMRAU0A0MFN0RW
+#     RSSMRA8LAL1FN0RD
+#     RSSMRAU0AL1FN0RP
+#     RSSMRAULA01FN0RP
+#     RSSMRA8LALMF20RG
+#     RSSMRAU0ALMF20RS
+#     RSSMRAULA0MF20RS
+#     RSSMRAULAL1F20RL
+#     RSSMRA80ALMFNL5A
+#     RSSMRA8LA0MFNL5A
+#     RSSMRAU0A0MFNL5M
+#     RSSMRA8LAL1FNL5T
+#     RSSMRAU0AL1FNL5F
+#     RSSMRAULA01FNL5F
+#     RSSMRA8LALMF2L5W
+#     RSSMRAU0ALMF2L5I
+#     RSSMRAULA0MF2L5I
+#     RSSMRAULAL1F2L5B
+#     RSSMRA8LALMFN05A
+#     RSSMRAU0ALMFN05M
+#     RSSMRAULA0MFN05M
+#     RSSMRAULAL1FN05F
+#     RSSMRAULALMF205I
 #     RSSMRA80ALMFNLRV
+#     RSSMRA8LA0MFNLRV
+#     RSSMRAU0A0MFNLRH
+#     RSSMRA8LAL1FNLRO
+#     RSSMRAU0AL1FNLRA
+#     RSSMRAULA01FNLRA
+#     RSSMRA8LALMF2LRR
+#     RSSMRAU0ALMF2LRD
+#     RSSMRAULA0MF2LRD
+#     RSSMRAULAL1F2LRW
+#     RSSMRA8LALMFN0RV
+#     RSSMRAU0ALMFN0RH
+#     RSSMRAULA0MFN0RH
+#     RSSMRAULAL1FN0RA
+#     RSSMRAULALMF20RD
+#     RSSMRA8LALMFNL5L
+#     RSSMRAU0ALMFNL5X
+#     RSSMRAULA0MFNL5X
+#     RSSMRAULAL1FNL5Q
+#     RSSMRAULALMF2L5T
+#     RSSMRAULALMFN05X
 #     RSSMRA8LALMFNLRG
+#     RSSMRAU0ALMFNLRS
+#     RSSMRAULA0MFNLRS
+#     RSSMRAULAL1FNLRL
+#     RSSMRAULALMF2LRO
+#     RSSMRAULALMFN0RS
+#     RSSMRAULALMFNL5I
 #     RSSMRAULALMFNLRD
 #   ],
 #   raw: {

data/itax_code.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "activesupport"
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["rubygems_mfa_required"] = "false"
 end

data/lib/itax_code/encoder.rb

@@ -20,7 +20,7 @@ module ItaxCode
   #
   # @return [String] The encoded tax code
   class Encoder
-    class MissingDataError < StandardError; end
+    MissingDataError = Class.new(StandardError)
 
     def initialize(data = {}, utils = Utils.new)
       @surname    = data[:surname]

data/lib/itax_code/omocode.rb

@@ -19,7 +19,7 @@ module ItaxCode
     # @return [Array]
     def omocodes
       [original_omocode] + utils.omocodia_indexes_combos.map do |combo|
-        omocode(combo, ->(char) { utils.omocodia_encode(char) })
+        omocode(original_omocode, combo, ->(char) { utils.omocodia_encode(char) })
       end
     end
 
@@ -28,13 +28,15 @@ module ItaxCode
     #
     # @return [String]
     def original_omocode
-      omocode(utils.omocodia_indexes, ->(char) { utils.omocodia_decode(char) })
+      @original_omocode ||= omocode(
+        tax_code, utils.omocodia_indexes, ->(char) { utils.omocodia_decode(char) }
+      )
     end
 
     private
 
-      def omocode(indexes, translation)
-        chars = tax_code[0..14].chars
+      def omocode(code, indexes, translation)
+        chars = code[0..14].chars
 
         indexes.each do |index|
           chars[index] = translation.call(chars[index])

data/lib/itax_code/parser.rb

@@ -13,14 +13,18 @@ module ItaxCode
   #
   # @return [Hash]
   class Parser
-    class NoTaxCodeError      < StandardError; end
-    class InvalidTaxCodeError < StandardError; end
+    Error                             = Class.new(StandardError)
+    NoTaxCodeError                    = Class.new(Error)
+    InvalidControlInternalNumberError = Class.new(Error)
+    InvalidTaxCodeError               = Class.new(Error)
 
     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)
+
+      @utils = utils
+      raise InvalidControlInternalNumberError if raw[:cin] != @utils.encode_cin(tax_code)
     end
 
     # Decodes the tax code into its components.

data/lib/itax_code/utils.rb

@@ -27,24 +27,49 @@ module ItaxCode
       %w[a e i o u]
     end
 
-    def cin_odds
+    def cin
       {
-        "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
-      }
-    end
-
-    def cin_evens
-      {
-        "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
+        "0" => [0, 1],
+        "1" => [1, 0],
+        "2" => [2, 5],
+        "3" => [3, 7],
+        "4" => [4, 9],
+        "5" => [5, 13],
+        "6" => [6, 15],
+        "7" => [7, 17],
+        "8" => [8, 19],
+        "9" => [9, 21],
+        "A" => [0, 1],
+        "B" => [1, 0],
+        "C" => [2, 5],
+        "D" => [3, 7],
+        "E" => [4, 9],
+        "F" => [5, 13],
+        "G" => [6, 15],
+        "H" => [7, 17],
+        "I" => [8, 19],
+        "J" => [9, 21],
+        "K" => [10, 2],
+        "L" => [11, 4],
+        "M" => [12, 18],
+        "N" => [13, 20],
+        "O" => [14, 11],
+        "P" => [15, 3],
+        "Q" => [16, 6],
+        "R" => [17, 8],
+        "S" => [18, 12],
+        "T" => [19, 14],
+        "U" => [20, 16],
+        "V" => [21, 10],
+        "W" => [22, 22],
+        "X" => [23, 25],
+        "Y" => [24, 24],
+        "Z" => [25, 23]
       }
     end
 
     def cin_remainders
-      "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+      ("A".."Z").to_a
     end
 
     def omocodia
@@ -89,13 +114,13 @@ module ItaxCode
     end
 
     def encode_cin(code)
-      tot = 0
+      cin_tot = 0
 
-      code.chars.each_with_index do |char, index|
-        tot += (index + 1).odd? ? cin_odds[char.to_sym] : cin_evens[char.to_sym]
+      code[0..14].each_char.with_index do |char, i|
+        cin_tot += cin[char][((i + 1) % 2).to_i]
       end
 
-      cin_remainders[tot % 26]
+      cin_remainders[cin_tot % 26]
     end
 
     def cities

data/lib/itax_code/validator.rb

@@ -5,35 +5,76 @@ module ItaxCode
   #
   # @param [Hash] data The user input data
   class Validator
-    LENGTH = 16
+    LENGTH        = 16
+    REQUIRED_KEYS = %i[surname name gender birthdate birthplace].freeze
 
-    def initialize(data = {})
-      @encoded = Encoder.new(data).encode
+    # @param [String] tax_code The pre-computed tax code
+    # @param [Hash]   data     The optional user attributes
+    #
+    def initialize(tax_code, data = {})
+      @tax_code = tax_code
+      @data     = data
     end
 
     class << self
       # Checks the tax code standard length against user
-      # and business fical code standards.
+      # and business fiscal code standards.
       #
-      # @param [String] code The tax code
+      # @param [String] tax_code The tax code
       #
       # @return [true, false]
-      def standard_length?(code)
-        code.length == LENGTH
+      def standard_length?(tax_code)
+        tax_code.length == LENGTH
       end
     end
 
-    # Checks pre computed tax code validity against newly encoded tax code.
-    #
-    # @param [String] tax_code The pre computed tax code
+    # Checks pre-computed tax code validity against newly encoded tax code.
     #
     # @return [true, false]
-    def valid?(tax_code)
-      encoded[0..10] == tax_code[0..10]
+    def valid?
+      encoded_tax_code == tax_code
     end
 
     private
 
-      attr_accessor :encoded
+      attr_reader :tax_code, :data
+
+      # Encodes the tax code from the given 'data' hash, also backfilling missing information
+      # by decoding the pre-computed tax code.
+      #
+      # @return [String, nil] The encoded tax code or nil if decoding the tax code fails
+      def encoded_tax_code
+        if partial_data?
+          decoded_tax_code ? backfill_data! : return
+        end
+
+        Encoder.new(data).encode
+      end
+
+      # Decodes the given tax code to backfill possibly missing data in the 'data' hash.
+      # If the decode fails, it means that the provided tax code is not valid.
+      #
+      # @return [Hash, nil] The decoded hash or nil if the tax code is not valid
+      def decoded_tax_code
+        @decoded_tax_code ||= begin
+          Parser.new(tax_code).decode
+        rescue Parser::Error
+          nil
+        end
+      end
+
+      def partial_data?
+        REQUIRED_KEYS.any? { |required_key| data[required_key].blank? }
+      end
+
+      def backfill_data!
+        data.tap do |hash|
+          hash[:surname]    ||= decoded_tax_code[:raw][:surname]
+          hash[:name]       ||= decoded_tax_code[:raw][:name]
+          hash[:gender]     ||= decoded_tax_code[:gender]
+          hash[:birthdate]  ||= decoded_tax_code[:birthdate]
+          hash[:birthplace] ||= decoded_tax_code[:birthplace][:code]
+        end
+      end
   end
 end

data/lib/itax_code/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ItaxCode
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

data/lib/itax_code.rb

@@ -9,6 +9,8 @@ require "itax_code/parser"
 require "itax_code/validator"
 
 module ItaxCode
+  Error = Class.new(StandardError)
+
   class << self
     # Encodes user tax code.
     #
@@ -38,7 +40,7 @@ module ItaxCode
     # encoded from user informations.
     #
     # @param [String] tax_code The user tax code
-    # @param [Hash]   data     The user attributes
+    # @param [Hash]   data     The optional user attributes
     #
     # @option data [String]       :surname
     # @option data [String]       :name
@@ -47,10 +49,8 @@ module ItaxCode
     # @option data [String]       :birthplace
     #
     # @return [Boolean]
-    def valid?(tax_code, data)
-      Validator.new(data).valid?(tax_code)
+    def valid?(tax_code, data = {})
+      Validator.new(tax_code, data).valid?
     end
   end
-
-  class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itax_code
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matteo Rossi
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - mttrss5@gmail.com
 executables: []
@@ -64,8 +64,8 @@ metadata:
   homepage_uri: https://github.com/matteoredz/itax-code
   source_code_uri: https://github.com/matteoredz/itax-code
   changelog_uri: https://github.com/matteoredz/itax-code/CHANGELOG.md
-  rubygems_mfa_required: 'true'
-post_install_message:
+  rubygems_mfa_required: 'false'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Encode and decode Italian tax code (Codice Fiscale)
 test_files: []