br_documents 0.1.3 → 0.2.0

data/lib/br_documents/ie/sp.rb

@@ -1,17 +1,18 @@
-require_relative "base"
-require_relative "../commons/mod11"
+require_relative 'base'
+require_relative '../commons/mod11'
 
 module BrDocuments
   module IE
     class SP < Base
       include Commons::Mod11
 
-      private
+      protected
+
       def format_ie(number)
-        if number.gsub(/(\-)|(\.)|(\/)/, "").length == 13
-          number.sub(/(\w{1})(\d{8})(\d{1})(\d{3})/, "\\1-\\2.\\3/\\4")
+        if number.gsub(/(\-)|(\.)|(\/)/, '').length == 13
+          number.sub(/(\w{1})(\d{8})(\d{1})(\d{3})/, '\\1-\\2.\\3/\\4')
         else
-          number.sub(/(\d{3})(\d{3})(\d{3})(\d{3})/, "\\1.\\2.\\3.\\4")
+          number.sub(/(\d{3})(\d{3})(\d{3})(\d{3})/, '\\1.\\2.\\3.\\4')
         end
       end
 
@@ -20,33 +21,35 @@ module BrDocuments
         regex.match(@number).present?
       end
 
-      def valid_digital_check?
-        if @number[0].eql? "P"
+      def valid_check_digit?
+        if @number[0] == 'P'
           valid_rural_producer_digital_check?
         else
           valid_standard_digital_check?
         end
       end
 
+      private
+
       def valid_standard_digital_check?
-        @number.gsub!(/[\.\/P-]/, "")
+        @number.gsub!(/[\.\/P-]/, '')
 
         weight1 = [1, 3, 4, 5, 6, 7, 8, 10]
         weight2 = [3, 2, 10, 9, 8, 7, 6, 5, 4, 3, 2]
 
-        dc1 = generate_digital_check(weight1)
-        dc2 = generate_digital_check(weight2)
+        dc1 = generate_check_digit(weight1)
+        dc2 = generate_check_digit(weight2)
 
         (@number[8] == dc1) and (@number[11] == dc2)
       end
 
       def valid_rural_producer_digital_check?
-        @number.gsub!(/[\.\/P-]/, "")
+        @number.gsub!(/[\.\/P-]/, '')
         weight9 = [1, 3, 4, 5, 6, 7, 8, 10]
-        @number[8] == generate_digital_check(weight9)
+        @number[8] == generate_check_digit(weight9)
       end
 
-      def generate_digital_check(weights)
+      def generate_check_digit(weights)
         sum = reduce_weights(@number, weights)
         mod = sum % 11
         mod.to_s[-1]

data/lib/br_documents/ie/to.rb

@@ -1,11 +1,11 @@
-require_relative "pattern1"
+require_relative 'pattern1'
 
 module BrDocuments
   module IE
     class TO < Pattern1
       def initialize(number)
         super
-        if number.gsub(/(\.)|(\-)/, "").length == 9
+        if number.gsub(/(\.)|(\-)/, '').length == 9
           @mask = /^(\d{2}\.\d{6}\-\d{1})$|^(\d{9})$/
           @weight = [9, 8, 7, 6, 5, 4, 3, 2]
         else
@@ -15,11 +15,12 @@ module BrDocuments
       end
 
       private
+
       def format_ie(number)
-        if number.gsub(/(\.)|(\-)/, "").length == 9
-          number.sub(/(\d{2})(\d{6})(\d{1})/, "\\1.\\2-\\3")
+        if number.gsub(/(\.)|(\-)/, '').length == 9
+          number.sub(/(\d{2})(\d{6})(\d{1})/, '\\1.\\2-\\3')
         else
-          number.sub(/(\d{2})(\d{2})(\d{6})(\d{1})/, "\\1.\\2.\\3-\\4")
+          number.sub(/(\d{2})(\d{2})(\d{6})(\d{1})/, '\\1.\\2.\\3-\\4')
         end
       end
     end

data/lib/br_documents/ie_validator.rb

@@ -7,13 +7,13 @@ class IeValidator < ActiveModel::EachValidator
   end
 
   private
+
   def ie_present?(value)
     value.present?
   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')) unless options[:uf].present?
 
     options[:uf].present?
   end
@@ -22,8 +22,8 @@ class IeValidator < ActiveModel::EachValidator
     begin
       uf = read_uf(record)
     rescue NoMethodError
