itax_code 0.1.2

data/lib/itax_code/encoder.rb

@@ -0,0 +1,97 @@
+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
+  #
+  # @example
+  #
+  #   ItaxCode::Encoder.new(
+  #     surname: "Rossi",
+  #     name: "Matteo",
+  #     gender: "M",
+  #     birthdate: "1990-08-23",
+  #     birthplace: "Milano"
+  #   ).encode
+  #
+  # @return [String] The encoded tax code
+
+  class Encoder
+    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
+    end
+
+    ##
+    # This method calculates the tax code.
+    #
+    # @return [String] The calculated tax code
+
+    def encode
+      code = encode_surname
+      code += encode_name
+      code += encode_birthdate
+      code += encode_birthplace
+      code += utils.encode_cin code
+      code
+    end
+
+    private
+
+      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
+        "#{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
+
+        if consonants.length > 3
+          arr = consonants.dup.chars
+          arr.delete_at 1
+          consonants = arr.join
+        end
+
+        "#{consonants[0..2]}#{vowels[0..2]}XXX"[0..2].upcase
+      end
+
+      def encode_birthdate
+        year  = birthdate.year.to_s[2..-1]
+        month = utils.months[birthdate.month - 1]
+        day   = format "%02d", (birthdate.day + (gender == "F" ? 40 : 0))
+        "#{year}#{month}#{day}"
+      end
+
+      def encode_birthplace
+        utils.municipalities.find do |m|
+          utils.slugged(m["name"]) == utils.slugged(birthplace)
+        end.try(:[], "code")
+      end
+
+      def parsed_date(date)
+        case date.class.name
+        when "Date", "Time", "DateTime" then date
+        else Date.parse(date)
+        end
+      end
+  end
+end

data/lib/itax_code/parser.rb

@@ -0,0 +1,114 @@
+module ItaxCode
+  ##
+  # This class handles the parsing logic for TaxCode module.
+  #
+  # @param [String] tax_code
+  #
+  # @example
+  #
+  #   ItaxCode::Parser.new("RSSMRA70A01L726S").decode
+  #
+  # @return [Hash]
+
+  class Parser
+    def initialize(tax_code, utils = Utils.new)
+      @tax_code = (tax_code || "").upcase
+      @utils    = utils
+    end
+
+    ##
+    # This method decodes the tax code.
+    #
+    # @return [Hash]
+
+    def decode
+      year        = decode_year
+      month       = utils.months.find_index(raw[:birthdate_month]) + 1
+      day, gender = decode_day_and_gender
+      birthplace  = decode_birthplace
+
+      {
+        code: tax_code,
+        gender: gender,
+        birthdate: [year, month, day].join("-"),
+        birthplace: birthplace,
+        omocodes: omocodes,
+        raw: raw
+      }
+    end
+
+    private
+
+      attr_accessor :tax_code, :utils
+
+      def raw
+        matches = tax_code.scan(utils.regex).flatten
+
+        {
+          surname: matches[0],
+          name: matches[1],
+          birthdate: matches[2],
+          birthdate_year: matches[3],
+          birthdate_month: matches[4],
+          birthdate_day: matches[5],
+          birthplace: matches[6],
+          cin: matches[7]
+        }
+      end
+
+      def decode_year
+        year = utils.omocodia_decode raw[:birthdate_year]
+        year = (Date.today.year.to_s[0..1] + year).to_i
+        year -= 100 if year > Date.today.year
+        year
+      end
+
+      def decode_day_and_gender
+        day = utils.omocodia_decode(raw[:birthdate_day]).to_i
+
+        if day > 40
+          day -= 40
+          [day, "F"]
+        else
+          [day, "M"]
+        end
+      end
+
+      def decode_birthplace
+        places = utils.municipalities
+                      .select { |m| m["code"] == municipality_code }
+        place = places.find { |m| !m["name"].include? "soppresso" }
+        place = (place.presence || places.last).deep_symbolize_keys
+        place[:name] = place[:name].gsub(" (soppresso)", "")
+        place
+      end
+
+      def municipality_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

