sjekksum 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6d1ff16d06db67ad288e906d6550e945c1550e4
-  data.tar.gz: daf3d1554d22f668c7f61af87a86feb00f8e0c39
+  metadata.gz: ebf2decf9fa08a77d79569fc64a315cafdaf33b0
+  data.tar.gz: 32770f2b17ad7053f425b38a24a82ff28780ebc3
 SHA512:
-  metadata.gz: f20e2ba3177709dd77cc43fd92b541f889b2fc192bbe9fdba0eae82492c7dac8c3f5f90fa34231efb865f0c675f68f607feef574708f8566ef5cde3b2126c721
-  data.tar.gz: 5b13d80284d30c3afdb52161f2f90f5c532e4823bd5cfde53e51646f1be57a5b33561954c39fce7357957fa51fbc8b88c252d9b2a08b9bbc5da59e27e25d7ae9
+  metadata.gz: 7f4b7601494c7e8631b2203c81d9e4333212cfcd4f0d7861da62e78a8715bddef3ee255b904d7556de1c3acce5de87c9b64f851bfec5dd3917e61a6ebbe0a900
+  data.tar.gz: 41346fdd102f54ac079cc5e53bdff8bb8aed90feaa90be508eb9e8581e904e1111b53252a47381f0bcdd86d89bf2b6cb3176cbab7255da187e62d7cf73d484bd

data/README.md

@@ -1,7 +1,18 @@
-# Sjekksum
+# 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.
 
+----
+
+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.«
+
 
 
 ## Installation
@@ -22,7 +33,33 @@ Or install it yourself as:
 
 ## Usage
 
-__(TODO)__
+```ruby
+require "sjekksum"
+
+Sjekksum.damm(572)            #=> 4
+Sjekksum.damm!(572)           #=> 5724
+Sjekksum.damm?(5724)          #=> 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.verhoeff(142857)     #=> 0
+Sjekksum.verhoeff?(1428570)   #=> true
+Sjekksum.verhoeff!(142857)    #=> 1428570
+
+Sjekksum.primitive(232323)    #=> 6
+Sjekksum.primitive?(2323236)  #=> true
+Sjekksum.primitive!(232323)   #=> 2323236
+
+Sjekksum.primitive97(23569)   #=> 0
+Sjekksum.primitive97?(235695) #=> true
+Sjekksum.primitive97!(23569)  #=> 235695
+```
 
 
 

data/lib/sjekksum/damm.rb

@@ -11,16 +11,16 @@ module Sjekksum
     # The totally anti-symmetric quasigroup
     # @see http://archiv.ub.uni-marburg.de/diss/z2004/0516/pdf/dhmd.pdf [PDF] Damm, H. Michael (2004). Total anti-symmetrische Quasigruppen (Dr. rer. nat.). Philipps-Universität Marburg.
     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]
