sjekksum 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5766c405550125325430eb38e4ce6f8600721311
-  data.tar.gz: a8e2cc7a1cd0f8f89eb9214335fc3a7e35a93108
+  metadata.gz: 3e68d799e7f1e30802bc9f64ea41f0274328be23
+  data.tar.gz: 4b873a7bea6e7ab8a0f12f0d883c6aa344e675fc
 SHA512:
-  metadata.gz: 8db7a683ca0a17d7ea7962e4210cab4dc0bad173f492b7fe44797f72f110882fdcd5295c0eb21d37612955507dd4d3eb588b491a00ed72774916211961a40f39
-  data.tar.gz: adc09f1148201ca7755cea7b81a42085181d9fe476481523fe5b2c9126bd9044d9c1902eed36287e9be0e10a8e398c3ff8d0acdeadae9b60a303453385a68060
+  metadata.gz: ba1ada821381e10cf13b37a15fdf985a04ec1326ca62919391e98fd9382085f230c448a39cceffac61207043423566f884aceb7ea4fc99ef5eaf4ae64c3e87a5
+  data.tar.gz: 76b890f5e049a5c892a252a77c6480c101029fb37b4c9c9dc54d5ba1ec0b667dd8aacb80535260dc02f04e0a7fa80030cfeed7fcc99dce83ebfbee57cef3c126

data/README.md

@@ -50,33 +50,37 @@ gem install sjekksum
 ```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.isbn10("147743025")           #=> 3
+Sjekksum.isbn10!("147743025")          #=> "1477430253"
+Sjekksum.isbn10?("1477430253")         #=> true
 
-Sjekksum.luhn(7992739871)       #=> 3
-Sjekksum.luhn!(7992739871)      #=> 79927398713
-Sjekksum.luhn?(79927398713)     #=> true
+Sjekksum.isbn13("978-0-306-40615-")    #=> 7
+Sjekksum.isbn13!("978-0-306-40615-")   #=> "978-0-306-40615-7"
+Sjekksum.isbn13?("978-0-306-40615-7")  #=> true
 
-Sjekksum.upc("03600024145")     #=> 7
-Sjekksum.upc!("03600024145")    #=> "036000241457"
-Sjekksum.upc?("036000241457")   #=> true
+Sjekksum.luhn(7992739871)              #=> 3
+Sjekksum.luhn!(7992739871)             #=> 79927398713
+Sjekksum.luhn?(79927398713)            #=> true
 
-Sjekksum.verhoeff(142857)       #=> 0
-Sjekksum.verhoeff!(142857)      #=> 1428570
-Sjekksum.verhoeff?(1428570)     #=> true
+Sjekksum.upc("03600024145")            #=> 7
+Sjekksum.upc!("03600024145")           #=> "036000241457"
+Sjekksum.upc?("036000241457")          #=> true
 
-Sjekksum.primitive(232323)      #=> 6
-Sjekksum.primitive!(232323)     #=> 2323236
-Sjekksum.primitive?(2323236)    #=> true
+Sjekksum.verhoeff(142857)              #=> 0
+Sjekksum.verhoeff!(142857)             #=> 1428570
+Sjekksum.verhoeff?(1428570)            #=> true
 
-Sjekksum.primitive97(23569)     #=> 5
-Sjekksum.primitive97!(23569)    #=> 235695
-Sjekksum.primitive97?(235695)   #=> true
+Sjekksum.primitive(232323)             #=> 6
+Sjekksum.primitive!(232323)            #=> 2323236
+Sjekksum.primitive?(2323236)           #=> true
+
+Sjekksum.primitive97(23569)            #=> 5
+Sjekksum.primitive97!(23569)           #=> 235695
+Sjekksum.primitive97?(235695)          #=> true
 ```
 
 

data/lib/sjekksum/isbn10.rb

@@ -1,6 +1,6 @@
 module Sjekksum
   #
-  # Module for calculation and validation of ISBN 10 (International Standard Book Number) checksums
+  # 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
   #
@@ -9,7 +9,7 @@ module Sjekksum
     extend Shared
 
     #
-    # Calculates ISBN 10 checksum
+    # Calculates ISBN-10 checksum
     #
     # @example
     #   Sjekksum::ISBN10.of("147743025") #=> 3
@@ -21,16 +21,18 @@ module Sjekksum
     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
+    # ISBN-10 validation of provided number
     #
     # @example
     #   Sjekksum::ISBN10.valid?("1477430253") #=> true
@@ -47,7 +49,7 @@ module Sjekksum
     alias_method :is_valid?, :valid?
 
     #
