module Sjekksum::Primitive

Module for calculation and validation of Primitive checksums

The primitive checksum is just a reduced digit sum (modulo 9).

Public Instance Methods

checksum(number)
Alias for: of
convert(number) click to toggle source

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

# File lib/sjekksum/primitive.rb, line 51
def convert number
  raise_on_type_mismatch number
  typed_conversion number
end
Also aliased as: transform
is_valid?(number)
Alias for: valid?
of(number) click to toggle source

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

# File lib/sjekksum/primitive.rb, line 20
def of number
  raise_on_type_mismatch number
  convert_to_int(number) % 9
end
Also aliased as: checksum
transform(number)
Alias for: convert
valid?(number) click to toggle source

Primitive validation of provided number

@example

Sjekksum::Primitive.valid?(232323) #=> true

@param number [Integer, String] number with included checksum

@return [Boolean]

# File lib/sjekksum/primitive.rb, line 35
def valid? number
  raise_on_type_mismatch number
  num, check = split_number(number)
  self.of(num) == check
end
Also aliased as: is_valid?