+      [ 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
 
     #
@@ -29,13 +29,13 @@ module Sjekksum
     # @example
     #   Sjekksum::Damm.of(572) #=> 4
     #
-    # @param  number [Integer] number for which the checksum should be calculated
+    # @param  number [Integer, String] number for which the checksum should be calculated
     #
     # @return [Integer] calculated checksum
     def of number
       raise_on_type_mismatch number
-      digits = number.to_s.chars.map(&:to_i)
-      digits.reduce(0){|check, digit| QUASIGROUP[check][digit] }
+      digits = convert_number_to_digits(number)
+      digits.reduce(0){ |check, digit| QUASIGROUP[check][digit] }
     end
     alias_method :checksum, :of
 
@@ -45,7 +45,7 @@ module Sjekksum
     # @example
     #   Sjekksum::Damm.valid?(5724) #=> true
     #
-    # @param  number [Integer] number with included checksum
+    # @param  number [Integer, String] number with included checksum
     #
     # @return [Boolean]
     def valid? number
@@ -60,12 +60,12 @@ module Sjekksum
     # @example
     #   Sjekksum::Damm.convert(572) #=> 5724
     #
-    # @param  number [Integer] number without a checksum
+    # @param  number [Integer, String] number without a checksum
     #
-    # @return [Integer] final number including the checksum
+    # @return [Integer, String] final number including the checksum
     def convert number
       raise_on_type_mismatch number
-      (number * 10) + self.of(number)
+      typed_conversion number
     end
     alias_method :transform, :convert
 

data/lib/sjekksum/luhn.rb

@@ -14,15 +14,15 @@ module Sjekksum
     # @example
     #   Sjekksum::Luhn.of(7992739871) #=> 3
     #
-    # @param  number [Integer] number for which the checksum should be calculated
+    # @param  number [Integer, String] number for which the checksum should be calculated
     #
     # @return [Integer] calculated checksum
     def of number
       raise_on_type_mismatch number
-      digits = number.to_s.chars.map(&:to_i)
+      digits = convert_number_to_digits(number)
       sum    = digits.reverse.map.with_index do |digit, idx|
         idx.even? ? (digit * 2).divmod(10).reduce(&:+) : digit
-      end.reverse.reduce(&:+)
+      end.reduce(&:+)
 
       (10 - sum % 10) % 10
     end
@@ -34,12 +34,13 @@ module Sjekksum
     # @example
     #   Sjekksum::Luhn.valid?(79927398713) #=> true
     #
-    # @param  number [Integer] number with included checksum
+    # @param  number [Integer, String] number with included checksum
     #
     # @return [Boolean]
     def valid? number
       raise_on_type_mismatch number
-      self.of(number.div(10)) == (number % 10)
+      num, check = split_number(number)
+      self.of(num) == check
     end
     alias_method :is_valid?, :valid?
 
@@ -49,12 +50,12 @@ module Sjekksum
     # @example
     #   Sjekksum::Luhn.convert(7992739871) #=> 79927398713
     #
-    # @param  number [Integer] number without a checksum
+    # @param  number [Integer, String] number without a checksum
     #
-    # @return [Integer] final number including the checksum
+    # @return [Integer, String] final number including the checksum
     def convert number
       raise_on_type_mismatch number
-      (number * 10) + self.of(number)
+      typed_conversion number
     end
     alias_method :transform, :convert
 

data/lib/sjekksum/primitive.rb

@@ -0,0 +1,58 @@
+module Sjekksum
+  #
+  # Module for calculation and validation of Primitive checksums
+  #
+  # The primitive checksum is just a reduced digit sum (modulo 9).
+  #
+  module Primitive
+    extend self
+    extend Shared
+
+    #
+    # Calculates Primitive checksum
+    #
+    # @example
+    #   Sjekksum::Primitive.of(232323) #=> 6
+    #
+    # @param  number [Integer, String] number for which the checksum should be calculated
+    #
+    # @return [Integer] calculated checksum
+    def of number
+      raise_on_type_mismatch number
+      convert_to_int(number) % 9
+    end
+    alias_method :checksum, :of
+
+    #
+    # Primitive validation of provided number
+    #
+    # @example
+    #   Sjekksum::Primitive.valid?(232323) #=> true
+    #
+    # @param  number [Integer, String] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      num, check = split_number(number)
+      self.of(num) == check
+    end
+    alias_method :is_valid?, :valid?
+
+    #
+    # Transforms a number by appending the Primitive checksum digit
+    #
+    # @example
+    #   Sjekksum::Primitive.convert(232323) #=> 2323236
+    #
+    # @param  number [Integer, String] number without a checksum
+    #
+    # @return [Integer, String] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      typed_conversion number
+    end
+    alias_method :transform, :convert
+
+  end
+end

data/lib/sjekksum/primitive97.rb

@@ -0,0 +1,58 @@
+module Sjekksum
+  #
+  # Module for calculation and validation of Primitive97 checksums
+  #
+  # This primitive checksum is based on the modulo 97 (calculation of check digits) and modulo 9 (reduction to a single digit).
+  #
+  module Primitive97
+    extend self
+    extend Shared
+
+    #
+    # Calculates Primitive97 checksum
+    #
+    # @example
+    #   Sjekksum::Primitive97.of(23569) #=> 5
+    #
+    # @param  number [Integer, String] number for which the checksum should be calculated
+    #
+    # @return [Integer] calculated checksum
+    def of number
+      raise_on_type_mismatch number
+      (convert_to_int(number) % 97) % 9
+    end
+    alias_method :checksum, :of
+
+    #
+    # Primitive97 validation of provided number
+    #
+    # @example
+    #   Sjekksum::Primitive97.valid?(235695) #=> true
+    #
+    # @param  number [Integer, String] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      num, check = split_number(number)
+      self.of(num) == check
+    end
+    alias_method :is_valid?, :valid?
+
+    #
+    # Transforms a number by appending the Primitive97 checksum digit
+    #
+    # @example
+    #   Sjekksum::Primitive97.convert(23569) #=> 235695
+    #
+    # @param  number [Integer, String] number without a checksum
+    #
+    # @return [Integer, String] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      typed_conversion number
+    end
+    alias_method :transform, :convert
+
+  end
+end

data/lib/sjekksum/shared.rb

@@ -10,7 +10,31 @@ module Sjekksum
     # Checks input type and raises if requirement is not met (currently the value has to be an integer)
     # @param  number [Object]
     def raise_on_type_mismatch number
-      raise ArgumentError unless number.is_a?(Integer)
+      raise ArgumentError unless number.is_a?(Integer) or number.is_a?(String)
+    end
+
+    def convert_number_to_digits number
+      number.to_s.scan(/\d/).map{ |b| b.chr.to_i }
+    end
+
+    def convert_to_int number
+      convert_number_to_digits(number).join.to_i
+    end
+
+    def split_number number
+      if number.is_a?(String)
+        [ number[0..-2], number[-1].to_i ]
+      else
+        number.divmod(10)
+      end
+    end
+
+    def typed_conversion number
+      if number.is_a?(String)
+        number << self.of(number).to_s
+      else
+        convert_to_int(number) * 10 + self.of(number)
+      end
     end
 
   end

data/lib/sjekksum/upc.rb

@@ -0,0 +1,68 @@
+module Sjekksum
+  #
+  # Module for calculation and validation of UPC (Universal Product Code) checksums
+  #
+  # @see http://en.wikipedia.org/wiki/Universal_Product_Code#Check_digits Universal Product Code
+  #
+  # It's like Luhn but multiplies by 3 instead of 2.
+  # Also it must allow validation of numbers with leading zeros.
+  #
+  module UPC
+    extend self
+    extend Shared
+
+    #
+    # Calculates UPC checksum
+    #
+    # @example
+    #   Sjekksum::UPC.of("03600024145") #=> 7
+    #
+    # @param  number [Integer, String] number for which the checksum should be calculated
+    #
+    # @return [Integer] calculated checksum
+    def of number
+      raise_on_type_mismatch number
+      digits = convert_number_to_digits(number)
+      sum    = digits.map.with_index do |digit, idx|
+        idx.even? ? (digit * 3) : digit
+      end.reduce(&:+)
+
+      (10 - sum % 10) % 10
+    end
+    alias_method :checksum, :of
+
+    #
+    # UPC validation of provided number
+    #
+    # @example
+    #   Sjekksum::UPC.valid?("036000241457") #=> true
+    #
+    # @param  number [Integer, String] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      num, check = split_number(number)
+      self.of(num) == check
+    end
+    alias_method :is_valid?, :valid?
+
+    #
+    # Transforms a number by appending the UPC checksum digit
+    #
+    # It will preserve type (Integer/String) and therefore leading zeros.
+    #
+    # @example
+    #   Sjekksum::UPC.convert("03600024145") #=> "036000241457"
+    #
+    # @param  number [Integer, String] number without a checksum
+    #
+    # @return [Integer, String] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      typed_conversion number
+    end
+    alias_method :transform, :convert
+
+  end
+end

data/lib/sjekksum/verhoeff.rb

@@ -43,12 +43,12 @@ module Sjekksum
     # @example
     #   Sjekksum::Verhoeff.of(142857) #=> 0
     #
-    # @param  number [Integer] number for which the checksum should be calculated
+    # @param  number [Integer, String] number for which the checksum should be calculated
     #
     # @return [Integer] calculated checksum
     def of number
       raise_on_type_mismatch number
-      digits = number.to_s.chars.map(&:to_i)
+      digits = convert_number_to_digits(number)
       INVERSE[digits.reverse_each.with_index.reduce(0) { |check, (digit, idx)|
         d_row = DIHEDRAL_GROUP_D5[check]
         d_row[ PERMUTATION[idx.next % 8][digit] ]
@@ -62,12 +62,13 @@ module Sjekksum
     # @example
     #   Sjekksum::Verhoeff.valid?(1428570) #=> true
     #
-    # @param  number [Integer] number with included checksum
+    # @param  number [Integer, String] number with included checksum
     #
     # @return [Boolean]
     def valid? number
       raise_on_type_mismatch number
-      self.of(number.div(10)) == (number % 10)
+      num, check = split_number(number)
+      self.of(num) == check
     end
     alias_method :is_valid?, :valid?
 
@@ -77,12 +78,12 @@ module Sjekksum
     # @example
     #   Sjekksum::Verhoeff.convert(142857) #=> 1428570
     #
-    # @param  number [Integer] number without a checksum
+    # @param  number [Integer, String] number without a checksum
     #
-    # @return [Integer] final number including the checksum
+    # @return [Integer, String] final number including the checksum
     def convert number
       raise_on_type_mismatch number
-      (number * 10) + self.of(number)
+      typed_conversion number
     end
     alias_method :transform, :convert
 

data/lib/sjekksum/version.rb

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

data/lib/sjekksum.rb

@@ -2,7 +2,10 @@ require "sjekksum/version"
 require "sjekksum/shared"
 require "sjekksum/damm"
 require "sjekksum/luhn"
+require "sjekksum/upc"
 require "sjekksum/verhoeff"
+require "sjekksum/primitive"
+require "sjekksum/primitive97"
 
 #
 # Base module with convenient shortcuts
@@ -18,7 +21,7 @@ module Sjekksum
   #
   # @see Sjekksum::Damm#of
   #
-  # @param  number [Integer] number for which the checksum should be calculated
+  # @param  number [Integer, String] number for which the checksum should be calculated
   #
   # @return [Integer] calculated checksum
   def damm_of number
@@ -34,7 +37,7 @@ module Sjekksum
   #
   # @see Sjekksum::Luhn#of
   #
-  # @param  number [Integer] number for which the checksum should be calculated
+  # @param  number [Integer, String] number for which the checksum should be calculated
   #
   # @return [Integer] calculated checksum
   def luhn_of number
@@ -42,6 +45,22 @@ module Sjekksum
   end
   alias_method :luhn, :luhn_of
 
+  #
+  # Calculates UPC checksum
+  #
+  # @example
+  #   Sjekksum.upc("03600024145") #=> 7
+  #
+  # @see Sjekksum::UPC#of
+  #
+  # @param  number [Integer, String] number for which the checksum should be calculated
+  #
+  # @return [Integer] calculated checksum
+  def upc_of number
+    UPC.of number
+  end
+  alias_method :upc, :upc_of
+
   #
   # Calculates Verhoeff checksum
   #
@@ -50,7 +69,7 @@ module Sjekksum
   #
   # @see Sjekksum::Verhoeff#of
   #
-  # @param  number [Integer] number for which the checksum should be calculated
+  # @param  number [Integer, String] number for which the checksum should be calculated
   #
   # @return [Integer] calculated checksum
   def verhoeff_of number
@@ -58,6 +77,38 @@ module Sjekksum
   end
   alias_method :verhoeff, :verhoeff_of
 
+  #
+  # Calculates Primitive checksum
+  #
+  # @example
+  #   Sjekksum.primitive(232323) #=> 6
+  #
+  # @see Sjekksum::Primitive#of
+  #
+  # @param  number [Integer, String] number for which the checksum should be calculated
+  #
+  # @return [Integer] calculated checksum
+  def primitive_of number
+    Primitive.of number
+  end
+  alias_method :primitive, :primitive_of
+
+  #
+  # Calculates Primitive97 checksum
+  #
+  # @example
+  #   Sjekksum.primitive97(232323) #=> 6
+  #
+  # @see Sjekksum::Primitive97#of
+  #
+  # @param  number [Integer, String] number for which the checksum should be calculated
+  #
+  # @return [Integer] calculated checksum
+  def primitive97_of number
+    Primitive97.of number
+  end
+  alias_method :primitive97, :primitive97_of
+
   #
   # Damm validation of provided number
   #
@@ -66,7 +117,7 @@ module Sjekksum
   #
   # @see Sjekksum::Damm#valid?
   #
-  # @param  number [Integer] number with included checksum
+  # @param  number [Integer, String] number with included checksum
   #
   # @return [Boolean]
   def valid_damm? number
@@ -82,7 +133,7 @@ module Sjekksum
   #
   # @see Sjekksum::Luhn#valid?
   #
-  # @param  number [Integer] number with included checksum
+  # @param  number [Integer, String] number with included checksum
   #
   # @return [Boolean]
   def valid_luhn? number
@@ -90,6 +141,22 @@ module Sjekksum
   end
   alias_method :luhn?, :valid_luhn?
 
+  #
+  # UPC validation of provided number
+  #
+  # @example
+  #   Sjekksum.upc?("036000241457") #=> true
+  #
+  # @see Sjekksum::UPC#valid?
+  #
+  # @param  number [Integer, String] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_upc? number
+    UPC.valid? number
+  end
+  alias_method :upc?, :valid_upc?
+
   #
   # Verhoeff validation of provided number
   #
@@ -98,7 +165,7 @@ module Sjekksum
   #
   # @see Sjekksum::Verhoeff#valid?
   #
-  # @param  number [Integer] number with included checksum
+  # @param  number [Integer, String] number with included checksum
   #
   # @return [Boolean]
   def valid_verhoeff? number
@@ -106,6 +173,38 @@ module Sjekksum
   end
   alias_method :verhoeff?, :valid_verhoeff?
 
+  #
+  # Primitive validation of provided number
+  #
+  # @example
+  #   Sjekksum.primitive?(2323236) #=> true
+  #
+  # @see Sjekksum::Primitive#valid?
+  #
+  # @param  number [Integer, String] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_primitive? number
+    Primitive.valid? number
+  end
+  alias_method :primitive?, :valid_primitive?
+
+  #
+  # Primitive97 validation of provided number
+  #
+  # @example
+  #   Sjekksum.primitive97?(2323235) #=> true
+  #
+  # @see Sjekksum::Primitive97#valid?
+  #
+  # @param  number [Integer, String] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_primitive97? number
+    Primitive97.valid? number
+  end
+  alias_method :primitive97?, :valid_primitive97?
+
   #
   # Transforms a number by appending the Damm checksum digit
   #
@@ -114,9 +213,9 @@ module Sjekksum
   #
   # @see Sjekksum::Damm#convert
   #
-  # @param  number [Integer] number without a checksum
+  # @param  number [Integer, String] number without a checksum
   #
-  # @return [Integer] final number including the checksum
+  # @return [Integer, String] final number including the checksum
   def make_damm number
     Damm.convert number
   end
@@ -130,14 +229,30 @@ module Sjekksum
   #
   # @see Sjekksum::Luhn#convert
   #
-  # @param  number [Integer] number without a checksum
+  # @param  number [Integer, String] number without a checksum
   #
-  # @return [Integer] final number including the checksum
+  # @return [Integer, String] final number including the checksum
   def make_luhn number
     Luhn.convert number
   end
   alias_method :luhn!, :make_luhn
 
+  #
+  # Transforms a number by appending the UPC checksum digit
+  #
+  # @example
+  #   Sjekksum.upc!("03600024145") #=> "03600024147"
+  #
+  # @see Sjekksum::UPC#convert
+  #
+  # @param  number [Integer, String] number without a checksum
+  #
+  # @return [Integer, String] final number including the checksum
+  def make_upc number
+    UPC.convert number
+  end
+  alias_method :upc!, :make_upc
+
   #
   # Transforms a number by appending the Verhoeff checksum digit
   #
@@ -146,12 +261,44 @@ module Sjekksum
   #
   # @see Sjekksum::Verhoeff#convert
   #
-  # @param  number [Integer] number without a checksum
+  # @param  number [Integer, String] number without a checksum
   #
-  # @return [Integer] final number including the checksum
+  # @return [Integer, String] final number including the checksum
   def make_verhoeff number
     Verhoeff.convert number
   end
   alias_method :verhoeff!, :make_verhoeff
 
+  #
+  # Transforms a number by appending the Primitive checksum digit
+  #
+  # @example
+  #   Sjekksum.primitive!(232323) #=> 2323236
+  #
+  # @see Sjekksum::Primitive#convert
+  #
+  # @param  number [Integer, String] number without a checksum
+  #
+  # @return [Integer, String] final number including the checksum
+  def make_primitive number
+    Primitive.convert number
+  end
+  alias_method :primitive!, :make_primitive
+
+  #
+  # Transforms a number by appending the Primitive97 checksum digit
+  #
+  # @example
+  #   Sjekksum.primitive97!(232323) #=> 2323235
+  #
+  # @see Sjekksum::Primitive97#convert
+  #
+  # @param  number [Integer, String] number without a checksum
+  #
+  # @return [Integer, String] final number including the checksum
+  def make_primitive97 number
+    Primitive97.convert number
+  end
+  alias_method :primitive97!, :make_primitive97
+
 end

data/spec/shared_implementation.rb

@@ -16,14 +16,14 @@ shared_examples "a checksum implementation:" do |success_spec_matrix, fail_spec_
 
   describe :valid? do
     success_spec_matrix.each do |spec_item|
-      spec_value = spec_item[0] * 10 + spec_item[1]
+      spec_value = transform_spec_value(spec_item[0],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]
+      spec_value = transform_spec_value(spec_item[0],spec_item[1])
       it "does not return true for #{spec_value}" do
         expect(described_class.valid?(spec_value)).to_not be_true
       end
@@ -32,14 +32,14 @@ shared_examples "a checksum implementation:" do |success_spec_matrix, fail_spec_
 
   describe :convert do
     success_spec_matrix.each do |spec_item|
-      spec_value = spec_item[0] * 10 + spec_item[1]
+      spec_value = transform_spec_value(spec_item[0],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]
+      spec_value = transform_spec_value(spec_item[0],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
@@ -47,7 +47,7 @@ shared_examples "a checksum implementation:" do |success_spec_matrix, fail_spec_
   end
 
   context "invalid input" do
-    ["1234", 12.34, true, false, nil, {}, [], Proc.new{}, Class.new, Module.new].each do |invalid_input|
+    [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

data/spec/sjekksum/damm_spec.rb

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

data/spec/sjekksum/luhn_spec.rb

@@ -4,18 +4,22 @@ require "shared_implementation"
 describe Sjekksum::Luhn do
 
   success_spec_matrix = [
-    [ 1,          8 ],
-    [ 20,         8 ],
-    [ 300,        4 ],
-    [ 4000,       6 ],
-    [ 55555,      7 ],
-    [ 424242,     6 ],
-    [ 7992739871, 3 ],
+    [ 1,               8 ],
+    [ 20,              8 ],
+    [ 300,             4 ],
+    [ 4000,            6 ],
+    [ 55555,           7 ],
+    [ 424242,          6 ],
+    [ 7992739871,      3 ],
+    [ "7992739871",    3 ],
+    [ "799.273-98 71", 3 ]
   ]
 
   fail_spec_matrix = [
-    [ 1,          1 ],
-    [ 7992739871, 9 ]
+    [ 1,               1 ],
+    [ 7992739871,      9 ],
+    [ "7992739871",    9 ],
+    [ "799.273-98 71", 9 ]
   ]
 
   it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix

data/spec/sjekksum/primitive97_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::Primitive97 do
+
+  success_spec_matrix = [
+    [ 1,          1 ],
+    [ 20,         2 ],
+    [ 300,        0 ],
+    [ 4000,       5 ],
+    [ 55555,      8 ],
+    [ 424242,     7 ],
+    [ 23569,      5 ],
+    [ "23569",    5 ],
+    [ "23.5-69",  5 ]
+  ]
+
+  fail_spec_matrix = [
+    [ 1,          7 ],
+    [ 23569,      9 ],
+    [ "23569",    9 ],
+    [ "23.5-69",  9 ]
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum/primitive_spec.rb

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

data/spec/sjekksum/upc_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::UPC do
+
+  success_spec_matrix = [
+    [ 1,                7 ],
+    [ 20,               4 ],
+    [ 300,              1 ],
+    [ 4000,             8 ],
+    [ 55555,            5 ],
+    [ 424242,           8 ],
+    [ 3600024145,       3 ],
+    [ "03600024145",    7 ],
+    [ "036 000-241.45", 7 ]
+  ]
+
+  fail_spec_matrix = [
+    [ 1,                1 ],
+    [ 3600024145,       7 ],
+    [ "03600024145",    9 ],
+    [ "036 000-241.45", 9 ]
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum/verhoeff_spec.rb

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

data/spec/sjekksum_spec.rb

@@ -3,10 +3,13 @@ require "spec_helper"
 describe Sjekksum do
 
   spec_values = {
-    input: 12345,
-    damm: 9,
-    luhn: 5,
-    verhoeff: 1
+    input:       12345,
+    damm:        9,
+    luhn:        5,
+    upc:         7,
+    verhoeff:    1,
+    primitive:   6,
+    primitive97: 8
   }
 
   specify { expect(described_class).to be_a(Module) }
@@ -41,6 +44,21 @@ describe Sjekksum do
     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])
@@ -56,4 +74,34 @@ describe Sjekksum do
     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
+
+  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 "#primitive97?" do
+    value = spec_values[:input] * 10 + spec_values[:primitive97]
+    expect(described_class.primitive97?(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)
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,6 +1,16 @@
 # coding: utf-8
 require "sjekksum"
 
+module SjekksumRSpecHelpers
+  def transform_spec_value origin_value, check_digit
+    if origin_value.is_a?(String)
+      "#{origin_value}#{check_digit}"
+    else
+      origin_value * 10 + check_digit
+    end
+  end
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
@@ -8,4 +18,6 @@ RSpec.configure do |config|
   config.mock_with :rspec do |c|
     c.syntax = :expect
   end
+  config.include SjekksumRSpecHelpers
+  config.extend  SjekksumRSpecHelpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sjekksum
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Christoph Grabo
@@ -111,13 +111,19 @@ files:
 - lib/sjekksum.rb
 - lib/sjekksum/damm.rb
 - lib/sjekksum/luhn.rb
+- lib/sjekksum/primitive.rb
+- lib/sjekksum/primitive97.rb
 - lib/sjekksum/shared.rb
+- lib/sjekksum/upc.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/primitive97_spec.rb
+- spec/sjekksum/primitive_spec.rb
+- spec/sjekksum/upc_spec.rb
 - spec/sjekksum/verhoeff_spec.rb
 - spec/sjekksum_spec.rb
 - spec/spec_helper.rb
@@ -149,6 +155,9 @@ test_files:
 - spec/shared_implementation.rb
 - spec/sjekksum/damm_spec.rb
 - spec/sjekksum/luhn_spec.rb
+- spec/sjekksum/primitive97_spec.rb
+- spec/sjekksum/primitive_spec.rb
+- spec/sjekksum/upc_spec.rb
 - spec/sjekksum/verhoeff_spec.rb
 - spec/sjekksum_spec.rb
 - spec/spec_helper.rb