br_documents 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25cf99032b0bea6b2a016595a560e0a7ea5777154f74d9259009b50323473a61
-  data.tar.gz: f19aa466afa9077bfbe14184d8311bc7db6486d36d1f73ed855c2b00218a062a
+  metadata.gz: 72fc6e3288fa8c5e3b94ddecb5c7488f106ae4108cf9c786b71229fe42b1e9c9
+  data.tar.gz: a7cf947a33a61a3f467f433173598a0c8d7dee127872618b80bc5d3e88321904
 SHA512:
-  metadata.gz: 3f37a4a5244a984e8ed4bf93077e43dd92caec88ea2e9ee7243b8819c6c520050658d7fdcc3164518a7b324f0e777b78346cbe3e024bc019515e258d251d68a3
-  data.tar.gz: 67cf2292f3ca90a52ff6790155c6a32382f7c54475b7d572c3fd491f63a756676c88c333f83bd6f961cc97a6fc321df5139c2c7f10881a0af3239bafac313a5c
+  metadata.gz: 2ac55324bcf44f94bad987e1100fe659b9150dec1c2d20495b73e4367c4ac65d025dbda3e48183d4ae978e1c75eebeb5149bc293ab464b823af11930f8fbba66
+  data.tar.gz: 687d8f399192783ed87b1b75a5cfe07d34e336dae966ee8bcb56eff11010d71c9d8404be20e3674286e8c7c4749f4ffeaab6946fee6e02f608026f966c44d65d

data/.github/workflows/config.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+
+    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
+
+  rspec:
+    runs-on: ubuntu-latest
+
+    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}}

data/.rubocop.yml

@@ -0,0 +1,73 @@
+# 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
+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
+
+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
+
+# Offense count: 39
+# Cop supports --auto-correct.
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+# 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/.tool-versions

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,54 +1,86 @@
 PATH
   remote: .
   specs:
-    br_documents (0.1.3)
+    br_documents (0.2.2)
       activemodel (>= 4.0.0)
       i18n (>= 0.6.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    byebug (10.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.5)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    i18n (1.7.0)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (2.0.3)
-    minitest (5.13.0)
-    rake (12.0.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.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.6)
+    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.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    simplecov (0.14.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+      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.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)
+    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
@@ -56,11 +88,16 @@ PLATFORMS
 DEPENDENCIES
   br_documents!
   bundler (>= 1.3)
-  byebug (= 10.0.2)
-  codeclimate-test-reporter
-  rake (>= 10.1.0)
-  rspec (>= 3.0.0)
-  simplecov (>= 0.9.0)
+  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-rake (>= 0.5.1)
+  rubocop-rspec (~> 2.3.0)
+  simplecov (>= 0.21.2)
 
 BUNDLED WITH
-   1.17.2
+   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,6 +170,16 @@ 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:

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"
+task console: :enviroment do
+  sh 'irb -rubygems -I lib -r br_documents.rb'
 end

data/br_documents.gemspec

@@ -1,30 +1,37 @@
-# 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'
 
+# rubocop:disable Metrics/BlockLength
 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", "10.0.2" 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-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/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.chars.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

data/lib/br_documents/cnpj_validator.rb

@@ -1,8 +1,8 @@
 class CnpjValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    if value.present?
-      cnpj = BrDocuments::CnpjCpf::Cnpj.new(value)
-      record.errors.add(attribute, :invalid) if not cnpj.valid?
-    end
+    return if value.blank?
+
+    cnpj = BrDocuments::CnpjCpf::Cnpj.new(value)
+    record.errors.add(attribute, :invalid) unless cnpj.valid?
   end
 end

data/lib/br_documents/commons/mod11.rb

@@ -1,8 +1,7 @@
 module BrDocuments
   module Commons
     module Mod11
-
-      def generate_digital_check(values, weights)
+      def generate_check_digit(values, weights)
         sum = reduce_weights(values, weights)
         mod = sum % 11
         mod < 2 ? 0 : (11 - mod)

data/lib/br_documents/commons/mod14.rb

@@ -1,8 +1,7 @@
 module BrDocuments
   module Commons
     module Mod14
-
-      def generate_digital_check(values, weights)
+      def generate_check_digit(values, weights)
         sum = reduce_weights(values, weights)
         mod = sum % 11
         mod = (11 - mod)

data/lib/br_documents/cpf_validator.rb

@@ -1,8 +1,8 @@
 class CpfValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    if value.present?
-      cpf = BrDocuments::CnpjCpf::Cpf.new(value)
-      record.errors.add(attribute, :invalid) if not cpf.valid?
-    end
+    return if value.blank?
+
+    cpf = BrDocuments::CnpjCpf::Cpf.new(value)
+    record.errors.add(attribute, :invalid) unless cpf.valid?
   end
 end

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
+end

data/lib/br_documents/gtin_validator.rb

@@ -1,8 +1,8 @@
-class GtinValidator  < ActiveModel::EachValidator
+class GtinValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    if value.present?
-      gtin = BrDocuments::Gtin.new(value)
-      record.errors.add(attribute, :invalid) if not gtin.valid?
-    end
+    return if value.blank?
+
+    gtin = BrDocuments::Gtin.new(value)
+    record.errors.add(attribute, :invalid) unless gtin.valid?
   end
-end
+end

data/lib/br_documents/ie/ac.rb

@@ -1,4 +1,4 @@
-require_relative "pattern2"
+require_relative 'pattern2'
 
 module BrDocuments
   module IE
@@ -9,8 +9,9 @@ module BrDocuments
       end
 
       private
+
       def format_ie(number)
-        number.sub(/(\d{2})(\d{3})(\d{3})(\d{3})(\d{2})/, "\\1.\\2.\\3/\\4-\\5")
+        number.sub(/(\d{2})(\d{3})(\d{3})(\d{3})(\d{2})/, '\\1.\\2.\\3/\\4-\\5')
       end
     end
   end

data/lib/br_documents/ie/al.rb

@@ -1,4 +1,4 @@
-require_relative "pattern1"
+require_relative 'pattern1'
 
 module BrDocuments
   module IE
@@ -9,6 +9,7 @@ module BrDocuments
       end
 
       private
+
       def format_ie(number)
         number
       end

data/lib/br_documents/ie/am.rb

@@ -1,4 +1,4 @@
-require_relative "pattern1"
+require_relative 'pattern1'
 
 module BrDocuments
   module IE
@@ -9,8 +9,9 @@ module BrDocuments
       end
 
       private
+
       def format_ie(number)
-        number.sub(/(\d{2})(\d{3})(\d{3})(\d{1})/, "\\1.\\2.\\3-\\4")
+        number.sub(/(\d{2})(\d{3})(\d{3})(\d{1})/, '\\1.\\2.\\3-\\4')
       end
     end
   end