brazilian_documents 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce861f68d1133840aa6d946360599d544ef049df
-  data.tar.gz: a1d8b2c6ff7a9a201bc8f0102cae450b3c295bb7
+  metadata.gz: a00ed4e14230b1dc6dc05f66449535f88c2a4128
+  data.tar.gz: d746ee8acb43df9a4a7041870fd47ad9937133d2
 SHA512:
-  metadata.gz: d957127f476c56923c209f4d2068c2552b8b1192aba19ca9ddfb556e3dcd68d93256c6e5756ac8fcc96d08d7044d87338f4622eb733f80b632e7ef38e82e9fa2
-  data.tar.gz: ac4d6be54ce6100896ec60bab4ca0ba2833d7e681fd65cebc1aac396d560e6bc4f5dab035d06fbe111763acb90dd88a2320a58e913fe8c37624dc96f29542942
+  metadata.gz: b2d82b3519305678f83bb18940ffaa3eb1834160a6362be63d669764b0674f006e6b6f2247b1721b9bfc9bb1206af774c21f2c5d28aa6b1f7888004a3f6b6ab0
+  data.tar.gz: c75f0d66da3a47cc9d24ab8cf25650eda95d1f77534c30e5d629dfa440c9ddfc995a02b18ead3f632f2eccad706ced71167ce3a9ca08bd7360aced7689c50711

data/README.md

@@ -1,7 +1,7 @@
-# BRDocuments
+# Brazilian Documents
 
 Esta gem tem como proposta ser um repositório com os principais validadores de documentos **oficiais do Brasil**.
-Atualmente existem **validadores**(e não geradores) para:
+Atualmente existem **validadores e geradores** para os seguintes documentos:
 
 * CPF
 * CNPJ
@@ -10,6 +10,8 @@ Atualmente existem **validadores**(e não geradores) para:
 
 Essa gem é construída em cima da gem [**digit_checksum**](https://github.com/fidelisrafael/digit_checksum), que torna todo o processo muito mais simples e padronizado!
 
+Se você deseja validar `Inscrição Estadual` e integração dos validadores com models do ActiveRecord, veja a gem [`asseinfo/br_documents`](https://github.com/asseinfo/br_documents)
+
 ---
 
 ## Instalação
@@ -49,6 +51,17 @@ Nos exemplos abaixo, a classe `BRDocuments::CPF` será utilizada para detalhar a
 
 Você pode usar essa biblioteca para:
 
+#### Gerar números [falsos]
+
+```ruby
+require 'br_documents'
+
+BRDocuments::CPF.generate # "585.483.998-99"
+BRDocuments::CPF.generate(false) # "00670564826" -- sem formatação
+
+BRDocuments::CNPJ.generate # "53.091.177/2847-09"
+
+```
 
 #### Validar documento
 
@@ -58,7 +71,7 @@ require 'br_documents'
 BRDocuments::CPF.valid?(number) # verifica se um CPF é valido
 BRDocuments::CPF.invalid?(number) # verifica se um CPF é inválido
 
-# Ex: 
+### Exemplos:
 
 BRDocuments::CPF.valid?("481.455.512-18") # true
 BRDocuments::CPF.valid?("481.455.512-20") # false
@@ -74,7 +87,7 @@ require 'br_documents'
 # Calcula os dígitos verificadores de um CPF(number deve ser composto de 9 dígitos
 BRDocuments::CPF.calculate_verify_digits(number)
 
-# Ex:
+### Exemplos:
 
 # Número válido
 BRDocuments::CPF.calculate_verify_digits("481.455.512") # [1, 8]
@@ -91,19 +104,20 @@ require 'br_documents'
 BRDocuments::CPF.pretty_formatted(number) # (XXX.XXX.XXX-XX)
 
 # Retorna CPF normalizado como Array ([X,X,X,X,X,X,X,X,X,X,X,X])
-BRDocuments::CPF.normalize_document_number(number)
+BRDocuments::CPF.normalize_number(number)
 
 # Retorna CPF normalizado como String (XXXXXXXXXXXX)
-BRDocuments::CPF.normalize_document_number_to_s(number)
+BRDocuments::CPF.normalize_number_to_s(number)
 
-# Ex:
+### Exemplos:
 
-BRDocuments::CPF.pretty_formatted("48145551218") # 481.455.512-18
+# Retorna CPF formatado
+BRDocuments::CPF.pretty_formatted("48145551218") # 481.455.512-18 
 
 # Normaliza número e retorna como Array: [4, 8, 1, 4, 5, 5, 5, 1, 2, 1, 8]
-BRDocuments::CPF.normalize_document_number("481.455.512-18")
+BRDocuments::CPF.normalize_number("481.455.512-18")
 
-BRDocuments::CPF.normalize_document_number_to_s("481.455.512-18") # "48145551218"
+BRDocuments::CPF.normalize_number_to_s("481.455.512-18") # "48145551218"
 
 ```
 ---

data/br_documents.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'digit_checksum', '~> 0.1.0'
+  spec.add_dependency 'digit_checksum', '~> 0.1.1'
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/br_documents/documents/cnpj.rb

@@ -14,6 +14,10 @@ module BRDocuments
     # match format such as: 99.999.999/9999-99 | 99-999-999/9999-99 | 99999999/999999 | 99999999999999
     valid_format_regexp %r{(\d{2})[-.]?(\d{3})[-.]?(\d{3})[\/]?(\d{4})[-.]?(\d{2})}
 
+    # mask utilized to prettify doc number
     pretty_format_mask %(%s.%s.%s/%s-%s)
+
+    # numbers sampled to generate new document numbers
+    generator_numbers (0..9).to_a
   end
 end

data/lib/br_documents/documents/cpf.rb

@@ -14,6 +14,10 @@ module BRDocuments
     # match format such as: 999.999.999-99 | 999-999-999-99 | 99999999999
     valid_format_regexp %r{(\d{3})[-.]?(\d{3})[-.]?(\d{3})[-.]?(\d{2})}
 
+    # mask utilized to prettify doc number
     pretty_format_mask %(%s.%s.%s-%s)
+
+    # numbers sampled to generate new document numbers
+    generator_numbers (0..9).to_a
   end
 end

data/lib/br_documents/version.rb

@@ -1,3 +1,3 @@
 module BRDocuments
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brazilian_documents
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rafael Fidelis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digit_checksum
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement