Improve omocodes algo (#16)

* feat: expose the full list of omocodes

* chore: enable frozen_string_literal rule in .rubocop.yml

* refactor: apply new cops suggestions

.rubocop.yml

@@ -5,6 +5,7 @@ require:
   - rubocop-rake
 
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.5
 
 Bundler/OrderedGems:
@@ -42,9 +43,6 @@ Metrics/MethodLength:
 Style/Documentation:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "itax_code"

itax_code.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/itax_code/version"
 
 Gem::Specification.new do |spec|
@@ -23,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "activesupport"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

lib/itax_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/all"
 
 require "itax_code/version"

lib/itax_code/encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ItaxCode
   # Handles the tax code generation logic.
   #
@@ -60,9 +62,7 @@ def encode_name
         consonants = utils.extract_consonants chars
         vowels     = utils.extract_vowels chars
 
-        if consonants.length > 3
-          consonants = consonants.chars.values_at(0, 2..consonants.chars.size).join
-        end
+        consonants = consonants.chars.values_at(0, 2..consonants.size).join if consonants.length > 3
 
         "#{consonants[0..2]}#{vowels[0..2]}XXX"[0..2].upcase
       end

lib/itax_code/omocode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ItaxCode
   class Omocode
     attr_reader :tax_code, :utils
@@ -11,26 +13,35 @@ def initialize(tax_code, utils = Utils.new)
       @utils    = utils
     end
 
-    # Computes the omocodes from a given tax_code.
+    # Computes the omocodes from a given tax_code by first identifying the original
+    # tax_code and then appending all the omocodes.
     #
     # @return [Array]
-    def list
-      chars = tax_code[0..14].chars
-      (omocodes(:decode, chars) + omocodes(:encode, chars)).uniq
+    def omocodes
+      [original_omocode] + utils.omocodia_indexes_combos.map do |combo|
+        omocode(combo, ->(char) { utils.omocodia_encode(char) })
+      end
+    end
+
+    # The original omocode is the one that have all the omocody indexes decoded
+    # as number, and from which any of its omocodes are generated.
+    #
+    # @return [String]
+    def original_omocode
+      omocode(utils.omocodia_indexes, ->(char) { utils.omocodia_decode(char) })
     end
 
     private
 
-      def omocodes(action, chars)
-        utils.omocodia_subs_indexes.reverse.map do |i|
-          chars[i] = utils.public_send("omocodia_#{action}".to_sym, chars[i])
-          omocode(chars)
+      def omocode(indexes, translation)
+        chars = tax_code[0..14].chars
+
+        indexes.each do |index|
+          chars[index] = translation.call(chars[index])
         end
-      end
 
-      def omocode(chars)
-        code = chars.join
-        code + utils.encode_cin(code)
+        omocode = chars.join
+        omocode + utils.encode_cin(omocode)
       end
   end
 end

lib/itax_code/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "itax_code/omocode"
 
 module ItaxCode
@@ -30,7 +32,7 @@ def decode
         gender: gender,
         birthdate: birthdate,
         birthplace: birthplace,
-        omocodes: Omocode.new(tax_code).list,
+        omocodes: Omocode.new(tax_code).omocodes,
         raw: raw
       }
     end

lib/itax_code/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "csv"
 
 module ItaxCode
@@ -10,9 +12,7 @@ def regex
     end
 
     def slugged(str, separator = "-")
-      str.gsub!(/\s*@\s*/, " at ")
-      str.gsub!(/\s*&\s*/, " and ")
-      str.parameterize(separator: separator)
+      str.gsub(/\s*@\s*/, " at ").gsub(/\s*&\s*/, " and ").parameterize(separator: separator)
     end
 
     def months
@@ -29,23 +29,17 @@ def vowels
 
     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
+        "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
+        "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
 
@@ -68,8 +62,14 @@ def omocodia_letters
       omocodia.values.join
     end
 
-    def omocodia_subs_indexes
-      [6, 7, 9, 10, 12, 13, 14]
+    def omocodia_indexes
+      [6, 7, 9, 10, 12, 13, 14].reverse
+    end
+
+    def omocodia_indexes_combos
+      (1..omocodia_indexes.size).flat_map do |index|
+        omocodia_indexes.combination(index).to_a
+      end
     end
 
     def omocodia_encode(val)

lib/itax_code/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ItaxCode
   # Handles the validation logic.
   #

lib/itax_code/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ItaxCode
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.0"
 end

rakelib/cities.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "csv"
 require "net/http"
 require "tempfile"
@@ -25,9 +27,7 @@ namespace :cities do
       end
     end
 
-    File.open("lib/itax_code/data/cities.csv", "w") do |output_file|
-      output_file.write(output_string)
-    end
+    File.write("lib/itax_code/data/cities.csv", output_string)
   ensure
     tempfile.close
     tempfile.unlink

test/itax_code/encoder_test.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 module ItaxCode
   class EncoderTest < ActiveSupport::TestCase
     test "public interface" do
       instance_methods = Encoder.instance_methods - Object.instance_methods
+
       assert_equal %i[encode], instance_methods
     end