simple_cpf_cnpj 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c48ec6a7277ae88f6940a5f497f016ab1fb40722
+  data.tar.gz: 8705d45f357935c0f251ccbe6d5025c5d077761e
+SHA512:
+  metadata.gz: 398e74ab0a04215fb60246520fd45d922122543ec5a70b6f333f584633d9c97217a42841bf0ce43d71bb77a5cf45473f033b5a026cc5fddd37a681817d66be70
+  data.tar.gz: b91dedda38533dad0f18d1e27125d9396e44bffeb285bec3b69b54e609817574776b47a8d7e739359c8ad461d48e95cf11861a837631e05724e3e062e84a543d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7-p374
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby
+  - ree
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cpf_cnpj.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 David Santos
+
+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,119 @@
+# simple_cpf_cnpj
+
+The gem `simple_cpf_cnpj` provides the module `CpfCnpj`, with utility
+methods for dealing with CPFs and CNPJs.
+
+A CPF is a Brazilian federal ID number issued to natural persons, and a CNPJ
+is its counterpart for juridic persons (companies and the like).
+
+The module provides methods for differentiating a CPF from a CNPJ, formatting,
+and validating the numbers by verifying the check digits.
+
+### Expected format
+
+The methods in this module expect CPFs/CNPJs as strings, with only numbers. If
+the string is formatted, it's up to you to remove the punctuation.
+
+For example:
+
+```ruby
+CpfCnpj.valid_cpf?(formatted_cpf.gsub(/\D/, ''))
+```
+
+## Compatibility
+
+The code has been tested with MRI Ruby (1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1, and 2.2), JRuby, and Ruby Enterprise Edition 1.8.7.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_cpf_cnpj'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install simple_cpf_cnpj
+```
+
+## Usage
+
+The full documentation can be found at: http://docs.dsantosdev.com/simple_cpf_cnpj/
+
+If necessary for your installation, add this to your code in the appropriate place:
+
+```ruby
+require 'simple_cpf_cnpj'
+```
+
+### Validate
+Use CpfCnpj.valid_cpf?, CpfCnpj.valid_cnpj?, or CpfCnpj.valid_cpf_cnpj? to
+check if a number is valid.
+
+```ruby
+CpfCnpj.valid_cpf?("12345678900") # invalid
+# => false
+CpfCnpj.valid_cpf?("11026822840") # valid
+# => true
+CpfCnpj.valid_cnpj?("12345678000100") # invalid
+# => false
+CpfCnpj.valid_cnpj?("63871464000193") # valid
+# => true
+CpfCnpj.valid_cpf_cnpj?("11026822840") # valid CPF
+# => true
+CpfCnpj.valid_cpf_cnpj?("63871464000193") # valid CNPJ
+# => true
+```
+
+### Format
+Use CpfCnpj.format to format a CPF or CNPJ.
+
+```ruby
+CpfCnpj.format("12345678987") # 11 characters (CPF)
+# => "123.456.789-87"
+CpfCnpj.format("01234567000198") # 14 characters (CNPJ)
+# => "01.234.567/0001-98"
+```
+
+### Identify the type
+Use CpfCnpj.type_of to determine if a number is a CPF or a CNPJ. Note that
+this check is only based on the length of the string. The actual characters in
+the string aren't checked at all.
+
+```ruby
+CpfCnpj.type_of("12345678987") # 11 characters
+# => :cpf
+CpfCnpj.type_of("123456789876") # 12 characters
+# => nil
+CpfCnpj.type_of("01234567000198") # 14 characters
+# => :cnpj
+```
+
+## Development
+
+**Note:** this is not necessary in order to use the gem, only to make changes
+or run the included tests.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/davidsantos-br/simple_cpf_cnpj.
+
+## License and copyright
+
+Copyright (c) 2015 David Santos
+
+This software is released under the MIT license, which can be found in the
+file [LICENSE](rdoc-ref:LICENSE).

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+Rake::TestTask.new(:test) do |t|
+	t.libs << "test"
+	t.libs << "lib"
+	t.test_files = FileList['test/**/*_test.rb']
+end
+
+RDoc::Task.new(:doc) do |rd|
+	rd.main = "README.md"
+	rd.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
+	rd.rdoc_dir = "doc/v#{CpfCnpj::VERSION}"
+end
+
+desc "Prepare the documentation for publishing"
+task 'doc:prepare' => [:doc] do |t|
+	File.write("doc/index.html", <<-EOT)
+		<html>
+			<head>
+				<meta http-equiv='content-type' content='text/html; charset=utf-8' />
+				<meta http-equiv='refresh' content='0; ./v#{CpfCnpj::VERSION}/index.html' />
+				<title>Redirecting&hellip;</title>
+			</head>
+			<body>Redirecting&hellip;</body>
+		</html>
+	EOT
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_cpf_cnpj"
+
+# 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

data/bin/setup

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

data/cpf_cnpj.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_cpf_cnpj/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "simple_cpf_cnpj"
+	spec.version       = CpfCnpj::VERSION
+	spec.authors       = ["David Santos"]
+	spec.email         = ["david@dsantosdev.com"]
+
+	spec.summary       = %q{Provides the module CpfCnpj, with functions to detect, format, and validate CPFs and CNPJs.}
+	spec.description   = %q{Provides the module CpfCnpj, with functions to detect, validate, and format CPFs and CNPJs (Brazilian federal ID numbers).}
+	spec.homepage      = "https://github.com/davidsantos-br/simple_cpf_cnpj"
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.bindir        = "exe"
+	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+	spec.required_ruby_version = '>= 1.8.7'
+
+	spec.add_development_dependency "bundler", "~> 1.10"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "minitest"
+	spec.add_development_dependency "rdoc"
+end

data/lib/simple_cpf_cnpj/version.rb

@@ -0,0 +1,3 @@
+module CpfCnpj # :nodoc:
+	VERSION = "0.1.0"
+end

data/lib/simple_cpf_cnpj.rb

@@ -0,0 +1,140 @@
+require "simple_cpf_cnpj/version"
+
+# +CpfCnpj+ is a module that provides utility methods for dealing with CPFs and CNPJs.
+#
+# A CPF is a Brazilian federal ID number issued to natural persons, and a CNPJ is its counterpart
+# for juridic persons (companies and the like).
+#
+# The module provides methods for differentiating a CPF from a CNPJ, formatting, and
+# validating the numbers by verifying the check digits.
+#
+# *Important:* The methods in this module expect CPFs/CNPJs as strings, with only numbers.
+# If the string is formatted, it's up to you to remove the punctuation.
+#
+# One way to do that is, for example:
+# 	CpfCnpj.valid_cpf?(formatted_cpf.gsub(/\D/, ''))
+module CpfCnpj
+	# Checks the length of +cpf_or_cnpj+ to determine if it's a CPF or a CNPJ.
+	#
+	# 	CpfCnpj.type_of("12345678987") # 11 characters
+	# 	# => :cpf
+	# 	CpfCnpj.type_of("123456789876") # 12 characters
+	# 	# => nil
+	# 	CpfCnpj.type_of("01234567000198") # 14 characters
+	# 	# => :cnpj
+	# 	CpfCnpj.type_of(nil)
+	# 	# => nil
+	# 	CpfCnpj.type_of(12345678987)
+	# 	# ArgumentError: argument must be a string or nil
+ 	def self.type_of(cpf_cnpj) # :arg: cpf_or_cnpj
+		return nil if cpf_cnpj.nil?
+		unless cpf_cnpj.is_a?(String)
+			raise(ArgumentError, "argument must be a string or nil")
+		end
+		case cpf_cnpj.length
+		when 11 ; :cpf
+		when 14 ; :cnpj
+		else ; nil
+		end
+	end
+
+	# Formats +cpf_or_cnpj+ as a CPF or a CNPJ.
+	#
+	# 	CpfCnpj.format("12345678987") # 11 characters (CPF)
+	# 	# => "123.456.789-87"
+	# 	CpfCnpj.format("123456789876") # 12 characters
+	# 	# => "123456789876"
+	# 	CpfCnpj.format("01234567000198") # 14 characters (CNPJ)
+	# 	# => "01.234.567/0001-98"
+	# 	CpfCnpj.format(nil)
+	# 	# => nil
+	# 	CpfCnpj.format(12345678987)
+	# 	# ArgumentError: argument must be a string or nil
+	def self.format(cpf_cnpj) # :arg: cpf_or_cnpj
+		case type_of(cpf_cnpj)
+		when :cpf
+			"#{cpf_cnpj[0..2]}.#{cpf_cnpj[3..5]}.#{cpf_cnpj[6..8]}-#{cpf_cnpj[9..10]}"
+		when :cnpj
+			"#{cpf_cnpj[0..1]}.#{cpf_cnpj[2..4]}.#{cpf_cnpj[5..7]}/#{cpf_cnpj[8..11]}-#{cpf_cnpj[12..13]}"
+		else
+			cpf_cnpj
+		end
+	end
+
+	# Validates +cpf+ as a CPF by verifying that the check digits match.
+	#
+	# 	CpfCnpj.valid_cpf?("12345678900") # invalid
+	# 	# => false
+	# 	CpfCnpj.valid_cpf?("11026822840") # valid
+	# 	# => true
+	# 	CpfCnpj.valid_cpf?("63871464000193") # valid CNPJ
+	# 	# => false
+	# 	CpfCnpj.valid_cpf?(nil)
+	# 	# => false
+	# 	CpfCnpj.valid_cpf?(11026822840)
+	# 	# ArgumentError: argument must be a string or nil
+	def self.valid_cpf?(cpf)
+		return type_of(cpf) == :cpf && _mod11_check(cpf, 11)
+	end
+
+	# Validates +cnpj+ as a CNPJ by verifying that the check digits match.
+	#
+	# 	CpfCnpj.valid_cnpj?("12345678000100") # invalid
+	# 	# => false
+	# 	CpfCnpj.valid_cnpj?("63871464000193") # valid
+	# 	# => true
+	# 	CpfCnpj.valid_cnpj?("11026822840") # valid CPF
+	# 	# => false
+	# 	CpfCnpj.valid_cnpj?(nil)
+	# 	# => false
+	# 	CpfCnpj.valid_cnpj?(63871464000193)
+	# 	# ArgumentError: argument must be a string or nil
+	def self.valid_cnpj?(cnpj)
+		return type_of(cnpj) == :cnpj && _mod11_check(cnpj, 9)
+	end
+
+	# Validates +cnpj_or_cnpj+ as either a CPF or a CNPJ by verifying that the check digits match.
+	#
+	# 	CpfCnpj.valid_cpf_cnpj?("12345678900") # invalid CPF
+	# 	# => false
+	# 	CpfCnpj.valid_cpf_cnpj?("12345678000100") # invalid CNPJ
+	# 	# => false
+	# 	CpfCnpj.valid_cpf_cnpj?("11026822840") # valid CPF
+	# 	# => true
+	# 	CpfCnpj.valid_cpf_cnpj?("63871464000193") # valid CNPJ
+	# 	# => true
+	# 	CpfCnpj.valid_cpf_cnpj?(nil)
+	# 	# => false
+	# 	CpfCnpj.valid_cpf_cnpj?(63871464000193)
+	# 	# ArgumentError: argument must be a string or nil
+	def self.valid_cpf_cnpj?(cpf_cnpj) # :arg: cpf_or_cnpj
+		return valid_cpf?(cpf_cnpj) || valid_cnpj?(cpf_cnpj)
+	end
+
+	def self._mod11_check_digit(digits, mult_max) # :nodoc:
+		sum = 0
+		mult = 2
+		digits[0..-2].reverse.each_char do |digit|
+			digit = _int_value(digit)
+			return false unless digit.between?(0, 9)
+			sum += mult * digit
+			mult += 1
+			mult = 2 if mult > mult_max
+		end
+		sum = 11 - (sum % 11)
+		sum = 0 if sum > 9
+		_int_value(digits[-1]) == sum
+	end
+
+	def self._mod11_check(digits, mult_max) # :nodoc:
+		_mod11_check_digit(digits[0..-2], mult_max) && _mod11_check_digit(digits, mult_max)
+	end
+
+	# ruby 1.8.7 doesn't have String#ord, and in versions after 1.8.7 String#[num] returns a
+	# one-character string instead of the byte value of the character.
+	# Since the return of this is always used to perform what is essentially an unclamped to_i
+	# on the first character, do it right here.
+	def self._int_value(str) # :nodoc:
+		(str.respond_to?(:ord) ? str.ord : str[0]) - 48
+	end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: simple_cpf_cnpj
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Santos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rdoc
+  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: Provides the module CpfCnpj, with functions to detect, validate, and
+  format CPFs and CNPJs (Brazilian federal ID numbers).
+email:
+- david@dsantosdev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cpf_cnpj.gemspec
+- lib/simple_cpf_cnpj.rb
+- lib/simple_cpf_cnpj/version.rb
+homepage: https://github.com/davidsantos-br/simple_cpf_cnpj
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Provides the module CpfCnpj, with functions to detect, format, and validate
+  CPFs and CNPJs.
+test_files: []