digit_checksum 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 197f09d394623c37323a0a06b9436a75ae3e8d29
-  data.tar.gz: 517ca82d155c67af243c561445fd65eaf7e88f4d
+  metadata.gz: 175e4e3a36c8e9303127d13650327da966e13629
+  data.tar.gz: 474383c0dd57977a2038c667de810a3a1603d9fc
 SHA512:
-  metadata.gz: c316d80d8711f4a79aae222905f999dde0e0615593d59f06e1a615ef0e0e82711865d417babe2d30c0930a4054c217ad1456597eed0d2d210f4c8e69e3ecf2d4
-  data.tar.gz: c4b81cb5c9d8f1aa23b9b84ce063782138ac9bf57ac688cca32005fe4a4aa7bd98da984052693b8190171193c421c3c6e956d6c155d630ac994350ef36f80d4f
+  metadata.gz: 71834735b4c85da42ff05ef937a24a039d21ce4d733ac5ddcd4ba2050446656176d5de3b3031a14296032a41db238f399e7f633e588284c33e2367aeba57ba8f
+  data.tar.gz: b53f86b1bdd6a7d06f1ef77950b6aa14e23cb4d5cae061de9cb2d0e4b0a6454d04a144576e4d0632d2a6d621fe30c44848532947b62dba9ded031de6baaf8972

data/README.md

@@ -1,9 +1,9 @@
 # DigitCheckSum
 
 Hi there, I'm glad you're looking in this gem!
