bookland 2.0.0 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f62422a2d6bb33379862e355d5fc372afc75aea1
+  data.tar.gz: 47be6f9d863d31e9ce5edc605fac48338e09e88a
+SHA512:
+  metadata.gz: 401687a31df67958367e50699e0a574f26f0370eb4c5edf684828446492261f9101aac55d4f0d9c22cd5f85f985534cc075d63cbbfc89c9074c6a189621c9680
+  data.tar.gz: 2e53af118ccd411f724a17fc74548cdfa0df3898a03c10ccedf2068de0680097fb6ba16e1a22e35ed0e44586ccf0c62dadea787edec2b26aede85987cd3143ee

data/.travis.yml

@@ -1,7 +1,5 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
+  - 2.0.0
   - 1.9.3
-  - jruby
-  - rbx
-  - ree
+  - jruby-19mode
+  - rbx-19mode

data/README.md

@@ -1,14 +1,11 @@
 # Bookland
 
-[![travis] [1]] [2]
-
-[Bookland] [3] provides ISBN and EAN classes in Ruby.
+[Bookland][bo] provides ISBN and ASIN classes, which should come in handy when trading books online.
 
 ## Installation
 
-```ruby
-# Gemfile
-gem 'bookland', '~> 2.0.0.beta'
+```bash
+gem install bookland
 ```
 
 ## Usage
@@ -16,19 +13,9 @@ gem 'bookland', '~> 2.0.0.beta'
 ```ruby
 include 'bookland'
 
