bra_document_validation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27d8c78d6db49bc48c0e1dfd5ed47ed8dc9ae540e2b8972c28ef1a19d763b8bc
+  data.tar.gz: 2a2694b688925f879cf5d0fd2d859e107eab8305c33ea87f402674c7f469540f
+SHA512:
+  metadata.gz: 3179114b07dbd55af289d116e5d2c8dfb860aa67c7b6b7523d5051a79a17b1bc3e8e3d91a38d33b5fc54e544ad3df711b30dd0cecb20f2a4182a9b902dca2c3c
+  data.tar.gz: 047cede5bb6692ac13edd7fc06aca61382954df487d1708103de5f25ff96b4d785e28871449ac788b80a1aa86ede1b171d9a09d5a8299bca84a8205c6fd4dbb1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-11-08
+### Added
+  - CPF and CNPJ Validators

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bra_document_validation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    bra_document_validation (0.1.0)
+      activemodel (>= 4.0)
+      bra_documents
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    bra_documents (1.0.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.14.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bra_document_validation!
+  pry
+  pry-nav
+  rake
+  rspec
+
+BUNDLED WITH
+   2.1.4

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,62 @@
+# BraDocumentValidation
+
+This gem allows to validate Brazilian documents, CPF and CNPJ, with format and digit verification.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bra_document_validation'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bra_document_validation
+
+## Usage
+
+```rb
+validates :document_number, 'bra_document_validation/cpf': true
+validates :document_number, 'bra_document_validation/cnpj': true
+```
+
+# Format
+
+By default, it expects a raw document number (only numbers).
+However you can pass options if your number is formatted.
+
+```rb
+validates :document_number, 'bra_document_validation/cpf': { formatted: true }
+validates :document_number, 'bra_document_validation/cnpj': { formatted: false }
+```
+
+# Messaging
+
+When the document format does not match `invalid_format` message is added to the errors on field.
+When the document verification digit is invalid `invalid_verification_digit`.
+However you can add a custom message that substitute the above messages.
+
+```rb
+validates :document_number, 'bra_document_validation/cpf': { message: :invalid }
+validates :document_number, 'bra_document_validation/cnpj': { message: 'A custom message' }
+```
+
+## 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_document_validation.
+
+
+## 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_document_validation'
+
+# 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_document_validation.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/bra_document_validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bra_document_validation'
+  spec.version       = BraDocumentValidation::VERSION
+  spec.authors       = ['Bruno Vicenzo']
+  spec.email         = ['bruno@alumni.usp.br']
+
+  spec.summary       = %q{This gem add ActiveModel validations to Brazilian documents.}
+  spec.description   = %q{We can validate CPF and CNPJ formats and verifying digits.}
+  spec.homepage      = 'https://github.com/bvicenzo/bra_document_validation'
+  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_document_validation/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_runtime_dependency 'activemodel', '>= 4.0'
+  spec.add_runtime_dependency 'bra_documents'
+
+  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_document_validation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'bra_documents'
+require 'bra_document_validation/version'
+require 'bra_document_validation/cnpj_validator'
+require 'bra_document_validation/cpf_validator'
+
+module BraDocumentValidation
+end

data/lib/bra_document_validation/cnpj_validator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BraDocumentValidation
+  class CNPJValidator < ActiveModel::EachValidator
+    FORMATTED_CNPJ_PATTERN = /\A(\d{2}\.\d{3}\.\d{3}\/\d{4})-(\d{2})\Z/.freeze
+    RAW_CNPJ_PATTERN = /\A\d{14}\Z/.freeze
+    NOT_NUMBER_PATTERN = /\D/.freeze
+
+    def validate_each(record, attribute, value)
+      return record.errors.add(attribute, error_message(:invalid_format)) unless document_format.match?(value.to_s)
+      full_number = only_numbers_for(value.to_s)
+      record.errors.add(attribute, error_message(:invalid_verification_digit)) if black_listed?(full_number) || !digit_verified?(full_number)
+    end
+
+    private
+
+    def digit_verified?(full_number)
+      company_number, matrix_subsidiary_number = numbers_for(full_number)
+
+      full_number == BraDocuments::CNPJGenerator.generate(company_number: company_number, matrix_subsidiary_number: matrix_subsidiary_number)
+    end
+
+    def numbers_for(value)
+      number = value.gsub(NOT_NUMBER_PATTERN, '').chars
+
+      [
+        number.shift(BraDocuments::CNPJGenerator::COMPANY_NUMBER_SIZE).join,
+        number.shift(BraDocuments::CNPJGenerator::MATRIX_SUBSIDIARY_SIZE).join
+      ]
+    end
+
+    def only_numbers_for(value)
+      value.gsub(NOT_NUMBER_PATTERN, '')
+    end
+
+    def black_listed?(number)
+      number.chars.uniq.size == 1
+    end
+
+    def document_format
+      options[:formatted] ? FORMATTED_CNPJ_PATTERN : RAW_CNPJ_PATTERN
+    end
+
+    def error_message(default_message)
+      options.fetch(:message, default_message)
+    end
+  end
+end

data/lib/bra_document_validation/cpf_validator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BraDocumentValidation
+  class CPFValidator < ActiveModel::EachValidator
+    FORMATTED_CPF_PATTERN = /^(\d{3}\.\d{3}\.\d{3})-(\d{2})$/.freeze
+    RAW_CPF_PATTERN = /\A\d{11}\z/
+    NOT_NUMBER_PATTERN = /\D/.freeze
+
+    def validate_each(record, attribute, value)
+      return record.errors.add(attribute, error_message(:invalid_format)) unless document_format.match?(value.to_s)
+      full_number = only_numbers_for(value.to_s)
+      record.errors.add(attribute, error_message(:invalid_verification_digit)) if black_listed?(full_number) || !digit_verified?(full_number)
+    end
+
+    private
+
+    def digit_verified?(number)
+      person_number = number_without_verifying_digits_for(number)
+
+      number == BraDocuments::CPFGenerator.generate(person_number: person_number)
+    end
+
+    def number_without_verifying_digits_for(number)
+      number.chars.shift(BraDocuments::CPFGenerator::PERSON_NUMBER_SIZE).join
+    end
+
+    def only_numbers_for(value)
+      value.gsub(NOT_NUMBER_PATTERN, '')
+    end
+
+    def black_listed?(number)
+      number.chars.uniq.size == 1
+    end
+
+    def document_format
+      options[:formatted] ? FORMATTED_CPF_PATTERN : RAW_CPF_PATTERN
+    end
+
+    def error_message(default_message)
+      options.fetch(:message, default_message)
+    end
+  end
+end

data/lib/bra_document_validation/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BraDocumentValidation
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: bra_document_validation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bruno Vicenzo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bra_documents
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: We can validate CPF and CNPJ formats and verifying digits.
+email:
+- bruno@alumni.usp.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bra_document_validation.gemspec
+- lib/bra_document_validation.rb
+- lib/bra_document_validation/cnpj_validator.rb
+- lib/bra_document_validation/cpf_validator.rb
+- lib/bra_document_validation/version.rb
+homepage: https://github.com/bvicenzo/bra_document_validation
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/bvicenzo/bra_document_validation
+  source_code_uri: https://github.com/bvicenzo/bra_document_validation
+  changelog_uri: https://github.com/bvicenzo/bra_document_validation/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: This gem add ActiveModel validations to Brazilian documents.
+test_files: []