itax_code 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0e835f20154cc65702c909819b2b51c0e45574bcdd13b0f87d564b59ad04edf
-  data.tar.gz: 0aece7fbba1dc0684e588359f00f4f00462cd87381a3d1665ad1eb8d2f979d6f
+  metadata.gz: f9a3fe75a4e8f5c3de8c43680261cea42ee2ab4a4146be4ea3b7ba1a58def000
+  data.tar.gz: c736ec5f0541b0d62d9f8e38cecbcbb915f7a5f2d71a906b437dc9836dde5151
 SHA512:
-  metadata.gz: b351e1ab6cf075330713e445d18bfa4fcd69db780d32de5884e0e30954f11ca0b121d68355be662a4529ec72fbd2d063b9dc4264230160f16df1929215860604
-  data.tar.gz: 2a5d140abcaeb819d083f13a87e5a8623c570b578c1cd6cd5fc979fb5645eb94719565c6779c92164ef74fefa7eac5b1dbdcf473788d4026c8648e0d58c09338
+  metadata.gz: 55ef80049f4b9e4bfc47937ddb127643ac16c5ea1b754fb1a976d4ca301463cf72293c918d41c02270537ad1e30bd1e19f790bd2dbc6db98d3297c43917417d0
+  data.tar.gz: 9bd055d8d7aea94dfc5c1adf155096d93e60541555cad86e5a090782d7f7804c1017b0348a2023623212fc5acb5aaa077315d1c44c2f0092b13e9613e19ba29e

data/.github/workflows/lint.yml

@@ -6,12 +6,13 @@ on:
       - opened
       - reopened
       - synchronize
+  workflow_call:
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/.github/workflows/release.yml

@@ -5,12 +5,20 @@ on:
     branches:
       - main
 
-permissions:
-  contents: write
-  pull-requests: write
-
 jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+  test:
+    uses: ./.github/workflows/test.yml
+    secrets:
+      CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
   release-please:
+    needs:
+      - lint
+      - test
+    permissions:
+      contents: write
+      pull-requests: write
     runs-on: ubuntu-latest
     steps:
       - uses: google-github-actions/release-please-action@v3
@@ -20,7 +28,21 @@ jobs:
           release-type: ruby
           token: ${{secrets.GITHUB_TOKEN}}
           version-file: "lib/itax_code/version.rb"
-      - uses: actions/checkout@v3
+          changelog-types: >
+            [
+              { "type": "build", "section": "Build System", "hidden": false },
+              { "type": "ci", "section": "Continuous Integration", "hidden": false },
+              { "type": "chore", "section": "Miscellaneous Chores", "hidden": false },
+              { "type": "docs", "section": "Documentation", "hidden": false },
+              { "type": "feat", "section": "Features", "hidden": false },
+              { "type": "fix", "section": "Bug Fixes", "hidden": false },
+              { "type": "perf", "section": "Performance Improvements", "hidden": false },
+              { "type": "revert", "section": "Reverts", "hidden": false },
+              { "type": "refactor", "section": "Code Refactoring", "hidden": false },
+              { "type": "style", "section": "Styles", "hidden": false },
+              { "type": "test", "section": "Tests", "hidden": false }
+            ]
+      - uses: actions/checkout@v4
         if: ${{steps.release.outputs.release_created}}
       - uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -6,20 +6,40 @@ on:
       - opened
       - reopened
       - synchronize
+  workflow_call:
+    secrets:
+      CC_TEST_REPORTER_ID:
+        required: true
 
 jobs:
   test:
     runs-on: ubuntu-latest
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    continue-on-error: ${{endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug'}}
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, head]
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, 3.2, head]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version: ${{matrix.ruby}}
       - run: bundle install
       - run: bundle exec rake
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.2
+      - run: bundle install
+      - name: Test & publish code coverage
+        uses: paambaati/codeclimate-action@v5.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        with:
+          coverageCommand: bundle exec rake
+          debug: true

data/.rubocop.yml

@@ -37,6 +37,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Enabled: true
   Exclude:
+    - 'lib/itax_code/transliterator.rb'
     - 'lib/itax_code/utils.rb'
     - 'test/**/*'
 

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [2.0.2](https://github.com/matteoredz/itax-code/compare/v2.0.1...v2.0.2) (2023-11-04)
+
+
+### Continuous Integration
+
+* remove .travis.yml ([#49](https://github.com/matteoredz/itax-code/issues/49)) ([179141c](https://github.com/matteoredz/itax-code/commit/179141c9fc6aedefaad7f38cab70d6aa0d31e478))
+
+
+### Miscellaneous Chores
+
+* add quality badges + enable branch coverage ([#41](https://github.com/matteoredz/itax-code/issues/41)) ([cd3a950](https://github.com/matteoredz/itax-code/commit/cd3a950d85bf499526e7aa89dd468cb324e60e1b))
+
+
+### Bug Fixes
+
+* display all changelog-types ([#47](https://github.com/matteoredz/itax-code/issues/47)) ([d4eddf1](https://github.com/matteoredz/itax-code/commit/d4eddf109fc2bf112ded9f7ee7fca4d188269aaa))
+* pass CC_TEST_REPORTER_ID top-down to test workflow ([#45](https://github.com/matteoredz/itax-code/issues/45)) ([89398f2](https://github.com/matteoredz/itax-code/commit/89398f2fd681f62296268a1aeffd6f0782ccdf95))
+* require lint and test workflows run also on main ([#43](https://github.com/matteoredz/itax-code/issues/43)) ([f0a0d06](https://github.com/matteoredz/itax-code/commit/f0a0d06cc3682c39b2a5036d7bddc205eb0fc21c))
+* update README.md for SEO ([#48](https://github.com/matteoredz/itax-code/issues/48)) ([04db3eb](https://github.com/matteoredz/itax-code/commit/04db3eb4299e22b598fd13223fb4f8e36da52539))
+
+
+### Code Refactoring
+
+* make gem errors inherit from base classes ([#37](https://github.com/matteoredz/itax-code/issues/37)) ([99b00f1](https://github.com/matteoredz/itax-code/commit/99b00f152d9172bebd5f59d4d69e187cf7968a23))
+* remove ActiveSupport dependency ([#39](https://github.com/matteoredz/itax-code/issues/39)) ([9302954](https://github.com/matteoredz/itax-code/commit/93029541f510924a92acdf413f33a1b9ea939230))
+
 ## [2.0.1](https://github.com/matteoredz/itax-code/compare/v2.0.0...v2.0.1) (2023-10-06)
 
 

data/Gemfile

@@ -13,3 +13,4 @@ gem "rubocop-minitest"
 gem "rubocop-performance"
 gem "rubocop-rake"
 gem "simplecov"
+gem "timecop"

data/README.md

@@ -1,9 +1,8 @@
 # ItaxCode
 
-`ItaxCode` is a Ruby Gem to encode and decode Italian tax code (Codice Fiscale).
+[![Gem Version](https://badge.fury.io/rb/itax_code.svg)](https://badge.fury.io/rb/itax_code) [![Maintainability](https://api.codeclimate.com/v1/badges/6ce5347018f4b448098f/maintainability)](https://codeclimate.com/github/matteoredz/itax-code/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/6ce5347018f4b448098f/test_coverage)](https://codeclimate.com/github/matteoredz/itax-code/test_coverage)
 
-It handles common operations on Italian tax code like, for instance, encoding, decoding and validation.
-It also handles [omocodia](https://it.wikipedia.org/wiki/Omocodia) complexity.
+A Ruby Gem to encode, decode, and validate the Italian Tax Code (Fiscal Code, Codice Fiscale), dealing with [Omocodia](https://it.wikipedia.org/wiki/Omocodia) too.
 
 ## Installation
 

data/itax_code.gemspec

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

data/lib/itax_code/encoder.rb

@@ -14,8 +14,6 @@ module ItaxCode
   #
   # @return [String] The encoded tax code
   class Encoder
-    MissingDataError = Class.new(StandardError)
-
     # @param [Hash]  data  The user attributes
     # @param [Utils] utils
     #
@@ -25,6 +23,8 @@ module ItaxCode
     # @option data [String, Date] :birthdate  The user birthdate
     # @option data [String]       :birthplace The user birthplace
     def initialize(data = {}, utils = Utils.new)
+      @utils = utils
+
       @surname    = data[:surname]
       @name       = data[:name]
       @gender     = data[:gender]&.upcase
@@ -33,7 +33,6 @@ module ItaxCode
       validate_data_presence!
 
       @birthdate = parse_birthdate!
-      @utils     = utils
     end
 
     # Computes the tax code from its components.
@@ -81,8 +80,8 @@ module ItaxCode
         place_slug = utils.slugged(birthplace)
         place_item = src.find { |i| place_slug == utils.slugged(i[lookup_key]) }
 
-        code = place_item.try(:[], "code")
-        return code if code.present?
+        code = place_item&.[]("code")
+        return code if utils.present?(code)
         raise MissingDataError, "no code found for #{birthplace}" if stop
 
         encode_birthplace(utils.countries, stop: true)
@@ -90,7 +89,7 @@ module ItaxCode
 
       def validate_data_presence!
         instance_variables.each do |ivar|
-          next if instance_variable_get(ivar).present?
+          next if utils.present?(instance_variable_get(ivar))
 
           raise MissingDataError, "missing #{ivar} value"
         end
@@ -99,7 +98,7 @@ module ItaxCode
       def parse_birthdate!
         Date.parse(birthdate)
       rescue StandardError
-        raise ArgumentError, "#{birthdate} is not a valid date"
+        raise InvalidBirthdateError, "#{birthdate} is not a valid date"
       end
   end
 end

data/lib/itax_code/error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ItaxCode
+  Error = Class.new(StandardError)
+
+  class Encoder
+    Error = Class.new(Error)
+
+    InvalidBirthdateError = Class.new(Error)
+    MissingDataError = Class.new(Error)
+  end
+
+  class Parser
+    Error = Class.new(Error)
+
+    InvalidControlInternalNumberError = Class.new(Error)
+    InvalidTaxCodeError = Class.new(Error)
+    NoTaxCodeError = Class.new(Error)
+  end
+end

data/lib/itax_code/parser.rb

@@ -11,11 +11,6 @@ module ItaxCode
   #
   # @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
@@ -24,7 +19,7 @@ module ItaxCode
       @tax_code = tax_code&.upcase
       @utils    = utils
 
-      raise NoTaxCodeError if @tax_code.blank?
+      raise NoTaxCodeError if @utils.blank?(@tax_code)
       raise InvalidTaxCodeError if @tax_code.length != LENGTH
       raise InvalidControlInternalNumberError if raw[:cin] != @utils.encode_cin(@tax_code)
     end
@@ -61,7 +56,7 @@ module ItaxCode
       end
 
       def raw_matches
-        @raw_matches ||= tax_code.scan(utils.regex).flatten
+        @raw_matches ||= tax_code.scan(utils.tax_code_sections_regex).flatten
       end
 
       def gender
@@ -73,8 +68,9 @@ module ItaxCode
       # value could be wrong. E.g. a person born on 1920 would have birthdate_year = 20 meaning
       # that both 1920 and 2020 could be valid born years.
       def year
-        val = (Date.today.year.to_s[0..1] + utils.omocodia_decode(raw[:birthdate_year])).to_i
-        val > Date.today.year ? val - 100 : val
+        current_year = Date.today.year
+        val = (current_year.to_s[0..1] + utils.omocodia_decode(raw[:birthdate_year])).to_i
+        val > current_year ? val - 100 : val
       end
 
       def month
@@ -96,7 +92,7 @@ module ItaxCode
         if place.nil?
           birthplace(utils.countries, stop: true) unless stop
         else
-          place.to_h.deep_symbolize_keys
+          place.to_h.transform_keys(&:to_sym)
         end
       end
 

data/lib/itax_code/transliterator.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module ItaxCode
+  # https://github.com/ruby-i18n/i18n/blob/master/lib/i18n/backend/transliterator.rb
+  class Transliterator
+    DEFAULT_REPLACEMENT_CHAR = "?"
+
+    def transliterate(string, replacement = nil)
+      replacement ||= DEFAULT_REPLACEMENT_CHAR
+      string.gsub(/[^\x00-\x7f]/u) { |char| approximations[char] || replacement }
+    end
+
+    private
+
+      def approximations
+        @approximations ||= {
+          "À" => "A",
+          "Á" => "A",
+          "Â" => "A",
+          "Ã" => "A",
+          "Ä" => "A",
+          "Å" => "A",
+          "Æ" => "AE",
+          "Ç" => "C",
+          "È" => "E",
+          "É" => "E",
+          "Ê" => "E",
+          "Ë" => "E",
+          "Ì" => "I",
+          "Í" => "I",
+          "Î" => "I",
+          "Ï" => "I",
+          "Ð" => "D",
+          "Ñ" => "N",
+          "Ò" => "O",
+          "Ó" => "O",
+          "Ô" => "O",
+          "Õ" => "O",
+          "Ö" => "O",
+          "×" => "x",
+          "Ø" => "O",
+          "Ù" => "U",
+          "Ú" => "U",
+          "Û" => "U",
+          "Ü" => "U",
+          "Ý" => "Y",
+          "Þ" => "Th",
+          "ß" => "ss",
+          "ẞ" => "SS",
+          "à" => "a",
+          "á" => "a",
+          "â" => "a",
+          "ã" => "a",
+          "ä" => "a",
+          "å" => "a",
+          "æ" => "ae",
+          "ç" => "c",
+          "è" => "e",
+          "é" => "e",
+          "ê" => "e",
+          "ë" => "e",
+          "ì" => "i",
+          "í" => "i",
+          "î" => "i",
+          "ï" => "i",
+          "ð" => "d",
+          "ñ" => "n",
+          "ò" => "o",
+          "ó" => "o",
+          "ô" => "o",
+          "õ" => "o",
+          "ö" => "o",
+          "ø" => "o",
+          "ù" => "u",
+          "ú" => "u",
+          "û" => "u",
+          "ü" => "u",
+          "ý" => "y",
+          "þ" => "th",
+          "ÿ" => "y",
+          "Ā" => "A",
+          "ā" => "a",
+          "Ă" => "A",
+          "ă" => "a",
+          "Ą" => "A",
+          "ą" => "a",
+          "Ć" => "C",
+          "ć" => "c",
+          "Ĉ" => "C",
+          "ĉ" => "c",
+          "Ċ" => "C",
+          "ċ" => "c",
+          "Č" => "C",
+          "č" => "c",
+          "Ď" => "D",
+          "ď" => "d",
+          "Đ" => "D",
+          "đ" => "d",
+          "Ē" => "E",
+          "ē" => "e",
+          "Ĕ" => "E",
+          "ĕ" => "e",
+          "Ė" => "E",
+          "ė" => "e",
+          "Ę" => "E",
+          "ę" => "e",
+          "Ě" => "E",
+          "ě" => "e",
+          "Ĝ" => "G",
+          "ĝ" => "g",
+          "Ğ" => "G",
+          "ğ" => "g",
+          "Ġ" => "G",
+          "ġ" => "g",
+          "Ģ" => "G",
+          "ģ" => "g",
+          "Ĥ" => "H",
+          "ĥ" => "h",
+          "Ħ" => "H",
+          "ħ" => "h",
+          "Ĩ" => "I",
+          "ĩ" => "i",
+          "Ī" => "I",
+          "ī" => "i",
+          "Ĭ" => "I",
+          "ĭ" => "i",
+          "Į" => "I",
+          "į" => "i",
+          "İ" => "I",
+          "ı" => "i",
+          "IJ" => "IJ",
+          "ij" => "ij",
+          "Ĵ" => "J",
+          "ĵ" => "j",
+          "Ķ" => "K",
+          "ķ" => "k",
+          "ĸ" => "k",
+          "Ĺ" => "L",
+          "ĺ" => "l",
+          "Ļ" => "L",
+          "ļ" => "l",
+          "Ľ" => "L",
+          "ľ" => "l",
+          "Ŀ" => "L",
+          "ŀ" => "l",
+          "Ł" => "L",
+          "ł" => "l",
+          "Ń" => "N",
+          "ń" => "n",
+          "Ņ" => "N",
+          "ņ" => "n",
+          "Ň" => "N",
+          "ň" => "n",
+          "ʼn" => "'n",
+          "Ŋ" => "NG",
+          "ŋ" => "ng",
+          "Ō" => "O",
+          "ō" => "o",
+          "Ŏ" => "O",
+          "ŏ" => "o",
+          "Ő" => "O",
+          "ő" => "o",
+          "Œ" => "OE",
+          "œ" => "oe",
+          "Ŕ" => "R",
+          "ŕ" => "r",
+          "Ŗ" => "R",
+          "ŗ" => "r",
+          "Ř" => "R",
+          "ř" => "r",
+          "Ś" => "S",
+          "ś" => "s",
+          "Ŝ" => "S",
+          "ŝ" => "s",
+          "Ş" => "S",
+          "ş" => "s",
+          "Š" => "S",
+          "š" => "s",
+          "Ţ" => "T",
+          "ţ" => "t",
+          "Ť" => "T",
+          "ť" => "t",
+          "Ŧ" => "T",
+          "ŧ" => "t",
+          "Ũ" => "U",
+          "ũ" => "u",
+          "Ū" => "U",
+          "ū" => "u",
+          "Ŭ" => "U",
+          "ŭ" => "u",
+          "Ů" => "U",
+          "ů" => "u",
+          "Ű" => "U",
+          "ű" => "u",
+          "Ų" => "U",
+          "ų" => "u",
+          "Ŵ" => "W",
+          "ŵ" => "w",
+          "Ŷ" => "Y",
+          "ŷ" => "y",
+          "Ÿ" => "Y",
+          "Ź" => "Z",
+          "ź" => "z",
+          "Ż" => "Z",
+          "ż" => "z",
+          "Ž" => "Z",
+          "ž" => "z"
+        }
+      end
+  end
+end

data/lib/itax_code/utils.rb

@@ -1,20 +1,37 @@
 # frozen_string_literal: true
 
 require "csv"
+require "itax_code/transliterator"
 
 module ItaxCode
   class Utils
-    def regex
+    def blank?(obj)
+      obj.respond_to?(:empty?) ? !!obj.empty? : !obj
+    end
+
+    def present?(obj)
+      !blank?(obj)
+    end
+
+    def slugged(string)
+      transliterated = transliterate(string.downcase.strip)
+      transliterated.gsub(/[^\w-]+/, "-").gsub(/-{2,}/, "-").gsub(/^-+|-+$/, "")
+    end
+
+    def transliterate(string)
+      return string if string.ascii_only?
+
+      transliterator = Transliterator.new
+      transliterator.transliterate(string.unicode_normalize(:nfc))
+    end
+
+    def tax_code_sections_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 ").gsub(/\s*&\s*/, " and ").parameterize(separator: separator)
-    end
-
     def months
       %w[A B C D E H L M P R S T]
     end

data/lib/itax_code/version.rb

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

data/lib/itax_code.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
-require "active_support/all"
-
 require "itax_code/version"
 require "itax_code/utils"
 require "itax_code/encoder"
 require "itax_code/parser"
+require "itax_code/error"
 
 module ItaxCode
-  Error = Class.new(StandardError)
-
   class << self
     # Encodes the user tax code.
     #

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: itax_code
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Matteo Rossi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-06 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'
+date: 2023-11-04 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - mttrss5@gmail.com
@@ -37,7 +23,6 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -51,8 +36,10 @@ files:
 - lib/itax_code/data/cities.csv
 - lib/itax_code/data/countries.csv
 - lib/itax_code/encoder.rb
+- lib/itax_code/error.rb
 - lib/itax_code/omocode.rb
 - lib/itax_code/parser.rb
+- lib/itax_code/transliterator.rb
 - lib/itax_code/utils.rb
 - lib/itax_code/version.rb
 - rakelib/cities.rake

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.4