oklasoft-verhoeff 1.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/README.markdown

@@ -0,0 +1,16 @@
+This is pure Ruby (1.9 compatible) implementation of the Verchoeff algorithm.
+
+### Trivia
+The Verhoeff algorithm uses the properties of D5 (the dihedral group of order 10) — a non-commutative system of operations on ten elements, corresponding to the results of rotating or reflecting (flipping) a regular pentagon.
+
+### Implementation
+The Verhoeff algorithm implemented using three tables: a multiplication table D, a permutation table P, and an inverse table INV. All tables are precomputed.
+
+### Example
+    Verhoeff.checkum_of 12345 # => "123451"
+    Verhoeff.checkum_of 54321 # => "543217"
+    Verhoeff.valid? 543217 # => true
+    Verhoeff.valid? 543211 # => false
+
+### References
+  * Verhoeff, J. “Error Detecting Decimal Codes”, Mathematical Centre Tract 29, The Mathematical Centre, Amsterdam, 1969.

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/verhoeff.rb

@@ -0,0 +1 @@
+require "verhoeff/verhoeff"

data/lib/verhoeff/verhoeff.rb

@@ -0,0 +1,45 @@
+require 'enumerator'
+
+module 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]
+  ]
+
+  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]
+  
+  ZERO_ORDINAL = '0'.each_byte.first
+
+  def self.checksum_digit_of(arg)
+    INV[arg.to_s.each_byte.reverse_each.enum_for(:each_with_index).inject(0) { |check,(x,i)|
+      D[check][P[i.next % 8][x - ZERO_ORDINAL]]
+    }]
+  end
+
+  def self.checksum_of(arg)
+    arg.to_i * 10 + checksum_digit_of(arg)
+  end
+
+  def self.valid?(num)
+    checksum_digit_of(num.to_s[0..-2]) == num.to_s.each_byte.reverse_each.next - ZERO_ORDINAL
+  end
+end

data/rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "oklasoft-verhoeff"
+    gem.summary = %Q{Pure-Ruby implementation of the Verhoeff checksum algorithm.}
+    gem.description = %Q{Pure-Ruby implementation of the Verhoeff checksum algorithm.}
+    gem.email = "oklasoft@lupus.omrf.org"
+    gem.homepage = "http://github.com/oklasoft/verhoeff"
+    gem.authors = ["beawesomeinstead","oklasoft"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  elsif File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "verhoeff #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/test/checksum_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class ChecksumTest < Test::Unit::TestCase
+  context "The Verhoeff checksum algorithm" do
+    should "work with correct, previously calculated checksums" do
+      checksum = (1..23).inject(1) { |checksum, i| Verhoeff.checksum_of checksum }
+      assert_equal 150493068613366131371194, checksum
+    end
+
+    should "work when given a String argument and return a Fixnum" do
+      assert_equal 9998, Verhoeff.checksum_of("999")
+    end
+
+    should "validate a properly generated checksum" do
+      assert_equal true, Verhoeff.valid?(13375)
+      assert_equal false, Verhoeff.valid?(13735)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'verhoeff'
+
+class Test::Unit::TestCase
+end

data/verhoeff.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{verhoeff}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["beawesomeinstead", "oklasoft"]
+  s.date = %q{2010-11-05}
+  s.description = %q{Pure-Ruby implementation of the Verhoeff checksum algorithm.}
+  s.email = %q{oklasoft@lupus.omrf.org}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "VERSION",
+     "lib/verhoeff.rb",
+     "lib/verhoeff/verhoeff.rb",
+     "rakefile",
+     "test/checksum_test.rb",
+     "test/test_helper.rb",
+     "verhoeff.gemspec"
+  ]
+  s.homepage = %q{http://github.com/oklasoft/verhoeff}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Pure-Ruby implementation of the Verhoeff checksum algorithm.}
+  s.test_files = [
+    "test/checksum_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: oklasoft-verhoeff
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- beawesomeinstead
+- oklasoft
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Pure-Ruby implementation of the Verhoeff checksum algorithm.
+email: oklasoft@lupus.omrf.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- VERSION
+- lib/verhoeff.rb
+- lib/verhoeff/verhoeff.rb
+- rakefile
+- test/checksum_test.rb
+- test/test_helper.rb
+- verhoeff.gemspec
+has_rdoc: true
+homepage: http://github.com/oklasoft/verhoeff
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Pure-Ruby implementation of the Verhoeff checksum algorithm.
+test_files: 
+- test/checksum_test.rb
+- test/test_helper.rb