br_documents 0.1.3 → 0.2.2

data/lib/br_documents/ie/ro.rb

@@ -1,17 +1,18 @@
-require_relative "base"
-require_relative "../commons/mod14"
+require_relative 'base'
+require_relative '../commons/mod14'
 
 module BrDocuments
   module IE
     class RO < Base
       include Commons::Mod14
 
-      private
+      protected
+
       def format_ie(number)
-        if number.gsub(/(\.)|(\-)/, "").length == 9
-          number.sub(/(\d{3})(\d{5})(\d{1})/, "\\1.\\2-\\3")
+        if number.gsub(/(\.)|(\-)/, '').length == 9
+          number.sub(/(\d{3})(\d{5})(\d{1})/, '\\1.\\2-\\3')
         else
-          number.sub(/(\d{13})(\d{1})/, "\\1-\\2")
+          number.sub(/(\d{13})(\d{1})/, '\\1-\\2')
         end
       end
 
@@ -19,6 +20,12 @@ module BrDocuments
         valid_old_format or valid_new_format
       end
 
+      def valid_check_digit?
+        valid_old_digital_check or valid_new_digital_check
+      end
+
+      private
+
       def valid_old_format
         regex = /^(\d{3}\.\d{5}\-\d{1})$|^(\d{9})$/
         regex.match(@number).present?
@@ -29,24 +36,20 @@ module BrDocuments
         regex.match(@number).present?
       end
 
-      def valid_digital_check?
-        valid_old_digital_check or valid_new_digital_check
-      end
-
       def valid_old_digital_check
         weight = [3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
         remove_mask!
-        @number[-1].eql? generate_digital_check(@number[-6, 6], weight).to_s
+        @number[-1] == generate_check_digit(@number[-6, 6], weight).to_s
       end
 
       def valid_new_digital_check
         weight = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
         remove_mask!
-        @number[-1].eql? generate_digital_check(@number, weight).to_s
+        @number[-1] == generate_check_digit(@number, weight).to_s
       end
 
       def remove_mask!
-        @number.gsub!(/[\.\/-]/, "")
+        @number.gsub!(/[\.\/-]/, '')
       end
     end
   end

data/lib/br_documents/ie/rr.rb

@@ -1,4 +1,4 @@
-require_relative "pattern1"
+require_relative 'pattern1'
 
 module BrDocuments
   module IE
@@ -10,11 +10,12 @@ module BrDocuments
       end
 
       private
+
       def format_ie(number)
-        number.sub(/(\d{8})(\d{1})/, "\\1-\\2")
+        number.sub(/(\d{8})(\d{1})/, '\\1-\\2')
       end
 
-      def generate_digital_check(values, weights)
+      def generate_check_digit(values, weights)
         sum = reduce_weights(values, weights)
         sum % 9
       end

data/lib/br_documents/ie/rs.rb

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

data/lib/br_documents/ie/sc.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{3})(\d{3})(\d{3})/, "\\1.\\2.\\3")
+        number.sub(/(\d{3})(\d{3})(\d{3})/, '\\1.\\2.\\3')
       end
     end
   end

data/lib/br_documents/ie/se.rb

@@ -1,11 +1,12 @@
-require_relative "pattern1"
+require_relative 'pattern1'
 
 module BrDocuments
   module IE
     class SE < Pattern1
       private
+
       def format_ie(number)
-        number.sub(/(\d{8})(\d{1})/, "\\1-\\2")
+        number.sub(/(\d{8})(\d{1})/, '\\1-\\2')
       end
     end
   end

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')) if options[:uf].blank?
 
     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.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/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.2'.freeze
 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/spec/br_documents/cnpj_cpf/cnpj_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe BrDocuments::CnpjCpf::Cnpj do
+  describe '#formatted' do
+    it 'returns a formatted number' do
+      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 = described_class.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|
+      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 = 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 = 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 = 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 = 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 = described_class.new(number)
+      expect(cnpj).to be_valid
+    end
+  end
+end

data/spec/br_documents/cnpj_cpf/cpf_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe BrDocuments::CnpjCpf::Cpf do
+  describe '#formatted' do
+    it 'returns a formatted number' do
+      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 = described_class.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|
+      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 = 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 = 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 = 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 = 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 = described_class.new(number)
+      expect(cpf).to be_valid
+    end
+  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

@@ -1,7 +1,7 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe BrDocuments::Gtin do
-  describe "#valid?" do
+  describe '#valid?' do
     context 'when the checksum is valid' do
       context 'when the GTIN has 8 digits' do
         subject { described_class.new('12345618') }
@@ -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,46 +1,46 @@
-require "spec_helper"
+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([])
     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.messages[attribute] = [error]
     end
   end
 
-  subject { GtinValidator.new(attributes: "gtin") }
-
-  context "when GTIN code is valid" do
-    before { subject.validate_each(record, "gtin", "1243658721548") }
+  context 'when GTIN code is valid' do
+    before { subject.validate_each(record, 'gtin', '1243658721548') }
 
     it "doesn't add errors in model" do
       expect(record.errors.messages).to be_empty
     end
   end
 
-  context "when GTIN is blank" do
-    before { subject.validate_each(record, "gtin", "") }
+  context 'when GTIN is blank' do
+    before { subject.validate_each(record, 'gtin', '') }
 
     it "doesn't add errors in model" do
       expect(record.errors.messages).to be_empty
     end
   end
 
-  context "when GTIN is nil" do
-    before { subject.validate_each(record, "gtin", nil) }
+  context 'when GTIN is nil' do
+    before { subject.validate_each(record, 'gtin', nil) }
 
     it "doesn't add errors in model" do
       expect(record.errors.messages).to be_empty
     end
   end
 
-  context "when GTIN is invalid" do
-    before { subject.validate_each(record, "gtin", "253667853") }
+  context 'when GTIN is invalid' do
+    before { subject.validate_each(record, 'gtin', '253667853') }
 
-    it "adds errors in model" do
+    it 'adds errors in model' do
       expect(record.errors.messages).to include 'gtin' => [:invalid]
     end
   end