br-utils 0.1.1 → 0.2.0

data/lib/brazilian-utils/vin-utils.rb

@@ -0,0 +1,46 @@
+module BrazilianUtils
+  # Utilities for validating a VIN (chassi) structurally: 17 characters,
+  # none of the excluded letters `I`, `O`, `Q`, and the check digit at
+  # position 9 (the North American / ISO 3779 rule).
+  #
+  # Brazilian rules do not mandate the check digit, so many Brazilian-built
+  # VINs fail it; this validates structure only, as the contract does.
+  module VINUtils
+    TRANSLITERATION = {
+      'A' => 1, 'B' => 2, 'C' => 3, 'D' => 4, 'E' => 5, 'F' => 6, 'G' => 7, 'H' => 8,
+      'J' => 1, 'K' => 2, 'L' => 3, 'M' => 4, 'N' => 5, 'P' => 7, 'R' => 9,
+      'S' => 2, 'T' => 3, 'U' => 4, 'V' => 5, 'W' => 6, 'X' => 7, 'Y' => 8, 'Z' => 9
+    }.freeze
+
+    WEIGHTS = [8, 7, 6, 5, 4, 3, 2, 10, 0, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+    EXCLUDED_LETTERS = %w[I O Q].freeze
+
+    # Validates a VIN structurally.
+    #
+    # @param value [String] Case-insensitive.
+    # @return [Boolean]
+    def self.is_valid(value)
+      return false unless value.is_a?(String)
+
+      vin = value.strip.upcase
+      return false unless vin.length == 17
+      return false unless vin.match?(/\A[A-Z0-9]{17}\z/)
+      return false if EXCLUDED_LETTERS.any? { |l| vin.include?(l) }
+      return false if vin.chars.uniq.length == 1
+
+      values = vin.chars.map { |c| c.match?(/\d/) ? c.to_i : TRANSLITERATION[c] }
+      return false if values.include?(nil)
+
+      sum = values.each_with_index.sum { |v, i| v * WEIGHTS[i] }
+      remainder = sum % 11
+      check_char = remainder == 10 ? 'X' : remainder.to_s
+
+      vin[8] == check_char
+    end
+
+    class << self
+      alias valid? is_valid
+    end
+  end
+end

data/lib/brazilian-utils/voter-id-utils.rb

@@ -176,5 +176,41 @@ module BrazilianUtils
     private_class_method :is_length_valid?, :get_sequential_number, :get_federative_union,
                           :get_verifying_digits, :is_federative_union_valid?, :calculate_vd1,
                           :calculate_vd2
+
+    # Removes the voter ID formatting symbols (spaces), keeping everything else.
+    #
+    # @param value [String] A voter ID, with or without spacing.
+    # @return [String] The value with spaces removed.
+    #
+    # @example
+    #   remove_symbols("1234 5678 01 24")  #=> "123456780124"
+    def self.remove_symbols(value)
+      return '' unless value.is_a?(String)
+
+      value.gsub(/\s/, '')
+    end
+
+    # Removes voter ID formatting and keeps only digits, capped to 12 digits
+    # (13 when the UF portion is SP or MG).
+    #
+    # @param value [String, Integer] A voter ID, with or without formatting.
+    # @return [String] The parsed digits.
+    #
+    # @example
+    #   parse("1234 5678 01 24")     #=> "123456780124"
+    #   parse("1234 5678 8 01 91")   #=> "1234567880191" (13-digit SP/MG form)
+    def self.parse(value)
+      return '' unless value.is_a?(String) || value.is_a?(Integer)
+
+      digits = value.to_s.gsub(/\D/, '')
+      return '' if digits.empty?
+
+      if digits.length > 12
+        candidate = digits[0, 13]
+        return candidate if candidate.length == 13 && %w[01 02].include?(candidate[-4..-3])
+      end
+
+      digits[0, 12]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: br-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Rocha
@@ -97,21 +97,59 @@ files:
 - examples/pis_usage_example.rb
 - examples/renavam_usage_example.rb
 - examples/voter_id_usage_example.rb
+- lib/brazilian-utils/area-code-utils.rb
+- lib/brazilian-utils/bank-account-utils.rb
+- lib/brazilian-utils/bank-utils.rb
 - lib/brazilian-utils/boleto-utils.rb
+- lib/brazilian-utils/caepf-utils.rb
+- lib/brazilian-utils/cbo-utils.rb
+- lib/brazilian-utils/cei-utils.rb
 - lib/brazilian-utils/cep-utils.rb
+- lib/brazilian-utils/certidao-utils.rb
+- lib/brazilian-utils/cfop-utils.rb
+- lib/brazilian-utils/cnae-utils.rb
 - lib/brazilian-utils/cnh-utils.rb
+- lib/brazilian-utils/cno-utils.rb
 - lib/brazilian-utils/cnpj-utils.rb
+- lib/brazilian-utils/cns-utils.rb
 - lib/brazilian-utils/cpf-utils.rb
+- lib/brazilian-utils/credit-card-utils.rb
+- lib/brazilian-utils/csosn-utils.rb
+- lib/brazilian-utils/cst-utils.rb
 - lib/brazilian-utils/currency-utils.rb
+- lib/brazilian-utils/data/area_codes.json
+- lib/brazilian-utils/data/banks.json
+- lib/brazilian-utils/data/cbo.json
+- lib/brazilian-utils/data/cfop.json
+- lib/brazilian-utils/data/cnae.json
+- lib/brazilian-utils/data/csosn.json
+- lib/brazilian-utils/data/cst.json
+- lib/brazilian-utils/data/legal_nature.json
 - lib/brazilian-utils/data/legal_process_ids.json
+- lib/brazilian-utils/data/municipalities.json
+- lib/brazilian-utils/data/ncm.json
+- lib/brazilian-utils/data/states.json
 - lib/brazilian-utils/date-utils.rb
 - lib/brazilian-utils/email-utils.rb
+- lib/brazilian-utils/iban-utils.rb
+- lib/brazilian-utils/ie-utils.rb
 - lib/brazilian-utils/legal-nature-utils.rb
 - lib/brazilian-utils/legal-process-utils.rb
 - lib/brazilian-utils/license-plate-utils.rb
+- lib/brazilian-utils/municipality-utils.rb
+- lib/brazilian-utils/ncm-utils.rb
+- lib/brazilian-utils/nfe-key-utils.rb
+- lib/brazilian-utils/number-utils.rb
+- lib/brazilian-utils/passport-utils.rb
 - lib/brazilian-utils/phone-utils.rb
 - lib/brazilian-utils/pis-utils.rb
+- lib/brazilian-utils/pix-key-utils.rb
+- lib/brazilian-utils/pix-payload-utils.rb
+- lib/brazilian-utils/registro-profissional-utils.rb
 - lib/brazilian-utils/renavam-utils.rb
+- lib/brazilian-utils/state-utils.rb
+- lib/brazilian-utils/text-utils.rb
+- lib/brazilian-utils/vin-utils.rb
 - lib/brazilian-utils/voter-id-utils.rb
 homepage: https://github.com/brazilian-utils/ruby
 licenses: