br_documents 0.0.15 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85b3dba0a5cb19581015f983a1ec5f186521756d
-  data.tar.gz: f4166ebcf7711bc8849438bd317649ce0c02a5a4
+SHA256:
+  metadata.gz: 26654dc4bd73502f9cf3fadf4a33104f218a47fb81e02c71c8a23f9d78c75d91
+  data.tar.gz: 5ec58159f531151f3b759ac907d3d16dfd269fb3a26091f559a6e23798bcce07
 SHA512:
-  metadata.gz: 74be958176462d91c7eeb8779b0976191dd34fdf361b086717806d1462ffcb9d89b08c63fc2efb20513986e70ac8056e9876531d16c391793dabcc340b2109d2
-  data.tar.gz: 69fc04d5fa9cc32d5b52544b094281fa923cec602c11a92f7ea58752e9d4f0400e2b08a2141104e8b356e49e3d2d0b969b05b117337a917d4e1e46ce787aff0f
+  metadata.gz: 724248b106f9db144d555521a59728e100e881e77261d25d2399d630e10461694adc241b027f6b53577db2d3f68ab11806d6fecaf76261bf98401d0daef780a8
+  data.tar.gz: 05b814e328dec4ef44f0ebe2f5af18a86ea35d920cb5537ca235e8ba30c2786a550577e4f86fc232d6760d9b589557a76c29f1c09f2848ad305ae1e8d184707b

data/.github/workflows/config.yml

@@ -0,0 +1,54 @@
+name: Containers
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.3
+          bundler-cache: true
+
+  rspec:
+    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: |
+            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/.gitignore

@@ -4,7 +4,7 @@
 .config
 .yardoc
 .idea/
