sjekksum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 138a821d406efac0c481425e7de8956af20f390d
+  data.tar.gz: 6655ede5c5a4c17a69ea6a166d46632128327c90
+SHA512:
+  metadata.gz: 057656143728ce66d976633e71c73da8e4392cc7672eedcebc4c83499a905805260b15b35ed5603447db53432662a1b14990d86f93a5215a2561e0fc30451bb7
+  data.tar.gz: a2b2c5962a35890d0a203bd845fc3cf7270a3a5e9002416d1e00725750faecba6dcff2416183abba9a9058f5d6c7edc0e51a3432897b102336693e6d48a67a47

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-f d

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+
+branches:
+  only:
+    - develop
+    - master

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Christoph Grabo
+
+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,33 @@
+# Sjekksum
+
+A gem to provide some checksum algorithms like Luhn, Damm and Verhoeff.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "sjekksum"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install damm
+
+
+
+## Usage
+
+__(TODO)__
+
+
+
+## License
+
+[MIT/X11](./LICENSE)
+
+Copyright (c) 2013—2014 Christoph Grabo

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Starts PRY with gem loaded"
+task :console do
+  sh "pry -I lib -r sjekksum --no-pager"
+end
+
+desc "Run all specs"
+task RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = false
+end
+
+task :default => :spec

data/lib/sjekksum/damm.rb

