digit_checksum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 197f09d394623c37323a0a06b9436a75ae3e8d29
+  data.tar.gz: 517ca82d155c67af243c561445fd65eaf7e88f4d
+SHA512:
+  metadata.gz: c316d80d8711f4a79aae222905f999dde0e0615593d59f06e1a615ef0e0e82711865d417babe2d30c0930a4054c217ad1456597eed0d2d210f4c8e69e3ecf2d4
+  data.tar.gz: c4b81cb5c9d8f1aa23b9b84ce063782138ac9bf57ac688cca32005fe4a4aa7bd98da984052693b8190171193c421c3c6e956d6c155d630ac994350ef36f80d4f

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[Gemfile]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rafa_fidelis@yahoo.com.br. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in digit_checksum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rafael Fidelis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# 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).
+
+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.
+
+**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!
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digit_checksum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install digit_checksum
+
+---
+
+## Usage
+
+This gem by yourself don't do anything unless you create a class that inherit from `DigitChecksum::BaseDocument` class, example:
+
+```ruby
+require 'digit_checksum'
+
+class CNPJ < DigitChecksum::BaseDocument
+  # masks that will be used to calculate each check digit
+  digits_verify_mask first:  %w(5 4 3 2 9 8 7 6 5 4 3 2),
+                     second: %w(6 5 4 3 2 9 8 7 6 5 4 3 2)
+
+  # remove any non digit from document number
+  # this is the default value, feel free to override
+  clear_number_regexp %r{[^(\d+)]}
+
+  # use modulo 11 as algorithm (can be any value)
+  division_factor_modulo 11
+
+  # 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})}
+
+  pretty_format_mask %(%s.%s.%s/%s-%s)
+end
+```
+
+The example below it's intent to validated brazilian `CNPJ` documents, equivalent to `Corporate Taxpayer Registry Number`, so this can be used to:
+
+#### Calculate check digits
+```ruby
+# valid format
+CNPJ.calculate_verify_digits("123.456.78/0001") # [9,5]
+
+# invalid format
+CNPJ.calculate_verify_digits("123.456.78/00001") # []
+```
+
+#### Validate documents numbers
+```ruby
+# convenience methods to check if document is valid
+
+# invalid format
+CNPJ.valid?("123.456.78/0001") # false
+CNPJ.invalid?("123.456.78/0001") # true
+
+# valid format
+CNPJ.valid?("123.456.78/0001-95") # true
+CNPJ.valid?(12345678000195) # true
+
+```
+
+#### Normalize and format documents number
+
+```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_document_number_to_s("123.456.78/0001-95") # "12345678000195"
+
+CNPJ.pretty_formatted("123456780001") # "123.456.78/0001-95"
+
+CNPJ.clear_document_number("123.456.78/0001-95") # "12345678000195"
+```
+
+See `examples/`for more detailed samples.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.   
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fidelisrafael/digit_checksum.   
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "digit_checksum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/digit_checksum.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'digit_checksum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "digit_checksum"
+  spec.version       = DigitChecksum::VERSION
+  spec.authors       = ["Rafael Fidelis"]
+  spec.email         = ["rafa_fidelis@yahoo.com.br"]
+
+  spec.summary       = %q{Ruby implementation of check digits algorithm for generic documents numbers}
+  spec.description   = %q{Ruby implementation of check digits algorithm for generic documents numbers}
+  spec.homepage      = "https://github.com/fidelisrafael/digit_checksum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

data/examples/brazilian_cnpj.rb

@@ -0,0 +1,24 @@
+class CNPJ < DigitChecksum::BaseDocument
+  digits_verify_mask first:  %w(5 4 3 2 9 8 7 6 5 4 3 2),
+                     second: %w(6 5 4 3 2 9 8 7 6 5 4 3 2)
+
+  # MOD 11
+  division_factor_modulo 11
+
+  # remove any non digit from document number
+  clear_number_regexp %r{[^(\d+)]}
+
+  # 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})}
+
+  pretty_format_mask %(%s.%s.%s/%s-%s)
+end
+
+
+CNPJ.valid?(nil) # false
+CNPJ.valid?(69739073000104) # true
+CNPJ.valid?("38.485.271/0001-57") # true
+
+CNPJ.calculate_verify_digits("423.819.53/0001") # [9,7]
+CNPJ.pretty_formatted("69739073000104") # "69.739.073/0001-04"
+CNPJ.clear_document_number("38.485.271/0001-57") # 38485271000157

