br-cpf 0.1.2 → 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,28 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## BUNDLE
+.bundle
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+doc
+
+## PROJECT::SPECIFIC
+tmp
+*.so
+*.gemspec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in br-cpf.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rake (0.8.7)
+    rake-compiler (0.7.1)
+      rake (>= 0.8.3, < 0.9)
+    rspec (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake-compiler
+  rspec (~> 1.3.0)

data/README.rdoc

@@ -1,6 +1,7 @@
 = BR::CPF
 
 Lib implementada em C (gera uma lib compilada nativamente) que calcula e valida CPFs.
+Recomendada para Validar CPFs ou Gerar CPFs quando o sistema requer que sejam feitas mais de 1000 Validações/Gerações por segundo.
 
 == Instalação
 
@@ -8,9 +9,12 @@ Lib implementada em C (gera uma lib compilada nativamente) que calcula e valida
 
 == Exemplos
 
+=== Usar
  require 'rubygems'
  require 'br/cpf'
 
+=== Validar
+
  BR::CPF.valid? '00000000191'
   => true
 
@@ -20,11 +24,64 @@ Lib implementada em C (gera uma lib compilada nativamente) que calcula e valida
  BR::CPF.valid? 12345678900
   => false
 
- raiz = 0
+=== Gerar CPF
+
+ raiz = 1
  BR::CPF.new(raiz).to_s
   => '00000000191'
 
+== Benchmark sobre uma implementação puro Ruby
+Comparação de validação com a brcpfcnpj (Brazilian Rails)
+
+  $ cat benchmark.rb
+  require "rubygems"
+  require "br/cpf"
+  require "brcpfcnpj"
+  require "benchmark"
+
+  [1, 10, 100, 1000, 10_000, 100_000, 1_000_000].each do |n|
+    puts "Teste com n = #{n}"
+    Benchmark.bm do |x|
+      x.report { n.times { BR::CPF.valid?(rand(999_999_999_99).to_s.rjust(11, '0')) } }
+      x.report { n.times { Cpf.new(rand(999_999_999_99).to_s.rjust(11, '0')).valido? } }
+    end
+  end
+
+Resultados
+
+  Teste com n = 1
+    user     system      total        real
+    0.000000   0.000000   0.000000 (  0.000053)
+    0.000000   0.000000   0.000000 (  0.000243)
+  Teste com n = 10
+    user     system      total        real
+    0.000000   0.000000   0.000000 (  0.000080)
+    0.000000   0.000000   0.000000 (  0.001187)
+  Teste com n = 100
+    user     system      total        real
+    0.000000   0.000000   0.000000 (  0.002193)
+    0.020000   0.000000   0.020000 (  0.011373)
+  Teste com n = 1000
+    user     system      total        real
+    0.020000   0.000000   0.020000 (  0.017329)
+    0.150000   0.000000   0.150000 (  0.169375)
+  Teste com n = 10000
+    user     system      total        real
+    0.100000   0.000000   0.100000 (  0.094112)
+    1.490000   0.010000   1.500000 (  1.512164)
+  Teste com n = 100000
+    user     system      total        real
+    0.850000   0.000000   0.850000 (  0.874577)
+    15.050000   0.010000  15.060000 ( 15.193196)
+  Teste com n = 1000000
+    user     system      total        real
+    8.570000   0.010000   8.580000 (  8.631888)
+    150.620000   0.210000 150.830000 (152.158936)
+
+== Desvantagens
+Por precisar compilar a extensão em C, acaba incompatível com sistemas que não tem um compilador em C (Windows).
 
+E quando o ritmo de comparação for menor que 1000 por segundo a diferença é pequena, por volta de de 0.15 segundos. Talvez o acumulo de dependência não valha a pena.
 
 == Copyright
 

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/ext/CPF/cpf.c

@@ -1,7 +1,7 @@
 #include <stdlib.h>
 #include "cpf.h"
 
-long long calcula_digito_cpf(long long raiz){
+long long calc_check_digit(long long raiz){
     int produto=0, i, digito;
     long long aux=raiz, cpf;
     lldiv_t divisao;
@@ -27,8 +27,8 @@ long long calcula_digito_cpf(long long raiz){
 }
 
 
-int e_cpf(long long cpf){
-    return cpf==calcula_digito_cpf((long long)cpf / 100);
+int is_valid(long long cpf){
+    return cpf==calc_check_digit((long long)cpf / 100);
 }
 
 

data/ext/CPF/cpf.h

@@ -5,8 +5,8 @@
 extern "C" {
 #endif
 
-long long calcula_digito_cpf(long long raiz);
-int e_cpf(long long cpf);
+long long calc_check_digit(long long raiz);
+int is_valid(long long cpf);
 
 #ifdef	__cplusplus
 }

data/lib/br/cpf/cpf_wrapper.rb

@@ -0,0 +1,9 @@
+require 'ffi'
+module BR
+  module CPFWrapper
+    extend FFI::Library
+    ffi_lib File.join(File.dirname(__FILE__), "..", "..", "CPF.so")
+    attach_function :calc_check_digit, [:long_long], :long_long
+    attach_function :is_valid, [:long_long], :bool
+  end
+end

data/lib/br/cpf/version.rb

@@ -0,0 +1,5 @@
+module BR
+  class CPF
+    VERSION = "1.0.0"
+  end
+end

data/lib/br/cpf.rb

@@ -1,25 +1,49 @@
-require File.join(File.dirname(__FILE__), '../CPF')
+require File.join(File.dirname(__FILE__), 'cpf/cpf_wrapper')
 
 module BR
   class CPF
-    class << self
-      alias_method :orig_valid?, :valid?
+
+    CPF_MIN = 1
+    CPF_MAX = 999999999
+
+    extend CPFWrapper
+
+    attr_reader :cpf, :verif
+
+    def initialize(raiz)
+      self.raiz = raiz
+    end
+
+    def valid?
+      @valid
+    end
+
+    def raiz=(raiz)
+      @raiz = raiz.to_i
+      raise ArgumentError, "raiz should be between #{CPF_MIN} and #{CPF_MAX}" if @raiz < CPF_MIN or @raiz > CPF_MAX
+      @cpf = self.class.calc_check_digit(@raiz)
+      @verif = @cpf % 100
+      @valid = true
+    end
+
+    def raiz
+      @raiz
     end
 
     def self.valid?(cpf)
       if cpf.is_a? String
-        orig_valid?(cpf.to_i)
+        is_valid(cpf.to_i)
       else
-        orig_valid?(cpf)
+        is_valid(cpf)
       end
     end
 
     def to_i
-      @raiz * 100 + @verif
+      @cpf
     end
 
     def to_s
-      "%011d" % to_i
+      "%011d" % @cpf
     end
   end
 end

data/spec/br-cpf_spec.rb

@@ -2,6 +2,23 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe BR::CPF do
 
+  context "initializing new CPFs" do
+
+    it "should initialize correctly VALID CPFS" do
+      VALID_CPFS_INTEGER.each do |valid_cpf|
+        BR::CPF.new(valid_cpf/100).to_s.should == 
+          valid_cpf.to_s.rjust(11, '0')
+      end
+    end
+
+    it "should initializa correctly VALID CPFS as string" do
+      VALID_CPFS_STRING.each do |valid_cpf|
+        BR::CPF.new(valid_cpf[0,9]).to_s.should == valid_cpf
+      end
+    end
+
+  end
+
   context "when Fixnum" do
 
     it "should return true for valid cpfs" do

data/spec/faker_cpf.rb

@@ -45,9 +45,9 @@ module Faker
 
     INVALID_CPFS_INTEGER = VALID_CPFS_INTEGER.collect { |cpf| cpf + 1}
 
-    VALID_CPFS_STRING = VALID_CPFS_INTEGER.collect { |cpf| cpf.to_s }
+    VALID_CPFS_STRING = VALID_CPFS_INTEGER.collect { |cpf| cpf.to_s.rjust(11, '0') }
 
-    INVALID_CPFS_STRING = INVALID_CPFS_INTEGER.collect { |cpf| cpf.to_s}
+    INVALID_CPFS_STRING = INVALID_CPFS_INTEGER.collect { |cpf| cpf.to_s.rjust(11, '0') }
 
   end
 end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

metadata

@@ -1,84 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: br-cpf
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Bruno Coimbra
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-04-16 00:00:00 -03:00
+date: 2011-09-04 00:00:00.000000000 -03:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &78340280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+  version_requirements: *78340280
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &78340020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-description: Lib implemented in C that calculates and validates CPF.
-email: bbcoimbra@gmail.com
+  prerelease: false
+  version_requirements: *78340020
+description: ''
+email:
+- bbcoimbra@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/CPF/extconf.rb
-extra_rdoc_files: 
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
-files: 
+- Rakefile
+- VERSION
 - ext/CPF/cpf.c
 - ext/CPF/cpf.h
 - ext/CPF/extconf.rb
-- ext/CPF/ruby_cpf.c
 - lib/br/cpf.rb
-- LICENSE
-- README.rdoc
+- lib/br/cpf/cpf_wrapper.rb
+- lib/br/cpf/version.rb
+- spec/br-cpf_spec.rb
+- spec/faker_cpf.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/bbcoimbra/br-cpf
+homepage: ''
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Calculates and validates given CPF
-test_files: 
-- spec/faker_cpf.rb
-- spec/spec_helper.rb
-- spec/br-cpf_spec.rb
+summary: Lib implemented in C that calculates and validates CPF using FFI.
+test_files: []

data/ext/CPF/ruby_cpf.c

@@ -1,33 +0,0 @@
-#include <stdlib.h>
-#include "ruby.h"
-#include "cpf.h"
-
-static VALUE t_init_cpf(VALUE self, VALUE ruby_cpf_raiz){
-    long long cpf = 0, raiz = 0;
-    VALUE ruby_cpf;
-
-    raiz = NUM2LL(ruby_cpf_raiz);
-    if(raiz < 1 || raiz > 999999999)
-        rb_raise(rb_eArgError, "raiz should be greather than 0 and lesser than 999_999_999");
-    cpf = calcula_digito_cpf((long long) raiz);
-    ruby_cpf = LL2NUM(cpf);
-    rb_iv_set(self, "@raiz", INT2FIX(raiz));
-    rb_iv_set(self, "@cpf", ruby_cpf);
-    rb_iv_set(self, "@valid", e_cpf(cpf) ? Qtrue : Qfalse );
-    return self;
-}
-
-static VALUE valid_cpf(VALUE self, VALUE ruby_cpf){
-    long long cpf = 0;
-    cpf = (long long)NUM2LL(ruby_cpf);
-    if(cpf == 0) return Qfalse;
-    return e_cpf(cpf) ? Qtrue : Qfalse;
-}
-
-VALUE mBr, cCpf;
-void Init_CPF(){
-    mBr = rb_define_module("BR");
-    cCpf = rb_define_class_under(mBr, "CPF", rb_cObject);
-    rb_define_method(cCpf, "initialize", t_init_cpf, 1);
-    rb_define_singleton_method(cCpf, "valid?", valid_cpf, 1);
-}