br_documents 0.1.3 → 0.2.0

data/spec/ie_validator_spec.rb

@@ -4,10 +4,10 @@ RSpec.describe IeValidator do
   let(:record) { double('model') }
 
   before do
-    allow(record).to receive(:uf) {'SC'}
+    allow(record).to receive(:uf) { 'SC' }
     allow(record).to receive(:errors).and_return({})
     allow(record.errors).to receive(:messages).and_return({})
-    allow(record.errors).to receive(:add) do | attribute, error |
+    allow(record.errors).to receive(:add) do |attribute, error|
       record.errors[attribute] ||= []
       record.errors[attribute] << error
       record.errors.messages[attribute] = record.errors[attribute]
@@ -50,7 +50,7 @@ RSpec.describe IeValidator do
 
   context 'when UF is invalid' do
     before do
-      allow(record).to receive(:uf) {'XX'}
+      allow(record).to receive(:uf) { 'XX' }
       subject.validate_each(record, 'ie', '253667852')
     end
 
@@ -67,7 +67,8 @@ RSpec.describe IeValidator do
 
     it 'adds error in model' do
       expect(record.errors.messages[:base]).to eql [
-        t('validator.ie.uf.no_present', uf: 'uf')]
+        t('validator.ie.uf.no_present', uf: 'uf')
+      ]
     end
   end
 
@@ -77,7 +78,8 @@ RSpec.describe IeValidator do
 
     it 'adds error in model' do
       expect(record.errors.messages[:base]).to eql [
-        t('validator.ie.uf.no_configured')]
+        t('validator.ie.uf.no_configured')
+      ]
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,14 @@
-require "simplecov"
+require 'simplecov'
 SimpleCov.start
 
-require "bundler/setup"
+require 'bundler/setup'
 Bundler.require(:default, :development)
 
-require "br_documents"
+require 'br_documents'
 
