verhoeff 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.9.9 / 2007-07-10
+
+* Initial implementation. Has decent spec coverage but it could be better.

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/verhoeff
+lib/verhoeff.rb
+test/test_verhoeff.rb

data/README.txt

@@ -0,0 +1,55 @@
+verhoeff
+    by Jay Phillips (your name)
+    Codemecca LLC (http://codemecca.com)
+
+== DESCRIPTION:
+  
+Pure-Ruby implementation of the Verhoeff checksum algorithm. Useful for attaching to numbers which will later be entered by an error-prone human. Typos in the number can be found quickly with the checksum before any further work is performed.
+
+== FEATURES/PROBLEMS:
+  
+A library that returns
+
+== SYNOPSIS:
+
+  Verhoeff.checkum_of 12345 # => "123451"
+  Verhoeff.checkum_of 54321 # => "543217"
+  Verhoeff.checks_out? 543217 # => true
+  Verhoeff.checks_out? 543211 # => false
+
+  Or, if you've required verhoeff/monkey_patches, you can do this:
+  
+  656.checksum # => 6569
+  "657".checksum # => 6576
+  6567.checks_out? # => true
+  "6560".checks_out? # => false
+  
+
+== INSTALL:
+
+* sudo gem install verhoeff
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Jay Phillips
+
+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/Rakefile

@@ -0,0 +1,26 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/verhoeff.rb'
+require 'spec/rake/spectask'
+require 'rake/gempackagetask'
+
+Hoe.new('verhoeff', Verhoeff::VERSION) do |p|
+  p.rubyforge_name = 'verhoeff'
+  p.author = 'Jay Phillips'
+  p.email = 'jay -at- codemecca.com'
+  p.summary = 'A pure-Ruby implementation of the Verhoeff checksum algorithm'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.spec_extras = {
+    "files" => Dir['**/*']
+  }
+end
+
+Spec::Rake::SpecTask.new "spec" do |t|
+  t.spec_opts = ["-c"]
+  t.spec_files = Dir['spec/*_spec.rb']
+end
+

data/lib/monkey_patches.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/verhoeff.rb'
+
+module Verhoeff
+  module ChecksumMethods
+    def checksum
+      Verhoeff.checksum_of self
+    end
+    def checksum_digit
+      Verhoeff.checksum_digit_of self
+    end
+    def checks_out?
+      Verhoeff.checks_out? self
+    end
+  end
+end
+
+[Numeric,String].each do |klass|
+  klass.class_eval do
+    include Verhoeff::ChecksumMethods
+  end
+end

data/lib/verhoeff.rb

@@ -0,0 +1,42 @@
+require 'enumerator'
+module Verhoeff
+  VERSION = '1.0.0'
+  
+  # Verhoeff Multiplication Table
+  M = [ [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] ]
+        
+  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] ]
+        
+  INV = [0, 4, 3, 2, 1, 5, 6, 7, 8, 9]
+  
+  def self.checksum_digit_of(arg)
+    INV[arg.to_s.split("").reverse.enum_for(:each_with_index).inject(0) { |check,(x,i)|
+      M[check][P[i.next % 8][x[0] - ?0]]
+    }]
+  end
+  
+  def self.checksum_of(arg)
+    arg.to_i * 10 + checksum_digit_of(arg)
+  end
+  
+  def self.checks_out?(num)
+    checksum_digit_of(num.to_s[0..-2]) == num.to_s[-1] - ?0
+  end
+  
+end

data/spec/checksum_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../lib/verhoeff.rb'
+
+describe "The Verhoeff checksum algorithm implementation" do
+  it "should work with correct, previously calculated checksums" do
+    (1..23).inject(1) do |checksum,i|
+      Verhoeff.checksum_of checksum
+    end.should eql(150493068613366131371194)
+  end
+  
+  it "should work when given a String argument and return a Fixnum" do
+    Verhoeff.checksum_of("999").should equal(9998)
+  end
+  
+  it "should validate a properly generated checksum" do
+    Verhoeff.checks_out?(13375).should be_true
+    Verhoeff.checks_out?(13735).should be_false
+  end
+end

data/spec/monkey_patches_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + "/../lib/monkey_patches.rb"
+
+KNOWN_CASES = {
+  123 => 3,
+  765 => 7,
+  43167312675318282 => 3,
+  01 => 5
+}
+
+describe "The Verhoeff checksum monkey patches" do
+
+  it "should monkey patch Numeric and String properly" do
+    check = lambda do |k,v|
+      k.checksum_digit.should eql(v)
+      k.checksum.should eql(k.to_i*10+v)
+      (k.to_i*10+v).should be_checks_out
+    end
+    KNOWN_CASES.each_pair &check
+    KNOWN_CASES.each_pair do |k,v|
+      check.call(k.to_s,v)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: verhoeff
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-07-15 00:00:00 -07:00
+summary: A pure-Ruby implementation of the Verhoeff checksum algorithm
+require_paths: 
+- lib
+email: jay -at- codemecca.com
+homepage: "    by Jay Phillips (your name)"
+rubyforge_project: verhoeff
+description: "== FEATURES/PROBLEMS:  A library that returns  == SYNOPSIS:  Verhoeff.checkum_of 12345 # => \"123451\" Verhoeff.checkum_of 54321 # => \"543217\" Verhoeff.checks_out? 543217 # => true Verhoeff.checks_out? 543211 # => false  Or, if you've required verhoeff/monkey_patches, you can do this:  656.checksum # => 6569 \"657\".checksum # => 6576 6567.checks_out? # => true \"6560\".checks_out? # => false"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jay Phillips
+files: 
+- bin
+- bin/verhoeff
+- History.txt
+- lib
+- lib/monkey_patches.rb
+- lib/verhoeff.rb
+- Manifest.txt
+- pkg
+- Rakefile
+- README.txt
+- spec
+- spec/checksum_spec.rb
+- spec/monkey_patches_spec.rb
+- test
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- verhoeff
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: