sjekksum 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 138a821d406efac0c481425e7de8956af20f390d
-  data.tar.gz: 6655ede5c5a4c17a69ea6a166d46632128327c90
+  metadata.gz: e6d1ff16d06db67ad288e906d6550e945c1550e4
+  data.tar.gz: daf3d1554d22f668c7f61af87a86feb00f8e0c39
 SHA512:
-  metadata.gz: 057656143728ce66d976633e71c73da8e4392cc7672eedcebc4c83499a905805260b15b35ed5603447db53432662a1b14990d86f93a5215a2561e0fc30451bb7
-  data.tar.gz: a2b2c5962a35890d0a203bd845fc3cf7270a3a5e9002416d1e00725750faecba6dcff2416183abba9a9058f5d6c7edc0e51a3432897b102336693e6d48a67a47
+  metadata.gz: f20e2ba3177709dd77cc43fd92b541f889b2fc192bbe9fdba0eae82492c7dac8c3f5f90fa34231efb865f0c675f68f607feef574708f8566ef5cde3b2126c721
+  data.tar.gz: 5b13d80284d30c3afdb52161f2f90f5c532e4823bd5cfde53e51646f1be57a5b33561954c39fce7357957fa51fbc8b88c252d9b2a08b9bbc5da59e27e25d7ae9

data/lib/sjekksum/damm.rb

@@ -1,8 +1,15 @@
 module Sjekksum
+  #
+  # Module for calculation and validation of Damm checksums
+  #
+  # @see http://en.wikipedia.org/wiki/Damm_algorithm Damm algorithm
+  #
   module Damm
     extend self
     extend Shared
 
+    # 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],
@@ -16,21 +23,51 @@ module Sjekksum
       [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)
+    #
+    # Calculates Damm checksum
+    #
+    # @example
+    #   Sjekksum::Damm.of(572) #=> 4
+    #
+    # @param  number [Integer] 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] }
     end
+    alias_method :checksum, :of
 
-    def valid? input_value
-      raise_on_type_mismatch input_value
-      self.of(input_value).zero?
+    #
+    # Damm validation of provided number
+    #
+    # @example
+    #   Sjekksum::Damm.valid?(5724) #=> true
+    #
+    # @param  number [Integer] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      self.of(number).zero?
     end
+    alias_method :is_valid?, :valid?
 
-    def convert input_value
-      raise_on_type_mismatch input_value
-      (input_value * 10) + self.of(input_value)
+    #
+    # Transforms a number by appending the Damm checksum digit
+    #
+    # @example
+    #   Sjekksum::Damm.convert(572) #=> 5724
+    #
+    # @param  number [Integer] number without a checksum
+    #
+    # @return [Integer] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      (number * 10) + self.of(number)
     end
+    alias_method :transform, :convert
 
   end
 end

data/lib/sjekksum/luhn.rb

@@ -1,26 +1,62 @@
 module Sjekksum
+  #
+  # Module for calculation and validation of Luhn checksums
+  #
+  # @see http://en.wikipedia.org/wiki/Luhn_algorithm Luhn algorithm
+  #
   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)
+    #
+    # Calculates Luhn checksum
+    #
+    # @example
+    #   Sjekksum::Luhn.of(7992739871) #=> 3
+    #
+    # @param  number [Integer] 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)
       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
+    alias_method :checksum, :of
 
-    def valid? input_value
-      raise_on_type_mismatch input_value
-      self.of(input_value.div(10)) == (input_value % 10)
+    #
+    # Luhn validation of provided number
+    #
+    # @example
+    #   Sjekksum::Luhn.valid?(79927398713) #=> true
+    #
+    # @param  number [Integer] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      self.of(number.div(10)) == (number % 10)
     end
+    alias_method :is_valid?, :valid?
 