@@ -0,0 +1,112 @@
+module ItaxCode
+  class Utils
+    def regex
+      /^([A-Z]{3})([A-Z]{3})
+        (([A-Z\d]{2})([ABCDEHLMPRST]{1})([A-Z\d]{2}))
+        ([A-Z]{1}[A-Z\d]{3})
+        ([A-Z]{1})$/x
+    end
+
+    def slugged(str, separator = "-")
+      str.gsub!(/\s*@\s*/, " at ")
+      str.gsub!(/\s*&\s*/, " and ")
+      str.parameterize(separator: separator)
+    end
+
+    def months
+      %w[A B C D E H L M P R S T]
+    end
+
+    def consonants
+      %w[b c d f g h j k l m n p q r s t v w x y z]
+    end
+
+    def vowels
+      %w[a e i o u]
+    end
+
+    def cin_odds
+      {
+        "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
+      }
+    end
+
+    def cin_remainders
+      "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    end
+
+    def omocodia
+      {
+        "0": "L", "1": "M", "2": "N", "3": "P", "4": "Q",
+        "5": "R", "6": "S", "7": "T", "8": "U", "9": "V"
+      }
+    end
+
+    def omocodia_digits
+      omocodia.keys.join
+    end
+
+    def omocodia_letters
+      omocodia.values.join
+    end
+
+    def omocodia_subs_indexes
+      [6, 7, 9, 10, 12, 13, 14]
+    end
+
+    def omocodia_encode(val)
+      val.tr omocodia_digits, omocodia_letters
+    end
+
+    def omocodia_decode(val)
+      val.tr omocodia_letters, omocodia_digits
+    end
+
+    def extract_consonants(str)
+      str.select { |c| consonants.include? c }.join
+    end
+
+    def extract_vowels(str)
+      str.select { |c| vowels.include? c }.join
+    end
+
+    def encode_cin(code)
+      tot = 0
+
+      code.chars.each_with_index do |char, index|
+        tot += cin_odds[char.to_sym]  if (index + 1).odd?
+        tot += cin_evens[char.to_sym] if (index + 1).even?
+      end
+
+      cin_remainders[tot % 26]
+    end
+
+    def municipalities
+      @municipalities ||= JSON.parse(
+        File.read("#{__dir__}/data/municipalities.json")
+      )
+    end
+
+    # def countries
+    #   @countries ||= JSON.parse(
+    #     File.read("#{__dir__}/data/countries.json")
+    #   )
+    # end
+  end
+end

data/lib/itax_code/validator.rb

@@ -0,0 +1,44 @@
+module ItaxCode
+  ##
+  # This class holds the TaxCode validation logic.
+  #
+  # @param [Hash] data The citizen input data
+
+  class Validator
+    LENGTH = 16
+
+    def initialize(data = {})
+      @encoded = Encoder.new(data).encode
+    end
+
+    class << self
+      ##
+      # This method checks tax code standard length
+      # against citizen 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.
+    #
+    # @param [String] tax_code The pre calculated tax code
+    #
+    # @return [true, false]
+
+    def valid?(tax_code)
+      encoded[0..10] == tax_code[0..10]
+    end
+
+    private
+
+      attr_accessor :encoded
+  end
+end

data/lib/itax_code/version.rb

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

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: itax_code
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Matteo Rossi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mttrss5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- itax_code.gemspec
+- lib/itax_code.rb
+- lib/itax_code/data/countries.json
+- lib/itax_code/data/municipalities.json
+- lib/itax_code/encoder.rb
+- lib/itax_code/parser.rb
+- lib/itax_code/utils.rb
+- lib/itax_code/validator.rb
+- lib/itax_code/version.rb
+homepage: https://github.com/matteoredz/itax-code
+licenses:
+- MIT
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Encode and decode Italian tax code (Codice Fiscale).
+test_files: []