cpf_cnpj_tools 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b334d9f2cd553e996b9146601f3a3cafed9108379c716c4fb087ed2d5ae1472
-  data.tar.gz: e6631210c24a518bdac6493147bf3e47ce6f0eaf54ed0b405138cad48fa7bca1
+  metadata.gz: 960e2816d23cd9e748a8b09c2c9938b1528b68659e9e278d2a9b521428701b68
+  data.tar.gz: 211d39ed878ae4417c0b242dc42d6db1e8e94c55c3b95859a9729e79d9db266b
 SHA512:
-  metadata.gz: c7abd8c9649f3b3f8a485edf164b397449d5f5f2fd6b5dc1b320bbeddab48faa3a4790ad04d48284f87f1be22b677f96f4e2604ae1754c426f8e08615976047a
-  data.tar.gz: '08c10b9bd37f4441946100f8a1ba21e25ead5aacd5037d415b440f526ce381d11fd413a72204d79766e85366711ebc45135d90aad7f278d227d4416ef1961be4'
+  metadata.gz: c2b1e1db0a91f2eac6a68f9d8c14364096c6e1d4b35c43b6d22b81ed295428e6483e702da84630553b0ec36cfc9c9b83960ff94f525e28470a0cd59a83a3eb19
+  data.tar.gz: f8f44be528bdd50da122e62d8a61ca4d763ae1a2bf614c06ff80fb25885aa1fbb2790ca6b290cfcb2318a3bdb1d5466a2d4701df534406fa42e45e4a080f17ee

data/.rubocop.yml

@@ -20,7 +20,10 @@ Lint/ScriptPermission:
   Enabled: False
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 
 Metrics/ClassLength:
-  Max: 120
+  Max: 150
+
+Metrics/AbcSize:
+  Enabled: false

data/README.md

@@ -1,5 +1,8 @@
 # CpfCnpjTools
 
+A simple and very efficient Ruby Gem to validate and generate CPF and CNPJ values.
+** It supports the new alphanumeric CNPJ format!!! **
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/cpf_cnpj_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CpfCnpjTools
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end

data/lib/cpf_cnpj_tools.rb

@@ -8,6 +8,15 @@ module CpfCnpjTools
   # Class responsible for generating and
   # validating CPF and CNPJ numbers
   class Generator
+    BLACKLIST_CPF = %w[
+      00000000000 11111111111 22222222222 33333333333 44444444444
+      55555555555 66666666666 77777777777 88888888888 99999999999
+    ].freeze
+
+    REGEX_CPF_FORMATTED = /^\d{3}\.\d{3}\.\d{3}-\d{2}$/.freeze
+    REGEX_CNPJ_FORMATTED = %r{^[A-Za-z0-9]{2}\.[A-Za-z0-9]{3}\.[A-Za-z0-9]{3}/[A-Za-z0-9]{4}-\d{2}$}.freeze
+    REGEX_CNPJ_UNFORMATTED = /^[A-Z0-9]{12}\d{2}$/.freeze
+
     CPF1DIGIT = [10, 9, 8, 7, 6, 5, 4, 3, 2].freeze
     CPF2DIGIT = [11, 10, 9, 8, 7, 6, 5, 4, 3, 2].freeze
     CNPJ1DIGIT = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2].freeze
@@ -18,25 +27,35 @@ module CpfCnpjTools
     # @param {Boolean} formatted
     # @return String
     def generate_cpf(formatted: true)
-      base = generate_base
-      base << generate_identifier(base, true)
-      base << generate_identifier(base, false)
-      return base.join unless formatted
+      # Destructure the two arrays returned by the new generate_base
+      base_chars, base_values = generate_base(cnpj: false)
+
+      # Calculate the verification digits using base_values
+      first_digit = generate_identifier(base_values, true)
+      second_digit = generate_identifier(base_values + [first_digit], false)
+
+      # Combine the characters with the calculated digits
+      result = (base_chars + [first_digit, second_digit]).join
+      return result unless formatted
 
-      format(base.join)
+      format(result)
     end
 
     ##
-    # Method for generating valid CNPJ numbers
+    # Method for generating valid CNPJ numbers (Numeric)
+    # Standard numeric CNPJs remain 100% valid under the new rules.
     # @param {Boolean} formatted
     # @return String
-    def generate_cnpj(formatted: true)
-      base = generate_base(cnpj: true)
-      base << generate_identifier(base, true, cpf: false)
-      base << generate_identifier(base, false, cpf: false)
-      return base.join unless formatted
+    def generate_cnpj(formatted: true, alphanumeric: false)
+      base_chars, base_values = generate_base(cnpj: true, alphanumeric: alphanumeric)
 
-      format(base.join)
+      first_digit = generate_identifier(base_values, true, cpf: false)
+      second_digit = generate_identifier(base_values + [first_digit], false, cpf: false)
+
+      result = (base_chars + [first_digit, second_digit]).join
+      return result unless formatted
+
+      format(result)
     end
 
     ##
@@ -44,28 +63,41 @@ module CpfCnpjTools
     # @param {String, Integer} cpf
     # @return bool
     def cpf_valid?(cpf)
+      unformatted = remove_formatting(cpf.to_s)
+      return false if BLACKLIST_CPF.include?(unformatted)
+
       cpf_array = remove_formatting(cpf.to_s).split("").map!(&:to_i)
+      return false if cpf_array.length != 11
+
       first_digit = cpf_array[-2]
       second_digit = cpf_array[-1]
       base_cpf = cpf_array[0..8]
       calculated_first_digit = generate_identifier(base_cpf, true)
       calculated_second_digit = generate_identifier(base_cpf << calculated_first_digit, false)
