cpf_cnpj 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de9eb28c1f452532ed8ac6d4f4de50a90dfbfcc3
-  data.tar.gz: 245f841bb1134f3c196b9844a3aa2b2cd0dd2aff
+  metadata.gz: d13c9e2acfdc0d60eb9ffeb2c9008fdd6bad5d0f
+  data.tar.gz: bf59d4b1eb0c251086bc8d241b2811b61f7cefec
 SHA512:
-  metadata.gz: 14b110b3d281159204b1615b7c5b382f209f34ceb2c5d5680468796d1f93424f60fd7c8f743a10a189581994dd14087f0c52b7699123d4acef65d8f062d846ff
-  data.tar.gz: 5ba1e893019527388659e6141fef1685cc715641857192c68591af0165c891bca36915a6ac7ddb8f346a2e9f631f1bf3e0b2d7605d245aa6d75c2d0ffb14286f
+  metadata.gz: 778b36870ff6afc4ad0b4c5ba65aa148aef45ba8b8005c2e277808c5559d8e7b7ef4b8e06ff1036aef81b188ce765f5befea46901cbedf84e940a85d672755b2
+  data.tar.gz: c5a4bd47257e4afa53b44bbf514b17bb4c8b2b0726b8cb4157895f42184db1713201ace9c75550a0d566efb4bf65d9497479f1d134c678d5ffae36197177631b

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - '2.1.8'
+  - '2.2.3'
+  - '2.3.0'

data/README.md

@@ -1,9 +1,15 @@
 # CPF/CNPJ
 
