itax_code 0.1.4 → 0.3.0

data/lib/itax_code/encoder.rb

@@ -10,9 +10,9 @@ module ItaxCode
   # @example
   #   ItaxCode::Encoder.new(
   #     surname: "Rossi",
-  #     name: "Matteo",
+  #     name: "Mario",
   #     gender: "M",
-  #     birthdate: "1990-08-23",
+  #     birthdate: "1980-01-01",
   #     birthplace: "Milano"
   #   ).encode
   #
@@ -24,15 +24,12 @@ module ItaxCode
       @surname    = data[:surname]
       @name       = data[:name]
       @gender     = data[:gender]&.upcase
-      @birthdate  = Date.parse(data[:birthdate].to_s)
+      @birthdate  = data[:birthdate].to_s
       @birthplace = data[:birthplace]
       @utils      = utils
+      validate_data_presence!
 
-      instance_variables.each do |ivar|
-        next if instance_variable_get(ivar).present?
-
-        raise MissingDataError, "missing #{ivar} value"
-      end
+      @birthdate = parse_birthdate!
     end
 
     # Computes the tax code from its components.
@@ -64,8 +61,7 @@ module ItaxCode
         vowels     = utils.extract_vowels chars
 
         if consonants.length > 3
-          consonants =
-            consonants.chars.values_at(0, 2..consonants.chars.size).join
+          consonants = consonants.chars.values_at(0, 2..consonants.chars.size).join
         end
 
         "#{consonants[0..2]}#{vowels[0..2]}XXX"[0..2].upcase
@@ -78,15 +74,30 @@ module ItaxCode
         "#{year}#{month}#{day}"
       end
 
-      def encode_birthplace(src = utils.cities, exit: false)
-        place = src.find do |item|
-          utils.slugged(birthplace) == utils.slugged(item["name"])
-        end
+      def encode_birthplace(src = utils.cities, stop: false)
+        lookup_key = birthplace.match?(/^\w{1}\d{3}$/) ? "code" : "name"
+        place_slug = utils.slugged(birthplace)
+        place_item = src.find { |i| place_slug == utils.slugged(i[lookup_key]) }
 
-        code = place.try(:[], "code")
+        code = place_item.try(:[], "code")
         return code if code.present?
+        raise MissingDataError, "no code found for #{birthplace}" if stop
+
+        encode_birthplace(utils.countries, stop: true)
+      end
+
+      def validate_data_presence!
+        instance_variables.each do |ivar|
+          next if instance_variable_get(ivar).present?
+
+          raise MissingDataError, "missing #{ivar} value"
+        end
+      end
 
-        exit || encode_birthplace(utils.countries, exit: true)
+      def parse_birthdate!
+        Date.parse(birthdate)
+      rescue StandardError
+        raise ArgumentError, "#{birthdate} is not a valid date"
       end
   end
 end

data/lib/itax_code/parser.rb

@@ -25,15 +25,10 @@ module ItaxCode
     #
     # @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("-"),
+        birthdate: birthdate,
         birthplace: birthplace,
         omocodes: Omocode.new(tax_code).list,
         raw: raw
@@ -45,53 +40,66 @@ module ItaxCode
       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]
