bookland 3.0.0 → 3.1.0

checksums.yaml

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

data/README.md

@@ -1,21 +1,51 @@
 # Bookland
 
-[Bookland][bo] provides ISBN and ASIN classes, which should come in handy when trading books online.
-
-## Installation
-
-```bash
-gem install bookland
-```
+> [Bookland][bo] is a fictitious country that exists solely for the purposes of non-geographically cataloguing books in the otherwise geographically keyed EAN coding system.
 
 ## Usage
 
+**Bookland** provides EAN and ISBN classes:
+
 ```ruby
 include 'bookland'
 
+# functional
 ISBN.valid?('9780262011532') # => true
-ASIN.from_isbn('9780262011532') # => "0262011530"
-ASIN.to_isbn('0262011530') # => "9780262011532"
+
+# oo
+isbn = ISBN.new('9780262011532')
+isbn.valid? # => true
 ```
 
+**Bookland** also comes with an :poop: ASIN class:
+
+```ruby
+isbn = '9780262011532'
+asin = ASIN.from_isbn(isbn) # => "0262011530"
+ASIN.to_isbn(asin) # => "9780262011532"
+```
+
+Caveat: `ASIN` does not calculate the checksum digit for propietary ASINs. If you happen to break their code, ping me.
+
+All three classes expose a class-level `calculate_checksum_digit` method:
+
+```ruby
+data_digits = [9, 7, 8, 0, 2, 6, 2, 1, 1, 5, 3]
+ISBN.calculate_checksum_digit(data_digits) # => 2
+```
+
+Rails-heads: **Bookland** will include custom EAN, ISBN, and ASIN validators if Active Model is loaded. Use it like so:
+
+```ruby
+class Book
+  include ActiveModel::Model
+
+  attr_accessor :isbn
+
+  validates :isbn, isbn: true
+end
+```
+
+:metal:
+
 [bo]: http://en.wikipedia.org/wiki/Bookland

data/bookland.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version     = Bookland::VERSION
   spec.authors     = ['Hakan Ensari']
   spec.email       = 'hakan.ensari@papercavalier.com'
-  spec.description = %q{An ISBN toolkit}
+  spec.description = %q{Provides EAN, ISBN, and ASIN classes and validators in Ruby}
   spec.summary     = %q{An ISBN toolkit}
   spec.homepage    = 'https://github.com/hakanensari/bookland'
   spec.license     = 'MIT'

data/lib/bookland.rb

@@ -2,3 +2,4 @@ require 'bookland/identifier'
 require 'bookland/ean'
 require 'bookland/isbn'
 require 'bookland/asin'
+require 'bookland/validators' if defined?(ActiveModel)

data/lib/bookland/identifier.rb

@@ -1,7 +1,7 @@
 module Bookland
   class Identifier
     def self.valid?(raw)
-      new(raw).valid?
+      new(raw.to_s).valid?
     end
 
     def self.calculate_checksum_digit(data_digits)

data/lib/bookland/validators.rb

@@ -0,0 +1,29 @@
+class AsinValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.nil? && options[:allow_nil]
+
+    unless Bookland::ASIN.valid?(value)
+      record.errors[attribute] << (options[:message] || 'is not an ASIN')
+    end
+  end
+end
+
+class EanValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.nil? && options[:allow_nil]
+
+    unless Bookland::EAN.valid?(value.to_s)
+      record.errors[attribute] << (options[:message] || 'is not an EAN')
+    end
+  end
+end
+
+class IsbnValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.nil? && options[:allow_nil]
+
+    unless Bookland::ISBN.valid?(value)
+      record.errors[attribute] << (options[:message] || 'is not an ISBN')
+    end
+  end
+end

data/lib/bookland/version.rb

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

data/test/identifier_test.rb

@@ -26,4 +26,8 @@ class TestIdentifier < MiniTest::Test
     assert_raises(NotImplementedError) { Identifier.valid?('123') }
     assert_raises(NotImplementedError) { @id.valid? }
   end
+
+  def test_validator_casts_input_to_string
+    assert_raises(NotImplementedError) { Identifier.valid?(nil) }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookland
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
-description: An ISBN toolkit
+description: Provides EAN, ISBN, and ASIN classes and validators in Ruby
 email: hakan.ensari@papercavalier.com
 executables: []
 extensions: []
@@ -70,6 +70,7 @@ files:
 - lib/bookland/ean.rb
 - lib/bookland/identifier.rb
 - lib/bookland/isbn.rb
+- lib/bookland/validators.rb
 - lib/bookland/version.rb
 - test/asin_test.rb
 - test/data/isbns
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: An ISBN toolkit
@@ -108,4 +109,3 @@ test_files:
 - test/identifier_test.rb
 - test/isbn_test.rb
 - test/test_helper.rb
-has_rdoc: