bra_documents 1.0.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bruno Vicenzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,155 @@
+# BraDocuments
+
+[![Build Status](https://travis-ci.com/bvicenzo/bra_documents.svg?branch=master)](https://travis-ci.com/bvicenzo/bra_documents)
+
+This gem make us able to generate Brazilian documents, such as CPF and CNPJ.
+We can generate a tottaly random number, or pass the number and the gem completes with the verification digits.
+If you already have a CPF or CNPJ only their numbers, you can also put the mask using the formatter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bra_documents'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bra_documents
+
+## Usage
+
+### CPF Generation
+
+```rb
+BraDocuments::CPFGenerator.generate
+#=> "86027265892"
+
+BraDocuments::CPFGenerator.generate(formatted: true)
+#=> "038.857.544-10"
+
+BraDocuments::CPFGenerator.generate(person_number: '123123123')
+#=> "12312312387"
+
+BraDocuments::CPFGenerator.generate(person_number: '123123123', formatted: true)
+#=> "123.123.123-87"
+```
+
+### CNPJ Generation
+
+```rb
+BraDocuments::CNPJGenerator.generate
+#=> "62885807804809"
+
+BraDocuments::CNPJGenerator.generate(formatted: true)
+#=> "53.855.973/0664-39"
+
+BraDocuments::CNPJGenerator.generate(company_number: '53855973')
+#=> "53855973879456"
+
+BraDocuments::CNPJGenerator.generate(company_number: '53855973', formatted: true)
+#=> "53.855.973/8189-02"
+
+BraDocuments::CNPJGenerator.generate(company_number: '53855973', matrix_subsidiary_number: '0001')
+#=> "53855973000179"
+
+BraDocuments::CNPJGenerator.generate(company_number: '53855973', matrix_subsidiary_number: '0001', formatted: true)
+#=> "53.855.973/0001-79"
+```
+
+### Formatting
+
+```rb
+BraDocuments::Formatter.format('86027265892', as: :cpf)
+# => "860.272.658-92"
+
+BraDocuments::Formatter.format('53855973879456', as: :cnpj)
+#=> "53.855.973/8794-56"
+```
+
+### Tests Matching
+
+#### Config
+If you use RSpec to test your apps we also provide mathers to make easy test if your field has a CPF with a valid format.
+
+In your `spec/spec_helper.rb` file, require our helpers.
+
+```rb
+# spec/spec_helper.rb
+
+require 'bra_documents/testing/rspec'
+```
+
+#### Using
+
+```rb
+RSpec.describe 'my tests' do
+  it 'is a formatted CPF' do
+    expect('123.456.789-00').to be_a_formatted_cpf
+  end
+
+  it 'receives a formatted CPF' do
+    object = double(action: true)
+
+    expect(object).to receive(:action).with(a_formatted_cpf)
+
+    object.action('123.456.789-00')
+  end
+
+  it 'is a raw CPF' do
+    expect('12345678900').to be_a_raw_cpf
+  end
+
+  it 'receives a raw CPF' do
+    object = double(action: true)
+
+    expect(object).to receive(:action).with(a_raw_cpf)
+
+    object.action('12345678900')
+  end
+
+  it 'is a formatted CNPJ' do
+    expect('53.855.973/8794-56').to be_a_formatted_cnpj
+  end
+
+  it 'receives a formatted CNPJ' do
+    object = double(action: true)
+
+    expect(object).to receive(:action).with(a_formatted_cnpj)
+
+    object.action('53.855.973/8794-56')
+  end
+
+  it 'is a raw CNPJ' do
+    expect('53855973879456').to be_a_raw_cnpj
+  end
+
+  it 'receives a raw CNPJ' do
+    object = double(action: true)
+
+    expect(object).to receive(:action).with(a_raw_cnpj)
+
+    object.action('53855973879456')
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bra_documents.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bra_documents"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bra_documents.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/bra_documents/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bra_documents'
+  spec.version       = BraDocuments::VERSION
+  spec.authors       = ['Bruno Vicenzo']
+  spec.email         = ['bruno@alumni.usp.br']
+
+  spec.summary       = %q{A implementation for generating Brazilian CPF and CNPJ document numbers.}
+  spec.description   = %q{Here we are able to generate CPNJ and CPF documents, only numbers or formatted.}
+  spec.homepage      = 'https://github.com/bvicenzo/bra_documents'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/bvicenzo/bra_documents/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/bra_documents.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bra_documents/national_register_base'
+require 'bra_documents/cpf_generator'
+require 'bra_documents/cnpj_generator'
+require 'bra_documents/formatter'
+require "bra_documents/version"
+
+
+module BraDocuments
+end

data/lib/bra_documents/cnpj_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Libs are following this issue: https://github.com/rails/rails/issues/37835
+# Rules to generate a CPF https://www.geradorcpf.com/algoritmo_do_cpf.htm
+
+module BraDocuments
+  class CNPJGenerator < NationalRegisterBase
+    COMPANY_NUMBER_SIZE = 8
+    MATRIX_SUBSIDIARY_SIZE = 4
+
+    class << self
+      # Generates a random CNPJ document number or add verifying digits to one if it's given.
+      # It can return only numbers or formatted with mask
+      #
+      # BraDocuments::CNPJGenerator.generate # => "62885807804809"
+      # BraDocuments::CNPJGenerator.generate(formatted: true) # => "53.855.973/0664-39"
+      # BraDocuments::CNPJGenerator.generate(company_number: '53855973') # => "53855973879456"
+      # BraDocuments::CNPJGenerator.generate(company_number: '53855973', formatted: true) # => "53.855.973/8189-02"
+      # BraDocuments::CNPJGenerator.generate(company_number: '53855973', matrix_subsidiary_number: '0001') # => "53855973000179"
+      # BraDocuments::CNPJGenerator.generate(company_number: '53855973', matrix_subsidiary_number: '0001', formatted: true) # => "53.855.973/0001-79"
+      def generate(company_number: nil, matrix_subsidiary_number: nil, formatted: false)
+        company_number = number_for('Company', COMPANY_NUMBER_SIZE, company_number)
+        matrix_subsidiary_number = number_for('Matrix or subsidiary', MATRIX_SUBSIDIARY_SIZE, matrix_subsidiary_number)
+        numbers = company_number + matrix_subsidiary_number
+
+        full_number = complete!(numbers)
+
+        formatted ?  Formatter.format(full_number, as: :cnpj) : full_number
+      end
+
+      private
+
+      def verification_digit_multiplicators_for(numbers)
+        (2..(numbers.size - 7)).to_a.reverse + (2..9).to_a.reverse
+      end
+    end
+  end
+end

data/lib/bra_documents/cpf_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Libs are following this issue: https://github.com/rails/rails/issues/37835
+# Rules to generate a CPF https://www.geradorcpf.com/algoritmo_do_cpf.htm
+
+module BraDocuments
+  class CPFGenerator < NationalRegisterBase
+    PERSON_NUMBER_SIZE = 9
+
+    class << self
+      # Generates a random CPF document number or add verifying digits to one if it's given.
+      # It can return only numbers or formatted with mask
+      #
+      # BraDocuments::CPFGenerator.generate # => "86027265892"
+      # BraDocuments::CPFGenerator.generate(formatted: true) # => "038.857.544-10"
+      # BraDocuments::CPFGenerator.generate(person_number: '123123123') # => "12312312387"
+      # BraDocuments::CPFGenerator.generate(person_number: '123123123', formatted: true) # => "123.123.123-87"
+      def generate(person_number: nil, formatted: false)
+        numbers = number_for('Person', PERSON_NUMBER_SIZE, person_number)
+        full_number = complete!(numbers)
+
+        formatted ?  Formatter.format(full_number, as: :cpf) : full_number
+      end
+
+      private
+
+      def verification_digit_multiplicators_for(numbers)
+        (2..numbers.size.next).to_a.reverse
+      end
+    end
+  end
+end

data/lib/bra_documents/formatter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BraDocuments
+  class Formatter
+    FORMATS = {
+      cpf: { pattern: /\A(\d{3})(\d{3})(\d{3})(\d{2})\z/, mask: '%s.%s.%s-%s' },
+      cnpj: { pattern: /\A(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})\z/, mask: '%s.%s.%s/%s-%s'}
+    }.freeze
+
+    # Formats a only numbers CPF or CNPJ in their own mask
+    #
+    # BraDocuments::Formatter.format('86027265892', as: :cpf) # => "860.272.658-92"
+    # BraDocuments::Formatter.format('53855973879456', as: :cnpj) # => "53.855.973/8794-56"
+    def self.format(number, as:)
+      format_data = FORMATS[as]
+
+      Kernel.format(format_data[:mask], *format_data[:pattern].match(number).captures)
+    end
+  end
+end
+

data/lib/bra_documents/national_register_base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module BraDocuments
+  class NationalRegisterBase
+    class << self
+      NOT_NUMBER_PATTERN = /\D/.freeze
+      BASE = 11
+
+      private
+
+      def complete!(numbers)
+        2.times { numbers.push(verification_digit_for(numbers)) }
+        numbers.join
+      end
+
+      def number_for(number_description, number_size, given_value)
+        given_value = only_digits_for(given_value)
+        if !given_value.to_s.empty?
+          raise ArgumentError, "#{number_description} number must be a number with #{number_size} digits." unless given_value.size == number_size
+          given_value.split('').map(&:to_i)
+        else
+          number_with(number_size)
+        end
+      end
+
+      def number_with(size)
+        size.times.map { rand(10) }
+      end
+
+      def only_digits_for(number)
+        number.to_s.gsub(NOT_NUMBER_PATTERN, '')
+      end
+
+      def verification_digit_for(numbers)
+        verification_digit_multiplicators = verification_digit_multiplicators_for(numbers)
+        sum_and_multiplication = sum_and_multiply(numbers, verification_digit_multiplicators)
+        verified_digit(sum_and_multiplication)
+      end
+
+      def verified_digit(sum_and_multiplication)
+        rest = sum_and_multiplication % BASE
+        rest < 2 ? 0 : BASE - rest
+      end
+
+      def sum_and_multiply(numbers, multiplicators)
+        multiplicators.map
+          .with_index { |multiplicator, position| numbers[position] * multiplicator }
+          .sum
+      end
+    end
+  end
+end

data/lib/bra_documents/testing/rspec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bra_documents/testing/rspec/matchers/cpf_matcher'
+require 'bra_documents/testing/rspec/matchers/cnpj_matcher'

data/lib/bra_documents/testing/rspec/matchers/cnpj_matcher.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+RSpec::Matchers.define :a_formatted_cnpj do
+  match do |cnpj|
+    formatted_cnpj_pattern = /\A(\d{2}\.\d{3}\.\d{3}\/\d{4})-(\d{2})\z/
+
+    formatted_cnpj_pattern.match?(cnpj.to_s)
+  end
+
+  failure_message do |cnpj|
+    "Was expected `#{cnpj.inspect}` to be a Brazilian CNPJ document number but it isn't.\n"\
+      "A CNPJ has the following format XX.XXX.XXX/XXXX-XX where X are numbers from 0 to 9.\n"
+  end
+end
+
+RSpec::Matchers.define :a_raw_cnpj do
+  match do |cnpj|
+    raw_cnpj_pattern = /\A\d{14}\z/
+
+    raw_cnpj_pattern.match?(cnpj.to_s)
+  end
+
+  failure_message do |cnpj|
+    "Was expected `#{cnpj.inspect}` to be a raw Brazilian cnpj document number but it isn't.\n"\
+      "A raw CNPJ has the following format XXXXXXXXXXXXXX where X are numbers from 0 to 9.\n"
+  end
+end
+
+RSpec::Matchers.alias_matcher :be_a_formatted_cnpj, :a_formatted_cnpj
+RSpec::Matchers.alias_matcher :be_a_raw_cnpj, :a_raw_cnpj