data/examples/brazilian_cpf.rb

@@ -0,0 +1,23 @@
+class CPF < DigitChecksum::BaseDocument
+  digits_verify_mask first:  %w(10 9 8 7 6 5 4 3 2),
+                     second: %w(11 10 9 8 7 6 5 4 3 2)
+
+  # MOD 11
+  division_factor_modulo 11
+
+  # remove any non digit from document number
+  clear_number_regexp %r{[^(\d+)]}
+
+  # 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})}
+
+  pretty_format_mask %(%s.%s.%s-%s)
+end
+
+CPF.valid?(nil) # false
+CPF.valid?(31777259185) # true
+CPF.valid?("315.844.227-26") # true
+
+CPF.calculate_verify_digits("315.844.227") # [2, 6]
+CPF.pretty_formatted("31777259185") # "315.844.227-26"
+CPF.clear_document_number("315.844.227-26")

data/examples/h4ck.rb

@@ -0,0 +1,49 @@
+# This is one document type created to ilustrated how this library can
+# be fully apropriate to manipulate custom documents types
+class H4ck < DigitChecksum::BaseDocument
+
+  PROGRAMMINGS_LANGUAGES = {
+    '01' => 'C#',
+    '02' => 'Javascript',
+    '03' => 'Lua',
+    '04' => 'Python',
+    '05' => 'Ruby'
+  }
+
+  PROGRAMMINGS_LANGUAGES.default = 'Unknown'
+
+  division_factor_modulo 11
+
+  digits_verify_mask first:  %w(17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2),
+                     second: %w(18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2),
+                     last:   %w(19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2)
+
+  # remove any non digit and 0x character from document number
+  clear_number_regexp %r{(0x)|[^\d+]}
+
+  # 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})}
+
+  pretty_format_mask %(%s&&%s(0x%s)||[%s]<%s>!%s-VVV;)
+
+  def self.favorite_language(document_number)
+    document_number = normalize_document_number(document_number)
+    languange_identifier = document_number[8..9].join
+
+    PROGRAMMINGS_LANGUAGES[languange_identifier]
+  end
+end
+
+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.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
+H4ck.valid?(valid_doc_number) # true
+H4ck.valid?(invalid_doc_number) # false
+
+H4ck.favorite_language(valid_doc_number) # C#
+H4ck.favorite_language("0101&&1111(0x04)||[16]<07>!29-840") # Python

data/lib/digit_checksum/base_document.rb

