sjekksum 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebf2decf9fa08a77d79569fc64a315cafdaf33b0
-  data.tar.gz: 32770f2b17ad7053f425b38a24a82ff28780ebc3
+  metadata.gz: 5766c405550125325430eb38e4ce6f8600721311
+  data.tar.gz: a8e2cc7a1cd0f8f89eb9214335fc3a7e35a93108
 SHA512:
-  metadata.gz: 7f4b7601494c7e8631b2203c81d9e4333212cfcd4f0d7861da62e78a8715bddef3ee255b904d7556de1c3acce5de87c9b64f851bfec5dd3917e61a6ebbe0a900
-  data.tar.gz: 41346fdd102f54ac079cc5e53bdff8bb8aed90feaa90be508eb9e8581e904e1111b53252a47381f0bcdd86d89bf2b6cb3176cbab7255da187e62d7cf73d484bd
+  metadata.gz: 8db7a683ca0a17d7ea7962e4210cab4dc0bad173f492b7fe44797f72f110882fdcd5295c0eb21d37612955507dd4d3eb588b491a00ed72774916211961a40f39
+  data.tar.gz: adc09f1148201ca7755cea7b81a42085181d9fe476481523fe5b2c9126bd9044d9c1902eed36287e9be0e10a8e398c3ff8d0acdeadae9b60a303453385a68060

data/README.md

@@ -1,17 +1,26 @@
 # Sjekksum [![Gem Version](https://badge.fury.io/rb/sjekksum.png)](http://badge.fury.io/rb/sjekksum) [![Build Status](https://travis-ci.org/asaaki/sjekksum.png?branch=master)](https://travis-ci.org/asaaki/sjekksum)
 
-A gem to provide some checksum algorithms like Luhn, Damm and Verhoeff.
+A gem to provide some checksum algorithms like Damm, Luhn, UPC and Verhoeff.
 
 ----
 
-All used algorithms for generating and validating checksums must calculate a single check digit only.
+All used algorithms for generating and validating checksums **must calculate a single check digit only.**
 
 More extensive checksum algorithms like Adler-32, CRC, BSD checksum, SYSV checksum, all hash algorithms and friends are not part of this project.
-Also no advanced algorithms like IBAN and credit card number calculation can be found here due to their nature in these cases more transformations and steps have to be taken.
+
 Furthermore this gem does not allow any other input type than integers or strings of integer digits to simplify transformations here (so all extended algorithms allowing characters are not included as well).
-For the string inputs all non-integer bytes are thrown away (e. g. `"01-234.567 89" => "0123456789" => [0,1,2,3,4,5,6,7,8,9]`).
 
