isbn_validation 0.1.2 → 1.0.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008, 2009 Nick Plante
+Copyright (c) 2011 Nick Plante
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,36 @@
+# 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 behaviour 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
+
+To use it, add it to your Gemfile:
+
+    gem 'isbn_validation'
+
+The current version of isbn_validation only supports Rails 3. For Rails 2.x
+support, please use v0.1.2.
+
+## Example
+
+    class Book < ActiveRecord::Base
+      validates_isbn :isbn
+      validates_isbn :isbn10, :with => isbn10
+      validates_isbn :isbn13, :with => isbn13
+    end
+
+------
+
+## Contributors
+
+* Nick Plante
+* Omer Jakobinsky - Rails 3.0 compatibility
+
+Copyright &copy; 2011 Nick Plante, released under the MIT license

data/Rakefile

@@ -1,6 +1,8 @@
+require 'bundler'
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+
+Bundler::GemHelper.install_tasks
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -11,41 +13,3 @@ Rake::TestTask.new(:test) do |t|
   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.2"
-  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}/**/*.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

@@ -1,87 +1,97 @@
+require "isbn_validation/version"
+
+# The base module that gets included in ActiveRecord::Base.
+# 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.
 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"
-        }
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
-        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)
+      module ClassMethods
+        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
-          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
+        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 = 0
+            isbn_values.each_with_index do |value, index|
+              sum += (index + 1) * value.to_i
+            end
 
-          (sum % 11) == check_digit
-        else
-          false
+            (sum % 11) == check_digit
+          else
+            false
+          end
         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
+        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
+            sum = 0
+            isbn_values.each_with_index do |value, index|
+              multiplier = (index % 2 == 0) ? 1 : 3
+              sum += multiplier * value.to_i
+            end
 
-          result = (10 - (sum % 10))
-          result = 0 if result == 10
+            result = (10 - (sum % 10))
+            result = 0 if result == 10
 
-          result == check_digit
-        else
-          false
+            result == check_digit
+          else
+            false
+          end
         end
       end
     end
   end
 end
 
+ActiveRecord::Base.send(:include, Zerosum::ValidationExtensions::IsbnValidation)

data/lib/isbn_validation/version.rb

@@ -0,0 +1,3 @@
+module IsbnValidation
+  VERSION = "1.0.0"
+end

data/test/isbn_validation_test.rb

@@ -87,7 +87,7 @@ class IsbnValidationTest < Test::Unit::TestCase
   def test_should_have_custom_error_message
     @book.isbn = '978-159059AAAAAA'
     @book.valid?
-    assert_equal 'is too fantastical!', @book.errors.on(:isbn)
+    assert_equal 'is too fantastical!', @book.errors[:isbn].first
   end
   
   def test_isbn13_with_zero_check_digit_should_validate

data/test/test_helper.rb

@@ -1,13 +1,15 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 RAILS_ROOT = File.dirname(__FILE__)
 
+require 'logger'
 require 'rubygems'
 require 'test/unit'
 require 'active_record'
+require "active_record/test_case"
 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.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

@@ -1,39 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: isbn_validation
-version: !ruby/object:Gem::Version 
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Nick Plante
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-09-10 00:00:00 -04:00
+date: 2009-09-10 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
+  requirement: &2153555480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.1.2
-    version: 
+  prerelease: false
+  version_requirements: *2153555480
 description: isbn_validation adds an isbn validation routine to active record models.
 email: nap@zerosum.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - MIT-LICENSE
 - Rakefile
-- README
+- README.md
+- lib/isbn_validation/version.rb
 - lib/isbn_validation.rb
 - test/isbn_validation_test.rb
 - test/models.rb
@@ -42,33 +42,31 @@ files:
 has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --main
-- README
-require_paths: 
+- README.md
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: isbn_validation adds an isbn validation routine to active record models.
-test_files: 
+test_files:
 - test/isbn_validation_test.rb

data/README

@@ -1,27 +0,0 @@
-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