cpf_cnpj 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 060f6cfefb56f74570849d75281ab0f5d00fe500
-  data.tar.gz: 52d7c441db65b19ce5175aa82c168a670e708f06
+SHA256:
+  metadata.gz: d7b0bd493ddd22ed0ebe7128fd0e8dc17c8ff15bfb1209300e1ce60ae03b2c6b
+  data.tar.gz: c2f7a21d000907e8779790d8b72ce6177b58ddaa2fb0f369941d3e3d1989eae1
 SHA512:
-  metadata.gz: 21a524afa4993d82d12b1abe9ee15f957a786acf5ba89704dc5916f35946e475d50842ce40f78e56bd979c4ec66afdd90376da8d011b28e41e5203a31e8a5530
-  data.tar.gz: 9c25eb4c0c480eb29b040b8595d1b1a9b9e768f21dd689f4c24adc0b4f22be4051624013398a4259c400985c1f843e7a35859681409b0b3a9205f0f8f53866e5
+  metadata.gz: b58f3e8547dda2131b290a4db50c0c84da0ccaf266ebd241cef0d34e43eb935d0e31d1310185749f9a929d19db01136484d1b54bbb1abb9c41d351409c6b685b
+  data.tar.gz: 3d62c15ab2f3b0be301a55a5328368bcca1ccf1d2b453c3e28c01fa868dc10c403690b2ee2d33cd0bba375271a8a20b2415a77f477d3c3d2b941fad4049f8417

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+other: ["https://paypal.me/nandovieira/🍕"]
+github: [fnando]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,47 @@
+---
+name: ruby-tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request_target:
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }}
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        run: |
+          bundle exec rake

data/.rubocop.yml

@@ -1,59 +1,13 @@
-AllCops:
-  TargetRubyVersion: 2.3
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
 
-  Include:
-    - '**/*.gemspec'
-    - '**/*.podspec'
-    - '**/*.jbuilder'
-    - '**/*.rake'
-    - '**/*.opal'
-    - '**/config.ru'
-    - '**/Gemfile'
-    - '**/Rakefile'
-    - '**/Capfile'
-    - '**/Guardfile'
-    - '**/Podfile'
-    - '**/Thorfile'
-    - '**/Vagrantfile'
-    - '**/Berksfile'
-    - '**/Cheffile'
-    - '**/Vagabondfile'
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
 
-Style/Documentation:
+Style/OptionalBooleanParameter:
   Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Layout/SpaceInsideBlockBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: space
-  SpaceBeforeBlockParameters: false
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-  EnforcedStyleForEmptyBraces: no_space
-
-Layout/FirstArrayElementLineBreak:
-  Enabled: true
-
-Layout/FirstHashElementLineBreak:
-  Enabled: true
-
-Style/SymbolArray:
-  Enabled: true
-
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%':  '[]'
-    '%i': '[]'
-    '%q': '[]'
-    '%Q': '[]'
-    '%r': '[]'
-    '%s': '[]'
-    '%w': '[]'
-    '%W': '[]'
-    '%x': '[]'
-
-Metrics/LineLength:
-  Max: 100

data/README.md

@@ -1,14 +1,19 @@
 # CPF/CNPJ
 