+
       return false if (first_digit != calculated_first_digit) || (second_digit != calculated_second_digit)
 
       true
     end
 
     ##
-    # Method for validating CNPJ numbers.
-    # @param {Integer, String} cpf
+    # Method for validating CNPJ numbers (Handles Alphanumeric).
+    # @param {Integer, String} cnpj
     # @return bool
     def cnpj_valid?(cnpj)
-      cnpj_array = remove_formatting(cnpj.to_s).split("").map!(&:to_i)
-      first_digit = cnpj_array[-2]
-      second_digit = cnpj_array[-1]
-      base_cnpj = cnpj_array[0..11]
-      calculated_first_digit = generate_identifier(base_cnpj, true, cpf: false)
-      calculated_second_digit = generate_identifier(base_cnpj << calculated_first_digit, false, cpf: false)
+      unformatted = remove_formatting(cnpj.to_s).upcase
+
+      return false unless unformatted.match?(REGEX_CNPJ_UNFORMATTED)
+
+      cnpj_array = unformatted.chars
+      first_digit = cnpj_array[-2].to_i
+      second_digit = cnpj_array[-1].to_i
+
+      base_cnpj_values = cnpj_array[0..11].map { |char| cnpj_char_to_value(char) }
+
+      calculated_first_digit = generate_identifier(base_cnpj_values, true, cpf: false)
+      calculated_second_digit = generate_identifier(base_cnpj_values + [calculated_first_digit], false, cpf: false)
+
       return false if (first_digit != calculated_first_digit) || (second_digit != calculated_second_digit)
 
       true
@@ -78,20 +110,19 @@ module CpfCnpjTools
     # @return bool
     def formatted?(cpf_or_cnpj)
       number = cpf_or_cnpj.to_s
-      return true if (number =~ /\d{3}\.\d{3}\.\d{3}-\d{2}/) || (number =~ %r{\d{2}\.\d{3}\.\d{3}/0001-\d{2}})
+      return true if number =~ REGEX_CPF_FORMATTED
+      return true if number =~ REGEX_CNPJ_FORMATTED
 
       false
     end
 
     ##
     # Returns an unformatted CPF or CNPJ.
-    # If the value is already unformatted,
-    # the method returns the value passed as argument.
     # @param {String, Integer} cpf_or_cnpj
     # @return String
     def remove_formatting(cpf_or_cnpj)
       unformatted = cpf_or_cnpj.to_s.delete("./-")
-      return unformatted unless unformatted.nil?
+      return unformatted unless unformatted.empty?
 
       cpf_or_cnpj.to_s
     end
@@ -102,12 +133,12 @@ module CpfCnpjTools
     # @return String
     def format(cpf_or_cnpj)
       if cpf_valid?(cpf_or_cnpj)
-        cpf = cpf_or_cnpj.to_s.dup
+        cpf = remove_formatting(cpf_or_cnpj).dup
         cpf.insert(3, ".")
            .insert(7, ".")
            .insert(-3, "-")
       elsif cnpj_valid?(cpf_or_cnpj)
-        cnpj = cpf_or_cnpj.to_s.dup
+        cnpj = remove_formatting(cpf_or_cnpj).upcase.dup
         cnpj.insert(2, ".")
             .insert(6, ".")
             .insert(10, "/")
@@ -135,31 +166,48 @@ module CpfCnpjTools
     # @param {Integer} number
     # @param {bool} formatted
     # @return {Array[String]}
-    def generate_array_of_cnpj(number, formatted: true)
+    def generate_array_of_cnpj(number, formatted: true, alphanumeric: false)
       array = []
       number.times do
-        array << generate_cnpj(formatted: formatted)
+        array << generate_cnpj(formatted: formatted, alphanumeric: alphanumeric)
       end
       array
     end
 
     private
 
+    ##
+    # Converts a character to its mathematical value for CNPJ calculation.
+    # Numbers retain face value. Letters use ASCII value - 48.
+    # @param char (String)
+    # @return Integer
+    def cnpj_char_to_value(char)
+      char.match?(/[A-Z]/) ? char.ord - 48 : char.to_i
+    end
+
     ##
     # Generate the first numbers of CPF/CNPJ
     # randomly.
     # @param cnpj (Boolean)
     # @return (Array)
-    def generate_base(cnpj: false)
-      base_number = []
-      9.times do
-        base_number << rand(10)
-      end
+    def generate_base(cnpj: false, alphanumeric: false)
+      pool = ("0".."9").to_a
+      pool += ("A".."Z").to_a if alphanumeric
+
+      base_chars = []
+
       if cnpj
-        base_number.delete_at(-1)
-        base_number.push 0, 0, 0, 1
+        8.times { base_chars << pool.sample }
+        4.times { base_chars << pool.sample }
+      else
+        9.times { base_chars << rand(10).to_s }
       end
-      base_number
+
+      base_values = base_chars.map do |char|
+        char.match?(/[A-Z]/) ? char.ord - 48 : char.to_i
+      end
+
+      [base_chars, base_values]
     end
 
     ##

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cpf_cnpj_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Aria Diniz
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: With this tool you will be able to generate and validate brazilian CPF
   and CNPJ numbers.
@@ -37,7 +36,6 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/cpf_cnpj_tools
   homepage_uri: https://github.com/ariasdiniz/cpf_cnpj_tools
   source_code_uri: https://github.com/ariasdiniz/cpf_cnpj_tools
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A tool for generating and validating CPF/CNPJ numbers
 test_files: []