+        @raw ||= {
+          surname: raw_matches[0],
+          name: raw_matches[1],
+          birthdate: raw_matches[2],
+          birthdate_year: raw_matches[3],
+          birthdate_month: raw_matches[4],
+          birthdate_day: raw_matches[5],
+          birthplace: raw_matches[6],
+          cin: raw_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
+      def raw_matches
+        @raw_matches ||= tax_code.scan(utils.regex).flatten
       end
 
-      def decode_day_and_gender
-        day = utils.omocodia_decode(raw[:birthdate_day]).to_i
+      def gender
+        val = utils.omocodia_decode(raw[:birthdate_day]).to_i
+        val > 40 ? "F" : "M"
+      end
 
-        if day > 40
-          day -= 40
-          [day, "F"]
-        else
-          [day, "M"]
-        end
+      # This method tries to calculate the year based on a raw data. This means that the returned
+      # 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
       end
 
-      def decode_birthplace(src = utils.cities, exit: false)
-        place = src.find do |item|
-          item["code"] == city_code && !item["name"].include?("soppresso")
-        end
+      def month
+        utils.months.find_index(raw[:birthdate_month]) + 1
+      end
+
+      def day
+        val = utils.omocodia_decode(raw[:birthdate_day]).to_i
+        val > 40 ? val - 40 : val
+      end
+
+      def birthdate
+        @birthdate ||= Date.parse("#{year}-#{month}-#{day}").to_s
+      end
+
+      def birthplace(src = utils.cities, stop: false)
+        place = src.find { |item| item["code"] == birthplace_code && in_dates?(item) }
 
         if place.nil?
-          exit ? return : decode_birthplace(utils.countries, exit: true)
+          birthplace(utils.countries, stop: true) unless stop
         else
-          place["name"] = place["name"].gsub(" (soppresso)", "")
           place.to_h.deep_symbolize_keys
         end
       end
 
-      def city_code
+      def birthplace_code
         raw[:birthplace][0] + utils.omocodia_decode(raw[:birthplace][1..-1])
       end
+
+      def in_dates?(item)
+        created_on = Date.parse item.fetch("created_on", "0000-01-01")
+        deleted_on = Date.parse item.fetch("deleted_on", "9999-12-31")
+        Date.parse(birthdate).between? created_on, deleted_on
+      end
   end
 end

data/lib/itax_code/utils.rb

@@ -92,8 +92,7 @@ module ItaxCode
       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?
+        tot += (index + 1).odd? ? cin_odds[char.to_sym] : cin_evens[char.to_sym]
       end
 
       cin_remainders[tot % 26]

data/lib/itax_code/version.rb

@@ -1,3 +1,3 @@
 module ItaxCode
-  VERSION = "0.1.4".freeze
+  VERSION = "0.3.0".freeze
 end

data/rakelib/cities.rake

@@ -0,0 +1,35 @@
+require "csv"
+require "net/http"
+require "tempfile"
+require "uri"
+
+namespace :cities do
+  desc "Import cities from Istat remote CSV"
+  task :import do
+    tempfile = Tempfile.new
+    tempfile.write Net::HTTP.get(
+      URI("https://raw.githubusercontent.com/italia/anpr/master/src/archivi/ANPR_archivio_comuni.csv")
+    )
+
+    output_string = CSV.generate do |csv|
+      csv << %w[code province name created_on deleted_on]
+
+      CSV.foreach(tempfile.path, headers: true) do |row|
+        csv << [
+          row["CODCATASTALE"],
+          row["SIGLAPROVINCIA"],
+          row["DENOMINAZIONE_IT"].upcase,
+          row["DATAISTITUZIONE"],
+          row["DATACESSAZIONE"]
+        ]
+      end
+    end
+
+    File.open("lib/itax_code/data/cities.csv", "w") do |output_file|
+      output_file.write(output_string)
+    end
+  ensure
+    tempfile.close
+    tempfile.unlink
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itax_code
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Matteo Rossi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,118 +24,6 @@ dependencies:
     - - ">="
       - !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: rake
-  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
@@ -144,15 +32,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
-- ".github/workflows/build-and-push.yml"
 - ".github/workflows/lint.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -168,6 +56,7 @@ files:
 - 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
 licenses:
 - MIT

data/.github/workflows/build-and-push.yml

@@ -1,27 +0,0 @@
----
-name: Build and Push
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - uses: fregante/setup-git-user@v1
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: 2.7.0
-      - run: bundle install
-      - name: Build and Push to RubyGems
-        run: ./bin/release
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-...

data/Gemfile.lock

@@ -1,74 +0,0 @@
-PATH
-  remote: .
-  specs:
-    itax_code (0.1.4)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    docile (1.4.0)
-    i18n (1.8.11)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    mocha (1.13.0)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rubocop (1.22.3)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    rubocop-minitest (0.15.2)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.12.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  itax_code!
-  minitest
-  mocha
-  rake
-  rubocop
-  rubocop-minitest
-  rubocop-performance
-  simplecov
-
-BUNDLED WITH
-   2.1.4