-Dir[File.dirname(__FILE__) + "/support/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each { |f| require f }
 
-I18n.default_locale = "pt-BR"
+I18n.default_locale = 'pt-BR'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
@@ -18,5 +18,5 @@ RSpec.configure do |config|
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
 
-  config.order = "random"
+  config.order = 'random'
 end

data/spec/suframa/suframa_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe BrDocuments::Suframa do
+  subject { described_class.new }
+
+  describe '#formatted' do
+    it 'returns the formatted number' do
+      value = '100698107'
+
+      subject = described_class.new(value)
+
+      expect(subject.formatted).to eql '10.0698.107'
+    end
+
+    context 'when number is invalid' do
+      it 'returns a empty string' do
+        value = '123'
+
+        subject = described_class.new(value)
+
+        expect(subject.formatted).to eql ''
+      end
+    end
+
+    it 'is invalid if number is malformed' do
+      ['121.23.4123', '5.50.309.012', '5.503.090.12'].each do |number|
+        suframa = BrDocuments::Suframa.new(number)
+
+        expect(suframa).to_not be_valid
+      end
+    end
+
+    it 'is invalid with a number longer than 9' do
+      ['1234567890', '12.3456.7890'].each do |number|
+        suframa = BrDocuments::Suframa.new(number)
+
+        expect(suframa).to_not be_valid
+      end
+    end
+
+    it 'is invalid with a number shorter than 9' do
+      ['12345678', '12.3456.78'].each do |number|
+        suframa = BrDocuments::Suframa.new(number)
+
+        expect(suframa).to_not be_valid
+      end
+    end
+
+    it 'is invalid with a sequence of the same number' do
+      ['11.1111.111', '111111111'].each do |number|
+        suframa = BrDocuments::Suframa.new(number)
+
+        expect(suframa).to_not be_valid
+      end
+    end
+
+    it 'is invalid with invalid verifying digit' do
+      ['55.0309.010', '550309010'].each do |number|
+        suframa = BrDocuments::Suframa.new(number)
+
+        expect(suframa).to_not be_valid
+      end
+    end
+
+    it 'is valid with correct number' do
+      ['11.1279.100', '10.1040.105', '100628109', '100698107'].each do |number|
+        suframa = BrDocuments::Suframa.new(number)
+
+        expect(suframa).to be_valid
+      end
+    end
+
+    context 'activity sector' do
+      it 'is valid when activity_sector is in 01, 02, 10, 11, 20, 60' do
+        ['11.1279.100', '10.1040.105'].each do |number|
+          suframa = BrDocuments::Suframa.new(number)
+
+          expect(suframa).to be_valid
+        end
+      end
+
+      it 'is invalid when activity_sector is not in 01, 02, 10, 11, 20, 60' do
+        ['17.1279.107', '141161108'].each do |number|
+          suframa = BrDocuments::Suframa.new(number)
+
+          expect(suframa).to_not be_valid
+        end
+      end
+    end
+
+    context 'administration unit' do
+      it 'is valid when adm_unit is in 01, 10, 30' do
+        ['11.1279.100', '101160100'].each do |number|
+          suframa = BrDocuments::Suframa.new(number)
+
+          expect(suframa).to be_valid
+        end
+      end
+
+      it 'is invalid when adm_unit is not in 01, 10, 30' do
+        ['11.1279.124', '101160160'].each do |number|
+          suframa = BrDocuments::Suframa.new(number)
+
+          expect(suframa).to_not be_valid
+        end
+      end
+    end
+  end
+end

data/spec/suframa_validator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe SuframaValidator do
+  let(:mock) { double('mode') }
+
+  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
+
+  subject { SuframaValidator.new(attributes: 'suframa') }
+
+  context 'when SUFRAMA is valid' do
+    it "doesn't add errors in model" do
+      subject.validate_each(mock, 'suframa', '600215105')
+      expect(mock.errors.messages).to be_empty
+    end
+  end
+
+  context 'when SUFRAMA is blank' do
+    it "doesn't add errors in model" do
+      subject.validate_each(mock, 'suframa', '')
+      expect(mock.errors.messages).to be_empty
+    end
+  end
+
+  context 'when SUFRAMA is invalid' do
+    it 'adds errors in model' do
+      subject.validate_each(mock, 'suframa', '01233254121')
+      expect(mock.errors.messages).to_not be_empty
+    end
+  end
+end

data/spec/support/utilities.rb

@@ -1,3 +1,3 @@
-def t(string, options={})
+def t(string, options = {})
   I18n.t(string, options)
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: br_documents
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - ASSEINFO - Sistemas de Informação
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -53,75 +53,131 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 11.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 11.1.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.2
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.0.2
+        version: 0.21.2
 description: Validates brazilian documents like CPF, CNPJ and IE.
 email:
 - asseinfo@asseinfo.com.br
@@ -129,9 +185,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -180,6 +237,8 @@ files:
 - lib/br_documents/ie/sp.rb
 - lib/br_documents/ie/to.rb
 - lib/br_documents/ie_validator.rb
+- lib/br_documents/suframa/suframa.rb
+- lib/br_documents/suframa_validator.rb
 - lib/br_documents/version.rb
 - spec/cnpj_cpf/cnpj_spec.rb
 - spec/cnpj_cpf/cpf_spec.rb
@@ -219,6 +278,8 @@ files:
 - spec/ie/to_spec.rb
 - spec/ie_validator_spec.rb
 - spec/spec_helper.rb
+- spec/suframa/suframa_spec.rb
+- spec/suframa_validator_spec.rb
 - spec/support/utilities.rb
 homepage: http://github.com/asseinfo/br_documents
 licenses:
@@ -239,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Validates brazilian documents like CPF, CNPJ and IE. It can be used with
@@ -283,4 +344,6 @@ test_files:
 - spec/ie/to_spec.rb
 - spec/ie_validator_spec.rb
 - spec/spec_helper.rb
+- spec/suframa/suframa_spec.rb
+- spec/suframa_validator_spec.rb
 - spec/support/utilities.rb

data/.circleci/config.yml

@@ -1,42 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.5.1
-    steps:
-      - checkout
-      - restore_cache:
-          key: br-documents-cache-v1-{{ checksum "Gemfile.lock" }}
-      - run: bundle check || bundle install
-      - save_cache:
-          key: br-documents-cache-v1-{{ .Environment.CIRCLE_SHA1 }}
-          paths:
-            - .
-      - save_cache:
-          key: br-documents-cache-v1-{{ checksum "Gemfile.lock" }}
-          paths:
-            - ./vendor/bundle
-  rspec:
-    docker:
-      - image: circleci/ruby:2.5.1
-    steps:
-      - restore_cache:
-          key: br-documents-cache-v1-{{ .Environment.CIRCLE_SHA1 }}
-      - restore_cache:
-          key: br-documents-cache-v1-{{ checksum "Gemfile.lock" }}
-      - run:
-          name: Install Test Coverage for CodeClimate
-          command: |
-            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
-      - run: bundle exec rspec
-      - run: ./cc-test-reporter after-build --exit-code $?
-workflows:
-  version: 2
-  main:
-    jobs:
-      - build
-      - rspec:
-          requires:
-            - build