bookland 1.0.2 → 2.0.0.beta

data/.travis.yml

@@ -4,5 +4,4 @@ rvm:
   - 1.9.3
   - jruby
   - rbx
-  - rbx-2.0
   - ree

data/Gemfile

@@ -1,5 +1,2 @@
 source 'http://rubygems.org'
-
 gemspec
-
-gem 'rake'

data/LICENSE

@@ -1,28 +1,22 @@
-Copyright (c) 2008, Keiichirou SHIKANO <k16.shikano@gmail.com>
-All rights reserved.
+(The MIT License)
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
+Copyright (c) 2012 Hakan Ensari
 
-   * Redistributions of source code must retain the above copyright
-     notice,this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-     copyright notice, this list of conditions and the following
-     disclaimer in the documentation and/or other materials provided
-     with the distribution.
-   * Neither the name of the Keiichirou SHIKANO nor the names of its
-     contributors may be used to endorse or promote products derived
-     from this software without specific prior written permission.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
-OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,28 +1,34 @@
 # Bookland
 
-[Bookland] [1] provides an ISBN class in Ruby.
+[![travis] [1]] [2]
 
-[![travis](https://secure.travis-ci.org/hakanensari/bookland.png)](http://travis-ci.org/hakanensari/bookland)
+[Bookland] [3] provides ISBN and EAN classes in Ruby.
 
-## Usage
+## Installation
 
-    require "bookland"
+```ruby
+# Gemfile
+gem 'bookland', '~> 2.0.0.beta'
+```
 
-    isbn = ISBN.new("0262011530")
-    isbn.to_isbn13
-    => "9780262011532"
-    isbn.valid?
-    => true
+## Usage
 
-Bookland provides certain utility methods defined on the class level:
+```ruby
+include 'bookland'
 
-    ISBN.to_13("0262011530")
-    => "9780262011532"
+isbn = ISBN.new "9780262011532"
+isbn.valid? # => true
+isbn10 = isbn.to_isbn_10
+isbn10.to_s # => "0262011530"
+```
 
-    ISBN.to_10("9780262011532")
-    => "0262011530"
+Alternatively, use utility methods defined on the class level:
 
-    ISBN.valid?("9780262011532")
-    => true
+```ruby
+EAN.valid?  '0814916013890' # => true
+ISBN.valid? '0814916013890' # => false
+```
 
-[1]: http://en.wikipedia.org/wiki/Bookland
+[1]: https://secure.travis-ci.org/hakanensari/bookland.png
+[2]: http://travis-ci.org/hakanensari/bookland
+[3]: http://en.wikipedia.org/wiki/Bookland

data/Rakefile

@@ -1,11 +1,9 @@
-require 'bundler'
-require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-Bundler::GemHelper.install_tasks
-
-desc 'Run all specs in spec directory'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+Rake::TestTask.new do |test|
+  test.libs += %w{lib test}
+  test.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :spec
+task :default => :test

data/bookland.gemspec

@@ -7,17 +7,15 @@ Gem::Specification.new do |s|
   s.version     = Bookland::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Hakan Ensari']
-  s.email       = 'code@papercavalier.com'
+  s.email       = 'hakan.ensari@papercavalier.com'
   s.homepage    = 'https://github.com/hakanensari/bookland'
-  s.summary     = %q{An ISBN class}
-  s.description = %q{Bookland provides an ISBN class.}
+  s.summary     = %q{EAN and ISBN classes}
+  s.description = %q{Bookland provides EAN and ISBN classes.}
 
-  s.rubyforge_project = 'bookland'
+  s.add_development_dependency 'rake', '~> 0.9.2'
 
   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']
-
-  s.add_development_dependency('rspec', '~> 2.6')
 end

data/lib/bookland.rb

@@ -1,5 +1,6 @@
-require 'bookland/isbn'
+require 'bookland/identifier'
+require 'bookland/invalid_isbn'
 
-# Include Bookland in global namespace.
-#
-Object.send(:include, Bookland)
+require 'bookland/ean'
+require 'bookland/isbn'
+require 'bookland/isbn_10'

data/lib/bookland/ean.rb

@@ -0,0 +1,17 @@
+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 }
+
+      ((10 - sum % 10) % 10).to_s
+    end
+
+    def valid?
+      @raw.size == 13 && super
+    end
+  end
+end

data/lib/bookland/identifier.rb

@@ -0,0 +1,42 @@
+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
+    end
+
+    def checksum
+      digits[-1]
+    end
+
+    def payload
+      digits[0...-1]
+    end
+
+    def to_s
+      @raw
+    end
+
+    def valid?
+      checksum == self.class.calculate_checksum(payload)
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    private
+
+    def digits
+      @digits ||= @raw.split ''
+    end
+  end
+end

data/lib/bookland/invalid_isbn.rb

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

data/lib/bookland/isbn.rb

@@ -1,139 +1,24 @@
-# [Bookland][bl] is an ISBN class in Ruby.
-#
-# [bl]: http://en.wikipedia.org/wiki/Bookland
 module Bookland
-  class ISBN
-    class << self
-      # Converts specified string to a 10-digit ISBN and returns its
-      # string representation.
-      def to_10(isbn)
-        new(isbn).to_isbn10.to_s
-      end
-
-      # Converts specified string to a 13-digit ISBN and returns its
-      # string representation.
-      def to_13(isbn)
-        new(isbn).to_isbn13.to_s
-      end
-
-      # Returns `true` if the specified string is a valid ISBN.
-      def valid?(isbn)
-        new(isbn).valid?
-      end
-    end
-
-    # Instantiates a new ISBN object.
-    #
-    # Takes an optional string. The string should look like an ISBN and
-    # may contain extra characters that are traditionally used to
-    # format ISBNs.
-    #
-    # The following are valid instantiations for the same ISBN:
-    #
-    #     isbn13 = ISBN.new('9780826476951')
-    #     isbn10 = ISBN.new('0-8264-7695-3')
-    #
-    def initialize(seed = nil)
-      self.seed = seed
-    end
-
-    # Returns +true+ if the ISBN is equal to another specified ISBN.
-    def ==(other)
-      to_isbn13.to_s == other.to_isbn13.to_s
-    end
-
-    # Inspecting an ISBN object will return its string representation.
-    def inspect
-      to_s
-    end
-
-    # Sets the seed of the ISBN based on a specified string.
-    def seed=(seed)
-      @raw = seed.gsub(/[^\dx]/i, '').split('') rescue []
+  # 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
 
-    # Casts the ISBN to a 10-digit ISBN.
-    def to_isbn10
-      raise ISBNError unless valid?
-
-      if isbn13?
-        raw = @raw[3..11]
-        ISBN.new((raw << check_digit_10(raw)).to_s)
-      else
-        dup
-      end
-    end
-
-    def to_isbn13
-      raise ISBNError unless valid?
-
-      if isbn10?
-        raw = @raw[0..8].unshift('9', '7', '8')
-        ISBN.new((raw << check_digit_13(raw)).to_s)
-      else
-        dup
-      end
-    end
+    # Converts the ISBN to an ISBN-10.
+    def to_isbn_10
+      raise InvalidISBN unless valid?
 
-    # Returns a string representation of the ISBN.
-    #
-    # Takes an optional list of integers, which it then uses to dashify
-    # the ISBN like so:
-    #
-    #     isbn = ISBN.new('0826476953')
-    #     isbn.to_s(1,4,4,1)
-    #     => "0-8264-7695-3"
-    #
-    def to_s(*blocks)
-      return nil unless valid?
+      new_payload = payload[3..11]
+      new_checksum = ISBN10.calculate_checksum new_payload
 
-      raw = @raw.dup
-      if blocks.any?
-        (blocks.map { |i| raw.shift(i).join } << raw.join).delete_if(&:empty?).join('-')
-      else
-        raw.join
-      end
+      (new_payload << new_checksum).join
     end
 
-    # Returns +true+ if the ISBN is valid.
+    # Whether the ISBN is valid.
     def valid?
-      if isbn10?
-        @raw[9] == check_digit_10(@raw)
-      elsif isbn13?
-        @raw[12] == check_digit_13(@raw)
-      else
-        false
-      end
-    end
-
-    private
-
-    def check_digit_10(raw)
-      cd = 11 - 10.downto(2).to_a.zip(raw[0..8].map(&:to_i)).map { |n,m| n * m }.inject(0) { |i,j| i + j } % 11
-
-      case cd
-      when 0..9 then cd.to_s
-      when 10 then 'X'
-      when 11 then '0'
-      end
-    end
-
-    def check_digit_13(raw)
-      ((10 - ([1, 3] * 6).zip(raw[0..11].map(&:to_i)).map { |n,m| n * m }.inject(0) { |i,j| i + j } % 10) % 10).to_s
-    end
-
-    def isbn10?
-      @raw.length == 10
-    end
-
-    def isbn13?
-      @raw.length == 13
-    end
-  end
-
-  class ISBNError < StandardError
-    def initialize(msg='Invalid ISBN')
-      super
+      @raw.match(/^97[89]/) && super
     end
   end
 end

data/lib/bookland/isbn_10.rb

@@ -0,0 +1,37 @@
+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/lib/bookland/version.rb

@@ -1,3 +1,3 @@
 module Bookland
-  VERSION = '1.0.2'
+  VERSION = '2.0.0.beta'
 end

data/test/bookland_test.rb

@@ -0,0 +1,95 @@
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'test/unit'
+require 'bookland'
+
+include Bookland
+
+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 !EAN.valid?('978082647694')
+    assert !EAN.valid?('97808264769444')
+  end
+
+  def test_does_not_validate_if_checksum_not_correct
+    assert !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 !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 !EAN.valid?('014310582')
+    assert !EAN.valid?('01431058255')
+  end
+
+  def test_does_not_validate_if_checksum_not_correct
+    assert !EAN.valid?('0143105820')
+  end
+end