cpf_cnpj_tools 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d9d6635470921bf186a6348efe25fa7ee27c724be249310355e5f1c37a229b
-  data.tar.gz: 3ae4d8e0bf686a9b749728cdc2b246b52a5b2c21459b2401c9d0e135c66aa564
+  metadata.gz: 0b334d9f2cd553e996b9146601f3a3cafed9108379c716c4fb087ed2d5ae1472
+  data.tar.gz: e6631210c24a518bdac6493147bf3e47ce6f0eaf54ed0b405138cad48fa7bca1
 SHA512:
-  metadata.gz: b7ee4d37f9949766db7d72586394badfb74dc28bea3f04396dd5624e775ae1db2621fdf1f25f88dbc2b2c26ac765a1418ce313efd8c12e34dd328710db094424
-  data.tar.gz: 95f4e0df9235d19681183db299c24b1c75b3e309b175a3b79e2c209391c76314fd261139ba1530f506feedd2be18530911b01f268c218859e68072cec0e82131
+  metadata.gz: c7abd8c9649f3b3f8a485edf164b397449d5f5f2fd6b5dc1b320bbeddab48faa3a4790ad04d48284f87f1be22b677f96f4e2604ae1754c426f8e08615976047a
+  data.tar.gz: '08c10b9bd37f4441946100f8a1ba21e25ead5aacd5037d415b440f526ce381d11fd413a72204d79766e85366711ebc45135d90aad7f278d227d4416ef1961be4'

data/.rubocop.yml

@@ -1,22 +1,26 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Style/EndOfLine:
-  Enabled: False
-
-Lint/ScriptPermission:
-  Enabled: False
-
-Metrics/MethodLength:
-  Max: 15
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/EndOfLine:
+  Enabled: False
+
+Lint/ScriptPermission:
+  Enabled: False
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 120

data/CHANGELOG.md

@@ -1,9 +1,13 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-10-11
-
-- Initial release
-
-## [0.2.0] - 2022-10-12
-
-- Adding formatation methods
+## [Unreleased]
+
+## [0.1.0] - 2022-10-11
+
+- Initial release
+
+## [0.2.0] - 2022-10-12
+
+- Adding formatation methods
+
+## [0.2.1] - 2022-10-12
+
+- Adding gem dependencies to gemspec

data/README.md