-    def convert input_value
-      raise_on_type_mismatch input_value
-      (input_value * 10) + self.of(input_value)
+    #
+    # Transforms a number by appending the Luhn checksum digit
+    #
+    # @example
+    #   Sjekksum::Luhn.convert(7992739871) #=> 79927398713
+    #
+    # @param  number [Integer] number without a checksum
+    #
+    # @return [Integer] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      (number * 10) + self.of(number)
     end
+    alias_method :transform, :convert
+
   end
 end

data/lib/sjekksum/shared.rb

@@ -1,10 +1,16 @@
 module Sjekksum
+  #
+  # Shared helper methods
+  #
   module Shared
 
   private
 
-    def raise_on_type_mismatch input_value
-      raise ArgumentError unless input_value.is_a?(Integer)
+    #
+    # 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)
     end
 
   end

data/lib/sjekksum/verhoeff.rb

@@ -1,8 +1,14 @@
 module Sjekksum
+  #
+  # Module for calculation and validation of Verhoeff checksums
+  #
+  # @see http://en.wikipedia.org/wiki/Verhoeff_algorithm Verhoeff algorithm
+  #
   module Verhoeff
     extend self
     extend Shared
 
+    # Table of multiplication in the dihedral group D5
     DIHEDRAL_GROUP_D5 = [
       [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
       [ 1, 2, 3, 4, 0, 6, 7, 8, 9, 5 ],
@@ -16,6 +22,7 @@ module Sjekksum
       [ 9, 8, 7, 6, 5, 4, 3, 2, 1, 0 ]
     ].freeze
 
+    # The permutation table
     PERMUTATION = [
       [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
       [ 1, 5, 7, 6, 2, 8, 3, 0, 9, 4 ],
@@ -27,25 +34,57 @@ module Sjekksum
       [ 7, 0, 4, 6, 9, 1, 3, 2, 5, 8 ]
     ].freeze
 
+    # The multiplicative inverse of a digit in the dihedral group D5
     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)
+    #
+    # Calculates Verhoeff checksum
+    #
+    # @example
+    #   Sjekksum::Verhoeff.of(142857) #=> 0
+    #
+    # @param  number [Integer] 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)
       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
+    alias_method :checksum, :of
 
-    def valid? input_value
-      raise_on_type_mismatch input_value
-      self.of(input_value.div(10)) == (input_value % 10)
+    #
+    # Verhoeff validation of provided number
+    #
+    # @example
+    #   Sjekksum::Verhoeff.valid?(1428570) #=> true
+    #
+    # @param  number [Integer] number with included checksum
+    #
+    # @return [Boolean]
+    def valid? number
+      raise_on_type_mismatch number
+      self.of(number.div(10)) == (number % 10)
     end
+    alias_method :is_valid?, :valid?
 
-    def convert input_value
-      raise_on_type_mismatch input_value
-      (input_value * 10) + self.of(input_value)
+    #
+    # Transforms a number by appending the Verhoeff checksum digit
+    #
+    # @example
+    #   Sjekksum::Verhoeff.convert(142857) #=> 1428570
+    #
+    # @param  number [Integer] number without a checksum
+    #
+    # @return [Integer] final number including the checksum
+    def convert number
+      raise_on_type_mismatch number
+      (number * 10) + self.of(number)
     end
+    alias_method :transform, :convert
+
   end
 end

data/lib/sjekksum/version.rb

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

data/lib/sjekksum.rb

@@ -1,55 +1,156 @@
 require "sjekksum/version"
-
 require "sjekksum/shared"
 require "sjekksum/damm"
 require "sjekksum/luhn"
 require "sjekksum/verhoeff"
 
+#
+# Base module with convenient shortcuts
+#
 module Sjekksum
   extend self
 
-  def damm_of input_value
-    Damm.of input_value
+  #
+  # Calculates Damm checksum
+  #
+  # @example
+  #   Sjekksum.damm(572) #=> 4
+  #
+  # @see Sjekksum::Damm#of
+  #
+  # @param  number [Integer] number for which the checksum should be calculated
+  #
+  # @return [Integer] calculated checksum
+  def damm_of number
+    Damm.of number
   end
   alias_method :damm, :damm_of
 
-  def luhn_of input_value
-    Luhn.of input_value
+  #
+  # Calculates Luhn checksum
+  #
+  # @example
+  #   Sjekksum.luhn(7992739871) #=> 3
+  #
+  # @see Sjekksum::Luhn#of
+  #
+  # @param  number [Integer] number for which the checksum should be calculated
+  #
+  # @return [Integer] calculated checksum
+  def luhn_of number
+    Luhn.of number
   end
   alias_method :luhn, :luhn_of
 
-  def verhoeff_of input_value
-    Verhoeff.of input_value
+  #
+  # Calculates Verhoeff checksum
+  #
+  # @example
+  #   Sjekksum.verhoeff(142857) #=> 0
+  #
+  # @see Sjekksum::Verhoeff#of
+  #
+  # @param  number [Integer] number for which the checksum should be calculated
+  #
+  # @return [Integer] calculated checksum
+  def verhoeff_of number
+    Verhoeff.of number
   end
   alias_method :verhoeff, :verhoeff_of
 
-  def valid_damm? input_value
-    Damm.valid? input_value
+  #
+  # Damm validation of provided number
+  #
+  # @example
+  #   Sjekksum.damm?(5724) #=> true
+  #
+  # @see Sjekksum::Damm#valid?
+  #
+  # @param  number [Integer] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_damm? number
+    Damm.valid? number
   end
   alias_method :damm?, :valid_damm?
 
-  def valid_luhn? input_value
-    Luhn.valid? input_value
+  #
+  # Luhn validation of provided number
+  #
+  # @example
+  #   Sjekksum.luhn?(79927398713) #=> true
+  #
+  # @see Sjekksum::Luhn#valid?
+  #
+  # @param  number [Integer] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_luhn? number
+    Luhn.valid? number
   end
   alias_method :luhn?, :valid_luhn?
 
-  def valid_verhoeff? input_value
-    Verhoeff.valid? input_value
+  #
+  # Verhoeff validation of provided number
+  #
+  # @example
+  #   Sjekksum.verhoeff?(1428570) #=> true
+  #
+  # @see Sjekksum::Verhoeff#valid?
+  #
+  # @param  number [Integer] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_verhoeff? number
+    Verhoeff.valid? number
   end
   alias_method :verhoeff?, :valid_verhoeff?
 
-  def make_damm input_value
-    Damm.convert input_value
+  #
+  # Transforms a number by appending the Damm checksum digit
+  #
+  # @example
+  #   Sjekksum.damm!(572) #=> 5724
+  #
+  # @see Sjekksum::Damm#convert
+  #
+  # @param  number [Integer] number without a checksum
+  #
+  # @return [Integer] final number including the checksum
+  def make_damm number
+    Damm.convert number
   end
   alias_method :damm!, :make_damm
 
-  def make_luhn input_value
-    Luhn.convert input_value
+  #
+  # Transforms a number by appending the Luhn checksum digit
+  #
+  # @example
+  #   Sjekksum.luhn!(7992739871) #=> 79927398713
+  #
+  # @see Sjekksum::Luhn#convert
+  #
+  # @param  number [Integer] number without a checksum
+  #
+  # @return [Integer] final number including the checksum
+  def make_luhn number
+    Luhn.convert number
   end
   alias_method :luhn!, :make_luhn
 
-  def make_verhoeff input_value
-    Verhoeff.convert input_value
+  #
+  # Transforms a number by appending the Verhoeff checksum digit
+  #
+  # @example
+  #   Sjekksum.verhoeff!(142857) #=> 1428570
+  #
+  # @see Sjekksum::Verhoeff#convert
+  #
+  # @param  number [Integer] number without a checksum
+  #
+  # @return [Integer] final number including the checksum
+  def make_verhoeff number
+    Verhoeff.convert number
   end
   alias_method :verhoeff!, :make_verhoeff
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sjekksum
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Christoph Grabo