-Shortly: This gem tries to follow the [UNIX philosophy](http://en.wikipedia.org/wiki/Unix_philosophy) in parts: »Write programs that do one thing and do it well.«
+For the string inputs all non-integer bytes are thrown away:
+
+```ruby
+"01-234.567 89"
+#=>
+"0123456789" # cleaned string
+#=>
+[0,1,2,3,4,5,6,7,8,9] # internal digits representation
+```
+
+Shortly: This gem tries to follow the [UNIX philosophy](http://en.wikipedia.org/wiki/Unix_philosophy) in parts: _»Write programs that do one thing and do it well.«_
 
 
 
@@ -19,16 +28,21 @@ Shortly: This gem tries to follow the [UNIX philosophy](http://en.wikipedia.org/
 
 Add this line to your application's Gemfile:
 
-    gem "sjekksum"
+```ruby
+gem "sjekksum"
+```
 
 And then execute:
 
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install damm
-
+```shell
+gem install sjekksum
+```
 
 
 ## Usage
@@ -36,29 +50,33 @@ Or install it yourself as:
 ```ruby
 require "sjekksum"
 
-Sjekksum.damm(572)            #=> 4
-Sjekksum.damm!(572)           #=> 5724
-Sjekksum.damm?(5724)          #=> true
+Sjekksum.damm(572)              #=> 4
+Sjekksum.damm!(572)             #=> 5724
+Sjekksum.damm?(5724)            #=> true
+
+Sjekksum.isbn10("147743025")    #=> 3
+Sjekksum.isbn10!("147743025")   #=> "1477430253"
+Sjekksum.isbn10?("1477430253")  #=> true
 
-Sjekksum.luhn(7992739871)     #=> 3
-Sjekksum.luhn!(7992739871)    #=> 79927398713
-Sjekksum.luhn?(79927398713)   #=> true
+Sjekksum.luhn(7992739871)       #=> 3
+Sjekksum.luhn!(7992739871)      #=> 79927398713
+Sjekksum.luhn?(79927398713)     #=> true
 
-Sjekksum.upc("03600024145")   #=> 7
-Sjekksum.upc!("03600024145")  #=> "036000241457"
-Sjekksum.upc?("03600024145")  #=> true
+Sjekksum.upc("03600024145")     #=> 7
+Sjekksum.upc!("03600024145")    #=> "036000241457"
+Sjekksum.upc?("036000241457")   #=> true
 
-Sjekksum.verhoeff(142857)     #=> 0
-Sjekksum.verhoeff?(1428570)   #=> true
-Sjekksum.verhoeff!(142857)    #=> 1428570
+Sjekksum.verhoeff(142857)       #=> 0
+Sjekksum.verhoeff!(142857)      #=> 1428570
+Sjekksum.verhoeff?(1428570)     #=> true
 
-Sjekksum.primitive(232323)    #=> 6
-Sjekksum.primitive?(2323236)  #=> true
-Sjekksum.primitive!(232323)   #=> 2323236
+Sjekksum.primitive(232323)      #=> 6
+Sjekksum.primitive!(232323)     #=> 2323236
+Sjekksum.primitive?(2323236)    #=> true
 
-Sjekksum.primitive97(23569)   #=> 0
-Sjekksum.primitive97?(235695) #=> true
-Sjekksum.primitive97!(23569)  #=> 235695
+Sjekksum.primitive97(23569)     #=> 5
+Sjekksum.primitive97!(23569)    #=> 235695
+Sjekksum.primitive97?(235695)   #=> true
 ```
 
 

data/lib/sjekksum/isbn10.rb

@@ -0,0 +1,86 @@
+module Sjekksum
+  #
+  # Module for calculation and validation of ISBN 10 (International Standard Book Number) checksums
+  #
+  # @see http://en.wikipedia.org/wiki/International_Standard_Book_Number#ISBN-10_check_digit_calculation ISBN-10 check digit calculation
+  #
+  module ISBN10
+    extend self
+    extend Shared
+
+    #
+    # Calculates ISBN 10 checksum
+    #
+    # @example
+    #   Sjekksum::ISBN10.of("147743025") #=> 3
+    #   Sjekksum::ISBN10.of("193435600") #=> "X"
+    #
+    # @param  number [Integer, String] number for which the checksum should be calculated
+    #
+    # @return [Integer, String] calculated checksum
+    def of number
+      raise_on_type_mismatch number
+      digits = convert_number_to_digits(number)[0..9]
+      sum    = digits.reverse_each.with_index.reduce(0) do |check, (digit, idx)|
+        check += digit * (idx+2)
+      end
+      check = (11 - sum % 11) % 11
+      check == 10 ? "X" : check
+    end
+    alias_method :checksum, :of
+
+    #
+    # ISBN 10 validation of provided number
+    #
+    # @example
+    #   Sjekksum::ISBN10.valid?("1477430253") #=> true
+    #   Sjekksum::ISBN10.valid?("193435600X") #=> true
+    #
+    # @param  number [Integer, String] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      num, check = split_isbn_number(number)
+      convert_number_to_digits(num).length == 9 && self.of(num) == check
+    end
+    alias_method :is_valid?, :valid?
+
+    #
+    # Transforms a number by appending the ISBN 10 checksum digit
+    #
+    # @example
+    #   Sjekksum::ISBN10.convert("147743025") #=> "1477430253"
+    #   Sjekksum::ISBN10.convert("193435600") #=> "193435600X"
+    #
+    # @param  number [Integer, String] number without a checksum
+    #
+    # @return [Integer, String] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      check = self.of(number)
+      if number.is_a?(String) or check.is_a?(String)
+        number.to_s << self.of(number).to_s
+      else
+        convert_to_int(number) * 10 + self.of(number)
+      end
+    end
+    alias_method :transform, :convert
+
+  private
+
+    #
+    # [split_isbn_number description]
+    # @param  number [type] [description]
+    #
+    # @return [type] [description]
+    def split_isbn_number number
+      if number.is_a?(String)
+        [ number[0..-2], (%w[X x].include?(number[-1]) ? "X" : number[-1].to_i) ]
+      else
+        number.divmod(10)
+      end
+    end
+
+  end
+end

data/lib/sjekksum/version.rb

@@ -1,4 +1,4 @@
 module Sjekksum
   # Version constant
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/sjekksum.rb

@@ -1,6 +1,7 @@
 require "sjekksum/version"
 require "sjekksum/shared"
 require "sjekksum/damm"
+require "sjekksum/isbn10"
 require "sjekksum/luhn"
 require "sjekksum/upc"
 require "sjekksum/verhoeff"
@@ -29,6 +30,23 @@ module Sjekksum
   end
   alias_method :damm, :damm_of
 
+  #
+  # Calculates ISBN 10 checksum
+  #
+  # @example
+  #   Sjekksum::ISBN10.of("147743025") #=> 3
+  #   Sjekksum::ISBN10.of("193435600") #=> "X"
+  #
+  # @see Sjekksum::Damm#of
+  #
+  # @param  number [Integer, String] number for which the checksum should be calculated
+  #
+  # @return [Integer, String] calculated checksum
+  def isbn10_of number
+    ISBN10.of number
+  end
+  alias_method :isbn10, :isbn10_of
+
   #
   # Calculates Luhn checksum
   #
@@ -125,6 +143,23 @@ module Sjekksum
   end
   alias_method :damm?, :valid_damm?
 
+  #
+  # ISBN 10 validation of provided number
+  #
+  # @example
+  #   Sjekksum::ISBN10.valid?("1477430253") #=> true
+  #   Sjekksum::ISBN10.valid?("193435600X") #=> true
+  #
+  # @see Sjekksum::ISBN10#valid?
+  #
+  # @param  number [Integer, String] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_isbn10? number
+    ISBN10.valid? number
+  end
+  alias_method :isbn10?, :valid_isbn10?
+
   #
   # Luhn validation of provided number
   #
@@ -221,6 +256,23 @@ module Sjekksum
   end
   alias_method :damm!, :make_damm
 
+  #
+  # Transforms a number by appending the ISBN 10 checksum digit
+  #
+  # @example
+  #   Sjekksum::ISBN10.convert("147743025") #=> "1477430253"
+  #   Sjekksum::ISBN10.convert("193435600") #=> "193435600X"
+  #
+  # @see Sjekksum::ISBN10#convert
+  #
+  # @param  number [Integer, String] number without a checksum
+  #
+  # @return [Integer, String] final number including the checksum
+  def make_isbn10 number
+    ISBN10.convert number
+  end
+  alias_method :isbn10!, :make_isbn10
+
   #
   # Transforms a number by appending the Luhn checksum digit
   #

data/sjekksum.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Collection of some checksum validation algorithms}
+  spec.description   = %q{A gem to provide some checksum algorithms like Damm, Luhn, UPC and Verhoeff.}
   spec.homepage      = "https://github.com/asaaki/sjekksum"
   spec.license       = "MIT"
 

data/spec/sjekksum/isbn10_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::ISBN10 do
+
+  success_spec_matrix = [
+    [ "363941830",     1 ],
+    [ "193435600",   "X" ],
+    [ 364222974,       3 ],
+    [ "345330684",     8 ],
+    [ "3-882-21068",   0 ],
+    [ 388221591,       7 ],
+    [ "359617218",     7 ],
+    [ "147743025",     3 ],
+    [ "0-306-40615-",  2 ],
+  ]
+
+  fail_spec_matrix = [
+    [ 123,             9 ],
+    [ "123",           9 ],
+    [ "147743025",     9 ],
+    [ "0-306-40615-",  9 ],
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum_spec.rb

@@ -2,106 +2,34 @@ require "spec_helper"
 
 describe Sjekksum do
 
+  spec_input  = 193435600
+
   spec_values = {
-    input:       12345,
     damm:        9,
+    isbn10:      "X",
     luhn:        5,
-    upc:         7,
-    verhoeff:    1,
-    primitive:   6,
-    primitive97: 8
+    upc:         3,
+    verhoeff:    4,
+    primitive:   4,
+    primitive97: 7
   }
 
   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 "#upc" do
-    expected = spec_values[:input] * 10 + spec_values[:upc]
-    expect(described_class.upc(spec_values[:input])).to eq(spec_values[:upc])
-  end
-
-  it "#upc?" do
-    value = spec_values[:input] * 10 + spec_values[:upc]
-    expect(described_class.upc?(value)).to be_true
-  end
-
-  it "#upc!" do
-    expected = spec_values[:input] * 10 + spec_values[:upc]
-    expect(described_class.upc!(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
-
-  it "#primitive" do
-    expected = spec_values[:input] * 10 + spec_values[:primitive]
-    expect(described_class.primitive(spec_values[:input])).to eq(spec_values[:primitive])
-  end
-
-  it "#primitive?" do
-    value = spec_values[:input] * 10 + spec_values[:primitive]
-    expect(described_class.primitive?(value)).to be_true
-  end
-
-  it "#primitive!" do
-    expected = spec_values[:input] * 10 + spec_values[:primitive]
-    expect(described_class.primitive!(spec_values[:input])).to eq(expected)
-  end
+  spec_values.each do |algo, check|
+    final_value = check.is_a?(String) ? "#{spec_input}#{check}" : spec_input * 10 + check
 
-  it "#primitive97" do
-    expected = spec_values[:input] * 10 + spec_values[:primitive97]
-    expect(described_class.primitive97(spec_values[:input])).to eq(spec_values[:primitive97])
-  end
+    it "##{algo}" do
+      expect(described_class.send(algo, spec_input)).to eq(check)
+    end
 
-  it "#primitive97?" do
-    value = spec_values[:input] * 10 + spec_values[:primitive97]
-    expect(described_class.primitive97?(value)).to be_true
-  end
+    it "##{algo}?" do
+      expect(described_class.send(:"#{algo}?", final_value)).to be_true
+    end
 
-  it "#primitive97!" do
-    expected = spec_values[:input] * 10 + spec_values[:primitive97]
-    expect(described_class.primitive97!(spec_values[:input])).to eq(expected)
+    it "##{algo}!" do
+      expect(described_class.send(:"#{algo}!", spec_input)).to eq(final_value)
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sjekksum
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Christoph Grabo
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A gem to provide some checksum algorithms like Luhn, Damm and Verhoeff.
+description: A gem to provide some checksum algorithms like Damm, Luhn, UPC and Verhoeff.
 email:
 - chris@dinarrr.com
 executables: []
@@ -110,6 +110,7 @@ files:
 - Rakefile
 - lib/sjekksum.rb
 - lib/sjekksum/damm.rb
+- lib/sjekksum/isbn10.rb
 - lib/sjekksum/luhn.rb
 - lib/sjekksum/primitive.rb
 - lib/sjekksum/primitive97.rb
@@ -120,6 +121,7 @@ files:
 - sjekksum.gemspec
 - spec/shared_implementation.rb
 - spec/sjekksum/damm_spec.rb
+- spec/sjekksum/isbn10_spec.rb
 - spec/sjekksum/luhn_spec.rb
 - spec/sjekksum/primitive97_spec.rb
 - spec/sjekksum/primitive_spec.rb
@@ -150,10 +152,11 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Collection of some checksum/validation algorithms
+summary: Collection of some checksum validation algorithms
 test_files:
 - spec/shared_implementation.rb
 - spec/sjekksum/damm_spec.rb
+- spec/sjekksum/isbn10_spec.rb
 - spec/sjekksum/luhn_spec.rb
 - spec/sjekksum/primitive97_spec.rb
 - spec/sjekksum/primitive_spec.rb