module Sjekksum
Base module with convenient shortcuts
Constants
- VERSION
Version constant
Public Instance Methods
Calculates Damm
checksum
@example
Sjekksum.damm(572) #=> 4
@see Sjekksum::Damm#of
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer] calculated checksum
# File lib/sjekksum.rb, line 29 def damm_of number Damm.of number end
Calculates ISBN-10 checksum
@example
Sjekksum.isbn10("147743025") #=> 3 Sjekksum.isbn10("193435600") #=> "X"
@see Sjekksum::ISBN10#of
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer, String] calculated checksum
# File lib/sjekksum.rb, line 46 def isbn10_of number ISBN10.of number end
Calculates ISBN-13 checksum
@example
Sjekksum.isbn13("978-0-306-40615-") #=> 7
@see Sjekksum::ISBN13#of
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer, String] calculated checksum
# File lib/sjekksum.rb, line 62 def isbn13_of number ISBN13.of number end
Calculates Luhn
checksum
@example
Sjekksum.luhn(7992739871) #=> 3
@see Sjekksum::Luhn#of
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer] calculated checksum
# File lib/sjekksum.rb, line 78 def luhn_of number Luhn.of number end
Transforms a number by appending the Damm
checksum digit
@example
Sjekksum.damm!(572) #=> 5724
@param number [Integer, String] number without a checksum
@return [Integer, String] final number including the checksum
# File lib/sjekksum.rb, line 287 def make_damm number Damm.convert number end
Transforms a number by appending the ISBN-10 checksum digit
@example
Sjekksum.isbn10!("147743025") #=> "1477430253" Sjekksum.isbn10!("193435600") #=> "193435600X"
@param number [Integer, String] number without a checksum
@return [Integer, String] final number including the checksum
# File lib/sjekksum.rb, line 304 def make_isbn10 number ISBN10.convert number end
Transforms a number by appending the ISBN-13 checksum digit
@example
Sjekksum.isbn13("978-0-306-40615-") #=> "978-0-306-40615-7"
@param number [Integer, String] number without a checksum
@return [Integer, String] final number including the checksum
# File lib/sjekksum.rb, line 320 def make_isbn13 number ISBN13.convert number end
Transforms a number by appending the Luhn
checksum digit
@example
Sjekksum.luhn!(7992739871) #=> 79927398713
@param number [Integer, String] number without a checksum
@return [Integer, String] final number including the checksum
# File lib/sjekksum.rb, line 336 def make_luhn number Luhn.convert number end
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
# File lib/sjekksum.rb, line 384 def make_primitive number Primitive.convert number end
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
# File lib/sjekksum.rb, line 400 def make_primitive97 number Primitive97.convert number end
Transforms a number by appending the UPC
checksum digit
@example
Sjekksum.upc!("03600024145") #=> "03600024147"
@param number [Integer, String] number without a checksum
@return [Integer, String] final number including the checksum
# File lib/sjekksum.rb, line 352 def make_upc number UPC.convert number end
Transforms a number by appending the Verhoeff
checksum digit
@example
Sjekksum.verhoeff!(142857) #=> 1428570
@see Sjekksum::Verhoeff#convert
@param number [Integer, String] number without a checksum
@return [Integer, String] final number including the checksum
# File lib/sjekksum.rb, line 368 def make_verhoeff number Verhoeff.convert number end
Calculates Primitive97
checksum
@example
Sjekksum.primitive97(232323) #=> 6
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer] calculated checksum
# File lib/sjekksum.rb, line 142 def primitive97_of number Primitive97.of number end
Calculates Primitive
checksum
@example
Sjekksum.primitive(232323) #=> 6
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer] calculated checksum
# File lib/sjekksum.rb, line 126 def primitive_of number Primitive.of number end
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
# File lib/sjekksum.rb, line 94 def upc_of number UPC.of number end
Damm
validation of provided number
@example
Sjekksum.damm?(5724) #=> true
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 158 def valid_damm? number Damm.valid? number end
ISBN-10 validation of provided number
@example
Sjekksum.isbn10?("1477430253") #=> true Sjekksum.isbn10?("193435600X") #=> true
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 175 def valid_isbn10? number ISBN10.valid? number end
ISBN-13 validation of provided number
@example
Sjekksum.isbn13?("978-0-306-40615-7") #=> true
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 191 def valid_isbn13? number ISBN13.valid? number end
Luhn
validation of provided number
@example
Sjekksum.luhn?(79927398713) #=> true
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 207 def valid_luhn? number Luhn.valid? number end
Primitive97
validation of provided number
@example
Sjekksum.primitive97?(2323235) #=> true
@see Sjekksum::Primitive97#valid?
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 271 def valid_primitive97? number Primitive97.valid? number end
Primitive
validation of provided number
@example
Sjekksum.primitive?(2323236) #=> true
@see Sjekksum::Primitive#valid?
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 255 def valid_primitive? number Primitive.valid? number end
UPC
validation of provided number
@example
Sjekksum.upc?("036000241457") #=> true
@see Sjekksum::UPC#valid?
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 223 def valid_upc? number UPC.valid? number end
Verhoeff
validation of provided number
@example
Sjekksum.verhoeff?(1428570) #=> true
@see Sjekksum::Verhoeff#valid?
@param number [Integer, String] number with included checksum
@return [Boolean]
# File lib/sjekksum.rb, line 239 def valid_verhoeff? number Verhoeff.valid? number end
Calculates Verhoeff
checksum
@example
Sjekksum.verhoeff(142857) #=> 0
@param number [Integer, String] number for which the checksum should be calculated
@return [Integer] calculated checksum
# File lib/sjekksum.rb, line 110 def verhoeff_of number Verhoeff.of number end