br_documents 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26654dc4bd73502f9cf3fadf4a33104f218a47fb81e02c71c8a23f9d78c75d91
-  data.tar.gz: 5ec58159f531151f3b759ac907d3d16dfd269fb3a26091f559a6e23798bcce07
+  metadata.gz: a893a246eb1c07b45241c0eec46268a58a01aa7e2bbb0f02f8294e3c1f6c0ccf
+  data.tar.gz: 8ad80b4d402567412752ed48eab9c0adec82fa6d92cf8dcf6bfbf788e72e8a6b
 SHA512:
-  metadata.gz: 724248b106f9db144d555521a59728e100e881e77261d25d2399d630e10461694adc241b027f6b53577db2d3f68ab11806d6fecaf76261bf98401d0daef780a8
-  data.tar.gz: 05b814e328dec4ef44f0ebe2f5af18a86ea35d920cb5537ca235e8ba30c2786a550577e4f86fc232d6760d9b589557a76c29f1c09f2848ad305ae1e8d184707b
+  metadata.gz: 43d5217a448c6ed1297084b59c4935021a0bfda1968be33b109985cd169ea80b435adaec30373ba84b3125828842e7cce71033e3f7d842db3af0610f2c0e87d0
+  data.tar.gz: 63538e8845f2143637a685af12b944cc37c2b5ecb34fc32f3eb67c859cbd28968daaadac4669146322794e2029a0a0034c9fbdf94a90dcf887a309e125ca4e7d

data/.github/workflows/config.yml

@@ -1,26 +1,27 @@
-name: Containers
+name: Tests
 
 on: [push]
 
 jobs:
-  build:
+  linter:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
 
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7.3
-          bundler-cache: true
+    - uses: actions/checkout@v3
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.3
+        bundler-cache: true
+
+    - run: bundle exec rubocop --display-cop-names --parallel
 
   rspec:
     runs-on: ubuntu-latest
 
-    needs: build
-
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: ruby/setup-ruby@v1
         with:
@@ -30,25 +31,10 @@ jobs:
       - run: |
             curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
             chmod +x ./cc-test-reporter
+
       - run: |
             ./cc-test-reporter before-build
             bundle exec rspec
             ./cc-test-reporter after-build -r $CC_TEST_REPORTER_ID --exit-code $?
         env:
            CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
-  
-  lint:
-    runs-on: ubuntu-latest
-
-    needs: build
-
-    steps:
-
-    - uses: actions/checkout@v2
-
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7.3
-        bundler-cache: true
-
-    - run: bundle exec rubocop --display-cop-names --parallel

data/.rubocop.yml

@@ -1,3 +1,20 @@
+# You can find more information about RuboCop pending cops policy
+# https://docs.rubocop.org/rubocop/versioning.html#pending-cops
+#
+# These are the default options. The .rubocop.yml inherit and
+# override all the default options.
+# https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml
+require:
+  - rubocop-rails
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+AllCops:
+  TargetRubyVersion: 2.7.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  NewCops: enable
+
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -24,6 +41,18 @@ Metrics/BlockLength:
 Style/Documentation:
   Enabled: false
 
+RSpec/NamedSubject:
+  Enabled: false # default: true
+
+RSpec/MultipleExpectations:
+  Enabled: false # default: true
+
+RSpec/NestedGroups:
+  Enabled: false # default: true
+
+Style/RegexpLiteral:
+  Enabled: false # default: true
+
 Style/FrozenStringLiteralComment:
   EnforcedStyle: never # default: always
 
@@ -32,27 +61,6 @@ Style/FrozenStringLiteralComment:
 Style/RedundantRegexpEscape:
   Enabled: false
 