-    # Transforms a number by appending the ISBN 10 checksum digit
+    # Transforms a number by appending the ISBN-10 checksum digit
     #
     # @example
     #   Sjekksum::ISBN10.convert("147743025") #=> "1477430253"

data/lib/sjekksum/isbn13.rb

@@ -0,0 +1,68 @@
+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-13_check_digit_calculation ISBN-13 check digit calculation
+  #
+  # Its check digit is generated the same way as the {Sjekksum::UPC} except that the even digits are multiplied by 3 instead of the odd digits.
+  #
+  module ISBN13
+    extend self
+    extend Shared
+
+    #
+    # Calculates ISBN13 checksum
+    #
+    # @example
+    #   Sjekksum::ISBN13.of("978-0-306-40615-") #=> 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.odd? ? (digit * 3) : digit
+      end.reduce(&:+)
+
+      (10 - sum % 10) % 10
+    end
+    alias_method :checksum, :of
+
+    #
+    # ISBN13 validation of provided number
+    #
+    # @example
+    #   Sjekksum::ISBN13.valid?("978-0-306-40615-7") #=> 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 ISBN13 checksum digit
+    #
+    # It will preserve type (Integer/String) and therefore leading zeros.
+    #
+    # @example
+    #   Sjekksum::ISBN13.convert("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
+    def convert number
+      raise_on_type_mismatch number
+      typed_conversion number
+    end
+    alias_method :transform, :convert
+
+  end
+end

data/lib/sjekksum/luhn.rb

@@ -20,6 +20,7 @@ module Sjekksum
     def of number
       raise_on_type_mismatch number
       digits = convert_number_to_digits(number)
+
       sum    = digits.reverse.map.with_index do |digit, idx|
         idx.even? ? (digit * 2).divmod(10).reduce(&:+) : digit
       end.reduce(&:+)

data/lib/sjekksum/upc.rb

@@ -23,6 +23,7 @@ module Sjekksum
     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(&:+)

data/lib/sjekksum/verhoeff.rb

@@ -49,6 +49,7 @@ module Sjekksum
     def of number
       raise_on_type_mismatch number
       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] ]

data/lib/sjekksum/version.rb

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

data/lib/sjekksum.rb

@@ -2,6 +2,7 @@ require "sjekksum/version"
 require "sjekksum/shared"
 require "sjekksum/damm"
 require "sjekksum/isbn10"
+require "sjekksum/isbn13"
 require "sjekksum/luhn"
 require "sjekksum/upc"
 require "sjekksum/verhoeff"
@@ -31,13 +32,13 @@ module Sjekksum
   alias_method :damm, :damm_of
 
   #
-  # Calculates ISBN 10 checksum
+  # Calculates ISBN-10 checksum
   #
   # @example
-  #   Sjekksum::ISBN10.of("147743025") #=> 3
-  #   Sjekksum::ISBN10.of("193435600") #=> "X"
+  #   Sjekksum.isbn10("147743025") #=> 3
+  #   Sjekksum.isbn10("193435600") #=> "X"
   #
-  # @see Sjekksum::Damm#of
+  # @see Sjekksum::ISBN10#of
   #
   # @param  number [Integer, String] number for which the checksum should be calculated
   #
@@ -47,6 +48,22 @@ module Sjekksum
   end
   alias_method :isbn10, :isbn10_of
 
+  #
+  # 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
+  def isbn13_of number
+    ISBN13.of number
+  end
+  alias_method :isbn13, :isbn13_of
+
   #
   # Calculates Luhn checksum
   #
@@ -144,11 +161,11 @@ module Sjekksum
   alias_method :damm?, :valid_damm?
 
   #
-  # ISBN 10 validation of provided number
+  # ISBN-10 validation of provided number
   #
   # @example
-  #   Sjekksum::ISBN10.valid?("1477430253") #=> true
-  #   Sjekksum::ISBN10.valid?("193435600X") #=> true
+  #   Sjekksum.isbn10?("1477430253") #=> true
+  #   Sjekksum.isbn10?("193435600X") #=> true
   #
   # @see Sjekksum::ISBN10#valid?
   #
@@ -160,6 +177,22 @@ module Sjekksum
   end
   alias_method :isbn10?, :valid_isbn10?
 
+  #
+  # ISBN-13 validation of provided number
+  #
+  # @example
+  #   Sjekksum.isbn13?("978-0-306-40615-7") #=> true
+  #
+  # @see Sjekksum::ISBN13#valid?
+  #
+  # @param  number [Integer, String] number with included checksum
+  #
+  # @return [Boolean]
+  def valid_isbn13? number
+    ISBN13.valid? number
+  end
+  alias_method :isbn13?, :valid_isbn13?
+
   #
   # Luhn validation of provided number
   #
