lisbn 0.1.0

data/lib/lisbn.rb

@@ -0,0 +1,3 @@
+require 'nori'
+require "lisbn/cache_method"
+require "lisbn/lisbn"

data/lib/lisbn/cache_method.rb

@@ -0,0 +1,15 @@
+class Lisbn < String
+  module CacheMethod
+    def cache_method(*methods)
+      methods.map(&:to_s).each do |method|
+        alias_method method + "_without_cache", method
+        define_method method do |*args, &blk|
+          @cache ||= {}
+          @cache[[method, self]] ||= send(method + "_without_cache", *args, &blk)
+        end
+      end
+    end
+  end
+
+  extend CacheMethod
+end

data/lib/lisbn/lisbn.rb

@@ -0,0 +1,135 @@
+class Lisbn < String
+  # Returns a normalized ISBN form
+  def isbn
+    upcase.gsub(/[^0-9X]/, '')
+  end
+
+  # Returns true if the ISBN is valid, false otherwise.
+  def valid?
+    case isbn.length
+      when 10
+        valid_isbn_10?
+      when 13
+        valid_isbn_13?
+      else
+        false
+    end
+  end
+
+  # Returns a valid ISBN in ISBN-10 format.
+  # Returns nil if the ISBN is invalid or incapable of conversion to ISBN-10.
+  def isbn10
+    return unless valid?
+    return isbn if isbn.length == 10
+    return unless isbn[0..2] == "978"
+
+    isbn[3..-2] + isbn_10_checksum
+  end
+
+  # Returns a valid ISBN in ISBN-13 format.
+  # Returns nil if the ISBN is invalid.
+  def isbn13
+    return unless valid?
+    return isbn if isbn.length == 13
+
+    '978' + isbn[0..-2] + isbn_13_checksum
+  end
+
+  # Returns an Array with the 'parts' of the ISBN-13 in left-to-right order.
+  # The parts of an ISBN are as follows:
+  #   - GS1 prefix
+  #   - Group identifier
+  #   - Prefix/publisher code
+  #   - Item number
+  #   - Check digit
+  #
+  # Returns nil if the ISBN is not valid.
+  # Returns nil if the group and prefix cannot be identified.
+  def parts
+    return unless isbn13
+
+    group = prefix = nil
+
+    RANGES.each_pair do |g, prefixes|
+      next unless isbn13.match("^#{g}")
+      group = g
+
+      pre_loc = group.length
+      prefixes.each do |p|
+        number = isbn13.slice(pre_loc, p[:length]).to_i
+        next unless p[:range].include?(number)
+
+        prefix = p.merge(:number => number)
+        break
+      end
+
+      break
+    end
+
+    # In the unlikely event we can't categorize it...
+    return unless group && prefix
+
+    prefix = sprintf("%0#{prefix[:length]}d", prefix[:number])
+    [group[0..2], group[3..-1], prefix, isbn13[(group.length + prefix.length)..-2], isbn13[-1..-1]]
+  end
+
+  cache_method :isbn, :valid?, :isbn10, :isbn13, :parts
+
+private
+
+  def isbn_10_checksum
+    base = isbn.length == 13 ? isbn[3..-2] : isbn[0..-2]
+
+    products = base.each_char.each_with_index.map do |chr, i|
+      chr.to_i * (10 - i)
+    end
+
+    remainder = products.inject(0) {|m, v| m + v} % 11
+    case remainder
+      when 0
+        0
+      when 1
+        'X'
+      else
+        11 - remainder
+    end.to_s
+  end
+
+  def isbn_13_checksum
+    base = (isbn.length == 13 ? '' : '978') + isbn[0..-2]
+
+    products = base.each_char.each_with_index.map do |chr, i|
+      chr.to_i * (i % 2 == 0 ? 1 : 3)
+    end
+
+    remainder = products.inject(0) {|m, v| m + v} % 10
+    (remainder == 0 ? 0 : 10 - remainder).to_s
+  end
+
+  def valid_isbn_10?
+    return false unless isbn.match(/^[0-9]{9}[0-9X]$/)
+    isbn[-1..-1] == isbn_10_checksum
+  end
+
+  def valid_isbn_13?
+    return false unless isbn.match(/^[0-9]{13}$/)
+    isbn[-1..-1] == isbn_13_checksum
+  end
+
+  def self.ranges
+    rngs = Nori.parse(File.read(File.dirname(__FILE__) + '/../../data/RangeMessage.xml'))
+    Array(rngs["ISBNRangeMessage"]["RegistrationGroups"]["Group"]).flatten.inject({}) do |memo, group|
+      prefix = group["Prefix"].gsub(/-/, '')
+      ranges = Array(group["Rules"]["Rule"]).flatten.map do |rule|
+        length = rule["Length"].to_i
+        next unless length > 0
+
+        {:range => Range.new(*rule["Range"].split("-").map {|r| r[0..(length - 1)].to_i }), :length => length}
+      end.compact
+
+      memo.update(prefix => ranges)
+    end
+  end
+
+  RANGES = ranges
+end

data/lisbn.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mike Ragalie"]
+  gem.email         = ["michael.ragalie@verbasoftware.com"]
+  gem.description   = %q{ISBN manipulation helpers}
+  gem.summary       = %q{Provides methods for converting between ISBN-10 and ISBN-13,
+                         checking validity and splitting ISBNs into groups and prefixes}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "lisbn"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+
+  gem.add_dependency "nori"
+  gem.add_development_dependency "rspec"
+end