-Gemfile.lock
+.byebug_history
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -0,0 +1,65 @@
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'br_documents.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RubyVersionGlobalsUsage:
+  Exclude:
+    - 'br_documents.gemspec'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+   - 'spec/**/*.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never # default: always
+
+# Offense count: 39
+# Cop supports --auto-correct.
+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.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'br_documents.gemspec'
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    br_documents (0.2.0)
+      activemodel (>= 4.0.0)
+      i18n (>= 0.6.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    byebug (11.1.3)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      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-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  br_documents!
+  bundler (>= 1.3)
+  byebug (= 11.1.3)
+  codeclimate-test-reporter (>= 1.0.7)
+  rake (>= 13.0.3)
+  rspec (>= 3.10.0)
+  rubocop (~> 1.15.0)
+  rubocop-performance (~> 1.11.3)
+  rubocop-rails (~> 2.10.1)
+  rubocop-rspec (~> 2.3.0)
+  simplecov (>= 0.21.2)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -115,6 +115,29 @@ pj.ie = "111.111.111"
 pj.valid? # => false
 ```
 
+#### SUFRAMA
+
+```ruby
+class Person < ActiveRecord::Base
+
+  attr_accessor :suframa
+
+  validates :suframa,
+    suframa: true
+end
+
+
+pj = Person.new
+pj.suframa = "100698107"
+pj.valid? # => true
+
+pj.suframa = "10.0698.107" # with mask
+pj.valid? # => true
+
+pj.suframa = "11.1111.111"
+pj.valid? # => false
+```
+
 ### Ruby
 
 #### CNPJ
@@ -147,9 +170,43 @@ ie.formatted # => "254.062.407"
 ie.valid?    # => true
 ```
 
+#### SUFRAMA
+
+```ruby
+require "br_documents"
+
+suframa = BrDocuments::Suframa.new("100698107")
+suframa.formatted # => "10.0698.107"
+suframa.valid? # => true
+```
+
+## Environment variables
+
+The following variables are necessary to be set:
+
+Environment var                | Development? | Test? | CI  | Production? | Data
+-------------------------------|--------------|-------|-----|-------------|-----
+TZ                             | no           | no    | yes | no          | America/Sao_Paulo
+BUNDLE_PATH                    | no           | no    | yes | no          | ./vendor/bundle
+CC_TEST_REPORTER_ID            | no           | no    | yes | no          | get at codeclimate
+RAILS_ENV                      | no           | no    | yes | no          | test
+
+## Deploy to Rubygems
+
+    $ bundle exec rake release  # Create tag vX.X.X, build and push br_documents-X.X.X.gem to Rubygems
+
+You can build or install using one of the above tasks
+
+    $ bundle exec rake build    # Build br_documents-X.X.X.gem into the pkg directory
+    $ bundle exec rake install  # Build and install br_documents-X.X.X.gem into system gems
+
+#### Login
+    $ gem signin
+    $ gem signout
+
 ## How to add contributors
 
-		gem owner --add leandrolourenci@gmail.com br_documents
+    gem owner --add leandrolourenci@gmail.com br_documents
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,10 @@
-require "rspec/core/rake_task"
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
 task default: :spec
 RSpec::Core::RakeTask.new
 
 desc "Open an irb session preloaded class's"
 task :console do
-  sh "irb -rubygems -I lib -r br_documents.rb"
+  sh 'irb -rubygems -I lib -r br_documents.rb'
 end

data/br_documents.gemspec

@@ -1,30 +1,34 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "br_documents/version"
+require 'br_documents/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "br_documents"
+  spec.name          = 'br_documents'
   spec.version       = BrDocuments::VERSION
-  spec.authors       = ["ASSEINFO - Sistemas de Informação"]
-  spec.email         = ["asseinfo@asseinfo.com.br"]
-  spec.description   = "Validates brazilian documents like CPF, CNPJ and IE."
-  spec.summary       = "Validates brazilian documents like CPF, CNPJ and IE. It can be used with active record or just in ruby."
-  spec.homepage      = "http://github.com/asseinfo/br_documents"
-  spec.license       = "MIT"
+  spec.authors       = ['ASSEINFO - Sistemas de Informação']
+  spec.email         = ['asseinfo@asseinfo.com.br']
+  spec.description   = 'Validates brazilian documents like CPF, CNPJ and IE.'
+  spec.summary       = 'Validates brazilian documents like CPF, CNPJ and IE. It can be used with active record '\
+                       'or just in ruby.'
+  spec.homepage      = 'http://github.com/asseinfo/br_documents'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activemodel", ">= 4.0.0"
-  spec.add_dependency "i18n", ">= 0.6.5"
+  spec.add_dependency 'activemodel', '>= 4.0.0'
+  spec.add_dependency 'i18n', '>= 0.6.5'
 
-  spec.add_development_dependency "bundler", ">= 1.3"
-  spec.add_development_dependency "rake", ">= 10.1.0"
-  spec.add_development_dependency "rspec", ">= 3.0.0"
-  spec.add_development_dependency "codeclimate-test-reporter"
-  spec.add_development_dependency "simplecov", ">= 0.9.0"
-  spec.add_development_dependency "byebug", "4.0.1" if RUBY_VERSION >= "2.0"
+  spec.add_development_dependency 'bundler', '>= 1.3'
+  spec.add_development_dependency 'byebug', '11.1.3' if RUBY_VERSION >= '2.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '>= 1.0.7'
+  spec.add_development_dependency 'rake', '>= 13.0.3'
+  spec.add_development_dependency 'rspec', '>= 3.10.0'
+  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-rspec', '~> 2.3.0'
+  spec.add_development_dependency 'simplecov', '>= 0.21.2'
 end

data/lib/br_documents.rb

@@ -1,5 +1,5 @@
-require "active_model"
+require 'active_model'
 
-Dir[File.dirname(__FILE__) + "/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].sort.each { |f| require f }
 
-I18n.load_path << File.expand_path("../../config/locales/pt-BR.yml", __FILE__)
+I18n.load_path << File.expand_path('../config/locales/pt-BR.yml', __dir__)

data/lib/br_documents/cnpj_cpf/cnpj.rb

@@ -1,4 +1,4 @@
-require_relative "document"
+require_relative 'document'
 
 module BrDocuments
   module CnpjCpf
@@ -16,7 +16,7 @@ module BrDocuments
       end
 
       def format_number
-        @number.sub(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/, "\\1.\\2.\\3/\\4-\\5")
+        @number.sub(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/, '\\1.\\2.\\3/\\4-\\5')
       end
     end
   end

data/lib/br_documents/cnpj_cpf/cpf.rb

@@ -1,4 +1,4 @@
-require_relative "document"
+require_relative 'document'
 
 module BrDocuments
   module CnpjCpf
@@ -16,7 +16,7 @@ module BrDocuments
       end
 
       def format_number
-        @number.sub(/(\d{3})(\d{3})(\d{3})(\d{2})/, "\\1.\\2.\\3-\\4")
+        @number.sub(/(\d{3})(\d{3})(\d{3})(\d{2})/, '\\1.\\2.\\3-\\4')
       end
     end
   end

data/lib/br_documents/cnpj_cpf/document.rb

@@ -1,4 +1,4 @@
-require_relative "../commons/mod11"
+require_relative '../commons/mod11'
 
 module BrDocuments
   module CnpjCpf
@@ -10,11 +10,11 @@ module BrDocuments
       end
 
       def valid?
-        valid_format? && !sequence_of_equal_numbers? && valid_digital_check?
+        valid_format? && !sequence_of_equal_numbers? && valid_check_digit?
       end
 
       def formatted
-        valid? ? format_number : ""
+        valid? ? format_number : ''
       end
 
       private
@@ -24,19 +24,19 @@ module BrDocuments
       end
 
       def sequence_of_equal_numbers?
-        number_without_mask.split("").uniq.length == 1
+        number_without_mask.split('').uniq.length == 1
       end
 
-      def valid_digital_check?
+      def valid_check_digit?
         weight1, weight2 = weights_for_digital_check
 
-        digital_check1 = generate_digital_check(number_without_mask, weight1)
-        digital_check2 = generate_digital_check(number_without_mask, weight2)
-        @number[-2, 2].eql? "#{digital_check1}#{digital_check2}"
+        digital_check1 = generate_check_digit(number_without_mask, weight1)
+        digital_check2 = generate_check_digit(number_without_mask, weight2)
+        @number[-2, 2] == "#{digital_check1}#{digital_check2}"
       end
 
       def number_without_mask
-        @number.gsub(/[\.\/-]/, "")
+        @number.gsub(/[\.\/-]/, '')
       end
     end
   end