itax_code 1.0.1 → 2.0.1

data/lib/itax_code/encoder.rb

@@ -3,12 +3,6 @@
 module ItaxCode
   # Handles the tax code generation logic.
   #
-  # @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
   #   ItaxCode::Encoder.new(
   #     surname: "Rossi",
@@ -22,16 +16,24 @@ module ItaxCode
   class Encoder
     MissingDataError = Class.new(StandardError)
 
+    # @param [Hash]  data  The user attributes
+    # @param [Utils] utils
+    #
+    # @option data [String]       :surname    The user first name
+    # @option data [String]       :name       The user last name
+    # @option data [String]       :gender     The user gender
+    # @option data [String, Date] :birthdate  The user birthdate
+    # @option data [String]       :birthplace The user birthplace
     def initialize(data = {}, utils = Utils.new)
       @surname    = data[:surname]
       @name       = data[:name]
       @gender     = data[:gender]&.upcase
       @birthdate  = data[:birthdate].to_s
       @birthplace = data[:birthplace]
-      @utils      = utils
       validate_data_presence!
 
       @birthdate = parse_birthdate!
+      @utils     = utils
     end
 
     # Computes the tax code from its components.

data/lib/itax_code/parser.rb

@@ -5,26 +5,28 @@ require "itax_code/omocode"
 module ItaxCode
   # Handles the parsing logic.
   #
-  # @param [String] tax_code
-  #
   # @example
   #
   #   ItaxCode::Parser.new("RSSMRA70A01L726S").decode
   #
-  # @return [Hash]
+  # @return [Hash] The parsed tax code
   class Parser
     Error                             = Class.new(StandardError)
     NoTaxCodeError                    = Class.new(Error)
     InvalidControlInternalNumberError = Class.new(Error)
     InvalidTaxCodeError               = Class.new(Error)
 
+    LENGTH = 16
+
+    # @param [String] tax_code
+    # @param [Utils]  utils
     def initialize(tax_code, utils = Utils.new)
       @tax_code = tax_code&.upcase
-      raise NoTaxCodeError if @tax_code.blank?
-      raise InvalidTaxCodeError unless Validator.standard_length?(@tax_code)
+      @utils    = utils
 
-      @utils = utils
-      raise InvalidControlInternalNumberError if raw[:cin] != @utils.encode_cin(tax_code)
+      raise NoTaxCodeError if @tax_code.blank?
+      raise InvalidTaxCodeError if @tax_code.length != LENGTH
+      raise InvalidControlInternalNumberError if raw[:cin] != @utils.encode_cin(@tax_code)
     end
 
     # Decodes the tax code into its components.

data/lib/itax_code/version.rb

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

data/lib/itax_code.rb

@@ -6,13 +6,12 @@ require "itax_code/version"
 require "itax_code/utils"
 require "itax_code/encoder"
 require "itax_code/parser"
-require "itax_code/validator"
 
 module ItaxCode
   Error = Class.new(StandardError)
 
   class << self
-    # Encodes user tax code.
+    # Encodes the user tax code.
     #
     # @param [Hash] data The user attributes
     #
@@ -27,7 +26,7 @@ module ItaxCode
       Encoder.new(data).encode
     end
 
-    # Decodes tax code in its components.
+    # Decodes the tax code in its components.
     #
     # @param [String] tax_code The user tax code
     #
@@ -36,21 +35,16 @@ module ItaxCode
       Parser.new(tax_code).decode
     end
 
-    # Checks the given tax code validity against new one
-    # encoded from user informations.
+    # Checks the given tax code validity.
     #
     # @param [String] tax_code The user tax code
-    # @param [Hash]   data     The optional user attributes
-    #
-    # @option data [String]       :surname
-    # @option data [String]       :name
-    # @option data [String]       :gender
-    # @option data [String, Date] :birthdate
-    # @option data [String]       :birthplace
     #
     # @return [Boolean]
-    def valid?(tax_code, data = {})
-      Validator.new(tax_code, data).valid?
+    def valid?(tax_code)
+      decode(tax_code)
+      true
+    rescue Parser::Error
+      false
     end
   end
 end

data/rakelib/cities.rake

@@ -16,7 +16,7 @@ namespace :cities do
     output_string = CSV.generate do |csv|
       csv << %w[code province name created_on deleted_on]
 
-      CSV.foreach(tempfile.path, headers: true) do |row|
+      CSV.foreach(tempfile.path, encoding: "bom|utf-8", headers: true) do |row|
         csv << [
           row["CODCATASTALE"],
           row["SIGLAPROVINCIA"],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itax_code
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Matteo Rossi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -54,7 +54,6 @@ files:
 - lib/itax_code/omocode.rb
 - lib/itax_code/parser.rb
 - lib/itax_code/utils.rb
-- lib/itax_code/validator.rb
 - lib/itax_code/version.rb
 - rakelib/cities.rake
 homepage: https://github.com/matteoredz/itax-code

data/lib/itax_code/validator.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module ItaxCode
-  # Handles the validation logic.
-  #
-  # @param [Hash] data The user input data
-  class Validator
-    LENGTH        = 16
-    REQUIRED_KEYS = %i[surname name gender birthdate birthplace].freeze
-
-    # @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 fiscal code standards.
-      #
-      # @param [String] tax_code The tax code
-      #
-      # @return [true, false]
-      def standard_length?(tax_code)
-        tax_code.length == LENGTH
-      end
-    end
-
-    # Checks pre-computed tax code validity against newly encoded tax code.
-    #
-    # @return [true, false]
-    def valid?
-      encoded_tax_code == tax_code
-    end
-
-    private
-
-      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