itax_code 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a38d68de9f4fc5be15da055a5166c402adbe71d67b9e73213875e28c83b17db6
-  data.tar.gz: 7e27421ed321f9f6a8b8d0ec2ba38d005a81414401d5fbfbaa434c6a17e8d40d
+  metadata.gz: f9694d3dacddb70177a4bf256b129b20d3242cb35e8067d0583daeff2dc0755b
+  data.tar.gz: d05018606dcef62dd39806d81a2249f2d4e1cd3c883a4b2e1d131a36140c6fa7
 SHA512:
-  metadata.gz: 724473a7faa374ac886a4a65cf37fe0168e4f1de0e318be0155f42b525d4ee74252c60a474e5db794c2879792f82f9c912ea2d7385b3a5724ac4d042e08d5362
-  data.tar.gz: 7af13a9eb19e9e3558bf83072448d561b86e964a61e3c4444638b6c7ceb938a4c84232b95ec74386f10358c8f205cd4a99b54bc9e6f14152b72d87ace7635bfa
+  metadata.gz: c9a0f96094dc63a9a9a930ae1a63b0f188e4ff0b995038443c46fd08d4bc2362e4eecaf7cb92c7c6bd00ca1a2c330796c30bba1bb0e2f3357036d950f9d31407
+  data.tar.gz: 275a041c4e41271b5f0b1bc1b8d5e8ace9b78aaba2a66dc0d61ad99b07206753c576241364d0d2721385d417e719bec962ad9dde718f42eb27f78bdc4c9c5de6

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [2.0.0](https://github.com/matteoredz/itax-code/compare/v1.0.1...v2.0.0) (2023-10-01)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove Validator and merge its logic into Parser ([#32](https://github.com/matteoredz/itax-code/issues/32))
+* remove data hash argument from ItaxCode.valid? and ItaxCode::Validator#valid? ([#30](https://github.com/matteoredz/itax-code/issues/30))
+
+### Bug Fixes
+
+* remove data hash argument from ItaxCode.valid? and ItaxCode::Validator#valid? ([#30](https://github.com/matteoredz/itax-code/issues/30)) ([997f8b0](https://github.com/matteoredz/itax-code/commit/997f8b0b9f4bc00012475950a84465bf06b73a52))
+
+
+### Code Refactoring
+
+* remove Validator and merge its logic into Parser ([#32](https://github.com/matteoredz/itax-code/issues/32)) ([348bdd0](https://github.com/matteoredz/itax-code/commit/348bdd003d1709b0dd2d41e58b0307a1b8e23ab1))
+
+## [1.0.1](https://github.com/matteoredz/itax-code/compare/v1.0.0...v1.0.1) (2023-08-31)
+
+
+### Bug Fixes
+
+* NoMethodError undefined method 'upcase' for nil:NilClass ([#27](https://github.com/matteoredz/itax-code/issues/27)) ([15470d1](https://github.com/matteoredz/itax-code/commit/15470d104a8c0c958e24de199243692e88a94b92))
+
 ## [1.0.0](https://github.com/matteoredz/itax-code/compare/v0.4.1...v1.0.0) (2023-08-30)
 
 

data/README.md

@@ -33,6 +33,10 @@ ItaxCode.encode(
   birthdate: "1980-01-01", # String|Time|Date|DateTime
   birthplace: "Milano" # Name(Milano)|code(F205)
 )
+
+# Output
+#
+# "RSSMRA80A01F205X"
 ```
 
 ### Decode
@@ -197,16 +201,11 @@ ItaxCode.decode("RSSMRA80A01F205X")
 ### Validate
 
 ```ruby
-ItaxCode.valid?(
-  "RSSMRA80A01F205X",
-  {
-    surname: "Rossi",
-    name: "Mario",
-    gender: "M",
-    birthdate: "1980-01-01",
-    birthplace: "Milano"
-  }
-)
+ItaxCode.valid?("RSSMRA80A01F205X")
+
+# Output
+#
+# true
 ```
 
 ## Development

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)
+      @tax_code = tax_code&.upcase
+      @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.0"
+  VERSION = "2.0.0"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itax_code
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matteo Rossi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2023-10-01 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