check_digit 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGVlNWIwODBlZTE0NzI4Y2IxOGJiYTUyZjA4NWJhMGVlZmMyMzcwMQ==
+  data.tar.gz: !binary |-
+    NDQ3NmJhMThkZDIzMTZiZjk3OGRmNDVmM2MyNjdhNjBmYTM3ZjQ3Yw==
+SHA512:
+  metadata.gz: !binary |-
+    NTdmNzhiZjhlMGJlOTk3YzlmMTQ3MjZjYmU4YTFhMjM5YmQ1MThlODkzMmE0
+    ZDJiODFhZGMzZmNmMzY4YmMzZGJmNjE2Zjg3ZWQ2MGExMjJiNzhjNWRmZGU5
+    YWJhYTRhZjNhMDk0NTJhOTExODNkMTEzYzhmZjMyMGM2ZDMyN2E=
+  data.tar.gz: !binary |-
+    ZjBmYWIzMmM3NjEzMzI4YjZjMGRmYTAxOTI0OWUxNjkxOTg5MzVhZWJjMjhk
+    ODdjMDM5OTE1MzZhNmU5ZWY5YmE3MDI5YTVkODhkMjcyZTMyNGU1ODUyMjgz
+    YzY3YTAwNDg2OGRkMzNkMzVlMDEyNmFiNmY5ODA1YmJmZGM5YjY=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eric Litwin
+
+MIT License
+
+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,74 @@
+# CheckDigit
+
+Ruby implementation of the Luhn, Damm and Verhoeff check digit algorithms
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'check_digit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install check_digit
+
+## Usage
+
+Each implementation provides the same 2 class methods:
+* checksum(num) - returns a new number with the checksum digit appended at the end
+* valid?(num) - returns true if the number has a valid checksum digit, false if the number has an invalid checksum digit
+
+Code sample:
+
+    require 'check_digit'
+
+    Damm.checksum(123) # returns 1234
+    Damm.valid?(1234) # returns true
+    Damm.valid?(1239) # returns false
+
+## Algorithm Comparison - Error Prevention
+| Error Type                                 | % of All Errors | Luhn | Damm | Verhoeff |
+|:-----------------------------------------  |:--------------- |:----:|:----:|:--------:|
+| single errors: a becomes b                 | 60% to 95%      |  1   |  1   |     1    |
+| omitting or adding a digit                 | 10% to 20%      |  1   |  1   |     1    |
+| adjacent transpositions: *ab* becomes *ba* | 10% to 20%      |  2   |  1   |     1    |
+| twin errors: *aa* becomes *bb*             | 0.5% to 1.5%    |  3   |  1   |     2    |
+| jump transpositions: *acb* becomes *bca*   | 0.5% to 1.5%    |  2   |  1   |     2    |
+| jump twin errors: *aca* becomes *bcb*      | below 1%        |  1   |  1   |     2    |
+| phonetic errors: *a0* becomes *0a*         | 0.5% to 1.5%    |  1*  |  1   |     2    |
+
+Source: http://www.augustana.ab.ca/~mohrj/algorithms/checkdigit.html
+
+\* Not entirely sure if Luhn catches all phonetic errors, e.g. 13 instead of 30
+
+#####*Legend*
+1. Prevents all errors
+2. Prevents most errors
+3. Prevents some errors
+4. Does not prevent any errors
+
+## Algorithm Comparison - Performance
+#####50,000 iterations (time in seconds)*
+
+| Algorithm | Generate | Validate |
+|:--------- | --------:| --------:|
+| Luhn      | 6.630000 | 6.390000 |
+| Damm      | 1.700000 | 1.610000 |
+| Verhoeff  | 3.730000 | 3.720000 |
+
+\* Test was on Linux 10.04 with 2.80GHz Intel Xeon E5-1603 - relative timing is more important to consider
+
+## Contributing
+
+1. Fork it ( https://github.com/elitwin/check_digit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Attributions
+The Verhoeff implementation was provided from this repo (https://github.com/bai/verhoeff) and was the inspiration for the interface (checksum, valid?) used by all the implementations

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/check_digit.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'check_digit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "check_digit"
+  spec.version       = CheckDigit::VERSION
+  spec.authors       = ["Eric Litwin"]
+  spec.email         = ["eric.litwin@pnmac.com"]
+  spec.summary       = %q{Check Digit calculator/validator}
+  spec.description   = %q{Ruby implementation of Luhn, Damm and Verhoeff check digit algorithms}
+  spec.homepage      = "http://github.com/elitwin/check_digit"
+  spec.licenses      = ["MIT"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/check_digit.rb

@@ -0,0 +1,5 @@
+require 'check_digit/version'
+require 'check_digit/util'
+require 'check_digit/verhoeff'
+require 'check_digit/damm'
+require 'check_digit/luhn'

data/lib/check_digit/damm.rb

@@ -0,0 +1,31 @@
+module CheckDigit::Damm
+  D = [
+       [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
+
+  def self.checksum(num)
+    CheckDigit::Util.valid_arg(num)
+    num.to_i * 10 + calc(num)
+  end
+
+  def self.valid?(num)
+    CheckDigit::Util.valid_arg(num)
+    calc(num.to_s[0..-2]) == num % 10
+  end
+
+  private
+  def self.calc(num)
+    i = 0
+    num.to_s.each_char {|c| i = D[i][c.to_i] }
+    i
+  end
+end

data/lib/check_digit/luhn.rb

@@ -0,0 +1,23 @@
+module CheckDigit::Luhn
+  def self.checksum(num)
+    CheckDigit::Util.valid_arg(num)
+    num.to_i * 10 + calc(num)
+  end
+
+  def self.valid?(num)
+    CheckDigit::Util.valid_arg(num)
+    calc(num.to_s[0..-2]) == num % 10
+  end
+
+  private
+  def self.calc(num)
+    digits = num.to_s.reverse.scan(/\d/).map { |x| x.to_i }
+    digits = digits.each_with_index.map { |d, i|
+      d *= 2 if i.even?
+      d > 9 ? d - 9 : d
+    }
+    sum = digits.inject(0) { |m, x| m + x }
+    mod = 10 - sum % 10
+    mod==10 ? 0 : mod
+  end
+end

data/lib/check_digit/util.rb

@@ -0,0 +1,6 @@
+module CheckDigit::Util
+  def self.valid_arg(num)
+    raise ArgumentError, 'invalid argument' unless
+      num.is_a?(Integer) || (num.to_i.to_s == num)
+  end
+end

data/lib/check_digit/verhoeff.rb

@@ -0,0 +1,46 @@
+module CheckDigit::Verhoeff
+  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
+
+  P = [
+       [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
+
+  ZERO_ORDINAL = 48 # '0'.each_byte.first on 1.8 or '0'.ord on 1.9
+
+  def self.checksum(num)
+    CheckDigit::Util.valid_arg(num)
+    num.to_i * 10 + calc(num)
+  end
+
+  def self.valid?(num)
+    CheckDigit::Util.valid_arg(num)
+    calc(num.to_s[0..-2]) == num % 10
+  end
+
+  private
+  def self.calc(num)
+    INV[num.to_s.each_byte.reverse_each.with_index.inject(0) { |check,(x,i)|
+          D[check][P[i.next % 8][x - ZERO_ORDINAL]]
+        }]
+  end
+end

data/lib/check_digit/version.rb

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

data/spec/damm_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module CheckDigit
+  describe Damm do
+    it "generates checksum values" do
+      expect(Damm.checksum(100913449)).to eq(1009134493)
+      expect(Damm.checksum(123)).to eq(1234)
+    end
+
+    it "generates a checkum value for an integer string" do
+      expect(Damm.checksum("123")).to eq(1234)
+    end
+
+    it "raises an error for a non-integer string" do
+      expect {Damm.checksum("A123")}.
+        to raise_error(ArgumentError, 'invalid argument')
+
+      expect {Damm.valid?("A123")}.
+        to raise_error(ArgumentError, 'invalid argument')
+    end
+
+    it "raises an error for a non-integer numeric" do
+      expect {Damm.checksum("123.45")}.
+        to raise_error(ArgumentError, 'invalid argument')
+
+      expect {Damm.valid?("123.45")}.
+        to raise_error(ArgumentError, 'invalid argument')
+    end
+
+    it "tests an existing number for a valid checksum" do
+      expect(Damm.valid?(9990)).to be true
+      expect(Damm.valid?(9999)).to be false
+    end
+
+    it "benchmarks performance (#{BMITERS} iterations)" do
+      puts '  ' + '-' * 55
+      Benchmark.bm(10) do |x|
+        x.report("  generate:") {
+          i = BMITERS
+          while i > 1
+            Damm.checksum(i)
+            i-=1
+          end
+        }
+
+        x.report("  validate:") {
+          i = BMITERS
+          while i > 1
+            Damm.valid?(i)
+            i-=1
+          end
+        }
+      end
+      puts '  ' + '-' * 55
+    end
+  end
+end

data/spec/luhn_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module CheckDigit
+  describe Luhn do
+    it "generates checksum values" do
+      val = (1..23).inject(1) { |val, i| Luhn.checksum val }
+      expect(val).to eq(182675918342675918342675)
+
+      expect(Luhn.checksum(100913449)).to eq(1009134493)
+      expect(Luhn.checksum(123)).to eq(1230)
+    end
+
+    it "generates a checkum value for an integer string" do
+      expect(Luhn.checksum("123")).to eq(1230)
+    end
+
+    it "raises an error for a non-integer string" do
+      expect {Luhn.checksum("A123")}.
+        to raise_error(ArgumentError, 'invalid argument')
+
+      expect {Luhn.valid?("A123")}.
+        to raise_error(ArgumentError, 'invalid argument')
+    end
+
+    it "raises an error for a non-integer numeric" do
+      expect {Luhn.checksum("123.45")}.
+        to raise_error(ArgumentError, 'invalid argument')
+
+      expect {Luhn.valid?("123.45")}.
+        to raise_error(ArgumentError, 'invalid argument')
+    end
+
+    it "tests an existing number for a valid checksum" do
+      expect(Luhn.valid?(9993)).to be true
+      expect(Luhn.valid?(9999)).to be false
+    end
+
+    it "benchmarks performance (#{BMITERS} iterations)" do
+      puts '  ' + '-' * 55
+      Benchmark.bm(10) do |x|
+        x.report("  generate:") {
+          i = BMITERS
+          while i > 1
+            Luhn.checksum(i)
+            i-=1
+          end
+        }
+
+        x.report("  validate:") {
+          i = BMITERS
+          while i > 1
+            Luhn.valid?(i)
+            i-=1
+          end
+        }
+      end
+      puts '  ' + '-' * 55
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'check_digit'
+require 'benchmark'
+
+# of iterations to benchmark
+BMITERS = 500_000
+
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/verhoeff_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module CheckDigit
+  describe Verhoeff do
+    it "generates checksum values" do
+      val = (1..23).inject(1) { |val, i| Verhoeff.checksum val }
+      expect(val).to eq(150493068613366131371194)
+
+      expect(Verhoeff.checksum(100913449)).to eq(1009134492)
+      expect(Verhoeff.checksum(123)).to eq(1233)
+    end
+
+    it "generates a checkum value for an integer string" do
+      expect(Verhoeff.checksum("123")).to eq(1233)
+    end
+
+    it "raises an error for a non-integer string" do
+      expect {Verhoeff.checksum("A123")}.
+        to raise_error(ArgumentError, 'invalid argument')
+
+      expect {Verhoeff.valid?("A123")}.
+        to raise_error(ArgumentError, 'invalid argument')
+    end
+
+    it "raises an error for a non-integer numeric" do
+      expect {Verhoeff.checksum("123.45")}.
+        to raise_error(ArgumentError, 'invalid argument')
+
+      expect {Verhoeff.valid?("123.45")}.
+        to raise_error(ArgumentError, 'invalid argument')
+    end
+
+    it "tests an existing number for a valid checksum" do
+      expect(Verhoeff.valid?(9998)).to be true
+      expect(Verhoeff.valid?(9999)).to be false
+    end
+
+    it "benchmarks performance (#{BMITERS} iterations)" do
+      puts '  ' + '-' * 55
+      Benchmark.bm(10) do |x|
+        x.report("  generate:") {
+          i = BMITERS
+          while i > 1
+            Verhoeff.checksum(i)
+            i-=1
+          end
+        }
+
+        x.report("  validate:") {
+          i = BMITERS
+          while i > 1
+            Verhoeff.valid?(i)
+            i-=1
+          end
+        }
+      end
+      puts '  ' + '-' * 55
+    end
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+desc "Run RSpec code examples in progress mode"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: check_digit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Litwin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Ruby implementation of Luhn, Damm and Verhoeff check digit algorithms
+email:
+- eric.litwin@pnmac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- check_digit.gemspec
+- lib/check_digit.rb
+- lib/check_digit/damm.rb
+- lib/check_digit/luhn.rb
+- lib/check_digit/util.rb
+- lib/check_digit/verhoeff.rb
+- lib/check_digit/version.rb
+- spec/damm_spec.rb
+- spec/luhn_spec.rb
+- spec/spec_helper.rb
+- spec/verhoeff_spec.rb
+- tasks/rspec.rake
+homepage: http://github.com/elitwin/check_digit
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Check Digit calculator/validator
+test_files:
+- spec/damm_spec.rb
+- spec/luhn_spec.rb
+- spec/spec_helper.rb
+- spec/verhoeff_spec.rb