@@ -257,11 +290,11 @@ module Sjekksum
   alias_method :damm!, :make_damm
 
   #
-  # Transforms a number by appending the ISBN 10 checksum digit
+  # Transforms a number by appending the ISBN-10 checksum digit
   #
   # @example
-  #   Sjekksum::ISBN10.convert("147743025") #=> "1477430253"
-  #   Sjekksum::ISBN10.convert("193435600") #=> "193435600X"
+  #   Sjekksum.isbn10!("147743025") #=> "1477430253"
+  #   Sjekksum.isbn10!("193435600") #=> "193435600X"
   #
   # @see Sjekksum::ISBN10#convert
   #
@@ -273,6 +306,22 @@ module Sjekksum
   end
   alias_method :isbn10!, :make_isbn10
 
+  #
+  # Transforms a number by appending the ISBN-13 checksum digit
+  #
+  # @example
+  #   Sjekksum.isbn13("978-0-306-40615-") #=> "978-0-306-40615-7"
+  #
+  # @see Sjekksum::ISBN13#convert
+  #
+  # @param  number [Integer, String] number without a checksum
+  #
+  # @return [Integer, String] final number including the checksum
+  def make_isbn13 number
+    ISBN13.convert number
+  end
+  alias_method :isbn13!, :make_isbn13
+
   #
   # Transforms a number by appending the Luhn checksum digit
   #

data/spec/sjekksum/isbn10_spec.rb

@@ -12,14 +12,14 @@ describe Sjekksum::ISBN10 do
     [ 388221591,       7 ],
     [ "359617218",     7 ],
     [ "147743025",     3 ],
-    [ "0-306-40615-",  2 ],
+    [ "0-306-40615-",  2 ]
   ]
 
   fail_spec_matrix = [
     [ 123,             9 ],
     [ "123",           9 ],
     [ "147743025",     9 ],
-    [ "0-306-40615-",  9 ],
+    [ "0-306-40615-",  9 ]
   ]
 
   it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix

data/spec/sjekksum/isbn13_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "shared_implementation"
+
+describe Sjekksum::ISBN13 do
+
+  success_spec_matrix = [
+    [ "978-363941830", 9 ],
+    [ "978-193435600", 5 ],
+    [ 978364222974,    9 ],
+    [ "978345330684",  4 ],
+    [ "978-388221068", 2 ],
+    [ 978388221591,    5 ],
+    [ "978-359617218", 4 ],
+    [ "978-147743025", 5 ],
+    [ "978-030640615", 7 ]
+  ]
+
+  fail_spec_matrix = [
+    [ 123,             9 ],
+    [ "123",           9 ],
+    [ "978-147743025", 9 ],
+    [ "978-030640615", 9 ]
+  ]
+
+  it_behaves_like "a checksum implementation:", success_spec_matrix, fail_spec_matrix
+
+end

data/spec/sjekksum_spec.rb

@@ -7,6 +7,7 @@ describe Sjekksum do
   spec_values = {
     damm:        9,
     isbn10:      "X",
+    isbn13:      3,
     luhn:        5,
     upc:         3,
     verhoeff:    4,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sjekksum
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Christoph Grabo
@@ -111,6 +111,7 @@ files:
 - lib/sjekksum.rb
 - lib/sjekksum/damm.rb
 - lib/sjekksum/isbn10.rb
+- lib/sjekksum/isbn13.rb
 - lib/sjekksum/luhn.rb
 - lib/sjekksum/primitive.rb
 - lib/sjekksum/primitive97.rb
@@ -122,6 +123,7 @@ files:
 - spec/shared_implementation.rb
 - spec/sjekksum/damm_spec.rb
 - spec/sjekksum/isbn10_spec.rb
+- spec/sjekksum/isbn13_spec.rb
 - spec/sjekksum/luhn_spec.rb
 - spec/sjekksum/primitive97_spec.rb
 - spec/sjekksum/primitive_spec.rb
@@ -157,6 +159,7 @@ test_files:
 - spec/shared_implementation.rb
 - spec/sjekksum/damm_spec.rb
 - spec/sjekksum/isbn10_spec.rb
+- spec/sjekksum/isbn13_spec.rb
 - spec/sjekksum/luhn_spec.rb
 - spec/sjekksum/primitive97_spec.rb
 - spec/sjekksum/primitive_spec.rb