validatr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18066b6a0c46e32c74c331af7fe17efe05e13666
+  data.tar.gz: a2ee3976cd2dea56a26484cf52eb374ab965b5f9
+SHA512:
+  metadata.gz: 49b253cc9a94d554b8c0cb7de346fb95c987a7891e6e8a1e2180aa6d570aa13f7a8ad8ba0886b685ad1d3733c2f35a67ba05168e0364dcf51ffebeddf953c643
+  data.tar.gz: 8b781b98a77d5d7ceb9f997a1555d60960d5054cdf6f5e911dfa272f326c656fd0c124c1e582be67790e3f4526358e1a3860744b0af7683963eb35fd68c6d4c7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Julien Roger
+
+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,59 @@
+# Validatr
+
+An implementation of several error checking algorithms, including Luhn and Damm, for string and number error checking.
+
+This gem currently only supports validation of integers and strings of integers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "validatr"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validatr
+
+## Usage
+
+
+```ruby
+require "validatr"
+
+Validatr::Luhn.check_digit 12345678     # => 2
+Validatr::Verhoeff.check_digit 12345678 # => 4
+Validatr::Damm.check_digit 12345678     # => 6
+
+Validatr::Luhn.valid? 123456782         # => true
+Validatr::Verhoeff.valid? 123456784     # => true
+Validatr::Damm.valid? 123456786         # => true
+
+123456782.valid_luhn?                   # => true
+123456782.valid_verhoeff?               # => false
+123456782.valid_damm?                   # => false
+
+(123456784.0).valid_luhn?               # => false
+(123456784.0).valid_verhoeff?           # => true
+(123456784.0).valid_damm?               # => false
+
+"123456786".valid_luhn?                 # => false
+"123456786".valid_verhoeff?             # => false
+"123456786".valid_damm?                 # => true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julienroger/validatr.
+
+
+## License
+
+[MIT](./LICENSE)
+
+Copyright (c) 2017 Julien Roger

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "validatr"
+
+# 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/lib/validatr/damm.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Validatr
+  module Damm
+    extend Utils
+
+    # Totally Anti-Symmetric Quasigroup
+    TASQ = [
+      [0, 3, 1, 7, 5, 9, 8, 6, 4, 2],
+      [7, 0, 9, 2, 1, 5, 4, 8, 6, 3],
+      [4, 2, 0, 6, 8, 7, 1, 3, 5, 9],
+      [1, 7, 5, 0, 9, 8, 3, 4, 2, 6],
+      [6, 1, 2, 3, 0, 4, 5, 9, 7, 8],
+      [3, 6, 7, 4, 2, 0, 9, 5, 8, 1],
+      [5, 8, 6, 9, 7, 2, 0, 1, 3, 4],
+      [8, 9, 4, 5, 3, 6, 2, 0, 1, 7],
+      [9, 4, 3, 8, 6, 1, 7, 2, 0, 5],
+      [2, 5, 8, 1, 4, 3, 6, 7, 9, 0]
+    ].freeze
+
+    # Returns true if a number is a valid Damm number, false otherwise
+    def self.valid?(number)
+      encode(number).zero?
+    end
+
+    # Generates the check digit for a number
+    def self.check_digit(number)
+      encode number
+    end
+
+    def self.encode(number)
+      digits = digits_from_number(number)
+      i = 0
+      digits.map { |c| i = TASQ[i][c] }
+      i
+    end
+  end
+end

data/lib/validatr/ext/numeric.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Numeric
+  def valid_luhn?
+    to_s.valid_luhn?
+  end
+
+  def valid_verhoeff?
+    to_s.valid_verhoeff?
+  end
+
+  def valid_damm?
+    to_s.valid_damm?
+  end
+end

data/lib/validatr/ext/string.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class String
+  def valid_luhn?
+    Validatr::Luhn.valid? self
+  end
+
+  def valid_verhoeff?
+    Validatr::Verhoeff.valid? self
+  end
+
+  def valid_damm?
+    Validatr::Damm.valid? self
+  end
+end

data/lib/validatr/ext.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "validatr/ext/string"
+require "validatr/ext/numeric"

data/lib/validatr/luhn.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Validatr
+  module Luhn
+    extend Utils
+
+    def self.valid?(number, n = 10)
+      digits = digits_from_number(number)
+      sum = sum_digits(digits)
+      (sum % n).zero?
+    end
+
+    def self.check_digit(number, n = 10)
+      digits = digits_from_number(number)
+      digits.push(0)
+      sum = sum_digits(digits)
+      (sum * 9) % n
+    end
+
+    def self.sum_digits(digits)
+      digits.reverse.map.with_index do |d, i|
+        if i.even?
+          d
+        else
+          (d < 5 ? (d * 2) : ((d * 2) % 10) + 1)
+        end
+      end.inject(:+)
+    end
+  end
+end

data/lib/validatr/utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Validatr
+  module Utils
+    def digits_from_number(number)
+      number.to_i.to_s.chars.map(&:to_i)
+    end
+  end
+end

data/lib/validatr/verhoeff.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Validatr
+  module Verhoeff
+    extend Utils
+
+    D = [
+      [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
+      [1, 2, 3, 4, 0, 6, 7, 8, 9, 5],
+      [2, 3, 4, 0, 1, 7, 8, 9, 5, 6],
+      [3, 4, 0, 1, 2, 8, 9, 5, 6, 7],
+      [4, 0, 1, 2, 3, 9, 5, 6, 7, 8],
+      [5, 9, 8, 7, 6, 0, 4, 3, 2, 1],
+      [6, 5, 9, 8, 7, 1, 0, 4, 3, 2],
+      [7, 6, 5, 9, 8, 2, 1, 0, 4, 3],
+      [8, 7, 6, 5, 9, 3, 2, 1, 0, 4],
+      [9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
+    ].freeze
+
+    F = [
+      [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
+      [1, 5, 7, 6, 2, 8, 3, 0, 9, 4],
+      [5, 8, 0, 3, 7, 9, 6, 1, 4, 2],
+      [8, 9, 1, 6, 0, 4, 3, 5, 2, 7],
+      [9, 4, 5, 3, 1, 2, 6, 8, 7, 0],
+      [4, 2, 8, 6, 5, 7, 3, 9, 0, 1],
+      [2, 7, 9, 3, 8, 0, 6, 4, 1, 5],
+      [7, 0, 4, 6, 9, 1, 3, 2, 5, 8]
+    ].freeze
+
+    INV = [0, 4, 3, 2, 1, 5, 6, 7, 8, 9].freeze
+
+    # Returns true if a number is a valid Verhoeff number, false otherwise
+    def self.valid?(number)
+      digits = digits_from_number(number)
+      c = encode(digits)
+      c.zero?
+    end
+
+    # Generates the check digit for a number
+    def self.check_digit(number)
+      digits = digits_from_number(number)
+      digits.push(0)
+      c = encode(digits)
+      INV[c]
+    end
+
+    def self.encode(digits)
+      c = 0
+      digits.reverse.map.with_index do |d, i|
+        f = F[i % 8][d]
+        c = D[c][f]
+      end
+      c
+    end
+  end
+end

data/lib/validatr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Validatr
+  VERSION = "0.1.0"
+end

data/lib/validatr.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("..", __FILE__))
+
+require "validatr/version"
+require "validatr/utils"
+require "validatr/luhn"
+require "validatr/damm"
+require "validatr/verhoeff"
+require "validatr/ext"
+
+module Validatr
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: validatr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Roger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: An implementation of several error checking algorithms,including Luhn
+  and Damm.
+email:
+- jroger@abletribe.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/validatr.rb
+- lib/validatr/damm.rb
+- lib/validatr/ext.rb
+- lib/validatr/ext/numeric.rb
+- lib/validatr/ext/string.rb
+- lib/validatr/luhn.rb
+- lib/validatr/utils.rb
+- lib/validatr/verhoeff.rb
+- lib/validatr/version.rb
+homepage: https://github.com/julienroger/validatr
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A set of tools for string and number error checking.
+test_files: []