+[![Build Status](https://travis-ci.org/fnando/cpf_cnpj.svg)](https://travis-ci.org/fnando/cpf_cnpj)
+[![Code Climate](https://codeclimate.com/github/fnando/cpf_cnpj/badges/gpa.svg)](https://codeclimate.com/github/fnando/cpf_cnpj)
+[![Gem Version](https://badge.fury.io/rb/cpf_cnpj.svg)](http://badge.fury.io/rb/cpf_cnpj)
+
 This gem does some [CPF](http://en.wikipedia.org/wiki/Cadastro_de_Pessoas_F%C3%ADsicas)/[CNPJ](http://en.wikipedia.org/wiki/CNPJ) magic. It allows you to create, validate and format CPF/CNPJ, even through the command-line.
 
 Just making my life easier when filling these damn numbers on internet bankings and government sites.
 
+For ActiveModel/ActiveRecord validations, please check <https://github.com/fnando/validators>.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,16 +30,26 @@ Or install it yourself as:
 
 This library has the same API for both CNPJ/CPF, so only one of them is documented below.
 
-    require "cpf_cnpj"
+```ruby
+require "cpf_cnpj"
+
+CPF.valid?(number)    # Check if a CPF is valid
+CPF.generate          # Generate a random CPF number
+CPF.generate(true)    # Generate a formatted number
+
+cpf = CPF.new(number)
+cpf.formatted         # Return formatted CPF (xxx.xxx.xxx-xx)
+cpf.stripped          # Return stripped CPF (xxxxxxxxxxx)
+cpf.valid?            # Check if CPF is valid
+```
+
+#### Strict Validation
 
-    CPF.valid?(number)    # Check if a CPF is valid
-    CPF.generate          # Generate a random CPF number
-    CPF.generate(true)    # Generate a formatted number
+By default, validations will strip any characters that aren't numbers. This means that `532#####820------857\n96` is considered a valid number. To perform a strict validation use `strict: true`.
 
-    cpf = CPF.new(number)
-    cpf.formatted         # Return formatted CPF (xxx.xxx.xxx-xx)
-    cpf.stripped          # Return stripped CPF (xxxxxxxxxxx)
-    cpf.valid?            # Check if CPF is valid
+```ruby
+CPF.valid?(number, strict: true)
+```
 
 ### Command-line
 

data/Rakefile

@@ -1,2 +1,11 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+  t.warning = false
+end
+
+task :default => :test

data/bin/cnpj

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+$LOAD_PATH.unshift "#{__dir__}/../lib"
 require "cpf_cnpj"
-CNPJ::CLI.new(ARGV, STDIN, STDOUT, STDERR).start
+CpfCnpj::CLI.new(CNPJ, ARGV, STDIN, STDOUT, STDERR).start

data/bin/cpf

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+$LOAD_PATH.unshift "#{__dir__}/../lib"
 require "cpf_cnpj"
-CPF::CLI.new(ARGV, STDIN, STDOUT, STDERR).start
+CpfCnpj::CLI.new(CPF, ARGV, STDIN, STDOUT, STDERR).start

data/cpf_cnpj.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CPF::VERSION
 
-  gem.add_development_dependency "rspec"
   gem.add_development_dependency "pry-meta"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest-utils"
 end

data/lib/cnpj.rb

@@ -1,37 +1,40 @@
 class CNPJ
-  require "cnpj/cli"
+  require "cpf_cnpj"
   require "cnpj/formatter"
-  require "cnpj/generator"
   require "cnpj/verifier_digit"
 
   attr_reader :number
+  attr_reader :strict
 
   REGEX = /\A\d{2}\.\d{3}.\d{3}\/\d{4}-\d{2}\Z/
+  NUMBER_SIZE = 12
 
-  BLACKLIST = [
-    "00000000000000",
-    "11111111111111",
-    "22222222222222",
-    "33333333333333",
-    "44444444444444",
-    "55555555555555",
-    "66666666666666",
-    "77777777777777",
-    "88888888888888",
-    "99999999999999"
-  ]
+  BLACKLIST = %w[
+    00000000000000
+    11111111111111
+    22222222222222
+    33333333333333
+    44444444444444
+    55555555555555
+    66666666666666
+    77777777777777
+    88888888888888
+    9999999999999
+  ].freeze
 
-  def self.valid?(number)
-    new(number).valid?
+  def self.valid?(number, strict: false)
+    new(number, strict).valid?
   end
 
   def self.generate(formatted = false)
-    cnpj = new(Generator.generate)
+    number = CpfCnpj::Generator.generate(NUMBER_SIZE, VerifierDigit)
+    cnpj = new(number)
     formatted ? cnpj.formatted : cnpj.stripped
   end
 
-  def initialize(number)
+  def initialize(number, strict = false)
     @number = number.to_s
+    @strict = strict
   end
 
   def number=(number)
@@ -42,7 +45,7 @@ class CNPJ
   end
 
   def stripped
-    @stripped ||= Formatter.strip(number)
+    @stripped ||= Formatter.strip(number, strict)
   end
 
   def formatted
@@ -53,14 +56,15 @@ class CNPJ
     return unless stripped.size == 14
     return if BLACKLIST.include?(stripped)
 
-    _numbers = numbers[0...12]
-    _numbers << VerifierDigit.generate(_numbers)
-    _numbers << VerifierDigit.generate(_numbers)
+    digits = numbers[0...12]
+    digits << VerifierDigit.generate(digits)
+    digits << VerifierDigit.generate(digits)
 
-    _numbers[-2, 2] == numbers[-2, 2]
+    digits[-2, 2] == numbers[-2, 2]
   end
 
   private
+
   def numbers
     @numbers ||= stripped.each_char.to_a.map(&:to_i)
   end

data/lib/cnpj/formatter.rb

@@ -1,11 +1,14 @@
 class CNPJ
   class Formatter
+    STRICT_REGEX = /[\/.-]/
+    LOOSE_REGEX = /[^\d]/
+
     def self.format(number)
       strip(number).gsub(/\A(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})\Z/, "\\1.\\2.\\3/\\4-\\5")
     end
 
-    def self.strip(number)
-      number.to_s.gsub(/[^\d]/, "")
+    def self.strip(number, strict = false)
+      number.to_s.gsub(strict ? STRICT_REGEX : LOOSE_REGEX, "")
     end
   end
 end

data/lib/cpf.rb

@@ -1,38 +1,41 @@
 class CPF
-  require "cpf/cli"
+  require "cpf_cnpj"
   require "cpf/formatter"
-  require "cpf/generator"
   require "cpf/verifier_digit"
 
   attr_reader :number
+  attr_reader :strict
 
   REGEX = /\A\d{3}\.\d{3}\.\d{3}-\d{2}\Z/
+  NUMBER_SIZE = 9
 
-  BLACKLIST = [
-    "00000000000",
-    "11111111111",
-    "22222222222",
-    "33333333333",
-    "44444444444",
-    "55555555555",
-    "66666666666",
-    "77777777777",
-    "88888888888",
-    "99999999999",
-    "12345678909"
-  ]
+  BLACKLIST = %w[
+    00000000000
+    11111111111
+    22222222222
+    33333333333
+    44444444444
+    55555555555
+    66666666666
+    77777777777
+    88888888888
+    99999999999
+    12345678909
+  ].freeze
 
-  def self.valid?(number)
-    new(number).valid?
+  def self.valid?(number, strict: false)
+    new(number, strict).valid?
   end
 
   def self.generate(formatted = false)
-    cpf = new(Generator.generate)
+    number = CpfCnpj::Generator.generate(NUMBER_SIZE, VerifierDigit)
+    cpf = new(number)
     formatted ? cpf.formatted : cpf.stripped
   end
 
-  def initialize(number)
+  def initialize(number, strict = false)
     @number = number.to_s
+    @strict = strict
   end
 
   def number=(number)
@@ -43,25 +46,26 @@ class CPF
   end
 
   def stripped
-    @stripped ||= Formatter.strip(number)
+    @stripped ||= Formatter.strip(number, strict)
   end
 
   def formatted
     @formatted ||= Formatter.format(number)
   end
 
-  def valid?
+  def valid?(strict: false)
     return unless stripped.size == 11
     return if BLACKLIST.include?(stripped)
 
-    _numbers = numbers[0...9]
-    _numbers << VerifierDigit.generate(_numbers)
-    _numbers << VerifierDigit.generate(_numbers)
+    digits = numbers[0...9]
+    digits << VerifierDigit.generate(digits)
+    digits << VerifierDigit.generate(digits)
 
-    _numbers[-2, 2] == numbers[-2, 2]
+    digits[-2, 2] == numbers[-2, 2]
   end
 
   private
+
   def numbers
     @numbers ||= stripped.each_char.to_a.map(&:to_i)
   end

data/lib/cpf/formatter.rb

@@ -1,11 +1,14 @@
 class CPF
   class Formatter
+    STRICT_REGEX = /[.-]/
+    LOOSE_REGEX = /[^\d]/
+
     def self.format(number)
       strip(number).gsub(/\A(\d{3})(\d{3})(\d{3})(\d{2})\Z/, "\\1.\\2.\\3-\\4")
     end
 
-    def self.strip(number)
-      number.to_s.gsub(/[^\d]/, "")
+    def self.strip(number, strict = false)
+      number.to_s.gsub(strict ? STRICT_REGEX : LOOSE_REGEX, "")
     end
   end
 end

data/lib/cpf_cnpj.rb

@@ -1,3 +1,6 @@
+require "English"
 require "optparse"
+require "cpf_cnpj/generator"
+require "cpf_cnpj/cli"
 require "cpf"
 require "cnpj"

data/lib/cpf_cnpj/cli.rb

@@ -0,0 +1,109 @@
+module CpfCnpj
+  class CLI
+    attr_reader :document_class, :arguments, :stdin, :stdout, :stderr
+
+    def initialize(document_class, arguments, stdin, stdout, stderr)
+      @document_class = document_class
+      @arguments = arguments
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+    end
+
+    def bin_name
+      document_name.downcase
+    end
+
+    def document_name
+      document_class.name
+    end
+
+    def start
+      options = {}
+
+      opts.banner = "Usage: #{bin_name} [options] [#{document_name} number]"
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on("-c", "--check", "Check if #{document_name} is valid") do
+        options[:check] = true
+      end
+
+      opts.on("-g", "--generate", "Generate a new #{document_name}") do
+        options[:generate] = true
+      end
+
+      opts.on("-f", "--format", "Format #{document_name} with separators") do
+        options[:format] = true
+      end
+
+      opts.on("-s", "--strip", "Remove #{document_name} separators") do
+        options[:strip] = true
+      end
+
+      opts.on("-v", "--version", "Show version") do
+        stdout << VERSION
+        exit
+      end
+
+      opts.on_tail("-h", "--help", "Show help") do
+        help
+        exit
+      end
+
+      opts.parse!(arguments)
+      opts.permute!(arguments)
+
+      help if options.empty?
+      generate(options) if options[:generate]
+      input = stdin.tty? ? arguments.first : stdin.read
+      document = document_class.new(input)
+      validate(document)
+      format(document) if options[:format]
+      strip(document) if options[:strip]
+      check(document) if options[:check]
+    end
+
+    def validate(document)
+      return if document.valid?
+      stderr << "Error: Invalid number\n"
+      exit 1
+    end
+
+    # No-op method. CPF is always validated on CpfCnpj::CLI#start.
+    def check(_document)
+      exit
+    end
+
+    def generate(options)
+      document = document_class.new(document_class.generate)
+
+      if options[:strip]
+        stdout << document.stripped
+      else
+        stdout << document.formatted
+      end
+
+      exit
+    end
+
+    def format(document)
+      stdout << document.formatted
+      exit
+    end
+
+    def strip(document)
+      stdout << document.stripped
+      exit
+    end
+
+    def help
+      stderr << opts.to_s
+      exit 1
+    end
+
+    def opts
+      @opts ||= OptionParser.new
+    end
+  end
+end