@@ -0,0 +1,149 @@
+module DigitChecksum
+  class BaseDocument
+
+    CONSTANTS_MAP = [
+      :digits_verify_mask,
+      :division_factor_modulo,
+      :valid_format_regexp,
+      :clear_number_regexp,
+      :pretty_format_mask,
+    ]
+
+    class << self
+      def valid?(document_number, stop = true)
+        # remove all non digits and return an array to be matched with mask
+        normalized_document = normalize_document_number(document_number)
+
+        # if document is empty
+        return false if normalized_document.nil? || normalized_document.empty?
+
+        # if document dont match the exact size, it's invalid
+        return false unless valid_length?(document_number)
+
+        # remove last two digits to be verified
+        last_digits = normalized_document.slice!(-verify_digits_count,verify_digits_count).map(&:to_i)
+        digits = calculate_verify_digits(normalized_document)
+
+        last_digits == digits
+      end
+
+      def invalid?(document_number)
+        !valid?(document_number)
+      end
+
+      def calculate_verify_digits(document_number)
+        return [] unless correct_length_based_on_first_mask?(document_number)
+
+        division_modulo = get_division_factor_modulo
+        digits = []
+
+        get_digits_verify_mask.each do |position, mask|
+          document_number = root_document_number(document_number, mask)
+
+          verify_digit = calculate_verify_digit(document_number, mask, division_modulo)
+
+          digits << verify_digit
+          document_number << verify_digit
+        end
+
+        digits
+      end
+
+      def root_document_number(document_number, mask = nil)
+        mask ||= get_digits_verify_mask.values[0]
+
+        normalize_document_number(document_number, mask.size)
+      end
+
+      def root_document_number_to_s(document_number, mask = nil)
+        root_document_number(document_number, mask).join
+      end
+
+      def normalize_document_number(document_number, length = nil)
+        document_number = clear_document_number(document_number).split(//).map(&:to_i)
+
+        length.nil? ? document_number : document_number[0, length]
+      end
+
+      def normalize_document_number_to_s(document_number, length = nil)
+        normalize_document_number(document_number, length).join
+      end
+
+      def clear_document_number(document_number)
+        document_number.to_s.gsub(get_clear_number_regexp, '')
+      end
+
+      def pretty_formatted(document_number)
+        return "" if normalize_document_number(document_number).empty?
+
+        numbers = document_number.to_s.scan(get_valid_format_regexp).flatten
+
+        # document has a value but it's not valid
+        return "" if numbers.empty?
+
+        get_pretty_format_mask % numbers
+      end
+
+      def calculate_verify_digit(document_number, mask, division_factor)
+        digits = calculate_digits_data(document_number, mask, division_factor)
+
+        digits[:verify_digit].to_i
+      end
+
+      def calculate_digits_data(document_number, mask, division_factor)
+        sum = calculate_digits_sum(document_number, mask)
+        quotient = (sum / division_factor)
+        rest = (sum % division_factor)
+
+        { sum: sum, quotient: quotient, rest: rest, verify_digit: digit_verify(rest, division_factor) }
+      end
+
+      def calculate_digits_sum(document_number, mask)
+        normalized_document_number = normalize_document_number(document_number)
+
+        normalized_document_number.each_with_index.map {|n,i| n.to_i * mask[i].to_i }.reduce(:+).to_f
+      end
+
+      def digit_verify(quotient_rest, division_factor)
+        # thats the rule, if quotient_rest < 2, so its became 0
+        return 0 if quotient_rest < 2
+
+        (division_factor - quotient_rest).to_i
+      end
+
+      def first_verify_mask
+        get_digits_verify_mask.values[0]
+      end
+
+      def verify_digits_count
+        get_digits_verify_mask.size
+      end
+
+      def root_document_digits_count
+        first_verify_mask.size
+      end
+
+      def correct_length_based_on_first_mask?(document_number)
+        normalize_document_number(document_number).size == root_document_digits_count
+      end
+
+      def valid_length?(document_number)
+        normalize_document_number(document_number).size == root_document_digits_count + verify_digits_count
+      end
+
+      CONSTANTS_MAP.each do |const_identifier|
+        define_method "get_#{const_identifier}" do
+          const_name = const_identifier.to_s.upcase
+
+          self.const_get(const_identifier.upcase)
+        end
+
+        define_method const_identifier do |arg|
+          const_name = const_identifier.to_s.upcase
+
+          self.const_set(const_name, arg)
+        end
+      end
+    end
+  end
+end

data/lib/digit_checksum/version.rb

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

data/lib/digit_checksum.rb

@@ -0,0 +1,5 @@
+require "digit_checksum/version"
+require "digit_checksum/base_document"
+
+module DigitChecksum
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: digit_checksum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael Fidelis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: Ruby implementation of check digits algorithm for generic documents numbers
+email:
+- rafa_fidelis@yahoo.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- digit_checksum.gemspec
+- examples/brazilian_cnpj.rb
+- examples/brazilian_cpf.rb
+- examples/h4ck.rb
+- lib/digit_checksum.rb
+- lib/digit_checksum/base_document.rb
+- lib/digit_checksum/version.rb
+homepage: https://github.com/fidelisrafael/digit_checksum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of check digits algorithm for generic documents numbers
+test_files: []