br-cnpj 0.1.6 → 1.0.0

data/README.rdoc

@@ -1,12 +1,13 @@
 = br-cnpj
 
-Lib implementada em C (gera uma lib compilada nativamente) que calcula e valida CNPJs.
+Ruby native extension that calculates and validades CNPJ (Cadastro Nacional de
+Pessoas Jur�dicas)
 
-== Instalação
+== Install
 
  sudo gem install br-cnpj
 
-== Exemplos
+== Examples
 
  require 'rubygems'
  require 'br/cnpj'
@@ -20,9 +21,9 @@ Lib implementada em C (gera uma lib compilada nativamente) que calcula e valida
  BR::CNPJ.valid? 192
   => false
 
- raiz = 0
+ radix = 0
  filial = 1
- BR::CNPJ.new(raiz, filial).to_s
+ BR::CNPJ.new(radix, filial).to_s
   => '00000000000191'
 
  BR::CNPJ.new(191).valid?

data/ext/CNPJ/cnpj.c

@@ -1,72 +1,72 @@
 #include <stdlib.h>
 #include "cnpj.h"
 
-#define DIGITO1 0
-#define DIGITO2 1
+#define DIGIT1 0
+#define DIGIT2 1
 
-long long calcula_digito_cnpj(int raiz, int filial){
-    return (long long)raiz*1000000 + filial*100 + calcula_digito(raiz, filial);
+long long calculate_cnpj_digit(int radix, int filial){
+    return (long long)radix*1000000 + filial*100 + calculate_digit(radix, filial);
 }
 
-int calcula_digito(int raiz, int filial){
-    int digito1=0, digito2=0, i;
+int calculate_digit(int radix, int filial){
+    int digit1=0, digit2=0, i;
     int vet[14];
-    int pesos[][13] = {{5,4,3,2,9,8,7,6,5,4,3,2,0},
+    int weights[][13] = {{5,4,3,2,9,8,7,6,5,4,3,2,0},
                        {6,5,4,3,2,9,8,7,6,5,4,3,2}};
     long long cnpj;
-    div_t divisao;
+    div_t division;
 
-    cnpj = (long long)raiz*1000000 + filial*100;
+    cnpj = (long long)radix*1000000 + filial*100;
     for (i=0;i<14;i++){
-        lldiv_t divisao;
+        lldiv_t division;
 
-        divisao = lldiv(cnpj,10);
-        vet[13-i] = (int) divisao.rem;
-        cnpj = divisao.quot;
+        division = lldiv(cnpj,10);
+        vet[13-i] = (int) division.rem;
+        cnpj = division.quot;
     }
     for(i=0;i<12;i++)
-        digito1 += vet[i] * pesos[DIGITO1][i];
-    divisao = div(digito1,11);
-    digito1 = divisao.rem<2 ? 0 : 11-divisao.rem;
-    vet[12]=digito1;
+        digit1 += vet[i] * weights[DIGIT1][i];
+    division = div(digit1,11);
+    digit1 = division.rem<2 ? 0 : 11-division.rem;
+    vet[12]=digit1;
     for(i=0;i<13;i++)
-        digito2 += vet[i] * pesos[DIGITO2][i];
-    divisao = div(digito2,11);
-    digito2 = divisao.rem<2 ? 0 : 11- divisao.rem;
+        digit2 += vet[i] * weights[DIGIT2][i];
+    division = div(digit2,11);
+    digit2 = division.rem<2 ? 0 : 11- division.rem;
 
-    return digito1*10 + digito2;
+    return digit1*10 + digit2;
 }
 
-int e_cnpj(long long cnpj_l){
-    int raiz, filial;
-    lldiv_t divisao;
+int is_cnpj(long long cnpj_l){
+    int radix, filial;
+    lldiv_t division;
 
-    divisao = lldiv(cnpj_l,1000000);
-    raiz = divisao.quot;
-    divisao = lldiv(divisao.rem,100);
-    filial=divisao.quot;
-    return cnpj_l == calcula_digito_cnpj(raiz, filial);
+    division = lldiv(cnpj_l,1000000);
+    radix = division.quot;
+    division = lldiv(division.rem,100);
+    filial=division.quot;
+    return cnpj_l == calculate_cnpj_digit(radix, filial);
 }
 
-int e_cgc(long long cgc_l){
-    if(e_cnpj(cgc_l)){
-        int pesos[]={2,1,2,1,2,1,2,1};
-        int acumulador=0, raiz=0, i=0;
-        lldiv_t divisao;
+int is_cgc(long long cgc_l){
+    if(is_cnpj(cgc_l)){
+        int weights[]={2,1,2,1,2,1,2,1};
+        int sum=0, radix=0, i=0;
+        lldiv_t division;
 
-        divisao = lldiv(cgc_l, 1000000);
-        raiz = (int)divisao.quot;
+        division = lldiv(cgc_l, 1000000);
+        radix = (int)division.quot;
         for (i=0;i<8;i++){
-            int produto=0;
+            int product=0;
 
-            divisao = lldiv(raiz,10);
-            produto = divisao.rem*pesos[7-i];
-            acumulador += (produto>9) ? produto-9 : produto;
-            raiz = divisao.quot;
+            division = lldiv(radix,10);
+            product = division.rem*weights[7-i];
+            sum += (product>9) ? product-9 : product;
+            radix = division.quot;
         }
 
-        divisao=lldiv(acumulador, 10);
-        return !divisao.rem;
+        division=lldiv(sum, 10);
+        return !division.rem;
     }
     return 0;
 }

data/ext/CNPJ/cnpj.h

@@ -5,10 +5,10 @@
 extern "C" {
 #endif
 
-long long calcula_digito_cnpj(int raiz, int filial);
-int calcula_digito(int raiz, int filial);
-int e_cnpj(long long cnpj_l);
-int e_cgc(long long cgc_l);
+long long calculate_cnpj_digit(int radix, int filial);
+int calculate_digit(int radix, int filial);
+int is_cnpj(long long cnpj_l);
+int is_cgc(long long cgc_l);
 
 #ifdef __cplusplus
 }

data/ext/CNPJ/ruby_cnpj.c

@@ -3,19 +3,19 @@
 
 static VALUE t_init_cnpj(int argc, VALUE *argv, VALUE self)
 {
-    int raiz = 0;
+    int radix = 0;
     int filial = 0;
     int verif = 0;
     VALUE valid = Qnil;
 
     if (argc == 2) {
-        raiz = FIX2INT(argv[0]);
-        if( raiz >= 100000000 || raiz < 0 )
-            rb_raise(rb_eArgError, "raiz should be greater than -1 or lesser than 10_000_000");
+        radix = FIX2INT(argv[0]);
+        if( radix >= 100000000 || radix < 0 )
+            rb_raise(rb_eArgError, "radix should be greater than -1 or lesser than 10_000_000");
         filial = NUM2INT(argv[1]);
         if( filial >= 10000 || filial < 1)
             rb_raise(rb_eArgError, "filial should be greater than 0 or lesser than 10_000");
-        verif = calcula_digito(raiz,filial);
+        verif = calculate_digit(radix,filial);
         valid = Qtrue;
     }
     else if (argc == 1) {
@@ -33,32 +33,32 @@ static VALUE t_init_cnpj(int argc, VALUE *argv, VALUE self)
         verif = (int)v.rem;
         v = lldiv(v.quot, (long long)10000);
         filial = (int)v.rem;
-        raiz = (int)v.quot;
-        valid = verif == calcula_digito(raiz,filial) ? Qtrue : Qfalse;
+        radix = (int)v.quot;
+        valid = (verif == calculate_digit(radix,filial)) ? Qtrue : Qfalse;
     }
 
-    rb_iv_set(self, "@raiz", INT2FIX(raiz));
+    rb_iv_set(self, "@radix", INT2FIX(radix));
     rb_iv_set(self, "@filial", INT2FIX(filial));
-    rb_iv_set(self, "@verif", INT2FIX(verif));
+    rb_iv_set(self, "@digit", INT2FIX(verif));
     rb_iv_set(self, "@valid", valid);
 
     return self;
 }
 
-static VALUE is_cgc(VALUE self){
-    long long raiz=0;
-    int filial = 0, dv = 0;
-    raiz = NUM2INT(rb_iv_get(self, "@raiz"));
+static VALUE rb_is_cgc(VALUE self){
+    long long radix=0;
+    int filial = 0, verify_digit = 0;
+    radix = NUM2INT(rb_iv_get(self, "@radix"));
     filial = NUM2INT(rb_iv_get(self, "@filial"));
-    dv = NUM2INT(rb_iv_get(self, "@verif"));
-    return e_cgc((long long)raiz * 1000000 + filial * 100 + dv) ? Qtrue : Qfalse;
+    verify_digit = NUM2INT(rb_iv_get(self, "@digit"));
+    return is_cgc((long long)radix * 1000000 + filial * 100 + verify_digit) ? Qtrue : Qfalse;
 }
 
 static VALUE valid_cnpj(VALUE self, VALUE ruby_cnpj){
     long long cnpj=0;
     cnpj = (long long)NUM2LL(ruby_cnpj);
     if(cnpj == 0) return Qfalse;
-    return e_cnpj(cnpj) ? Qtrue : Qfalse;
+    return is_cnpj(cnpj) ? Qtrue : Qfalse;
 }
 
 VALUE mBR, cCNPJ;
@@ -67,5 +67,5 @@ void Init_CNPJ(){
     cCNPJ = rb_define_class_under(mBR, "CNPJ", rb_cObject);
     rb_define_method(cCNPJ, "initialize", t_init_cnpj, -1);
     rb_define_singleton_method(cCNPJ, "valid?", valid_cnpj, 1);
-    rb_define_method(cCNPJ, "is_cgc?", is_cgc, 0);
+    rb_define_method(cCNPJ, "is_cgc?", rb_is_cgc, 0);
 }

data/lib/br/cnpj.rb

@@ -6,18 +6,20 @@ module BR
         
         alias_method :orig_valid?, :valid?
         
-        # Formata o Cnpj desformatado
+        # Format unformated Cnpj
         #
-        # Cnpj.formatar(191) # => '00.000.000/0001-91'
+        # Cnpj.format(191) # => '00.000.000/0001-91'
         # Cnpj.formatar(30553786000135) # => "30.553.786/0001-35"
         #
         def format(cnpj)
           cnpj = cnpj.to_s.rjust(14, "0")
           "%s.%s.%s/%s-%s" % [cnpj[0,2], cnpj[2,3], cnpj[5,3], cnpj[8,4], cnpj[12,2]]
         end
+
+        ### pt-BR method name
         alias_method :formatar, :format
         
-        # Desformata o Cnpj formatado
+        # Unformat formated Cnpj
         #
         # Cnpj.desformatar("02.716.485/0001-40") # => "02716485000140"
         # Cnpj.unformat("00.086.001/0001-04")    # => "00086001000104"
@@ -25,10 +27,12 @@ module BR
         def unformat(cnpj)
            cnpj.gsub(/\D/, '')
         end
+
+        ### pt-BR method name
         alias_method :desformatar, :unformat
         
-        # Retorna true se o Cnpj for válido
-        # Retorna falso se o Cnpj for inválido
+        # Returns true if Cnpj is valid
+        # Retorns false if Cnpj is invalid
         #
         # CNPJ.valid?(191)           # => true
         # CNPJ.valid?(123456789101)  # => false
@@ -42,18 +46,18 @@ module BR
         end
         
     end
-    attr_reader :filial, :valid, :raiz, :verif
+    attr_reader :filial, :valid, :radix, :digit
 
     # Return if the instance CNPJ is valid?
     #
     # Cnpj.new(191).valid? # => true
     #
     def valid?
-      valid
+      @valid
     end
     
     def to_i
-      @raiz * 1_000_000 + @filial * 100 + @verif
+      @radix * 1_000_000 + @filial * 100 + @digit
     end
 
     # Return the CNPJ with 14 characters

data/spec/br-cnpj_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/spec_helper'
 
 module BR
   

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: br-cnpj
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
-  - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Bruno Coimbra
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-19 00:00:00 -03:00
+date: 2010-06-29 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -48,6 +51,9 @@ files:
 - lib/br/cnpj.rb
 - LICENSE
 - README.rdoc
+- spec/spec_helper.rb
+- spec/br-cnpj_spec.rb
+- spec/faker_cnpj.rb
 has_rdoc: true
 homepage: http://github.com/bbcoimbra/br-cnpj
 licenses: []
@@ -58,23 +64,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Calcules and validates given CNPJ