-# Offense count: 18
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'lib/br_documents/cnpj_cpf/cnpj.rb'
-    - 'lib/br_documents/cnpj_cpf/document.rb'
-    - 'lib/br_documents/ie/ac.rb'
-    - 'lib/br_documents/ie/ba.rb'
-    - 'lib/br_documents/ie/mg.rb'
-    - 'lib/br_documents/ie/mt.rb'
-    - 'lib/br_documents/ie/pattern1.rb'
-    - 'lib/br_documents/ie/pattern2.rb'
-    - 'lib/br_documents/ie/pe.rb'
-    - 'lib/br_documents/ie/rn.rb'
-    - 'lib/br_documents/ie/ro.rb'
-    - 'lib/br_documents/ie/rs.rb'
-    - 'lib/br_documents/ie/sp.rb'
-    - 'spec/ie/shared_examples_for_to_remove_all_masks.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    br_documents (0.2.0)
+    br_documents (0.2.3)
       activemodel (>= 4.0.0)
       i18n (>= 0.6.5)
 
@@ -31,7 +31,7 @@ GEM
       ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -58,13 +58,15 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.7.0)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.11.3)
+    rubocop-performance (1.11.4)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rails (2.10.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
     rubocop-rspec (2.3.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
@@ -93,8 +95,9 @@ DEPENDENCIES
   rubocop (~> 1.15.0)
   rubocop-performance (~> 1.11.3)
   rubocop-rails (~> 2.10.1)
+  rubocop-rake (>= 0.5.1)
   rubocop-rspec (~> 2.3.0)
   simplecov (>= 0.21.2)
 
 BUNDLED WITH
-   2.1.4
+   2.2.33

data/Rakefile

@@ -5,6 +5,6 @@ task default: :spec
 RSpec::Core::RakeTask.new
 
 desc "Open an irb session preloaded class's"
-task :console do
+task console: :enviroment do
   sh 'irb -rubygems -I lib -r br_documents.rb'
 end

data/br_documents.gemspec

@@ -2,6 +2,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'br_documents/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'br_documents'
   spec.version       = BrDocuments::VERSION
@@ -29,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 1.15.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.11.3'
   spec.add_development_dependency 'rubocop-rails', '~> 2.10.1'
+  spec.add_development_dependency 'rubocop-rake', '>= 0.5.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.3.0'
   spec.add_development_dependency 'simplecov', '>= 0.21.2'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/br_documents/cnpj_cpf/document.rb

@@ -24,7 +24,7 @@ module BrDocuments
       end
 
       def sequence_of_equal_numbers?
-        number_without_mask.split('').uniq.length == 1
+        number_without_mask.chars.uniq.length == 1
       end
 
       def valid_check_digit?

data/lib/br_documents/{gtin/gtin.rb → gtin.rb}

@@ -15,14 +15,14 @@ module BrDocuments
     end
 
     def valid_checksum?
-      numbers = @code.chars[0, @code.length - 1].reverse
+      numbers = @code[0, @code.length - 1].chars.reverse
       odd = even = 0
 
       numbers.each_with_index do |number, i|
         (i + 1).even? ? (even += number.to_i) : (odd += number.to_i * 3)
       end
 
-      @code.chars.last.to_i == ((10 - (odd + even)) % 10)
+      @code[-1].to_i == ((10 - (odd + even)) % 10)
     end
   end
 end

data/lib/br_documents/ie/ba.rb

@@ -9,7 +9,7 @@ module BrDocuments
       protected
 
       def format_ie(number)
-        if number.gsub(/-/, '').length == 8
+        if number.delete('-').length == 8
           number.sub(/(\d{6})(\d{2})/, '\\1-\\2')
         else
           number.sub(/(\d{7})(\d{2})/, '\\1-\\2')

data/lib/br_documents/ie/mg.rb

@@ -13,7 +13,7 @@ module BrDocuments
       end
 
       def valid_format?
-        regex = /^(\d{3}\.\d{3}\.\d{3}\.\d{2}\-\d{2})$|^(\d{13})$/
+        regex = /^(\d{3}\.\d{3}\.\d{3}\/\d{4})$|^(\d{13})$/
         regex.match(@number).present?
       end
 

data/lib/br_documents/ie/mt.rb

@@ -15,7 +15,7 @@ module BrDocuments
 
       def generate_zeros(number)
         just_numbers = number.gsub(/[\.\/-]/, '')
-        zeros = ('0' * 11).slice(just_numbers.length, 11)
+        zeros = ('0' * 11).slice(just_numbers.length, 11) if just_numbers.present?
         yield zeros.to_s if block_given?
       end
 

data/lib/br_documents/ie_validator.rb

@@ -13,7 +13,7 @@ class IeValidator < ActiveModel::EachValidator
   end
 
   def attribute_uf_was_configured_at_validator?(record)
-    record.errors.add(:base, I18n.t('validator.ie.uf.no_configured')) unless options[:uf].present?
+    record.errors.add(:base, I18n.t('validator.ie.uf.no_configured')) if options[:uf].blank?
 
     options[:uf].present?
   end

data/lib/br_documents/suframa.rb

@@ -0,0 +1,46 @@
+require_relative './commons/mod11'
+
+module BrDocuments
+  class Suframa
+    include BrDocuments::Commons::Mod11
+
+    def initialize(number)
+      @number = number
+    end
+
+    def formatted
+      valid? ? format_number : ''
+    end
+
+    def valid?
+      valid_pattern? &&
+        !sequence_of_equal_numbers? &&
+        valid_check_digit?
+    end
+
+    private
+
+    def valid_pattern?
+      /^(\d{2}\.\d{4}\.\d{3})$|^(\d{9})$/.match(@number).present?
+    end
+
+    def sequence_of_equal_numbers?
+      number_without_mask.chars.uniq.length == 1
+    end
+
+    def number_without_mask
+      @number_without_mask ||= @number.delete('.')
+    end
+
+    def valid_check_digit?
+      weights = [9, 8, 7, 6, 5, 4, 3, 2]
+
+      check_digit = generate_check_digit(number_without_mask, weights)
+      number_without_mask[8] == check_digit.to_s
+    end
+
+    def format_number
+      @number.sub(/(\d{2})(\d{4})(\d{3})/, '\\1.\\2.\\3')
+    end
+  end
+end

data/lib/br_documents/version.rb

@@ -1,3 +1,3 @@
 module BrDocuments
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/spec/{cnpj_cpf → br_documents/cnpj_cpf}/cnpj_spec.rb

@@ -3,13 +3,13 @@ require 'spec_helper'
 describe BrDocuments::CnpjCpf::Cnpj do
   describe '#formatted' do
     it 'returns a formatted number' do
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new('04001155000101')
+      cnpj = described_class.new('04001155000101')
       expect(cnpj.formatted).to eq '04.001.155/0001-01'
     end
 
     context 'when is invalid' do
       it 'returns an empty string' do
-        cnpj = BrDocuments::CnpjCpf::Cnpj.new('123')
+        cnpj = described_class.new('123')
         expect(cnpj.formatted).to eq ''
       end
     end
@@ -17,42 +17,42 @@ describe BrDocuments::CnpjCpf::Cnpj do
 
   it 'is invalid with malformed number' do
     ['242.2818/50001-54', '35.611.011/000192'].each do |number|
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(number)
-      expect(cnpj).to_not be_valid
+      cnpj = described_class.new(number)
+      expect(cnpj).not_to be_valid
     end
   end
 
   it 'is invalid with a number longer than 14' do
     ['24.228.185/0001-544', '936710360001881'].each do |number|
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(number)
-      expect(cnpj).to_not be_valid
+      cnpj = described_class.new(number)
+      expect(cnpj).not_to be_valid
     end
   end
 
   it 'is invalid with a number shorter than 14' do
     ['24.228.185/0001-5', '9367103600018'].each do |number|
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(number)
-      expect(cnpj).to_not be_valid
+      cnpj = described_class.new(number)
+      expect(cnpj).not_to be_valid
     end
   end
 
   it 'is invalid with a sequence of the same number' do
     ['11.111.111/1111-11', '22222222222222'].each do |number|
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(number)
-      expect(cnpj).to_not be_valid
+      cnpj = described_class.new(number)
+      expect(cnpj).not_to be_valid
     end
   end
 
   it 'is invalid with invalid check number' do
     ['04.001.155/0001-03', '85961757000101'].each do |number|
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(number)
-      expect(cnpj).to_not be_valid
+      cnpj = described_class.new(number)
+      expect(cnpj).not_to be_valid
     end
   end
 
   it 'is valid with correct number' do
     ['04.001.155/0001-01', '85961757000102'].each do |number|
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(number)
+      cnpj = described_class.new(number)
       expect(cnpj).to be_valid
     end
   end

data/spec/{cnpj_cpf → br_documents/cnpj_cpf}/cpf_spec.rb

@@ -3,13 +3,13 @@ require 'spec_helper'
 describe BrDocuments::CnpjCpf::Cpf do
   describe '#formatted' do
     it 'returns a formatted number' do
-      cpf = BrDocuments::CnpjCpf::Cpf.new('11144477735')
+      cpf = described_class.new('11144477735')
       expect(cpf.formatted).to eq '111.444.777-35'
     end
 
     context 'when is invalid' do
       it 'returns an empty string' do
-        cpf = BrDocuments::CnpjCpf::Cpf.new('123')
+        cpf = described_class.new('123')
         expect(cpf.formatted).to eq ''
       end
     end
@@ -17,42 +17,42 @@ describe BrDocuments::CnpjCpf::Cpf do
 
   it 'is invalid with malformed number' do
     ['111.126.491.07', '482.261.15-663', '111444.777-35'].each do |number|
-      cpf = BrDocuments::CnpjCpf::Cpf.new(number)
-      expect(cpf).to_not be_valid
+      cpf = described_class.new(number)
+      expect(cpf).not_to be_valid
     end
   end
 
   it 'is invalid with a number longer than 11' do
     ['045.769.421-150', '308514217766'].each do |number|
-      cpf = BrDocuments::CnpjCpf::Cpf.new(number)
-      expect(cpf).to_not be_valid
+      cpf = described_class.new(number)
+      expect(cpf).not_to be_valid
     end
   end
 
   it 'is invalid with a number shorter than 11' do
     ['111.444.777-3', '1234567890'].each do |number|
-      cpf = BrDocuments::CnpjCpf::Cpf.new(number)
-      expect(cpf).to_not be_valid
+      cpf = described_class.new(number)
+      expect(cpf).not_to be_valid
     end
   end
 
   it 'is invalid with a sequence of the same number' do
     ['111.111.111-11', '22222222222'].each do |number|
-      cpf = BrDocuments::CnpjCpf::Cpf.new(number)
-      expect(cpf).to_not be_valid
+      cpf = described_class.new(number)
+      expect(cpf).not_to be_valid
     end
   end
 
   it 'is invalid with invalid check number' do
     ['111.111.111-22', '2222222233'].each do |number|
-      cpf = BrDocuments::CnpjCpf::Cpf.new(number)
-      expect(cpf).to_not be_valid
+      cpf = described_class.new(number)
+      expect(cpf).not_to be_valid
     end
   end
 
   it 'is valid with correct number' do
     ['111.444.777-35', '01233254120'].each do |number|
-      cpf = BrDocuments::CnpjCpf::Cpf.new(number)
+      cpf = described_class.new(number)
       expect(cpf).to be_valid
     end
   end

data/spec/br_documents/cnpj_validator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe CnpjValidator do
+  subject { described_class.new(attributes: 'cnpj') }
+
+  let(:mock) { instance_double('model') }
+
+  before do
+    allow(mock).to receive(:errors).and_return([])
+    allow(mock.errors).to receive(:messages).and_return({})
+    allow(mock.errors).to receive(:add) do |attribute, error|
+      mock.errors.messages[attribute] = [error]
+    end
+  end
+
+  context 'when Cnpj is valid' do
+    it "doesn't add errors in model" do
+      subject.validate_each(mock, 'cnpj', '85961757000102')
+      expect(mock.errors.messages).to be_empty
+    end
+  end
+
+  context 'when Cnpj is blank' do
+    it "doesn't add errors in model" do
+      subject.validate_each(mock, 'cnpj', '')
+      expect(mock.errors.messages).to be_empty
+    end
+  end
+
+  context 'when Cnpj is invalid' do
+    it 'adds errors in model' do
+      subject.validate_each(mock, 'cnpj', '85961757000103')
+      expect(mock.errors.messages).not_to be_empty
+    end
+  end
+end

data/spec/br_documents/cpf_validator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe CpfValidator do
+  subject { described_class.new(attributes: 'cpf') }
+
+  let(:mock) { instance_double('model') }
+
+  before do
+    allow(mock).to receive(:errors).and_return([])
+    allow(mock.errors).to receive(:messages).and_return({})
+    allow(mock.errors).to receive(:add) do |attribute, error|
+      mock.errors.messages[attribute] = [error]
+    end
+  end
+
+  context 'when Cpf is valid' do
+    it "doesn't add errors in model" do
+      subject.validate_each(mock, 'cpf', '01233254120')
+      expect(mock.errors.messages).to be_empty
+    end
+  end
+
+  context 'when Cpf is blank' do
+    it "doesn't add errors in model" do
+      subject.validate_each(mock, 'cpf', '')
+      expect(mock.errors.messages).to be_empty
+    end
+  end
+
+  context 'when Cpf is invalid' do
+    it 'adds errors in model' do
+      subject.validate_each(mock, 'cpf', '01233254121')
+      expect(mock.errors.messages).not_to be_empty
+    end
+  end
+end

data/spec/{gtin → br_documents}/gtin_spec.rb

@@ -36,14 +36,14 @@ describe BrDocuments::Gtin do
       context 'when the number of digits is different of 8, 13 or 14' do
         subject { described_class.new('12345678901234560') }
 
-        it { is_expected.to_not be_valid }
+        it { is_expected.not_to be_valid }
       end
     end
 
     context 'when the checksum is invald' do
       subject { described_class.new('1145678548712') }
 
-      it { is_expected.to_not be_valid }
+      it { is_expected.not_to be_valid }
     end
   end
 end

data/spec/{gtin_validator_spec.rb → br_documents/gtin_validator_spec.rb}

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 describe GtinValidator do
-  let(:record) { double('model') }
+  subject { described_class.new(attributes: 'gtin') }
+
+  let(:record) { instance_double('model') }
 
   before do
     allow(record).to receive(:errors).and_return([])
@@ -11,8 +13,6 @@ describe GtinValidator do
     end
   end
 
-  subject { GtinValidator.new(attributes: 'gtin') }
-
   context 'when GTIN code is valid' do
     before { subject.validate_each(record, 'gtin', '1243658721548') }
 

data/spec/{ie → br_documents/ie}/ac_spec.rb

@@ -13,21 +13,21 @@ RSpec.describe BrDocuments::IE::AC do
     it 'is invalid with malformed number' do
       ['01.448.52/88.91-50', '01.278.704/5555-7', '01.AB7.904/028-50'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 
     it 'is invalid with length different to 13' do
       ['1234567890', '123456789012'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 
     it 'is invalid with invalid check number' do
       ['0135184641523', '0172567054082'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 

data/spec/{ie → br_documents/ie}/al_spec.rb

@@ -13,14 +13,14 @@ describe BrDocuments::IE::AL do
     it 'is invalid with length different to 9' do
       ['1234567', '122345678901'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 
     it 'is invalid with invalid check number' do
       ['245320152', '240046248'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 

data/spec/{ie → br_documents/ie}/am_spec.rb

@@ -13,21 +13,21 @@ describe BrDocuments::IE::AM do
     it 'is invalid with malformed number' do
       ['8.535.410-60', '884.67.826-1', '13.BA9.093-6'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 
     it 'is invalid with length different to 9' do
       ['1234567', '12345678901'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end
 
     it 'is invalid with invalid check number' do
       ['500085276', '886770232'].each do |number|
         ie = described_class.new(number)
-        expect(ie).to_not be_valid
+        expect(ie).not_to be_valid
       end
     end