data/spec/cache_method_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class String
+  extend Lisbn::CacheMethod
+
+  def with_excitement!
+    self + "!"
+  end
+
+  cache_method :with_excitement!
+end
+
+describe "cache_method" do
+  subject { String.new("awesomeness") }
+
+  it "evaluates the method the first time but not subsequent times" do
+    subject.should_receive(:+).with("!").once.and_return("you got stubbed!")
+    subject.with_excitement!
+    subject.with_excitement!.should == "you got stubbed!"
+  end
+
+  it "reevaluates the method if the object's hash changes" do
+    subject.with_excitement!.should == "awesomeness!"
+    subject.replace("more awesomeness")
+    subject.with_excitement!.should == "more awesomeness!"
+  end
+end

data/spec/lisbn_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe "Lisbn" do
+  describe "#isbn" do
+    it "converts the string to just digits and X" do
+      isbn = Lisbn.new("9487-028asdfasdf878X7")
+      isbn.isbn.should == "9487028878X7"
+    end
+  end
+
+  describe "#valid?" do
+    it "recognizes a valid ISBN10" do
+      isbn = Lisbn.new("0123456789")
+      isbn.valid?.should be_true
+    end
+
+    it "recognizes a valid ISBN10 with X checksum" do
+      isbn = Lisbn.new("160459411X")
+      isbn.valid?.should be_true
+    end
+
+    it "recognizes a valid ISBN10 with 0 checksum" do
+      isbn = Lisbn.new("0679405070")
+      isbn.valid?.should be_true
+    end
+
+    it "recognizes an invalid ISBN10" do
+      isbn = Lisbn.new("0123546789")
+      isbn.valid?.should be_false
+    end
+
+    it "recognizes a valid ISBN13" do
+      isbn = Lisbn.new("9780000000002")
+      isbn.valid?.should be_true
+    end
+
+    it "recognizes a valid ISBN13 with 0 checksum" do
+      isbn = Lisbn.new("9780062870780")
+      isbn.valid?.should be_true
+    end
+
+    it "recognizes an invalid ISBN13" do
+      isbn = Lisbn.new("9780000000003")
+      isbn.valid?.should be_false
+    end
+
+    it "returns false for improperly-formatted ISBNs" do
+      isbn = Lisbn.new("97800000X0002")
+      isbn.valid?.should be_false
+    end
+
+    it "regards anything not 10 or 13 digits as invalid" do
+      isbn = Lisbn.new("")
+      isbn.valid?.should be_false
+    end
+  end
+
+  describe "#isbn10" do
+    subject { Lisbn.new("9780000000002") }
+
+    it "returns nil if invalid" do
+      subject.stub(:valid? => false)
+      subject.isbn10.should be_nil
+    end
+
+    it "returns nil if the ISBN is 13-digits and isn't in the 978 GS1" do
+      lisbn = Lisbn.new("9790000000003")
+      lisbn.stub(:valid? => true)
+      lisbn.isbn10.should be_nil
+    end
+
+    it "computes the ISBN10 checksum" do
+      subject.isbn10.should == "0000000000"
+    end
+
+    it "returns the isbn if it's 10 digits" do
+      lisbn = Lisbn.new("0000000000")
+      lisbn.stub(:valid? => true)
+      lisbn.should_not_receive(:isbn_10_checksum)
+      lisbn.isbn10.should == "0000000000"
+    end
+  end
+
+  describe "#isbn13" do
+    subject { Lisbn.new("0000000000") }
+
+    it "returns nil if invalid" do
+      subject.stub(:valid? => false)
+      subject.isbn13.should be_nil
+    end
+
+    it "computes the ISBN13 checksum" do
+      subject.isbn13.should == "9780000000002"
+    end
+
+    it "returns the isbn if it's 13 digits" do
+      lisbn = Lisbn.new("9780000000002")
+      lisbn.stub(:valid? => true)
+      lisbn.should_not_receive(:isbn_13_checksum)
+      lisbn.isbn13.should == "9780000000002"
+    end
+  end
+
+  describe "#parts" do
+    subject { Lisbn.new("9780000000002") }
+
+    it "splits into the right groups" do
+      subject.parts.should == ["978", "0", "00", "000000", "2"]
+    end
+
+    it "works with long groups" do
+      lisbn = Lisbn.new("9786017002015")
+      lisbn.parts.should == ["978", "601", "7002", "01", "5"]
+    end
+
+    it "returns nil if it can't find a valid group" do
+      lisbn = Lisbn.new("9780100000002")
+      lisbn.parts.should be_nil
+    end
+  end
+
+  describe "ranges" do
+    it "skips over invalid '0-length' ranges" do
+      Lisbn::RANGES.values.flatten.map {|v| v[:length]}.should_not include(0)
+    end
+  end
+
+  describe "retains normal string methods" do
+    subject { Lisbn.new("9780000000002") }
+
+    it "#splits" do
+      subject.split("7").should == ["9", "80000000002"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'lisbn'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: lisbn
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Ragalie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nori
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: ISBN manipulation helpers
+email: 
+- michael.ragalie@verbasoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/RangeMessage.xml
+- lib/lisbn.rb
+- lib/lisbn/cache_method.rb
+- lib/lisbn/lisbn.rb
+- lisbn.gemspec
+- spec/cache_method_spec.rb
+- spec/lisbn_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides methods for converting between ISBN-10 and ISBN-13, checking validity and splitting ISBNs into groups and prefixes
+test_files: 
+- spec/cache_method_spec.rb
+- spec/lisbn_spec.rb
+- spec/spec_helper.rb