-The aim of this gem is to allow **any kind** of document to be validated through calculation of [**Check Digit/Digit Checksum**](https://en.wikipedia.org/wiki/Check_digit).
+The aim of this gem is to allow **any kind** of document to be validated e generated through calculation of [**Check Digit/Digit Checksum**](https://en.wikipedia.org/wiki/Check_digit).
 
-What this mean? This mean that you can validated any kind of documents such: **Passport numbers**, **Federal ID number**, **Books ISBN**, or even **create your own document** number, check `examples/` for more details.
+What this mean? This mean that you can **validate** and **generate fake numbers** of any kind of documents such: **Passport numbers**, **Federal ID number**, **Books ISBN**, or even **create your own document** number, check `examples/` for more details.
 
 **Tip**: Check [`examples/h4ck.rb`](examples/h4ck.rb) to see `h4ck` document specification, this is a sample document who can be manipulated using this library!
 
@@ -29,7 +29,10 @@ Or install it yourself as:
 
 ## Usage
 
-This gem by yourself don't do anything unless you create a class that inherit from `DigitChecksum::BaseDocument` class, example:
+This gem by yourself don't do anything unless you create a class that inherit from `DigitChecksum::BaseDocument` class, but when properly inherited and configured, believe me, you gain **awesomeness**!
+
+Don't you believe me? See for yourself an example:
+
 
 ```ruby
 require 'digit_checksum'
@@ -49,12 +52,26 @@ class CNPJ < DigitChecksum::BaseDocument
   # 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
 ```
 
 The example below it's intent to validated brazilian `CNPJ` documents, equivalent to `Corporate Taxpayer Registry Number`, so this can be used to:
 
+#### Generate fake document numbers
+
+```ruby
+CNPJ.generate # "79.552.921/0786-55"
+
+CNPJ.generate(false)  # 85215313606778 -- without pretty formating
+
+```
+
+
 #### Calculate check digits
 ```ruby
 # valid format
@@ -82,13 +99,13 @@ CNPJ.valid?(12345678000195) # true
 
 ```ruby
 # belows returns [1, 2, 3, 4, 5, 6, 7, 8, 0, 0, 0, 1, 9, 5]
-CNPJ.normalize_document_number("123.456.78/0001-95") 
+CNPJ.normalize_number("123.456.78/0001-95") 
 
-CNPJ.normalize_document_number_to_s("123.456.78/0001-95") # "12345678000195"
+CNPJ.normalize_number_to_s("123.456.78/0001-95") # "12345678000195"
 
-CNPJ.pretty_formatted("123456780001") # "123.456.78/0001-95"
+CNPJ.pretty_formatted("123456780001") # "123.456.78/0001-95" -- also aliased as CNPJ.pretty(number) or CNPJ.formatted(number)
 
-CNPJ.clear_document_number("123.456.78/0001-95") # "12345678000195"
+CNPJ.clear_number("123.456.78/0001-95") # "12345678000195" -- also aliased as CNPJ.stripped(number)
 ```
 
 See `examples/`for more detailed samples.

data/examples/brazilian_cnpj.rb

@@ -12,8 +12,13 @@ class CNPJ < DigitChecksum::BaseDocument
   valid_format_regexp %r{(\d{2})[-.]?(\d{3})[-.]?(\d{3})[\/]?(\d{4})[-.]?(\d{2})}
 
   pretty_format_mask %(%s.%s.%s/%s-%s)
+
+  # numbers sampled to generate new document numbers
+  generator_numbers (0..9).to_a
 end
 
+CNPJ.generate
+CNPJ.valid?(CNPJ.generate)
 
 CNPJ.valid?(nil) # false
 CNPJ.valid?(69739073000104) # true

data/examples/brazilian_cpf.rb

@@ -12,8 +12,14 @@ class CPF < DigitChecksum::BaseDocument
   valid_format_regexp %r{(\d{3})[-.]?(\d{3})[-.]?(\d{3})[-.]?(\d{2})}
 
   pretty_format_mask %(%s.%s.%s-%s)
+
+  # numbers sampled to generate new document numbers
+  generator_numbers (0..9).to_a
 end
 
+CPF.generate
+CPF.valid?(CPF.generate)
+
 CPF.valid?(nil) # false
 CPF.valid?(31777259185) # true
 CPF.valid?("315.844.227-26") # true

data/examples/h4ck.rb

@@ -23,9 +23,13 @@ class H4ck < DigitChecksum::BaseDocument
 
   # 0101&&1111(0x01)||[16]<07>!29
   # Ex: 0101&&1111(0x01)||[16]<07>!29-110
-  valid_format_regexp %r{(\d{4})\&\&(\d{4})\(0x(\d{2})\)\|\|\[(\d{2})\]\<(\d{2})\>\!(\d{2})\-(\d{3})}
+  valid_format_regexp %r{(\d{4})(\d{4})\(?[0x]?(\d{2})\)?\|?\|?\[?(\d{2})\]?\<?(\d{2})\>?\!?(\d{2})\-?(\d{3})}
 
-  pretty_format_mask %(%s&&%s(0x%s)||[%s]<%s>!%s-VVV;)
+  # XXXX&&XXXX(0xZZ)||[YY]<MM>!DD-VVV;
+  pretty_format_mask %(%s&&%s(0x%s)||[%s]<%s>!%s-%s;)
+
+  # numbers sampled to generate new document numbers
+  generator_numbers (0..9).to_a
 
   def self.favorite_language(document_number)
     document_number = normalize_document_number(document_number)
@@ -39,6 +43,8 @@ root_doc_number = "0101&&1111(0x01)||[16]<07>!29"
 valid_doc_number = "0101&&1111(0x01)||[16]<07>!29-840"
 invalid_doc_number = "0101&&1111(0x01)||[16]<07>!29-841"
 
+H4ck.generate
+H4ck.valid?(H4ck.generate)
 H4ck.normalize_document_number_to_s(root_doc_number) # "0101111101160729"
 H4ck.calculate_verify_digits(root_doc_number) # [8,4,0]
 H4ck.valid?(root_doc_number) # false

data/lib/digit_checksum/base_document.rb

@@ -7,10 +7,20 @@ module DigitChecksum
       :valid_format_regexp,
       :clear_number_regexp,
       :pretty_format_mask,
+      :generator_numbers
     ]
 
     class << self
-      def valid?(document_number, stop = true)
+      def generate(formatted = true)
+        doc_numbers = root_document_digits_count.times.map { get_generator_numbers.sample }
+        doc_numbers.concat(calculate_verify_digits(doc_numbers))
+
+        normalized_number = normalize_number_to_s(doc_numbers)
+
+        formatted ? pretty_formatted(normalized_number) : normalized_number
+      end
+
+      def valid?(document_number)
         # remove all non digits and return an array to be matched with mask
         normalized_document = normalize_document_number(document_number)
 
@@ -131,6 +141,13 @@ module DigitChecksum
         normalize_document_number(document_number).size == root_document_digits_count + verify_digits_count
       end
 
+      alias :normalize_number_to_s :normalize_document_number_to_s
+      alias :normalize_number :normalize_document_number
+      alias :clear_number :clear_document_number
+      alias :stripped :clear_document_number
+      alias :formatted :pretty_formatted
+      alias :pretty :pretty_formatted
+
       CONSTANTS_MAP.each do |const_identifier|
         define_method "get_#{const_identifier}" do
           const_name = const_identifier.to_s.upcase

data/lib/digit_checksum/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digit_checksum
 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: bundler