rbook-isbn 1.0

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/LICENSE

@@ -0,0 +1,13 @@
+= License Terms
+
+Distributed by James Healy under the user's choice* of the 
+{GPL version 2}[http://www.gnu.org/copyleft/gpl.html] (see COPYING for details)
+or the {Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt].
+
+Please email James[mailto:jimmy_AT_deefa.com] with any questions.
+
+*Note:  This license refers specifically to GPLv2.
+Distributing under other versions of the GPL require explicit permission from
+James Healy.  Though we will most likely adopt the GPLv3 when the final draft
+is published, we want to be able to make that decision for ourselves.
+

data/Rakefile

@@ -0,0 +1,90 @@
+require "rubygems"
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require "rake/gempackagetask"
+require 'spec/rake/spectask'
+
+PKG_VERSION = "1.0"
+PKG_NAME = "rbook-isbn"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBYFORGE_PROJECT = 'rbook'
+RUBYFORGE_USER = 'yob'
+
+CLEAN.include "**/.*.sw*"
+
+desc "Default Task"
+task :default => [ :spec ]
+
+desc "Cruise Control Tasks"
+task :cruise => [ :spec, :spec_report, :doc ]
+
+# run all rspecs
+desc "Run all rspec files"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.rcov = true
+  t.rcov_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + "/rcov"
+  t.rcov_opts = ["--exclude","spec.*\.rb"]
+end
+
+# generate specdocs
+desc "Generate Specdocs"
+Spec::Rake::SpecTask.new("specdocs") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.spec_opts = ["--format", "rdoc"]
+  t.out = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/specdoc.rd'
+end
+
+# generate failing spec report
+desc "Generate failing spec report"
+Spec::Rake::SpecTask.new("spec_report") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.spec_opts = ["--format", "html", "--diff"]
+  t.out = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/spec_report.html'
+  t.fail_on_error = false
+end
+
+# Genereate the RDoc documentation
+desc "Create documentation"
+Rake::RDocTask.new("doc") do |rdoc|
+  rdoc.title = "RBook"
+  rdoc.rdoc_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/rdoc'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('COPYING')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << "--inline-source"
+end
+
+spec = Gem::Specification.new do |spec|
+	spec.name = PKG_NAME
+	spec.version = PKG_VERSION
+	spec.platform = Gem::Platform::RUBY
+	spec.summary = "A library for manipulating ISBNs"
+	spec.files =  Dir.glob("{examples,lib,specs}/**/**/*") +
+                      ["Rakefile"]
+  
+  spec.require_path = "lib"
+  spec.test_files = Dir[ "specs/**/*.rb" ]
+	spec.has_rdoc = true
+	spec.extra_rdoc_files = %w{README COPYING LICENSE}
+	spec.rdoc_options << '--title' << 'isbn Documentation' <<
+	                     '--main'  << 'README' << '-q'
+  spec.author = "James Healy"
+	spec.email = "jimmy@deefa.com"
+	spec.rubyforge_project = "rbook"
+	spec.homepage = "http://rbook.rubyforge.org/"
+	spec.description = <<END_DESC
+  This library is designed to make working with both 10 and 13
+  digit ISBNs easier.
+END_DESC
+end
+
+desc "Generate a gem for rbook"
+Rake::GemPackageTask.new(spec) do |pkg|
+	pkg.need_zip = true
+	pkg.need_tar = true
+end
+

data/lib/rbook/isbn.rb

@@ -0,0 +1,245 @@
+module RBook
+  # A collection of useful functions for dealing with ISBNs. Each
+  # function can be used directly - examples listed below.
+  # To use these examples you will need the following 2 lines
+  # at the top of your script:
+  #   require 'rubygems'
+  #   require 'rbook/isbn'
+  class ISBN
+
+    # adds hyphens to a valid isbn in the appropriate spots
+    #
+    #   ISBN.add_groups("020161622X")
+    #         #=> 0-201-61622-X
+    #   ISBN.add_groups("9780201616224")
+    #         #=> 978-0-201-61622-4
+    def self.add_groups(isbn)
+      return nil unless isbn.class == String
+      if valid_isbn10?(isbn)
+        isbn = isbn.gsub("-","")
+        isbn = isbn.insert(1, "-")
+        isbn = isbn.insert(7, "-")
+        isbn = isbn.insert(11, "-")
+        return isbn
+      elsif valid_isbn13?(isbn)
+        isbn = isbn.gsub("-","")
+        isbn = isbn.insert(3, "-")
+        isbn = isbn.insert(5, "-")
+        isbn = isbn.insert(11, "-")
+        isbn = isbn.insert(15, "-")
+        return isbn
+      else
+        return isbn
+      end
+    end
+
+    # Returns true if the supplied string is a valid isbn10 or isbn13
+    #
+    #   ISBN.valid_isbn?("020161622X")
+    #         #=> true
+    #   ISBN.valid_isbn?("9780201616224")
+    #         #=> true
+    #   ISBN.valid_isbn?("9780201616223")
+    #         #=> false
+    #   ISBN.valid_isbn?("not an isbn")
+    #         #=> false
+    def self.valid_isbn?(isbn)
+      valid_isbn10?(isbn) || valid_isbn13?(isbn)
+    end
+
+    # returns true if the supplied string is a valid isbn10
+    #
+    #   ISBN.valid_isbn10?("020161622X")
+    #         #=> true
+    #   ISBN.valid_isbn10?("9780201616224")
+    #         #=> false
+    #   ISBN.valid_isbn10?("9780201616223")
+    #         #=> false
+    #   ISBN.valid_isbn10?("not an isbn")
+    #         #=> false
+    def self.valid_isbn10?(isbn)
+      return false unless isbn.class == String
+      isbn = isbn.gsub("-","")
+      if isbn.length != 10
+        false
+      elsif isbn[/[^\dxX]/]
+        false
+      else
+        checkdigit = self.calc_isbn10_check(isbn.to_s[0,9])
+        if checkdigit.eql?("X")
+          isbn == isbn[0,9] + "x" || isbn == isbn[0,9] + "X"
+        else
+          isbn == isbn[0,9] + checkdigit
+        end
+      end
+    end
+
+    # returns true if the supplied string is a valid isbn13
+    #
+    #   ISBN.valid_isbn13?("020161622X")
+    #         #=> false
+    #   ISBN.valid_isbn13?("9780201616224")
+    #         #=> true
+    #   ISBN.valid_isbn13?("9780201616223")
+    #         #=> false
+    #   ISBN.valid_isbn13?("not an isbn")
+    #         #=> false
+    def self.valid_isbn13?(isbn)
+      return false unless isbn.class == String
+      isbn = isbn.gsub("-","")
+      if isbn.length != 13
+        false
+      elsif isbn[/[^\dxX]/]
+        false
+      else
+        isbn == isbn[0,12] + self.calc_isbn13_check(isbn[0,12])
+      end
+    end
+
+    # Attempts to calculate the check digit on a supplied 9 digit string.
+    #
+    # If passed nil or a non string, nil is returned.
+    #
+    # If the supplied string length isn't chars 9 long, nil is returned.
+    #
+    # If the supplied string is 9 chars long, the check digit is calculated and returned
+    #
+    #   ISBN.calc_isbn10_check("020161622")
+    #         #=> X
+    #   ISBN.calc_isbn10_check("020161622X")
+    #         #=> nil
+    #   ISBN.calc_isbn10_check("9780201616224")
+    #         #=> nil
+    #   ISBN.calc_isbn10_check("9780201616223")
+    #         #=> nil
+    #   ISBN.calc_isbn10_check("not an isbn")
+    #         #=> nil
+    def self.calc_isbn10_check(isbn)
+      if isbn.nil? || isbn.class != String || isbn.length != 9
+        return nil
+      else
+        check = isbn[0,1].to_i
+        check = check + isbn[1,1].to_i * 2
+        check = check + isbn[2,1].to_i * 3
+        check = check + isbn[3,1].to_i * 4
+        check = check + isbn[4,1].to_i * 5
+        check = check + isbn[5,1].to_i * 6
+        check = check + isbn[6,1].to_i * 7
+        check = check + isbn[7,1].to_i * 8
+        check = check + isbn[8,1].to_i * 9
+        check = check % 11
+
+        if check == 10
+          return "X"
+        else
+          return check.to_s
+        end
+      end
+    end
+
+    # Attempts to calculate the check digit on a supplied 12 digit string.
+    #
+    # If passed nil or a non String, nil is returned.
+    #
+    # If the supplied string isn't 12 digits long, nil is returned.
+    #
+    # For all other strings the check digit will be returned
+    #
+    #   ISBN.calc_isbn13_check("978020161622")
+    #         #=> 4
+    #   ISBN.calc_isbn13_check("9780201616224")
+    #         #=> nil
+    #   ISBN.calc_isbn13_check("020161622X")
+    #         #=> nil
+    #   ISBN.calc_isbn13_check("9780201616223")
+    #         #=> nil
+    #   ISBN.calc_isbn13_check("not an isbn")
+    #         #=> nil
+    def self.calc_isbn13_check(isbn)
+      if isbn.nil? || isbn.class != String || isbn.length != 12
+        return nil
+      else
+        checkdigit = isbn[0,1].to_i * 1
+        checkdigit = checkdigit + isbn[1,1].to_i * 3
+        checkdigit = checkdigit + isbn[2,1].to_i * 1
+        checkdigit = checkdigit + isbn[3,1].to_i * 3
+        checkdigit = checkdigit + isbn[4,1].to_i * 1
+        checkdigit = checkdigit + isbn[5,1].to_i * 3
+        checkdigit = checkdigit + isbn[6,1].to_i * 1
+        checkdigit = checkdigit + isbn[7,1].to_i * 3
+        checkdigit = checkdigit + isbn[8,1].to_i * 1
+        checkdigit = checkdigit + isbn[9,1].to_i * 3
+        checkdigit = checkdigit + isbn[10,1].to_i * 1
+        checkdigit = checkdigit + isbn[11,1].to_i * 3
+
+        remainder = checkdigit % 10
+
+        if remainder == 0
+          checkdigit = 0
+        else
+          checkdigit = (10 - remainder)
+        end
+
+        return checkdigit.to_s
+
+      end
+    end
+
+    # Attempts to convert a valid isbn13 into an isbn10.
+    #
+    # If supplied string is a valid isbn10, it is returned unchanged.
+    #
+    # If if the string is a valid isbn13 and starts with 978, it is converted to an isbn10.
+    #
+    # All other strings return nil.
+    #
+    #   ISBN.convert_to_isbn10("9780201616224")
+    #         #=> 020161622X
+    #   ISBN.convert_to_isbn10("020161622X")
+    #         #=> 020161622X
+    #   ISBN.convert_to_isbn10("9793472834833")
+    #         #=> nil
+    #   ISBN.convert_to_isbn10("not an isbn")
+    #         #=> nil
+    def self.convert_to_isbn10(convert_me)
+      return nil unless convert_me.class == String
+      convert_me = convert_me.gsub("-","")
+      if self.valid_isbn10?(convert_me)
+        convert_me
+      elsif self.valid_isbn13?(convert_me) && convert_me[0,3] == '978'
+        convert_me[3,9] + self.calc_isbn10_check(convert_me[3,9])
+      else
+        nil
+      end
+    end
+
+    # Attempts to convert the supplied string into an ISBN13.
+    #
+    # If the string is a valid isbn13, it is returned unchanged.
+    #
+    # If the string is a valid isbn10, it will be converted to isbn13.
+    #
+    # All other strings will return nil.
+    #
+    #   ISBN.convert_to_isbn13("020161622X")
+    #         #=> 9780201616224
+    #   ISBN.convert_to_isbn13("9780201616224")
+    #         #=> 9780201616224
+    #   ISBN.convert_to_isbn13("9793472834833")
+    #         #=> nil
+    #   ISBN.convert_to_isbn13("not an isbn")
+    #         #=> nil
+    def self.convert_to_isbn13(convert_me)
+      return nil unless convert_me.class == String
+      convert_me = convert_me.gsub("-","")
+      if self.valid_isbn13?(convert_me)
+        convert_me
+      elsif self.valid_isbn10?(convert_me)
+      '978'+convert_me[0,9] + self.calc_isbn13_check('978'+convert_me[0,9])
+      else
+        nil
+      end
+    end
+
+  end
+end

data/specs/invalid_isbn_spec.rb

@@ -0,0 +1,68 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/isbn'
+include RBook
+
+context "Invalid ISBN's" do
+
+  setup do
+    @invalids = []
+    @invalids << '0201616221'
+    @invalids << '02016A6221'
+    @invalids << '9780764812201'
+    @invalids << '97807648A2201'
+    @invalids << nil
+    @invalids << ''
+    @invalids << 'This is a sentance that is much longer than a valid ISBN, silly'
+    @invalids << ' - '
+    @invalids << 'CD-DSE'
+  end
+
+  specify "should all be unchanged by add_groups" do
+    @invalids.each do |invalid|
+      ISBN.add_groups(invalid).should eql(invalid)
+    end
+  end
+
+  specify "should all be invalid isbns" do
+    @invalids.each do |invalid|
+      ISBN.valid_isbn?(invalid).should be_false
+    end
+  end
+
+  specify "should all be invalid isbn 10's" do
+    @invalids.each do |invalid|
+      ISBN.valid_isbn10?(invalid).should be_false
+    end
+  end
+
+  specify "should not be invalid isbn 13's" do
+    @invalids.each do |invalid|
+      ISBN.valid_isbn13?(invalid).should be_false
+    end
+  end
+
+  specify "should all fail to have an isbn 10 check digit calculated" do
+    @invalids.each do |invalid|
+      ISBN.calc_isbn10_check(invalid).should eql(nil)
+    end
+  end
+
+  specify "should all fail to have an isbn 13 check digit calculated" do
+    @invalids.each do |invalid|
+      ISBN.calc_isbn13_check(invalid).should eql(nil)
+    end
+  end
+
+  specify "should all fail to be converted to an isbn10" do
+    @invalids.each do |invalid|
+      ISBN.convert_to_isbn10(invalid).should eql(nil)
+    end
+  end
+
+  specify "should all fail to be converted to an isbn13" do
+    @invalids.each do |invalid|
+      ISBN.convert_to_isbn13(invalid).should eql(nil)
+    end
+  end
+end

data/specs/valid_isbn10_spec.rb

@@ -0,0 +1,69 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/isbn'
+include RBook
+
+context "Valid ISBN 10's" do
+
+  setup do
+    @valid_with_x = '020161622X'
+    @valid_with_x_isbn13 = '9780201616224'
+    @valid_all_numeric = '0764812203' 
+    @valid_all_numeric_isbn13 = '9780764812200' 
+    @valid_with_hyphens = '0-20161-622-X' 
+    @valid_with_hyphens_stripped = '020161622X' 
+    @valid_with_hyphens_isbn13 = '9780201616224' 
+  end
+
+  specify "should all have groups applied correctly" do
+    ISBN.add_groups(@valid_with_x).should eql('0-20161-622-X')
+    ISBN.add_groups(@valid_all_numeric).should eql('0-76481-220-3')
+    ISBN.add_groups(@valid_with_hyphens).should eql('0-20161-622-X')
+  end
+
+  specify "add groups shouldn't modify the variable it is passed" do
+    tmp_isbn = @valid_with_x.dup
+    ISBN.add_groups(tmp_isbn)
+    tmp_isbn.should eql(@valid_with_x)
+  end
+
+  specify "should all be valid isbns" do
+    ISBN.valid_isbn?(@valid_with_x).should be_true 
+    ISBN.valid_isbn?(@valid_all_numeric).should be_true 
+    ISBN.valid_isbn?(@valid_with_hyphens).should be_true
+  end
+
+  specify "should all be valid isbn 10's" do
+    ISBN.valid_isbn10?(@valid_with_x).should be_true 
+    ISBN.valid_isbn10?(@valid_all_numeric).should be_true 
+    ISBN.valid_isbn10?(@valid_with_hyphens).should be_true
+  end
+
+  specify "should not be valid isbn 13's" do
+    ISBN.valid_isbn13?(@valid_with_x).should_not be_true
+    ISBN.valid_isbn13?(@valid_all_numeric).should_not be_true
+    ISBN.valid_isbn13?(@valid_with_hyphens).should_not be_true
+  end
+
+  specify "should have the correct check digit" do
+    ISBN.calc_isbn10_check(@valid_with_x[0,9]).should eql("X")
+    ISBN.calc_isbn10_check(@valid_all_numeric[0,9]).should eql("3")
+  end
+
+  specify "should not have valid isbn 13 check digits" do
+    ISBN.calc_isbn13_check(@valid_with_x[0,9]).should eql(nil)
+    ISBN.calc_isbn13_check(@valid_all_numeric[0,9]).should eql(nil)
+  end
+
+  specify "should equal the output of convert_to_isbn10" do
+    ISBN.convert_to_isbn10(@valid_with_x).should eql(@valid_with_x)
+    ISBN.convert_to_isbn10(@valid_all_numeric).should eql(@valid_all_numeric)
+    ISBN.convert_to_isbn10(@valid_with_hyphens).should eql(@valid_with_hyphens_stripped)
+  end
+
+  specify "should convert to isbn 13's correctly" do
+    ISBN.convert_to_isbn13(@valid_with_x).should eql(@valid_with_x_isbn13)
+    ISBN.convert_to_isbn13(@valid_all_numeric).should eql(@valid_all_numeric_isbn13)
+    ISBN.convert_to_isbn13(@valid_with_hyphens).should eql(@valid_with_hyphens_isbn13)
+  end
+end

data/specs/valid_isbn13_spec.rb

@@ -0,0 +1,58 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/isbn'
+include RBook
+
+context "Valid ISBN 13's" do
+
+  setup do
+    @valid_all_numeric = '9780764812200' 
+    @valid_all_numeric_isbn10 = '0764812203'
+    @valid_with_hyphens = '978-0-20161-622-4'
+    @valid_with_hyphens_stripped = '9780201616224'
+    @valid_with_hyphens_isbn10 = '0-20161-622-X'
+  end
+
+  specify "should all have groups applied correctly" do
+    ISBN.add_groups(@valid_all_numeric).should eql('978-0-76481-220-0')
+  end
+
+  specify "add groups shouldn't modify the variable it is passed" do
+    tmp_isbn = @valid_all_numeric.clone
+    ISBN.add_groups(tmp_isbn)
+    tmp_isbn.should eql(@valid_all_numeric)
+  end
+
+  specify "should all be valid isbns" do
+    ISBN.valid_isbn?(@valid_all_numeric).should be_true 
+    ISBN.valid_isbn?(@valid_with_hyphens).should be_true
+  end
+
+  specify "should not be valid isbn 10's" do
+    ISBN.valid_isbn10?(@valid_all_numeric).should_not be_true 
+    ISBN.valid_isbn10?(@valid_with_hyphens).should_not be_true
+  end
+
+  specify "should all be valid isbn 13's" do
+    ISBN.valid_isbn13?(@valid_all_numeric).should be_true
+    ISBN.valid_isbn13?(@valid_with_hyphens).should be_true
+  end
+
+  specify "should not have valid isbn10 check digit" do
+    ISBN.calc_isbn10_check(@valid_all_numeric[0,12]).should eql(nil)
+  end
+
+  specify "should all have valid isbn 13 check digits" do
+    ISBN.calc_isbn13_check(@valid_all_numeric[0,12]).should eql(@valid_all_numeric[-1,1])
+  end
+
+  specify "should convert_to_isbn10's correctly" do
+    ISBN.convert_to_isbn10(@valid_all_numeric).should eql(@valid_all_numeric_isbn10)
+    ISBN.convert_to_isbn10(@valid_with_hyphens).should eql("020161622X")
+  end
+
+  specify "should be returned from convert_to_isbn13's unchanged" do
+    ISBN.convert_to_isbn13(@valid_all_numeric).should eql(@valid_all_numeric)
+    ISBN.convert_to_isbn13(@valid_with_hyphens).should eql(@valid_with_hyphens_stripped)
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: rbook-isbn
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+date: 2007-07-03 00:00:00 +10:00
+summary: A library for manipulating ISBNs
+require_paths: 
+- lib
+email: jimmy@deefa.com
+homepage: http://rbook.rubyforge.org/
+rubyforge_project: rbook
+description: This library is designed to make working with both 10 and 13 digit ISBNs easier.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- James Healy
+files: 
+- lib/rbook
+- lib/rbook/isbn.rb
+- specs/valid_isbn10_spec.rb
+- specs/valid_isbn13_spec.rb
+- specs/invalid_isbn_spec.rb
+- Rakefile
+- README
+- COPYING
+- LICENSE
+test_files: 
+- specs/valid_isbn10_spec.rb
+- specs/valid_isbn13_spec.rb
+- specs/invalid_isbn_spec.rb
+rdoc_options: 
+- --title
+- isbn Documentation
+- --main
+- README
+- -q
+extra_rdoc_files: 
+- README
+- COPYING
+- LICENSE
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+