-isbn = ISBN.new "9780262011532"
-isbn.valid? # => true
-isbn10 = isbn.to_isbn_10
-isbn10.to_s # => "0262011530"
-```
-
-Or use utility methods on the class level:
-
-```ruby
-EAN.valid?  '0814916013890' # => true
-ISBN.valid? '0814916013890' # => false
+ISBN.valid?('9780262011532') # => true
+ASIN.from_isbn('9780262011532') # => "0262011530"
+ASIN.to_isbn('0262011530') # => "9780262011532"
 ```
 
-[1]: https://secure.travis-ci.org/hakanensari/bookland.png
-[2]: http://travis-ci.org/hakanensari/bookland
-[3]: http://en.wikipedia.org/wiki/Bookland
+[bo]: http://en.wikipedia.org/wiki/Bookland

data/bookland.gemspec

@@ -1,21 +1,24 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bookland/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'bookland'
-  s.version     = Bookland::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Hakan Ensari']
-  s.email       = 'hakan.ensari@papercavalier.com'
-  s.homepage    = 'https://github.com/hakanensari/bookland'
-  s.summary     = %q{EAN and ISBN classes}
-  s.description = %q{Bookland provides EAN and ISBN classes.}
+Gem::Specification.new do |spec|
+  spec.name        = 'bookland'
+  spec.version     = Bookland::VERSION
+  spec.authors     = ['Hakan Ensari']
+  spec.email       = 'hakan.ensari@papercavalier.com'
+  spec.description = %q{An ISBN toolkit}
+  spec.summary     = %q{An ISBN toolkit}
+  spec.homepage    = 'https://github.com/hakanensari/bookland'
+  spec.license     = 'MIT'
 
-  s.add_development_dependency 'rake', '~> 0.9.2'
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.0'
 end

data/lib/bookland.rb

@@ -1,6 +1,4 @@
 require 'bookland/identifier'
-require 'bookland/invalid_isbn'
-
 require 'bookland/ean'
 require 'bookland/isbn'
-require 'bookland/isbn_10'
+require 'bookland/asin'

data/lib/bookland/asin.rb

@@ -0,0 +1,40 @@
+module Bookland
+  class ASIN < Identifier
+    WEIGHTS = 10.downto(2).to_a.freeze
+
+    def self.calculate_checksum_digit(digits)
+      sum = digits.map(&:to_i).zip(WEIGHTS).reduce(0) { |a , (i, j)| a + i * j }
+
+      case checksum_digit = 11 - sum % 11
+      when 0..9 then checksum_digit.to_s
+      when 10 then 'X'
+      when 11 then '0'
+      end
+    end
+
+    def self.from_isbn(isbn)
+      data_digits = isbn.split('')[3..11]
+      checksum_digit = ASIN.calculate_checksum_digit(data_digits)
+
+      (data_digits << checksum_digit).join
+    end
+
+    def self.to_isbn(asin)
+      return if asin[0] == 'B'
+
+      data_digits = %w(9 7 8) + asin.split('')[0, 9]
+      checksum_digit = ISBN.calculate_checksum_digit(data_digits)
+
+      (data_digits << checksum_digit).join
+    end
+
+    def valid?
+      case digits.first
+      when 'B'
+        digits.size == 10
+      else
+        digits.size == 10 && super
+      end
+    end
+  end
+end

data/lib/bookland/ean.rb

@@ -1,17 +1,14 @@
 module Bookland
-  # An International Article Number.
   class EAN < Identifier
-    # Calculates the checksum for the 12-digit payload of an EAN.
-    def self.calculate_checksum(payload)
-      payload.map! &:to_i
-      weights = [1, 3] * 6
-      sum = payload.zip(weights).inject(0) { |a, (i, j)| a + i * j }
+    WEIGHTS = ([1, 3] * 6).freeze
 
+    def self.calculate_checksum_digit(digits)
+      sum = digits.map(&:to_i).zip(WEIGHTS).reduce(0) { |a, (i, j)| a + i * j }
       ((10 - sum % 10) % 10).to_s
     end
 
     def valid?
-      @raw.size == 13 && super
+      digits.size == 13 && super
     end
   end
 end

data/lib/bookland/identifier.rb

@@ -1,32 +1,33 @@
 module Bookland
-  # An abstract unique commercial identifier for a product.
   class Identifier
-    def self.calculate_checksum(payload)
-      raise NotImplementedError
-    end
-
     def self.valid?(raw)
       new(raw).valid?
     end
 
-    def initialize(raw)
-      @raw = raw
+    def self.calculate_checksum_digit(data_digits)
+      raise NotImplementedError
     end
 
-    def checksum
-      digits[-1]
+    attr :digits
+
+    def initialize(raw)
+      @digits = raw.split('')
     end
 
-    def payload
+    def data_digits
       digits[0...-1]
     end
 
+    def checksum_digit
+      digits[-1]
+    end
+
     def to_s
-      @raw
+      digits.join
     end
 
     def valid?
-      checksum == self.class.calculate_checksum(payload)
+      checksum_digit == recalculate_checksum_digit
     end
 
     def ==(other)
@@ -35,8 +36,8 @@ module Bookland
 
     private
 
-    def digits
-      @digits ||= @raw.split ''
+    def recalculate_checksum_digit
+      self.class.calculate_checksum_digit(data_digits)
     end
   end
 end

data/lib/bookland/isbn.rb

@@ -1,24 +1,9 @@
 module Bookland
-  # An EAN that identifies a book.
   class ISBN < EAN
-    # Converts the given ISBN to an ISBN-10.
-    def self.to_isbn_10(raw)
-      new(raw).to_isbn_10
-    end
-
-    # Converts the ISBN to an ISBN-10.
-    def to_isbn_10
-      raise InvalidISBN unless valid?
-
-      new_payload = payload[3..11]
-      new_checksum = ISBN10.calculate_checksum new_payload
-
-      (new_payload << new_checksum).join
-    end
+    PREFIXES = [%w(9 7 8), %w(9 7 9)]
 
-    # Whether the ISBN is valid.
     def valid?
-      !!@raw.match(/^97[89]/) && super
+      PREFIXES.include?(digits[0, 3]) && super
     end
   end
 end

data/lib/bookland/version.rb

@@ -1,3 +1,3 @@
 module Bookland
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/test/asin_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class TestASIN < MiniTest::Test
+  def test_validates_isbn_like_asins
+    File.open('./test/data/isbns').each do |line|
+      asin = line.split.first.chomp
+      assert ASIN.valid?(asin)
+    end
+  end
+
+  def test_validates_proprietary_asins
+    ASIN.valid?('B000J8VLEC')
+  end
+
+  def test_does_not_validate_if_not_10_digits
+    refute ASIN.valid?('014310582')
+    refute ASIN.valid?('01431058255')
+  end
+
+  def test_does_not_validate_if_checksum_not_correct
+    refute ASIN.valid?('0143105820')
+  end
+
+  def test_converts_to_isbn
+    assert_equal '9780143105824', ASIN.to_isbn('0143105825')
+  end
+
+  def test_does_not_convert_proprietary_asins
+    assert_nil ASIN.to_isbn('B000J8VLEC')
+  end
+
+  def test_converts_to_asin
+    assert_equal '0143105825', ASIN.from_isbn('9780143105824')
+  end
+end

data/test/ean_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class TestEAN < MiniTest::Test
+  def test_validates
+    assert EAN.valid?('0814916013890')
+  end
+
+  def test_does_not_validate_if_not_13_digits
+    refute EAN.valid?('978082647694')
+  end
+
+  def test_does_not_validate_if_checksum_incorrect
+    refute EAN.valid?('9780826476940')
+  end
+end

data/test/identifier_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class TestIdentifier < MiniTest::Test
+  def setup
+    @id = Identifier.new('123')
+  end
+
+  def test_data_digits
+    assert_equal %w(1 2), @id.data_digits
+  end
+
+  def test_checksum_digit
+    assert_equal '3', @id.checksum_digit
+  end
+
+  def test_to_string
+    assert_equal '123', @id.to_s
+  end
+
+  def test_comparison
+    assert_equal Identifier.new('1'), Identifier.new('1')
+    refute_equal Identifier.new('1'), Identifier.new('2')
+  end
+
+  def test_validation_not_implemented
+    assert_raises(NotImplementedError) { Identifier.valid?('123') }
+    assert_raises(NotImplementedError) { @id.valid? }
+  end
+end

data/test/isbn_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TestISBN < MiniTest::Test
+  def test_validates
+    File.open('./test/data/isbns').each do |line|
+      isbn = line.split.last.chomp
+      assert ISBN.valid?(isbn)
+    end
+  end
+
+  def test_does_not_validate_an_ean_that_is_not_a_book
+    refute ISBN.valid?('0814916013890')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'bookland'
+include Bookland

metadata

@@ -1,28 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: bookland
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70194822851880 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '5.0'
   type: :development
   prerelease: false
-  version_requirements: *70194822851880
-description: Bookland provides EAN and ISBN classes.
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: An ISBN toolkit
 email: hakan.ensari@papercavalier.com
 executables: []
 extensions: []
@@ -36,38 +66,46 @@ files:
 - Rakefile
 - bookland.gemspec
 - lib/bookland.rb
+- lib/bookland/asin.rb
 - lib/bookland/ean.rb
 - lib/bookland/identifier.rb
-- lib/bookland/invalid_isbn.rb
 - lib/bookland/isbn.rb
-- lib/bookland/isbn_10.rb
 - lib/bookland/version.rb
-- test/bookland_test.rb
-- test/isbns
+- test/asin_test.rb
+- test/data/isbns
+- test/ean_test.rb
+- test/identifier_test.rb
+- test/isbn_test.rb
+- test/test_helper.rb
 homepage: https://github.com/hakanensari/bookland
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
-summary: EAN and ISBN classes
+specification_version: 4
+summary: An ISBN toolkit
 test_files:
-- test/bookland_test.rb
-- test/isbns
+- test/asin_test.rb
+- test/data/isbns
+- test/ean_test.rb
+- test/identifier_test.rb
+- test/isbn_test.rb
+- test/test_helper.rb
+has_rdoc: 

data/lib/bookland/invalid_isbn.rb

@@ -1,4 +0,0 @@
-module Bookland
-  class InvalidISBN < StandardError
-  end
-end

data/lib/bookland/isbn_10.rb

@@ -1,37 +0,0 @@
-module Bookland
-  # The now-obsolete 10-digit ISBN.
-  class ISBN10 < Identifier
-    # Calculates the checksum for the 9-digit payload of an ISBN-10.
-    def self.calculate_checksum(payload)
-      payload.map! &:to_i
-      weights = 10.downto(2).to_a
-      sum = payload.zip(weights).inject(0) { |a , (i, j)| a + i * j }
-      checksum = 11 - sum % 11
-
-      case checksum
-      when 0..9 then checksum.to_s
-      when 10 then 'X'
-      when 11 then '0'
-      end
-    end
-
-    # Converts the given ISBN-10 to an ISBN.
-    def self.to_isbn(raw)
-      new(raw).to_isbn
-    end
-
-    # Converts the ISBN-10 to an ISBN.
-    def to_isbn
-      raise InvalidISBN unless valid?
-
-      new_payload = [9, 7, 8] +  payload
-      new_checksum = ISBN.calculate_checksum new_payload
-
-      (new_payload << new_checksum).join
-    end
-
-    def valid?
-      @raw.size == 10 && super
-    end
-  end
-end

data/test/bookland_test.rb

@@ -1,101 +0,0 @@
-$:.push File.expand_path('../../lib', __FILE__)
-
-require 'test/unit'
-require 'bookland'
-
-include Bookland
-
-module Test::Unit::Assertions
-  def assert_false(object, message = '')
-    assert_equal false, object, message
-  end
-end
-
-class TestIdentifier < Test::Unit::TestCase
-  def setup
-    @id = Identifier.new '123'
-  end
-
-  def test_checksum
-    assert_equal '3', @id.checksum
-  end
-
-  def test_payload
-    assert_equal ['1', '2'], @id.payload
-  end
-
-  def test_comparison
-    assert Identifier.new('1') == Identifier.new('1')
-    assert Identifier.new('1') != Identifier.new('2')
-  end
-end
-
-class TestEAN < Test::Unit::TestCase
-  def test_validates_an_ean
-    assert EAN.valid? '0814916013890'
-  end
-
-  def test_does_not_validate_if_not_13_digits
-    assert_false EAN.valid?('978082647694')
-    assert_false EAN.valid?('97808264769444')
-  end
-
-  def test_does_not_validate_if_checksum_not_correct
-    assert_false EAN.valid?('9780826476940')
-  end
-end
-
-class TestISBN < Test::Unit::TestCase
-  def test_validates_isbns
-    File.open(File.expand_path('../isbns', __FILE__)).each do |line|
-      isbn = line.split.last.chomp
-      assert ISBN.valid? isbn
-    end
-  end
-
-  def test_does_not_validate_an_ean_that_is_not_a_book
-    assert_false ISBN.valid?('0814916013890')
-  end
-
-  def test_converts_to_isbn_10
-    isbn = ISBN.new '9780143105824'
-    assert_equal '0143105825', isbn.to_isbn_10
-  end
-
-  def test_raises_error_when_converting_invalid_isbn
-    isbn = ISBN.new '9780143105820'
-    assert_raise InvalidISBN do
-      isbn.to_isbn_10
-    end
-  end
-end
-
-class TestISBN10 < Test::Unit::TestCase
-  def test_validates_isbn_10s
-    File.open(File.expand_path('../isbns', __FILE__)).each do |line|
-      isbn10 = line.split.first.chomp
-      assert ISBN10.valid? isbn10
-    end
-  end
-
-  def test_converts_to_isbn
-    isbn10 = ISBN10.new '0143105825'
-    assert_equal '9780143105824', isbn10.to_isbn
-  end
-
-  def test_raises_error_when_converting_invalid_isbn10
-    isbn10 = ISBN10.new '0143105820'
-    assert_raise InvalidISBN do
-      isbn10.to_isbn
-    end
-  end
-
-  def test_does_not_validate_if_not_13_digits
-    assert_false EAN.valid?('014310582')
-    assert_false EAN.valid?('01431058255')
-  end
-
-  def test_does_not_validate_if_checksum_not_correct
-    assert_false EAN.valid?('0143105820')
-  end
-end