-      record.errors.add(:base, I18n.t("validator.ie.uf.no_present",
-        uf: options[:uf])
+      record.errors.add(
+        :base, I18n.t('validator.ie.uf.no_present', uf: options[:uf])
       )
     end
 
@@ -33,8 +33,8 @@ class IeValidator < ActiveModel::EachValidator
   def ie_valid?(record, attribute, value)
     begin
       record.errors.add(attribute, :invalid) unless number_valid?(record, value)
-    rescue ArgumentError => ex
-      record.errors.add(attribute, ex.message)
+    rescue ArgumentError => e
+      record.errors.add(attribute, e.message)
     end
     record.errors.messages.empty?
   end
@@ -47,7 +47,7 @@ class IeValidator < ActiveModel::EachValidator
 
   def read_uf(record)
     attribute = record
-    options[:uf].split("#").each do | field |
+    options[:uf].split('#').each do |field|
       attribute = attribute.send(field)
     end
     attribute

data/lib/br_documents/suframa/suframa.rb

@@ -0,0 +1,60 @@
+require_relative '../commons/mod11'
+
+# rubocop:disable Style/ClassAndModuleChildren
+class BrDocuments::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? &&
+      valid_activity_sector? &&
+      valid_administrative_unit?
+  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.split('').uniq.length == 1
+  end
+
+  def number_without_mask
+    @number_without_mask ||= @number.gsub('.', '')
+  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 valid_activity_sector?
+    activity_sector = number_without_mask[0] + number_without_mask[1]
+
+    ['01', '02', '10', '11', '20', '60'].include?(activity_sector)
+  end
+
+  def valid_administrative_unit?
+    administrative_unit = number_without_mask[6] + number_without_mask[7]
+
+    ['01', '10', '30'].include?(administrative_unit)
+  end
+
+  def format_number
+    @number.sub(/(\d{2})(\d{4})(\d{3})/, '\\1.\\2.\\3')
+  end
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/lib/br_documents/suframa_validator.rb

@@ -0,0 +1,8 @@
+class SuframaValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.blank?
+
+    suframa = BrDocuments::Suframa.new(value)
+    record.errors.add(attribute, :invalid) unless suframa.valid?
+  end
+end

data/lib/br_documents/version.rb

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

data/spec/cnpj_cpf/cnpj_spec.rb

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

data/spec/cnpj_cpf/cpf_spec.rb

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

data/spec/cnpj_validator_spec.rb

@@ -1,35 +1,35 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe CnpjValidator do
   before(:each) do
-    @validator = CnpjValidator.new(attributes: "cnpj")
-    @mock = double("model")
+    @validator = CnpjValidator.new(attributes: 'cnpj')
+    @mock = double('model')
     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]
+    allow(@mock.errors).to receive(:add) do |attribute, error|
+      @mock.errors.messages[attribute] = [error]
     end
   end
 
   subject { @validator }
 
-  context "when Cnpj is valid" do
+  context 'when Cnpj is valid' do
     it "doesn't add errors in model" do
-      subject.validate_each(@mock, "cnpj", "85961757000102")
+      subject.validate_each(@mock, 'cnpj', '85961757000102')
       expect(@mock.errors.messages).to be_empty
     end
   end
 
-  context "when Cnpj is blank" do
+  context 'when Cnpj is blank' do
     it "doesn't add errors in model" do
-      subject.validate_each(@mock, "cnpj", "")
+      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")
+  context 'when Cnpj is invalid' do
+    it 'adds errors in model' do
+      subject.validate_each(@mock, 'cnpj', '85961757000103')
       expect(@mock.errors.messages).to_not be_empty
     end
   end

data/spec/cpf_validator_spec.rb

@@ -1,35 +1,35 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe CpfValidator do
   before(:each) do
-    @validator = CpfValidator.new(attributes: "cpf")
-    @mock = double("model")
+    @validator = CpfValidator.new(attributes: 'cpf')
+    @mock = double('model')
     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]
+    allow(@mock.errors).to receive(:add) do |attribute, error|
+      @mock.errors.messages[attribute] = [error]
     end
   end
 
   subject { @validator }
 
-  context "when Cpf is valid" do
+  context 'when Cpf is valid' do
     it "doesn't add errors in model" do
-      subject.validate_each(@mock, "cpf", "01233254120")
+      subject.validate_each(@mock, 'cpf', '01233254120')
       expect(@mock.errors.messages).to be_empty
     end
   end
 
-  context "when Cpf is blank" do
+  context 'when Cpf is blank' do
     it "doesn't add errors in model" do
-      subject.validate_each(@mock, "cpf", "")
+      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")
+  context 'when Cpf is invalid' do
+    it 'adds errors in model' do
+      subject.validate_each(@mock, 'cpf', '01233254121')
       expect(@mock.errors.messages).to_not be_empty
     end
   end