library_stdnums 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bill Dueber
+
+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:
+
+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.rdoc

@@ -0,0 +1,17 @@
+= library_stdnums
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Bill Dueber. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "library_stdnums"
+    gem.summary = %Q{Normalize and compute checkdigits for ISBN, ISSN, and LCCN}
+    gem.description = %Q{Normalization and checksum computation for ISBN (10 and 13), ISSN, and LCCN}
+    gem.email = "bill@dueber.com"
+    gem.homepage = "http://github.com/billdueber/library_stdnums"
+    gem.authors = ["Bill Dueber"]
+    gem.add_development_dependency "bacon", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |spec|
+    spec.libs << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/library_stdnums.rb

@@ -0,0 +1,130 @@
+module StdNum
+  
+  STDNUMPAT = /^.*?(\d[\d\-]+[xX]?)/
+  
+  # Extract the most likely looking number from the string. This will be the first
+  # string of digits-and-hyphens-and-maybe-a-trailing-X, with the hypens removed
+  def self.extractNumber str
+    match = STDNUMPAT.match str
+    return nil unless match
+    return match[1].gsub(/\-/, '').upcase
+  end
+    
+
+
+  module ISBN
+  
+    # Compute check digits for 10 or 13-digit ISBNs. See algorithm at
+    # http://en.wikipedia.org/wiki/International_Standard_Book_Number
+    # @param [String] isbn The ISBN (we'll try to clean it up if possible)
+    # @return [String] the one-character checkdigit
+    def self.checkdigit isbn
+      isbn = StdNum.extractNumber isbn
+      size = isbn.size
+      return nil unless size == 10 or size == 13
+      checkdigit = 0
+      if size == 10
+        digits = isbn[0..8].split(//).map {|i| i.to_i}
+        (1..9).each do |i|
+          checkdigit += digits[i-1] * i
+        end
+        checkdigit = checkdigit % 11
+        return 'X' if checkdigit == 10
+        return checkdigit.to_s
+      else # size == 13
+        digits = isbn[0..11].split(//).map {|i| i.to_i}
+        6.times do
+          checkdigit += digits.shift
+          checkdigit += digits.shift * 3
+        end
+        return (10 - (checkdigit % 10)).to_s
+      end
+    end
+    
+    # Check to see if the checkdigit is correct
+    # @param [String] isbn The ISBN (we'll try to clean it up if possible)
+    # @return [Boolean] Whether or not the checkdigit is correct
+    def self.valid? isbn
+      isbn = StdNum.extractNumber isbn
+      size = isbn.size
+      return false unless (size == 10 or size == 13)
+      return isbn[-1..-1] == self.checkdigit(isbn)
+    end
+  
+    # To convert to an ISBN13, throw a '978' on the front and 
+    # compute the checkdigit
+    # We leave 13-digit numbers alone, figuring they're already ok,
+    # and return nil on anything that's not the right length
+    # @param [String] isbn The ISBN (we'll try to clean it up if possible)
+    # @return [String] The converted 13-character ISBN, nil if something looks wrong, or whatever was passed in if it already looked like a 13-digit ISBN
+    def self.convert_to_13 isbn
+      isbn = StdNum.extractNumber isbn
+      size = isbn.size
+      return isbn if size == 13
+      return nil unless size == 10
+    
+      prefix = '978' + isbn[0..8]
+      return prefix + self.checkdigit(prefix + '0')
+    end
+    
+    
+    # Convert to 10 if it's 13 digits and the first three digits are 978.
+    # Pass through anything 10-digits, and return nil for everything else.
+    # @param [String] isbn The ISBN (we'll try to clean it up if possible)
+    # @return [String] The converted 10-character ISBN, nil if something looks wrong, or whatever was passed in if it already looked like a 10-digit ISBN
+    def self.convert_to_10 isbn
+      isbn = StdNum.extractNumber isbn
+      size = isbn.size
+      return isbn if size == 10
+      return nil unless size == 13
+      return nil unless isbn[0..2] == '978'
+      
+      prefix = isbn[3..11]
+      return prefix + self.checkdigit(prefix + '0')
+    end
+  end
+  
+  module ISSN
+    
+    # Compute the checkdigit of an ISSN
+    # @param [String] issn The ISSN (we'll try to clean it up if possible)
+    # @return [String] the one-character checkdigit
+    def self.checkdigit issn
+      issn = StdNum.extractNumber issn
+      return nil unless issn.size == 8
+      digits = issn[0..6].split(//).map {|i| i.to_i}
+      checkdigit = 0
+      (0..6).each do |i|
+        checkdigit += digits[i] * (8 - i) 
+      end
+      checkdigit = checkdigit % 11
+      return 0 if checkdigit == 0
+      checkdigit = 11 - checkdigit
+      return 'X' if checkdigit == 10
+      return checkdigit.to_s
+    end
+      
+    
+  end
+  
+  module LCCN
+    # Normalize based on data at http://www.loc.gov/marc/lccn-namespace.html#syntax
+    # @param [String] str The LCCN to normalize
+    # @return [String] the normalized LCCN, or nil if it looks malformed
+    def self.normalize str
+      str.gsub!(/\s/, '')
+      str.gsub!(/\/.*$/, '')
+      if str =~ /^(.*?)\-(.+)/
+        pre =  $1
+        post = $2
+        return nil unless post =~ /^\d+$/ # must be all digits
+        return "%s%06d" % [pre, post]
+      end
+      return str
+    end
+  end  
+  
+  
+end
+      
+    

data/spec/library_stdnums_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe "Extract" do
+  it "should leave a number alone" do
+    StdNum.extractNumber('123456').should.equal '123456'
+  end
+  
+  it "should skip leading and trailing crap" do
+    StdNum.extractNumber(' 12345 (online)').should.equal '12345'
+  end
+  
+  it "should allow hyphens" do
+    StdNum.extractNumber(' 1-234-5').should.equal '12345'
+  end
+  
+  it "should return nil on a non-match" do
+    StdNum.extractNumber('bill dueber').should.equal nil
+  end
+  
+  it "should allow a trailing X" do 
+    StdNum.extractNumber('1-234-5-X').should.equal '12345X'
+  end
+  
+  it "should upcase any trailing X" do
+    StdNum.extractNumber('1-234-x').should.equal '1234X'
+  end
+  
+  it "only allows a single trailing X" do
+    StdNum.extractNumber('1234-X-X').should.equal '1234X'
+  end
+  
+end
+
+
+describe "ISBN" do
+  it "computes 10-digit checksum" do
+    StdNum::ISBN.checkdigit('0-306-40615-X').should.equal '2'
+  end
+  
+  it "correctly uses X for checksum" do
+    StdNum::ISBN.checkdigit('061871460X').should.equal 'X'
+  end
+  
+  it "finds a zero checkdigit" do
+    StdNum::ISBN.checkdigit('0139381430').should.equal '0'
+  end
+  
+  it "computes 13-digit checksum" do
+    StdNum::ISBN.checkdigit('9780306406157').should.equal '7'
+  end
+  
+  it "finds a good number valid" do
+    StdNum::ISBN.valid?('9780306406157').should.equal true
+  end
+  
+  it "finds a bad number false" do
+    StdNum::ISBN.valid?('9780306406154').should.equal false
+  end
+  
+  it "returns nil when computing checksum for bad ISBN" do
+    StdNum::ISBN.checkdigit('12345').should.equal nil
+  end
+  
+  it "converts 10 to 13" do
+    StdNum::ISBN.convert_to_13('0-306-40615-2').should.equal '9780306406157'
+  end
+  
+  it "passes through 13 digit number instead of converting to 13" do
+    StdNum::ISBN.convert_to_13('9780306406157').should.equal '9780306406157'
+  end
+  
+  it "converts 13 to 10" do 
+    StdNum::ISBN.convert_to_10('978-0-306-40615-7').should.equal '0306406152'
+  end
+  
+end
+
+
+
+describe 'ISSN' do
+  it "computes checksum" do 
+    StdNum::ISSN.checkdigit('0378-5955').should.equal '5'
+  end
+end
+
+
+describe 'LCCN' do
+  
+  # Tests take from http://www.loc.gov/marc/lccn-namespace.html#syntax
+  test = {
+    "n78-890351" => "n78890351",
+    "n78-89035" => "n78089035",
+    "n 78890351 " => "n78890351",
+    " 85000002 " => "85000002",
+    "85-2 " => "85000002",
+    "2001-000002" => "2001000002",
+    "75-425165//r75" => "75425165",
+    " 79139101 /AC/r932" => "79139101"
+  }
+  
+  test.each do |k, v|
+    it "normalizes #{k}" do
+      StdNum::LCCN.normalize(k.dup).should.equal v
+    end
+  end
+  
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bacon'
+begin
+  require 'greeneggs'
+rescue LoadError
+end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'library_stdnums'
+
+Bacon.summary_on_exit

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: library_stdnums
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bill Dueber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  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: Normalization and checksum computation for ISBN (10 and 13), ISSN, and LCCN
+email: bill@dueber.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/library_stdnums.rb
+- spec/library_stdnums_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/billdueber/library_stdnums
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Normalize and compute checkdigits for ISBN, ISSN, and LCCN
+test_files: 
+- spec/library_stdnums_spec.rb
+- spec/spec_helper.rb