@@ -0,0 +1,36 @@
+module Sjekksum
+  module Damm
+    extend self
+    extend Shared
+
+    QUASIGROUP = [
+      [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 of input_value
+      raise_on_type_mismatch input_value
+      digits = input_value.to_s.chars.map(&:to_i)
+      digits.reduce(0){|check, digit| QUASIGROUP[check][digit] }
+    end
+
+    def valid? input_value
+      raise_on_type_mismatch input_value
+      self.of(input_value).zero?
+    end
+
+    def convert input_value
+      raise_on_type_mismatch input_value
+      (input_value * 10) + self.of(input_value)
+    end
+
+  end
+end

data/lib/sjekksum/luhn.rb

@@ -0,0 +1,26 @@
+module Sjekksum
+  module Luhn
+    extend self
+    extend Shared
+
+    def of input_value
+      raise_on_type_mismatch input_value
+      digits = input_value.to_s.chars.map(&:to_i)
+      sum    = digits.reverse.map.with_index do |digit, idx|
+        idx.even? ? (digit * 2).divmod(10).reduce(&:+) : digit
+      end.reverse.reduce(&:+)
+
+      (10 - sum % 10) % 10
+    end
+
+    def valid? input_value
+      raise_on_type_mismatch input_value
+      self.of(input_value.div(10)) == (input_value % 10)
+    end
+
+    def convert input_value
+      raise_on_type_mismatch input_value
+      (input_value * 10) + self.of(input_value)
+    end
+  end
+end

data/lib/sjekksum/shared.rb

@@ -0,0 +1,11 @@
+module Sjekksum
+  module Shared
+
+  private
+
+    def raise_on_type_mismatch input_value
+      raise ArgumentError unless input_value.is_a?(Integer)
+    end
+
+  end
+end

data/lib/sjekksum/verhoeff.rb

@@ -0,0 +1,51 @@
+module Sjekksum
+  module Verhoeff
+    extend self
+    extend Shared
+
+    DIHEDRAL_GROUP_D5 = [
+      [ 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
+
+    PERMUTATION = [
+      [ 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
+
+    INVERSE = [ 0, 4, 3, 2, 1, 5, 6, 7, 8, 9 ].freeze
+
+    def of input_value
+      raise_on_type_mismatch input_value
+      digits = input_value.to_s.chars.map(&:to_i)
+      INVERSE[digits.reverse_each.with_index.reduce(0) { |check, (digit, idx)|
+        d_row = DIHEDRAL_GROUP_D5[check]
+        d_row[ PERMUTATION[idx.next % 8][digit] ]
+      }]
+    end
+
+    def valid? input_value
+      raise_on_type_mismatch input_value
+      self.of(input_value.div(10)) == (input_value % 10)
+    end
+
+    def convert input_value
+      raise_on_type_mismatch input_value
+      (input_value * 10) + self.of(input_value)
+    end
+  end
+end

data/lib/sjekksum/version.rb

@@ -0,0 +1,3 @@
+module Sjekksum
+  VERSION = "0.0.1"
+end

data/lib/sjekksum.rb

@@ -0,0 +1,56 @@
+require "sjekksum/version"
+
+require "sjekksum/shared"
+require "sjekksum/damm"
+require "sjekksum/luhn"
+require "sjekksum/verhoeff"
+
+module Sjekksum
+  extend self
+
+  def damm_of input_value
+    Damm.of input_value
+  end
+  alias_method :damm, :damm_of
+
+  def luhn_of input_value
+    Luhn.of input_value
+  end
+  alias_method :luhn, :luhn_of
+
+  def verhoeff_of input_value
+    Verhoeff.of input_value
+  end
+  alias_method :verhoeff, :verhoeff_of
+
+  def valid_damm? input_value
+    Damm.valid? input_value
+  end
+  alias_method :damm?, :valid_damm?
+
+  def valid_luhn? input_value
+    Luhn.valid? input_value
+  end
+  alias_method :luhn?, :valid_luhn?
+
+  def valid_verhoeff? input_value
+    Verhoeff.valid? input_value
+  end
+  alias_method :verhoeff?, :valid_verhoeff?
+
+  def make_damm input_value
+    Damm.convert input_value
+  end
+  alias_method :damm!, :make_damm
+
+  def make_luhn input_value
+    Luhn.convert input_value
+  end
+  alias_method :luhn!, :make_luhn
+
+  def make_verhoeff input_value
+    Verhoeff.convert input_value
+  end
+  alias_method :verhoeff!, :make_verhoeff
+
+end

data/sjekksum.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sjekksum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sjekksum"
+  spec.version       = Sjekksum::VERSION
+  spec.authors       = ["Christoph Grabo"]
+  spec.email         = ["chris@dinarrr.com"]
+  spec.summary       = %q{Collection of some checksum/validation algorithms}
+  spec.description   = %q{A gem to provide some checksum algorithms like Luhn, Damm and Verhoeff.}
+  spec.homepage      = "https://github.com/asaaki/sjekksum"
+  spec.license       = "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.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "inch"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "rspec"
+end

data/spec/shared_implementation.rb

@@ -0,0 +1,64 @@
+shared_examples "a checksum implementation:" do |success_spec_matrix, fail_spec_matrix|
+
+  describe :of do
+    success_spec_matrix.each do |spec_item|
+      it "calculates checksum: #{spec_item[0]} => #{spec_item[1]}" do
+        expect(described_class.of(spec_item[0])).to eq(spec_item[1])
+      end
+    end
+
+    fail_spec_matrix.each do |spec_item|
+      it "does not calculate checksum: #{spec_item[0]} => #{spec_item[1]}" do
+        expect(described_class.of(spec_item[0])).to_not eq(spec_item[1])
+      end
+    end
+  end
+
+  describe :valid? do
+    success_spec_matrix.each do |spec_item|
+      spec_value = spec_item[0] * 10 + spec_item[1]
+      it "returns true for #{spec_value}" do
+        expect(described_class.valid?(spec_value)).to be_true
+      end
+    end
+
+    fail_spec_matrix.each do |spec_item|
+      spec_value = spec_item[0] * 10 + spec_item[1]
+      it "does not return true for #{spec_value}" do
+        expect(described_class.valid?(spec_value)).to_not be_true
+      end
+    end
+  end
+
+  describe :convert do
+    success_spec_matrix.each do |spec_item|
+      spec_value = spec_item[0] * 10 + spec_item[1]
+      it "transforms #{spec_item[0]} to #{spec_value}" do
+        expect(described_class.convert(spec_item[0])).to eq(spec_value)
+      end
+    end
+
+    fail_spec_matrix.each do |spec_item|
+      spec_value = spec_item[0] * 10 + spec_item[1]
+      it "does not transform #{spec_item[0]} to #{spec_value}" do
+        expect(described_class.convert(spec_item[0])).to_not eq(spec_value)
+      end
+    end
+  end
+
+  context "invalid input" do
+    ["1234", 12.34, true, false, nil, {}, [], Proc.new{}, Class.new, Module.new].each do |invalid_input|
+      it "#of raises an ArgumentError for #{invalid_input.inspect} (type: #{invalid_input.class})" do
+        expect{ described_class.of(invalid_input) }.to raise_error(ArgumentError)
+      end
+      it "#valid? raises an ArgumentError for #{invalid_input.inspect} (type: #{invalid_input.class})" do
+        expect{ described_class.valid?(invalid_input) }.to raise_error(ArgumentError)
+      end
+      it "#convert raises an ArgumentError for #{invalid_input.inspect} (type: #{invalid_input.class})" do
+        expect{ described_class.convert(invalid_input) }.to raise_error(ArgumentError)
+      end
+
+    end
+  end
+
+end

data/spec/sjekksum/damm_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::Damm do
+
+  success_spec_matrix = [
+    [ 1,      3 ],
+    [ 20,     7 ],
+    [ 300,    9 ],
+    [ 4000,   7 ],
+    [ 55555,  5 ],
+    [ 424242, 0 ],
+    [ 572,    4 ],
+  ]
+
+  fail_spec_matrix = [
+    [ 1,   1 ],
+    [ 572, 9 ]
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum/luhn_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::Luhn do
+
+  success_spec_matrix = [
+    [ 1,          8 ],
+    [ 20,         8 ],
+    [ 300,        4 ],
+    [ 4000,       6 ],
+    [ 55555,      7 ],
+    [ 424242,     6 ],
+    [ 7992739871, 3 ],
+  ]
+
+  fail_spec_matrix = [
+    [ 1,          1 ],
+    [ 7992739871, 9 ]
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum/verhoeff_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::Verhoeff do
+
+  success_spec_matrix = [
+    [ 1,      5 ],
+    [ 20,     4 ],
+    [ 300,    0 ],
+    [ 4000,   1 ],
+    [ 55555,  7 ],
+    [ 424242, 3 ],
+    [ 142857, 0 ]
+  ]
+
+  fail_spec_matrix = [
+    [ 1,      1 ],
+    [ 142857, 9 ]
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Sjekksum do
+
+  spec_values = {
+    input: 12345,
+    damm: 9,
+    luhn: 5,
+    verhoeff: 1
+  }
+
+  specify { expect(described_class).to be_a(Module) }
+
+  it "#damm" do
+    expected = spec_values[:input] * 10 + spec_values[:damm]
+    expect(described_class.damm(spec_values[:input])).to eq(spec_values[:damm])
+  end
+
+  it "#damm?" do
+    value = spec_values[:input] * 10 + spec_values[:damm]
+    expect(described_class.damm?(value)).to be_true
+  end
+
+  it "#damm!" do
+    expected = spec_values[:input] * 10 + spec_values[:damm]
+    expect(described_class.damm!(spec_values[:input])).to eq(expected)
+  end
+
+  it "#luhn" do
+    expected = spec_values[:input] * 10 + spec_values[:luhn]
+    expect(described_class.luhn(spec_values[:input])).to eq(spec_values[:luhn])
+  end
+
+  it "#luhn?" do
+    value = spec_values[:input] * 10 + spec_values[:luhn]
+    expect(described_class.luhn?(value)).to be_true
+  end
+
+  it "#luhn!" do
+    expected = spec_values[:input] * 10 + spec_values[:luhn]
+    expect(described_class.luhn!(spec_values[:input])).to eq(expected)
+  end
+
+  it "#verhoeff" do
+    expected = spec_values[:input] * 10 + spec_values[:verhoeff]
+    expect(described_class.verhoeff(spec_values[:input])).to eq(spec_values[:verhoeff])
+  end
+
+  it "#verhoeff?" do
+    value = spec_values[:input] * 10 + spec_values[:verhoeff]
+    expect(described_class.verhoeff?(value)).to be_true
+  end
+
+  it "#verhoeff!" do
+    expected = spec_values[:input] * 10 + spec_values[:verhoeff]
+    expect(described_class.verhoeff!(spec_values[:input])).to eq(expected)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+require "sjekksum"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: sjekksum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christoph Grabo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to provide some checksum algorithms like Luhn, Damm and Verhoeff.
+email:
+- chris@dinarrr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sjekksum.rb
+- lib/sjekksum/damm.rb
+- lib/sjekksum/luhn.rb
+- lib/sjekksum/shared.rb
+- lib/sjekksum/verhoeff.rb
+- lib/sjekksum/version.rb
+- sjekksum.gemspec
+- spec/shared_implementation.rb
+- spec/sjekksum/damm_spec.rb
+- spec/sjekksum/luhn_spec.rb
+- spec/sjekksum/verhoeff_spec.rb
+- spec/sjekksum_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/asaaki/sjekksum
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Collection of some checksum/validation algorithms
+test_files:
+- spec/shared_implementation.rb
+- spec/sjekksum/damm_spec.rb
+- spec/sjekksum/luhn_spec.rb
+- spec/sjekksum/verhoeff_spec.rb
+- spec/sjekksum_spec.rb
+- spec/spec_helper.rb
+has_rdoc: