zapnap-isbn_validation 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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

@@ -0,0 +1,27 @@
+IsbnValidation
+==============
+
+Custom ActiveRecord Validation for International Standard Book Number (ISBN) fields.
+Supports both ISBN-10 and ISBN-13. Will guarantee that validated fields contain valid
+ISBNs.
+
+Default behavior is to allow either ISBN-10 or ISBN-13, but this can be altered by
+specifying the :with option as shown in the example below.
+
+For more information on ISBN, see http://en.wikipedia.org/wiki/Isbn
+
+Installation
+============
+
+ruby script/plugin install git://github.com/zapnap/isbn_validation
+
+Example
+=======
+
+class Book < ActiveRecord::Base
+  validates_isbn :isbn
+  validates_isbn :isbn10, :with => :isbn10
+  validates_isbn :isbn13, :with => :isbn13
+end
+
+Copyright (c) 2008 Nick Plante, released under the MIT license

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the isbn_validation plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the isbn_validation plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IsbnValidation'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name        = %q{isbn_validation}
+  s.name        = %q{isbn_validation}
+  s.version     = "0.1.0"
+  s.summary     = %q{isbn_validation adds an isbn validation routine to active record models.}
+  s.description = %q{isbn_validation adds an isbn validation routine to active record models.}
+
+  s.files        = FileList['[A-Z]*', '{lib,test,rails}/**/*.rb']
+  s.require_path = 'lib'
+  s.test_files   = Dir[*['test/**/*_test.rb']]
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README"]
+  s.rdoc_options = ['--line-numbers', '--inline-source', "--main", "README"]
+
+  s.authors = ["Nick Plante"]
+  s.email   = %q{nap@zerosum.org}
+
+  s.platform = Gem::Platform::RUBY
+  s.add_dependency(%q<activerecord>, [">= 2.1.2"])
+end
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/lib/isbn_validation.rb

@@ -0,0 +1,84 @@
+module Zerosum
+  module ValidationExtensions
+    module IsbnValidation
+      ISBN10_REGEX = /^(?:\d[\ |-]?){9}[\d|X]$/
+      ISBN13_REGEX = /^(?:\d[\ |-]?){13}$/
+
+      # Validates whether the value of the specified attribute is a proper ISBN number.
+      # Defaults to verifying that the value is either a valid ISBN-10 or ISBN-13 number
+      # but this behavior can be modified using configuration options (as shown below).
+      #
+      #   class Book < ActiveRecord::Base
+      #     validates_isbn :isbn
+      #     #validates_isbn :isbn10, :with => :isbn10
+      #     #validates_isbn :isbn13, :with => :isbn13
+      #   end
+      #
+      # Configuration options:
+      # * <tt>:message</tt> - A custom error message (default is: "is not a valid ISBN")
+      # * <tt>:with</tt> - A symbol referencing the type of ISBN to validate (:isbn10 or :isbn13)
+      # * <tt>:allow_nil</tt> - If set to true, skips this validation if the attribute is +nil+ (default is +false+).
+      # * <tt>:allow_blank</tt> - If set to true, skips this validation if the attribute is blank (default is +false+).
+      # * <tt>:on</tt> - Specifies when this validation is active (default is <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the validation should
+      #   occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>).  The
+      #   method, proc or string should return or evaluate to a true or false value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the validation should
+      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>).  The
+      #   method, proc or string should return or evaluate to a true or false value.
+      def validates_isbn(*attr_names)
+        configuration = { 
+          :message => "is not a valid ISBN code"
+        }
+
+        configuration.update(attr_names.extract_options!)
+        validates_each(attr_names, configuration) do |record, attr_name, value|
+          valid = case configuration[:with]
+          when :isbn10
+            validate_with_isbn10(value)
+          when :isbn13
+            validate_with_isbn13(value)
+          else
+            validate_with_isbn10(value) || validate_with_isbn13(value)
+          end
+          record.errors.add(attr_name, configuration[:message]) unless valid
+        end
+      end
+
+      def validate_with_isbn10(isbn) #:nodoc:
+        if isbn.match(ISBN10_REGEX)
+          isbn_values = isbn.upcase.gsub(/\ |-/, '').split('')
+          check_digit = isbn_values.pop # last digit is check digit
+          check_digit = (check_digit == 'X') ? 10 : check_digit.to_i
+
+          sum = 0
+          isbn_values.each_with_index do |value, index|
+            sum += (index + 1) * value.to_i
+          end
+
+          (sum % 11) == check_digit
+        else
+          false
+        end
+      end
+
+      def validate_with_isbn13(isbn) #:nodoc:
+        if isbn.match(ISBN13_REGEX)
+          isbn_values = isbn.upcase.gsub(/\ |-/, '').split('')
+          check_digit = isbn_values.pop.to_i # last digit is check digit
+
+          sum = 0
+          isbn_values.each_with_index do |value, index|
+            multiplier = (index % 2 == 0) ? 1 : 3
+            sum += multiplier * value.to_i
+          end
+
+          (10 - (sum % 10)) == check_digit
+        else
+          false
+        end
+      end
+    end
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'isbn_validation'
+ActiveRecord::Base.send(:extend, Zerosum::ValidationExtensions::IsbnValidation)

data/test/isbn_validation_test.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/models'
+
+class IsbnValidationTest < Test::Unit::TestCase
+  def setup
+    @book = Book.new
+  end
+
+  def test_isbn10_should_match_regex
+    isbn = '1590599934'
+    assert isbn.match(Zerosum::ValidationExtensions::IsbnValidation::ISBN10_REGEX)
+  end
+
+  def test_isbn10_should_not_match_regex
+    isbn = 'abc123ab3344'
+    assert !isbn.match(Zerosum::ValidationExtensions::IsbnValidation::ISBN10_REGEX)
+  end
+
+  def test_isbn10_with_dashes_and_spaces_should_match_regex
+    isbn = '159-059 9934'
+    assert isbn.match(Zerosum::ValidationExtensions::IsbnValidation::ISBN10_REGEX)
+  end
+
+  def test_isbn13_should_match_regex
+    isbn = '9781590599938'
+    assert isbn.match(Zerosum::ValidationExtensions::IsbnValidation::ISBN13_REGEX)
+  end
+
+  def test_isbn13_should_not_match_regex
+    isbn = '9991a9010599938'
+    assert !isbn.match(Zerosum::ValidationExtensions::IsbnValidation::ISBN13_REGEX)
+  end
+
+  def test_isbn13_with_dashes_and_spaces_should_match_regex
+    isbn = '978-159059 9938'
+    assert isbn.match(Zerosum::ValidationExtensions::IsbnValidation::ISBN13_REGEX)
+  end
+
+  def test_isbn10_should_pass_check_digit_verification
+    @book.isbn = '159059993-4'
+    assert @book.valid?
+  end
+
+  def test_isbn10_should_fail_check_digit_verification
+    @book.isbn = '159059993-0'
+    assert !@book.valid?
+  end
+
+  def test_isbn10_should_handle_x_character_checksum
+    @book.isbn = '0-9722051-1-X'
+    assert @book.valid?
+  end
+
+  def test_isbn13_should_pass_check_digit_verification
+    @book.isbn = '978-1590599938'
+    assert @book.valid?
+  end
+
+  def test_isbn13_should_fail_check_digit_verification
+    @book.isbn = '978-1590599934'
+    assert !@book.valid?
+  end
+
+  def test_isbn_should_be_valid_if_either_isbn10_or_isbn13
+    @book.isbn = '978-1590599938'
+    assert @book.valid?
+    @book.isbn = '1590599934'
+    assert @book.valid?
+  end
+
+  def test_isbn_should_validate_only_isbn10
+    @book = Book10.new
+    @book.isbn = '978-1590599938'
+    assert !@book.valid?
+    @book.isbn = '1590599934'
+    assert @book.valid?
+  end
+
+  def test_isbn_should_validate_only_isbn13
+    @book = Book13.new
+    @book.isbn = '1590599934'
+    assert !@book.valid?
+    @book.isbn = '978-1590599938'
+    assert @book.valid?
+  end
+
+  def test_should_have_custom_error_message
+    @book.isbn = '978-159059AAAAAA'
+    @book.valid?
+    assert_equal 'is too fantastical!', @book.errors.on(:isbn)
+  end
+end

data/test/models.rb

@@ -0,0 +1,13 @@
+class Book < ActiveRecord::Base
+  validates_isbn :isbn, :message => 'is too fantastical!'
+end
+
+class Book10 < ActiveRecord::Base
+  set_table_name 'books'
+  validates_isbn :isbn, :with => :isbn10
+end
+
+class Book13 < ActiveRecord::Base
+  set_table_name 'books'
+  validates_isbn :isbn, :with => :isbn13
+end

data/test/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :books, :force => true do |t|
+    t.string :isbn
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+RAILS_ROOT = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require "#{File.dirname(__FILE__)}/../init"
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: zapnap-isbn_validation
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nick Plante
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-03 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+description: isbn_validation adds an isbn validation routine to active record models.
+email: nap@zerosum.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- Rakefile
+- README
+- lib/isbn_validation.rb
+- test/isbn_validation_test.rb
+- test/models.rb
+- test/schema.rb
+- test/test_helper.rb
+- rails/init.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: isbn_validation adds an isbn validation routine to active record models.
+test_files: 
+- test/isbn_validation_test.rb