@@ -1,40 +1,40 @@
-# CpfCnpjTools
-
-## Installation
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add cpf_cnpj_tools
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install cpf_cnpj_tools
-
-## Usage
-
-For usage, import the gem and create a new instance of it:
-
-```ruby
-require "cpf_cnpj_tools"
-
-generate = CpfCnpjTools::Generator.new
-
-puts generate.generate_cpf # returns a valid CPF
-puts generate.generate_cnpj # returns a valid cnpj
-puts generate.cpf_valid?("999999900") # validate returning true or false
-puts generate.cnpj_valid?("99999999000100") # validate returning true or false
-puts generate.formatted?("99999999900") # validate if cpf/cnpj is formatted returning true or false
-puts generate.format("16255648800") # return the formatted cpf/cnpj. Ex: 162.556.488-00
-```
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ariasdiniz/cpf_cnpj_tools. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ariasdiniz/cpf_cnpj_tools/blob/main/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the CpfCnpjTools project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ariasdiniz/cpf_cnpj_tools/blob/main/CODE_OF_CONDUCT.md).
+# CpfCnpjTools
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cpf_cnpj_tools
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cpf_cnpj_tools
+
+## Usage
+
+For usage, import the gem and create a new instance of it:
+
+```ruby
+require "cpf_cnpj_tools"
+
+generate = CpfCnpjTools::Generator.new
+
+puts generate.generate_cpf(formatted: false) # returns a valid CPF
+puts generate.generate_cnpj(formatted: false) # returns a valid cnpj
+puts generate.cpf_valid?("999999900") # validate returning true or false
+puts generate.cnpj_valid?("99999999000100") # validate returning true or false
+puts generate.formatted?("99999999900") # validate if cpf/cnpj is formatted returning true or false
+puts generate.format("16255648800") # return the formatted cpf/cnpj. Ex: 162.556.488-00
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ariasdiniz/cpf_cnpj_tools. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ariasdiniz/cpf_cnpj_tools/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CpfCnpjTools project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ariasdiniz/cpf_cnpj_tools/blob/main/CODE_OF_CONDUCT.md).

data/lib/cpf_cnpj_tools/version.rb

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

data/lib/cpf_cnpj_tools.rb

@@ -1,165 +1,202 @@
-# frozen_string_literal: true
-
-require_relative "cpf_cnpj_tools/version"
-require_relative "invalid_cpf_cnpj_format_exception"
-
-module CpfCnpjTools
-  ##
-  # Class responsible for generating and
-  # validating CPF and CNPJ numbers
-  class Generator
-    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
-    CNPJ2DIGIT = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2].freeze
-
-    ##
-    # Method for generating valid CPF numbers
-    # @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
-
-      format(base.join)
-    end
-
-    ##
-    # Method for generating valid CNPJ numbers
-    # @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
-
-      format(base.join)
-    end
-
-    ##
-    # Method for validating CPF numbers.
-    # @param cpf (String, Integer)
-    # @return Boolean
-    def cpf_valid?(cpf)
-      cpf_array = remove_formatting(cpf.to_s).split("").map!(&:to_i)
-      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 cnpj (String, Integer)
-    # @return Boolean
-    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)
-      return false if (first_digit != calculated_first_digit) || (second_digit != calculated_second_digit)
-
-      true
-    end
-
-    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}})
-
-      false
-    end
-
-    ##
-    # Returns an unformatted CPF or CNPJ.
-    # If the value is already unformatted,
-    # the method returns the value passed as argument.
-    # @param cpf_or_cnpj (String, Integer)
-    # @return String
-    def remove_formatting(cpf_or_cnpj)
-      unformatted = cpf_or_cnpj.to_s.delete("./-")
-      return unformatted unless unformatted.nil?
-
-      cpf_or_cnpj.to_s
-    end
-
-    def format(cpf_or_cnpj)
-      if cpf_valid?(cpf_or_cnpj)
-        cpf = cpf_or_cnpj.to_s.dup
-        cpf.insert(3, ".")
-           .insert(7, ".")
-           .insert(-3, "-")
-      elsif cnpj_valid?(cpf_or_cnpj)
-        cnpj = cpf_or_cnpj.to_s.dup
-        cnpj.insert(2, ".")
-            .insert(6, ".")
-            .insert(10, "/")
-            .insert(-3, "-")
-      else
-        raise InvalidCpfCnpjFormatError
-      end
-    end
-
-    private
-
-    ##
-    # 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
-      if cnpj
-        base_number.delete_at(-1)
-        base_number.push 0, 0, 0, 1
-      end
-      base_number
-    end
-
-    ##
-    # Generate the first and second identifier numbers
-    # of the CPF/CNPJ.
-    # @param first_numbers (Array)
-    # @param first (Boolean)
-    # @param cpf (Boolean)
-    # @return Integer
-    def generate_identifier(first_numbers, first, cpf: true)
-      multipliers = if cpf
-                      first ? CPF1DIGIT : CPF2DIGIT
-                    else
-                      first ? CNPJ1DIGIT : CNPJ2DIGIT
-                    end
-      product = []
-      first_numbers.length.times do |index|
-        product << first_numbers[index] * multipliers[index]
-      end
-      generate_valid_digit(product)
-    end
-
-    ##
-    # Calculates the value of a valid identifier digit.
-    # @param digits (Array)
-    # @return Integer
-    def generate_valid_digit(digits)
-      sum = 0
-      digits.each do |item|
-        sum += item
-      end
-      remainder = sum % 11
-      if remainder < 2
-        0
-      else
-        11 - remainder
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative "cpf_cnpj_tools/version"
+require_relative "invalid_cpf_cnpj_format_exception"
+
+module CpfCnpjTools
+  ##
+  # Class responsible for generating and
+  # validating CPF and CNPJ numbers
+  class Generator
+    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
+    CNPJ2DIGIT = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+    ##
+    # Method for generating valid CPF numbers
+    # @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
+
+      format(base.join)
+    end
+
+    ##
+    # Method for generating valid CNPJ numbers
+    # @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
+
+      format(base.join)
+    end
+
+    ##
+    # Method for validating CPF numbers.
+    # @param {String, Integer} cpf
+    # @return bool
+    def cpf_valid?(cpf)
+      cpf_array = remove_formatting(cpf.to_s).split("").map!(&:to_i)
+      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
+    # @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)
+      return false if (first_digit != calculated_first_digit) || (second_digit != calculated_second_digit)
+
+      true
+    end
+
+    ##
+    # Return true if the CPF/CNPJ is formatted.
+    # Return false if not.
+    # @param {String, Integer} cpf_or_cnpj
+    # @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}})
+
+      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?
+
+      cpf_or_cnpj.to_s
+    end
+
+    ##
+    # Returns a String containing a formatted CPF/CNPJ.
+    # @param {String, Integer} cpf_or_cnpj
+    # @return String
+    def format(cpf_or_cnpj)
+      if cpf_valid?(cpf_or_cnpj)
+        cpf = cpf_or_cnpj.to_s.dup
+        cpf.insert(3, ".")
+           .insert(7, ".")
+           .insert(-3, "-")
+      elsif cnpj_valid?(cpf_or_cnpj)
+        cnpj = cpf_or_cnpj.to_s.dup
+        cnpj.insert(2, ".")
+            .insert(6, ".")
+            .insert(10, "/")
+            .insert(-3, "-")
+      else
+        raise InvalidCpfCnpjFormatError
+      end
+    end
+
+    ##
+    # Returns an array of valid random generated CPF numbers
+    # @param {Integer} number
+    # @param {bool} formatted
+    # @return {Array[String]}
+    def generate_array_of_cpf(number, formatted: true)
+      array = []
+      number.times do
+        array << generate_cpf(formatted: formatted)
+      end
+      array
+    end
+
+    ##
+    # Returns an array of valid random generated CNPJ numbers
+    # @param {Integer} number
+    # @param {bool} formatted
+    # @return {Array[String]}
+    def generate_array_of_cnpj(number, formatted: true)
+      array = []
+      number.times do
+        array << generate_cnpj(formatted: formatted)
+      end
+      array
+    end
+
+    private
+
+    ##
+    # 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
+      if cnpj
+        base_number.delete_at(-1)
+        base_number.push 0, 0, 0, 1
+      end
+      base_number
+    end
+
+    ##
+    # Generate the first and second identifier numbers
+    # of the CPF/CNPJ.
+    # @param first_numbers (Array)
+    # @param first (Boolean)
+    # @param cpf (Boolean)
+    # @return Integer
+    def generate_identifier(first_numbers, first, cpf: true)
+      multipliers = if cpf
+                      first ? CPF1DIGIT : CPF2DIGIT
+                    else
+                      first ? CNPJ1DIGIT : CNPJ2DIGIT
+                    end
+      product = []
+      first_numbers.length.times do |index|
+        product << first_numbers[index] * multipliers[index]
+      end
+      generate_valid_digit(product)
+    end
+
+    ##
+    # Calculates the value of a valid identifier digit.
+    # @param digits (Array)
+    # @return Integer
+    def generate_valid_digit(digits)
+      sum = 0
+      digits.each do |item|
+        sum += item
+      end
+      remainder = sum % 11
+      if remainder < 2
+        0
+      else
+        11 - remainder
+      end
+    end
+  end
+end

data/lib/invalid_cpf_cnpj_format_exception.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: true
-
-##
-# Error raised when trying to format
-# an invalid CPF or CNPJ.
-class InvalidCpfCnpjFormatError < StandardError
-  def initialize(msg = "Invalid CPF or CNPJ.")
-    super
-  end
-end
+# frozen_string_literal: true
+
+##
+# Error raised when trying to format
+# an invalid CPF or CNPJ.
+class InvalidCpfCnpjFormatError < StandardError
+  def initialize(msg = "Invalid CPF or CNPJ.")
+    super
+  end
+end

data/sig/cpf_cnpj_tools/generator.rbs

@@ -0,0 +1,24 @@
+module CpfCnpjTools
+  class Generator
+    CNPJ1DIGIT: Array[Integer]
+    CNPJ2DIGIT: Array[Integer]
+    CPF1DIGIT: Array[Integer]
+    CPF2DIGIT: Array[Integer]
+
+    def cnpj_valid?: -> bool
+
+    def cpf_valid?: -> bool
+
+    def formatted?: -> bool
+
+    def generate_array_of_cnpj: -> Array[String]
+
+    def generate_array_of_cpf: -> Array[String]
+
+    def generate_cnpj: -> String
+
+    def generate_cpf: -> String
+
+    def remove_formatting: -> String
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpf_cnpj_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Aria Diniz
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2023-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.
@@ -25,11 +25,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- cpf_cnpj_tools.gemspec
 - lib/cpf_cnpj_tools.rb
 - lib/cpf_cnpj_tools/version.rb
 - lib/invalid_cpf_cnpj_format_exception.rb
 - sig/cpf_cnpj_tools.rbs
+- sig/cpf_cnpj_tools/generator.rbs
 homepage: https://github.com/ariasdiniz/cpf_cnpj_tools
 licenses:
 - MIT
@@ -37,7 +37,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: A tool for generating and validating CPF/CNPJ numbers
 test_files: []

data/cpf_cnpj_tools.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/cpf_cnpj_tools/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "cpf_cnpj_tools"
-  spec.version = CpfCnpjTools::VERSION
-  spec.authors = ["Aria Diniz"]
-  spec.email = ["aria.diniz.dev@gmail.com"]
-
-  spec.summary = "A tool for generating and validating CPF/CNPJ numbers"
-  spec.description = "With this tool you will be able to generate and validate brazilian CPF and CNPJ numbers."
-  spec.homepage = "https://github.com/ariasdiniz/cpf_cnpj_tools"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6"
-
-  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/cpf_cnpj_tools"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/ariasdiniz/cpf_cnpj_tools"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end