-[![Build Status](https://travis-ci.org/fnando/cpf_cnpj.svg)](https://travis-ci.org/fnando/cpf_cnpj)
-[![Code Climate](https://codeclimate.com/github/fnando/cpf_cnpj/badges/gpa.svg)](https://codeclimate.com/github/fnando/cpf_cnpj)
-[![Gem Version](https://badge.fury.io/rb/cpf_cnpj.svg)](http://badge.fury.io/rb/cpf_cnpj)
+[![Tests](https://github.com/fnando/cpf_cnpj/workflows/ruby-tests/badge.svg)](https://github.com/fnando/cpf_cnpj)
+[![Gem](https://img.shields.io/gem/v/cpf_cnpj.svg)](https://rubygems.org/gems/cpf_cnpj)
+[![Gem](https://img.shields.io/gem/dt/cpf_cnpj.svg)](https://rubygems.org/gems/cpf_cnpj)
 
-This gem does some [CPF](http://en.wikipedia.org/wiki/Cadastro_de_Pessoas_F%C3%ADsicas)/[CNPJ](http://en.wikipedia.org/wiki/CNPJ) magic. It allows you to create, validate and format CPF/CNPJ, even through the command-line.
+This gem does some
+[CPF](http://en.wikipedia.org/wiki/Cadastro_de_Pessoas_F%C3%ADsicas)/[CNPJ](http://en.wikipedia.org/wiki/CNPJ)
+magic. It allows you to create, validate and format CPF/CNPJ, even through the
+command-line.
 
-Just making my life easier when filling these damn numbers on internet bankings and government sites.
+Just making my life easier when filling these damn numbers on internet bankings
+and government sites.
 
-For ActiveModel/ActiveRecord validations, please check <https://github.com/fnando/validators>.
+For ActiveModel/ActiveRecord validations, please check
+<https://github.com/fnando/validators>.
 
 ## Installation
 
@@ -28,24 +33,29 @@ Or install it yourself as:
 
 ### Ruby API
 
-This library has the same API for both CNPJ/CPF, so only one of them is documented below.
+This library has the same API for both CNPJ/CPF, so only one of them is
+documented below.
 
 ```ruby
 require "cpf_cnpj"
 
-CPF.valid?(number)    # Check if a CPF is valid
-CPF.generate          # Generate a random CPF number
-CPF.generate(true)    # Generate a formatted number
+CPF.format(number)            # Format CPF (xxx.xxx.xxx-xx)
+CPF.valid?(number)            # Check if a CPF is valid
+CPF.generate                  # Generate a random CPF number
+CPF.generate(true)            # Generate a formatted number
 
 cpf = CPF.new(number)
-cpf.formatted         # Return formatted CPF (xxx.xxx.xxx-xx)
-cpf.stripped          # Return stripped CPF (xxxxxxxxxxx)
-cpf.valid?            # Check if CPF is valid
+cpf.formatted                 # Return formatted CPF (xxx.xxx.xxx-xx)
+cpf.stripped                  # Return stripped CPF (xxxxxxxxxxx)
+cpf.valid?                    # Check if CPF is valid
+cpf.number_without_verifier   # Return CPF without verifier digits
 ```
 
 #### Strict Validation
 
-By default, validations will strip any characters that aren't numbers. This means that `532#####820------857\n96` is considered a valid number. To perform a strict validation use `strict: true`.
+By default, validations will strip any characters that aren't numbers. This
+means that `532#####820------857\n96` is considered a valid number. To perform a
+strict validation use `strict: true`.
 
 ```ruby
 CPF.valid?(number, strict: true)

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -10,4 +11,6 @@ Rake::TestTask.new(:test) do |t|
   t.warning = false
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/cnpj

@@ -3,4 +3,4 @@
 
 $LOAD_PATH.unshift "#{__dir__}/../lib"
 require "cpf_cnpj"
-CpfCnpj::CLI.new(CNPJ, ARGV, STDIN, STDOUT, STDERR).start
+CpfCnpj::CLI.new(CNPJ, ARGV, $stdin, $stdout, $stderr).start

data/bin/cpf

@@ -3,4 +3,4 @@
 
 $LOAD_PATH.unshift "#{__dir__}/../lib"
 require "cpf_cnpj"
-CpfCnpj::CLI.new(CPF, ARGV, STDIN, STDOUT, STDERR).start
+CpfCnpj::CLI.new(CPF, ARGV, $stdin, $stdout, $stderr).start

data/cpf_cnpj.gemspec

@@ -2,20 +2,27 @@
 
 require "./lib/cpf_cnpj/version"
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Nando Vieira"]
-  gem.email         = ["fnando.vieira@gmail.com"]
-  gem.description   = "Validate, generate and format CPF/CNPJ numbers. Include command-line tools."
-  gem.summary       = gem.description
+Gem::Specification.new do |spec|
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.description   = "Validate, generate and format CPF/CNPJ numbers. " \
+                       "Include command-line tools."
+  spec.summary       = spec.description
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.homepage = "https://github.com/fnando/cpf_cnpj"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
 
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r[^bin/]).map {|f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r[^(test|spec|features)/])
-  gem.name          = "cpf_cnpj"
-  gem.require_paths = ["lib"]
-  gem.version       = CPF::VERSION
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}).map {|f| File.basename(f) }
+  spec.name          = "cpf_cnpj"
+  spec.require_paths = ["lib"]
+  spec.version       = CPF::VERSION
 
-  gem.add_development_dependency "pry-meta"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
 end

data/lib/cnpj/formatter.rb

@@ -2,11 +2,12 @@
 
 class CNPJ
   class Formatter
-    STRICT_REGEX = %r[[/.-]]
-    LOOSE_REGEX = /[^\d]/
+    STRICT_REGEX = %r{[/.-]}.freeze
+    LOOSE_REGEX = /[^\d]/.freeze
 
     def self.format(number)
-      strip(number).gsub(/\A(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})\Z/, "\\1.\\2.\\3/\\4-\\5")
+      strip(number)
+        .gsub(/\A(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})\Z/, "\\1.\\2.\\3/\\4-\\5")
     end
 
     def self.strip(number, strict = false)

data/lib/cnpj/verifier_digit.rb

@@ -6,7 +6,7 @@ class CNPJ
       index = 2
 
       sum = numbers.reverse.reduce(0) do |buffer, number|
-        (buffer + number * index).tap do
+        (buffer + (number * index)).tap do
           index = index == 9 ? 2 : index + 1
         end
       end

data/lib/cnpj.rb

@@ -5,14 +5,13 @@ class CNPJ
   require "cnpj/formatter"
   require "cnpj/verifier_digit"
 
-  attr_reader :number
-  attr_reader :strict
+  attr_reader :number, :strict
 
-  REGEX = %r[\A\d{2}\.\d{3}.\d{3}/\d{4}-\d{2}\Z]
-  VALIDATION_SIZE_REGEX = /^\d{14}$/
+  REGEX = %r[\A\d{2}\.\d{3}.\d{3}/\d{4}-\d{2}\Z].freeze
+  VALIDATION_SIZE_REGEX = /^\d{14}$/.freeze
   NUMBER_SIZE = 12
 
-  BLACKLIST = %w[
+  DENYLIST = %w[
     00000000000000
     11111111111111
     22222222222222
@@ -25,6 +24,10 @@ class CNPJ
     99999999999999
   ].freeze
 
+  def self.format(number)
+    new(number).formatted
+  end
+
   def self.valid?(number, strict: false)
     new(number, strict).valid?
   end
@@ -56,19 +59,30 @@ class CNPJ
   end
 
   def valid?
-    return unless stripped =~ VALIDATION_SIZE_REGEX
-    return if BLACKLIST.include?(stripped)
+    if strict && !(number.match?(REGEX) || number.match?(VALIDATION_SIZE_REGEX))
+      return false
+    end
+
+    return false unless stripped.match?(VALIDATION_SIZE_REGEX)
+    return false if DENYLIST.include?(stripped)
 
-    digits = numbers[0...12]
+    digits = numbers[0...NUMBER_SIZE]
     digits << VerifierDigit.generate(digits)
     digits << VerifierDigit.generate(digits)
 
     digits[-2, 2] == numbers[-2, 2]
   end
 
-  private
+  def ==(other)
+    super || (other.instance_of?(self.class) && other.stripped == stripped)
+  end
+  alias eql? ==
+
+  def number_without_verifier
+    numbers[0...NUMBER_SIZE].join
+  end
 
-  def numbers
+  private def numbers
     @numbers ||= stripped.each_char.to_a.map(&:to_i)
   end
 end

data/lib/cpf/formatter.rb

@@ -2,8 +2,8 @@
 
 class CPF
   class Formatter
-    STRICT_REGEX = /[.-]/
-    LOOSE_REGEX = /[^\d]/
+    STRICT_REGEX = /[.-]/.freeze
+    LOOSE_REGEX = /[^\d]/.freeze
 
     def self.format(number)
       strip(number).gsub(/\A(\d{3})(\d{3})(\d{3})(\d{2})\Z/, "\\1.\\2.\\3-\\4")

data/lib/cpf/verifier_digit.rb

@@ -9,7 +9,7 @@ class CPF
         number * (modulus - index)
       end
 
-      mod = multiplied.reduce(:+) % 11
+      mod = multiplied.sum % 11
       mod < 2 ? 0 : 11 - mod
     end
   end

data/lib/cpf.rb

@@ -5,14 +5,13 @@ class CPF
   require "cpf/formatter"
   require "cpf/verifier_digit"
 
-  attr_reader :number
-  attr_reader :strict
+  attr_reader :number, :strict
 
-  REGEX = /\A\d{3}\.\d{3}\.\d{3}-\d{2}\Z/
-  VALIDATION_SIZE_REGEX = /^[0-9]{11}$/
+  REGEX = /\A\d{3}\.\d{3}\.\d{3}-\d{2}\Z/.freeze
+  VALIDATION_SIZE_REGEX = /^\d{11}$/.freeze
   NUMBER_SIZE = 9
 
-  BLACKLIST = %w[
+  DENYLIST = %w[
     00000000000
     11111111111
     22222222222
@@ -24,9 +23,12 @@ class CPF
     88888888888
     99999999999
     12345678909
-    01234567890
   ].freeze
 
+  def self.format(number)
+    new(number).formatted
+  end
+
   def self.valid?(number, strict: false)
     new(number, strict).valid?
   end
@@ -58,19 +60,30 @@ class CPF
   end
 
   def valid?
-    return unless stripped =~ VALIDATION_SIZE_REGEX
-    return if BLACKLIST.include?(stripped)
+    if strict && !(number.match?(REGEX) || number.match?(VALIDATION_SIZE_REGEX))
+      return false
+    end
+
+    return false unless stripped.match?(VALIDATION_SIZE_REGEX)
+    return false if DENYLIST.include?(stripped)
 
-    digits = numbers[0...9]
+    digits = numbers[0...NUMBER_SIZE]
     digits << VerifierDigit.generate(digits)
     digits << VerifierDigit.generate(digits)
 
     digits[-2, 2] == numbers[-2, 2]
   end
 
-  private
+  def number_without_verifier
+    numbers[0...NUMBER_SIZE].join
+  end
+
+  def ==(other)
+    super || (other.instance_of?(self.class) && other.stripped == stripped)
+  end
+  alias eql? ==
 
-  def numbers
+  private def numbers
     @numbers ||= stripped.each_char.to_a.map(&:to_i)
   end
 end

data/lib/cpf_cnpj/cli.rb

@@ -24,7 +24,6 @@ module CpfCnpj
       @options ||= {}
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def process_command
       opts.banner = "Usage: #{bin_name} [options] [#{document_name} number]"
       opts.separator ""
@@ -58,7 +57,6 @@ module CpfCnpj
       opts.parse!(arguments)
       opts.permute!(arguments)
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def input
       stdin.tty? ? arguments.first : stdin.read
@@ -77,6 +75,7 @@ module CpfCnpj
 
     def validate(document)
       return if document.valid?
+
       stderr << "Error: Invalid number\n"
       exit 1
     end

data/lib/cpf_cnpj/generator.rb

@@ -2,13 +2,13 @@
 
 module CpfCnpj
   class Generator
-    NUMBERS = [*0..9].freeze
+    NUMBERS = Array(0..9).freeze
 
     def self.generate(size, verifier_digit_generator)
       numbers = Array.new(size) { NUMBERS.sample }
       numbers << verifier_digit_generator.generate(numbers)
       numbers << verifier_digit_generator.generate(numbers)
-      numbers.join("")
+      numbers.join
     end
   end
 end

data/lib/cpf_cnpj/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module CpfCnpj
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end
 
 class CPF

data/test/cnpj/cli_test.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module CNPJCli
+  class CheckTest < Minitest::Test
+    include RunCommand
+
+    %w[-c --check].each do |switch|
+      test "checks if provided number is valid [using #{switch}]" do
+        exit_status, stdout = run_command([switch, "54550752000155"])
+
+        assert_equal 0, exit_status
+        assert_equal "", stdout
+      end
+
+      test "outputs error if provided number is invalid [using #{switch}]" do
+        exit_status, _, stderr = run_command([switch, "invalid"])
+
+        assert_equal 1, exit_status
+        assert_includes stderr, "Error: Invalid number"
+      end
+    end
+  end
+
+  class HelpTest < Minitest::Test
+    include RunCommand
+
+    %w[-h --help].each do |switch|
+      test "outputs help [using #{switch}]" do
+        exit_status, _, stderr = run_command([switch])
+
+        assert_equal 1, exit_status
+        assert_includes stderr, "Usage: cnpj"
+      end
+    end
+
+    test "outputs help on tail" do
+      exit_status, _, stderr = run_command([])
+
+      assert_equal 1, exit_status
+      assert_includes stderr, "Usage: cnpj"
+    end
+  end
+
+  class VersionTest < Minitest::Test
+    include RunCommand
+
+    %w[-v --version].each do |switch|
+      test "outputs version [using #{switch}]" do
+        exit_status, stdout = run_command([switch])
+
+        assert_equal 0, exit_status
+        assert_includes stdout, CNPJ::VERSION.to_s
+      end
+    end
+  end
+
+  class GenerateTest < Minitest::Test
+    include RunCommand
+
+    %w[-g --generate].each do |switch|
+      test "generates number [using #{switch}]" do
+        exit_status, stdout = run_command([switch])
+
+        assert_equal 0, exit_status
+        assert_match CNPJ::REGEX, stdout
+      end
+    end
+
+    test "generates stripped number" do
+      exit_status, stdout = run_command(["-gs"])
+
+      assert_equal 0, exit_status
+      assert_match(/\A\d{14}\Z/, stdout)
+    end
+  end
+
+  class FormatTest < Minitest::Test
+    include RunCommand
+
+    %w[-f --format].each do |switch|
+      test "formats argument [using #{switch}]" do
+        exit_status, stdout = run_command([switch, "54550752000155"])
+
+        assert_equal 0, exit_status
+        assert_includes stdout, "54.550.752/0001-55"
+      end
+    end
+
+    test "formats argument using stdin" do
+      exit_status, stdout = run_command(["--format"], input: "54550752000155")
+
+      assert_equal 0, exit_status
+      assert_includes stdout, "54.550.752/0001-55"
+    end
+
+    test "fails when providing invalid number" do
+      exit_status, _, stderr = run_command(["--format", "invalid"])
+
+      assert_equal 1, exit_status
+      assert_includes stderr, "Error: Invalid number"
+    end
+
+    test "fails when not providing a number" do
+      exit_status, _, stderr = run_command(["--format"])
+
+      assert_equal 1, exit_status
+      assert_includes stderr, "Error: Invalid number"
+    end
+  end
+end

data/test/{unit/cnpj → cnpj}/formatter_test.rb

@@ -5,11 +5,13 @@ require "test_helper"
 class CNPJFormatterTest < Minitest::Test
   test "formats strings without separators" do
     number = "12345678901234"
+
     assert_equal "12.345.678/9012-34", CNPJ::Formatter.format(number)
   end
 
   test "removes any non-numeric characters" do
     number = "\n12$345[678/9012-34"
+
     assert_equal "12345678901234", CNPJ::Formatter.strip(number)
   end
 end