library_stdnums 1.0.2 → 1.1.0

data/README.markdown

@@ -63,6 +63,9 @@ LCCNs are normalized according to the algorithm at http://www.loc.gov/marc/lccn-
 ````
 
 ## CHANGES
+* 1.1.0 (2012.02.06)
+  * Changed the ISBN/ISSN regex to make sure string of digits/dashes is at least 6 chars long
+  * Cleaned up LCCN validation code
 * 1.0.2
   * Made docs clearer.
 * 1.0.0

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/lib/library_stdnums.rb

@@ -1,12 +1,15 @@
 # Static Module functions to work with library "standard numbers" ISSN, ISBN, and LCCN
 module StdNum
-  
+
   # Helper methods common to ISBN/ISSN
   module Helpers
-    
+
     # The pattern we use to try and find an ISBN/ISSN. Ditch everthing before the first
     # digit, then take all the digits/hyphens, optionally followed by an 'X'
-    STDNUMPAT = /^.*?(\d[\d\-]+[xX]?)/
+    # Since the shortest possible string is 7 digits followed by a checksum digit
+    # for an ISSN, we'll make sure they're at least that long. Still imperfect
+    # (would fine "5------", for example) but should work in most cases.
+    STDNUMPAT = /^.*?(\d[\d\-]{6,}+[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
@@ -17,7 +20,7 @@ module StdNum
       return nil unless match
       return match[1].gsub(/\-/, '').upcase
     end
-    
+
     # Given any string, extract what looks like the most likely ISBN/ISSN
     # of the given size(s), or nil if nothing matches at the correct size.
     # @param [String] rawnum The raw string containing (hopefully) an ISSN/ISBN
@@ -26,29 +29,29 @@ module StdNum
     # @return [String,nil] the reduced and verified number, or nil if there's no match at the right size
     def reduce_to_basics rawnum, valid_sizes = nil
       return nil if rawnum.nil?
-      
+
       num = extractNumber rawnum
-      
+
       # Does it even look like a number?
       return nil unless num
-      
+
       # Return what we've got if we don't care about the size
       return num unless valid_sizes
-      
+
       # Check for valid size(s)
       [valid_sizes].flatten.each do |s|
         return num if num.size == s
       end
-      
+
       # Didn't check out size-wise. Return nil
       return nil
     end
   end
-    
+
   # Validate, convert, and normalize ISBNs (10-digit or 13-digit)
   module ISBN
     extend Helpers
-  
+
     # 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)
@@ -79,7 +82,7 @@ module StdNum
         return check.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)
     # @param [Boolean] preprocessed Set to true if the ISBN has already been through reduce_to_basics
@@ -91,8 +94,8 @@ module StdNum
       return false unless isbn[-1..-1] == self.checkdigit(isbn, true)
       return true
     end
-  
-    
+
+
     # For an ISBN normalizing it is the same as converting to ISBN 13
     # and making sure it's valid
     # @param [String] isbn The ISBN to normalize
@@ -105,8 +108,8 @@ module StdNum
         return nil
       end
     end
-      
-    # To convert to an ISBN13, throw a '978' on the front and 
+
+    # 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. NO CHECKSUM CHECK IS DONE FOR 13-DIGIT ISBNS!
     # and return nil on anything that's not the right length
@@ -130,14 +133,14 @@ module StdNum
 
       # Already 10 digits? Just return
       return isbn if isbn.size == 10
-      
+
       # Can't be converted to ISBN-10? Bail
       return nil unless isbn[0..2] == '978'
-      
+
       prefix = isbn[3..11]
       return prefix + self.checkdigit(prefix + '0')
     end
-    
+
     # Return an array of the ISBN13 and ISBN10 (in that order) for the passed in value. You'll
     # only get one value back if it's a 13-digit
     # ISBN that can't be converted to an ISBN10.
@@ -158,19 +161,19 @@ module StdNum
         return [isbn, self.convert_to_10(isbn)].compact
       end
     end
-    
-    
+
+
   end
-  
+
   # Validate and and normalize ISSNs
   module ISSN
     extend Helpers
-    
+
     # Compute the checkdigit of an ISSN
     # @param [String] issn The ISSN (we'll try to clean it up if possible)
-    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic    
+    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic
     # @return [String] the one-character checkdigit
-    
+
     def self.checkdigit issn, preprocessed = false
       issn = reduce_to_basics issn, 8 unless preprocessed
       return nil unless issn
@@ -178,7 +181,7 @@ module StdNum
       digits = issn[0..6].split(//).map {|i| i.to_i}
       checkdigit = 0
       (0..6).each do |i|
-        checkdigit += digits[i] * (8 - i) 
+        checkdigit += digits[i] * (8 - i)
       end
       checkdigit = checkdigit % 11
       return '0' if checkdigit == 0
@@ -186,10 +189,10 @@ module StdNum
       return 'X' if checkdigit == 10
       return checkdigit.to_s
     end
-    
+
     # Check to see if the checkdigit is correct
     # @param [String] isbn The ISSN (we'll try to clean it up if possible)
-    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic        
+    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic
     # @return [Boolean] Whether or not the checkdigit is correct
 
     def self.valid? issn, preprocessed = false
@@ -197,9 +200,9 @@ module StdNum
       return false unless issn
       return issn[-1..-1] == self.checkdigit(issn, true)
     end
-    
-    
-    
+
+
+
     # Make sure it's valid, remove the dashes, uppercase the X, and return
     # @param [String] isbn The ISBN to normalize
     # @return [String, nil] the normalized (to 13 digit) ISBN, or nil on failure
@@ -211,81 +214,81 @@ module StdNum
         return nil
       end
     end
-      
-    
-    
+
+
+
   end
-  
+
   # Validate and and normalize LCCNs
   module LCCN
-    
+
+
+    # Get a string ready for processing as an LCCN
+    # @param [String] str The possible lccn
+    # @return [String] The munged string, ready for normalization
+
+    def self.reduce_to_basic str
+      rv = str.gsub(/\s/, '')  # ditch spaces
+      rv.gsub!(/\/.*$/, '') # ditch everything after the first '/' (including the slash)
+      return rv
+    end
+
+    # Normalize based on data at http://www.loc.gov/marc/lccn-namespace.html#syntax
+    # @param [String] str The possible LCCN to normalize
+    # @return [String, nil] the normalized LCCN, or nil if it looks malformed
+    def self.normalize rawlccn
+      lccn = reduce_to_basic(rawlccn)
+      # If there's a dash in it, deal with that.
+      if lccn =~ /^(.*?)\-(.+)/
+        pre =  $1
+        post = $2
+        return nil unless post =~ /^\d+$/ # must be all digits
+        lccn = "%s%06d" % [pre, post.to_i]
+      end
+
+      if valid?(lccn, true)
+        return lccn
+      else
+        return nil
+      end
+    end
+
     # The rules for validity according to http://www.loc.gov/marc/lccn-namespace.html#syntax:
     #
     # A normalized LCCN is a character string eight to twelve characters in length. (For purposes of this description characters are ordered from left to right -- "first" means "leftmost".)
-    # The rightmost eight characters are always digits. 
+    # The rightmost eight characters are always digits.
     # If the length is 9, then the first character must be alphabetic.
     # If the length is 10, then the first two characters must be either both digits or both alphabetic.
     # If the length is 11, then the first character must be alphabetic and the next two characters must be either both digits or both alphabetic.
     # If the length is 12, then the first two characters must be alphabetic and the remaining characters digits.
     #
     # @param [String] lccn The lccn to attempt to validate
-    # @param [Boolean] preprocessed Set to true if the number has already been normalized   
+    # @param [Boolean] preprocessed Set to true if the number has already been normalized
     # @return [Boolean] Whether or not the syntax seems ok
 
-    def self.reduce_to_basic str
-      str.gsub!(/\s/, '') # ditch leading spaces
-      str.gsub!(/\/.*$/, '') # ditch everything after the first '/' (including the slash)
-      return str
-    end
-      
-
     def self.valid? lccn, preprocessed = false
       lccn = normalize(lccn) unless preprocessed
-      return false unless (8..12).include? lccn.size
       clean = lccn.gsub(/\-/, '')
-      suffix = clean[-8..-1]
-      prefix = clean[0..-9]
-      return false unless suffix =~ /^\d+$/
-      case clean.size
+      suffix = clean[-8..-1] # "the rightmost eight characters are always digits"
+      return false unless suffix and suffix =~ /^\d+$/
+      case clean.size # "...is a character string eight to twelve digits in length"
       when 8
         return true
       when 9
-        return true if prefix =~ /[A-Za-z]/
+        return true if clean =~ /^[A-Za-z]/
       when 10
-        return true if prefix =~ /\d{2}/ or prefix =~ /[A-Za-z]{2}/
+        return true if clean =~ /^\d{2}/ or clean =~ /^[A-Za-z]{2}/
       when 11
-        return true if prefix =~ /[A-Za-z](\d{2}|[A-Za-z]{2})/
+        return true if clean =~ /^[A-Za-z](\d{2}|[A-Za-z]{2})/
       when 12
-        return true if prefix =~ /[A-Za-z]{2}\d{2}/
+        return true if clean =~ /^[A-Za-z]{2}\d{2}/
       else
         return false
       end
     end
 
-    
-    
-    # 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 rawlccn
-      lccn = reduce_to_basic(rawlccn)      
-      # If there's a dash in it, deal with that.
-      if lccn =~ /^(.*?)\-(.+)/
-        pre =  $1
-        post = $2
-        return nil unless post =~ /^\d+$/ # must be all digits
-        lccn = "%s%06d" % [pre, post.to_i]
-      end
-      
-      if valid?(lccn, true)
-        return lccn
-      else
-        return nil
-      end
-    end
-  end  
-  
-  
+  end
+
 end
-      
+
     

data/spec/library_stdnums_spec.rb

@@ -2,33 +2,41 @@ require 'spec_helper'
 
 describe "Extract" do
   it "should leave a number alone" do
-    StdNum::ISBN.extractNumber('123456').must_equal '123456'
+    StdNum::ISBN.extractNumber('1234567').must_equal '1234567'
   end
-  
+
   it "should skip leading and trailing crap" do
-    StdNum::ISBN.extractNumber(' 12345 (online)').must_equal '12345'
+    StdNum::ISBN.extractNumber(' 1234567 (online)').must_equal '1234567'
   end
-  
+
   it "should allow hyphens" do
     StdNum::ISBN.extractNumber(' 1-234-5').must_equal '12345'
   end
-  
+
   it "should return nil on a non-match" do
     StdNum::ISBN.extractNumber('bill dueber').must_equal nil
   end
-  
-  it "should allow a trailing X" do 
+
+  it "should allow a trailing X" do
     StdNum::ISBN.extractNumber('1-234-5-X').must_equal '12345X'
   end
-  
+
   it "should upcase any trailing X" do
-    StdNum::ISBN.extractNumber('1-234-x').must_equal '1234X'
+    StdNum::ISBN.extractNumber('1-234-56-x').must_equal '123456X'
   end
-  
+
   it "only allows a single trailing X" do
-    StdNum::ISBN.extractNumber('1234-X-X').must_equal '1234X'
+    StdNum::ISBN.extractNumber('123456-X-X').must_equal '123456X'
+  end
+
+  it "doesn't allow numbers that are too short" do
+    StdNum::ISBN.extractNumber('12345').must_equal nil
   end
-  
+
+  it "skips over short prefixing numbers" do
+    StdNum::ISBN.extractNumber('ISBN13: 1234567890123').must_equal '1234567890123'
+  end
+
 end
 
 
@@ -36,63 +44,63 @@ describe "ISBN" do
   it "computes 10-digit checksum" do
     StdNum::ISBN.checkdigit('0-306-40615-X').must_equal '2'
   end
-  
+
   it "correctly uses X for checksum" do
     StdNum::ISBN.checkdigit('061871460X').must_equal 'X'
   end
-  
+
   it "finds a zero checkdigit" do
     StdNum::ISBN.checkdigit('0139381430').must_equal '0'
   end
-  
+
   it "computes 13-digit checksum" do
     StdNum::ISBN.checkdigit('9780306406157').must_equal '7'
   end
-  
+
   it "computes a 13-digit checksum that is 0" do
     StdNum::ISBN.checkdigit('9783837612950').must_equal '0'
   end
-  
+
   it "finds a good number valid" do
     StdNum::ISBN.valid?('9780306406157').must_equal true
   end
-  
+
   it "finds a bad number invalid" do
     StdNum::ISBN.valid?('9780306406154').must_equal false
   end
-  
+
   it "returns nil when computing checksum for bad ISBN" do
     StdNum::ISBN.checkdigit('12345').must_equal nil
   end
-  
+
   it "converts 10 to 13" do
     StdNum::ISBN.convert_to_13('0-306-40615-2').must_equal '9780306406157'
   end
-  
+
   it "passes through 13 digit number instead of converting to 13" do
     StdNum::ISBN.convert_to_13('9780306406157').must_equal '9780306406157'
   end
-  
-  it "converts 13 to 10" do 
+
+  it "converts 13 to 10" do
     StdNum::ISBN.convert_to_10('978-0-306-40615-7').must_equal '0306406152'
   end
-  
+
   it "gets both normalized values" do
     a = StdNum::ISBN.allNormalizedValues('978-0-306-40615-7')
     a.sort.must_equal ['9780306406157', '0306406152' ].sort
   end
-  
-  
-  
+
+
+
 end
 
 
 
 describe 'ISSN' do
-  it "computes checksum" do 
+  it "computes checksum" do
     StdNum::ISSN.checkdigit('0378-5955').must_equal '5'
   end
-  
+
   it "normalizes" do
     StdNum::ISSN.normalize('0378-5955').must_equal '03785955'
   end
@@ -100,7 +108,7 @@ end
 
 
 describe 'LCCN' do
-  
+
   # Tests take from http://www.loc.gov/marc/lccn-namespace.html#syntax
   test = {
     "n78-890351" => "n78890351",
@@ -110,14 +118,14 @@ describe 'LCCN' do
     "85-2 " => "85000002",
     "2001-000002" => "2001000002",
     "75-425165//r75" => "75425165",
-    " 79139101 /AC/r932" => "79139101",    
+    " 79139101 /AC/r932" => "79139101",
   }
-  
+
   test.each do |k, v|
     it "normalizes #{k}" do
       StdNum::LCCN.normalize(k.dup).must_equal v
     end
   end
-  
-    
+
+
 end

metadata

@@ -1,39 +1,36 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: library_stdnums
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  version: 1.0.2
 platform: ruby
-authors: 
+authors:
 - Bill Dueber
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-19 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153722800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Normalization and checksum computation for ISBN (10 and 13), ISSN, and LCCN
+  prerelease: false
+  version_requirements: *2153722800
+description: Normalization and checksum computation for ISBN (10 and 13), ISSN, and
+  LCCN
 email: bill@dueber.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.markdown
-files: 
+files:
 - .document
 - LICENSE
 - README.markdown
@@ -42,33 +39,28 @@ files:
 - 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: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Normalize and compute checkdigits for ISBN, ISSN, and LCCN
 test_files: []
-