validatable 1.1.0 → 1.1.1

data/README

@@ -16,79 +16,61 @@ You may use, copy and redistribute this library under the same terms as Ruby its
 
 == Examples
 
-=== Test Helper
-
-    require 'test/unit'
-    require 'rubygems'
-    require 'mocha'
-    require File.dirname(__FILE__) + '/../lib/validatable'
-    
-    class << Test::Unit::TestCase
-      def test(name, &block)
-        test_name = :"test_#{name.gsub(' ','_')}"
-        raise ArgumentError, "#{test_name} is already defined" if self.instance_methods.include? test_name.to_s
-        define_method test_name, &block
-      end
-      
-      def expect(expected_value, &block)
-        define_method :"test_#{caller.first.split("/").last}" do
-          assert_equal expected_value, instance_eval(&block)
-        end 
-      end
-    end
-
-=== Validations
-
-    require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-    
-    module Functional
-      class ValidatesPresenceOfTest < Test::Unit::TestCase
-        test "given no name, when validated, then error is in the objects error collection" do
-          klass = Class.new do
-            include Validatable
-            attr_accessor :name
-            validates_presence_of :name
-          end
-          instance = klass.new
-          instance.valid?
-          assert_equal "can't be empty", instance.errors.on(:name)
-        end
-      end
-    end
-
-    require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-    
-    module Functional
-      class ValidatesFormatOfTest < Test::Unit::TestCase
-        test "given invalid name format, when validated, then error is in the objects error collection" do
-          klass = Class.new do
-            include Validatable
-            attr_accessor :name
-            validates_format_of :name, :with => /.+/
-          end
-          instance = klass.new
-          instance.valid?
-          assert_equal "is invalid", instance.errors.on(:name)
-        end
-    
-        test "given invalid name format and nil name, when validated, then error is in the objects error collection" do
-          klass = Class.new do
-            include Validatable
-            attr_accessor :name
-            validates_format_of :name, :with => /.+/, :if => Proc.new { !name.nil? }
-          end
-          assert_equal true, klass.new.valid?
-        end
-        
-        test "given invalid name format and a name, when validated, then error is in the objects error collection" do
-          klass = Class.new do
-            include Validatable
-            attr_accessor :name
-            validates_format_of :name, :with => /.+/, :if => Proc.new { name.nil? }
-          end
-          assert_equal false, klass.new.valid?
-        end
-      end
-    end
+Validation of an entire hierarchy of objects with errors aggregated at the root object.
+
+	class Person
+	  include Validatable
+	  validates_presence_of :name
+	  attr_accessor :name
+	end
+
+	class PersonPresenter
+	  include Validatable
+	  include_validations_for :person
+	  attr_accessor :person
+  
+	  def initialize(person)
+	    @person = person
+	  end
+	end
+
+	presenter = PersonPresenter.new(Person.new)
+	presenter.valid? #=> false
+	presenter.errors.on(:name) #=> "can't be blank"
+
+Validations that turn off after X times of failed attempts.
+
+	class Person
+	  include Validatable
+	  validates_presence_of :name, :times => 1
+	  attr_accessor :name
+	end
+
+	person = Person.new
+	person.valid? #=> false
+	person.valid? #=> true
+
+Validations can be given levels. If a validation fails on a level the validations for subsequent levels will not be executed.
+
+	class Person
+	  include Validatable
+	  validates_presence_of :name, :level => 1, :message => "name message"
+	  validates_presence_of :address, :level => 2
+	  attr_accessor :name, :address
+	end
+
+	person = Person.new
+	person.valid? #=> false
+	person.errors.on(:name) #=> "name message"
+	person.errors.on(:address) #=> nil
+
+Similar to Rails, Validatable also supports conditional validation.
+
+	class Person
+	  include Validatable
+	  attr_accessor :name
+	  validates_format_of :name, :with => /.+/, :if => Proc.new { !name.nil? }
+	end
+	Person.new.valid? #=> true
 
 See the tests for more examples

data/lib/base.rb

@@ -10,6 +10,14 @@ module Validatable
     #   end
     # 
     # A regular expression must be provided or else an exception will be raised.
+    # 
+    # Configuration options:
+    # 
+    #     * message - The message to add to the errors collection when the validation fails
+    #     * times - The number of times the validation applies
+    #     * level - The level at which the validation should occur
+    #     * if - A block that when executed must return true of the validation will not occur
+    #     * with - The regular expression used to validate the format
     def validates_format_of(*args)
       add_validations(args, ValidatesFormatOf) do |validation, options|
         validation.with = options[:with]
@@ -28,6 +36,10 @@ module Validatable
     # 
     # Configuration options:
     # 
+    #     * message - The message to add to the errors collection when the validation fails
+    #     * times - The number of times the validation applies
+    #     * level - The level at which the validation should occur
+    #     * if - A block that when executed must return true of the validation will not occur
     #     * minimum - The minimum size of the attribute
     #     * maximum - The maximum size of the attribute
     def validates_length_of(*args)
@@ -46,6 +58,13 @@ module Validatable
     #     validates_acceptance_of :terms_of_service
     #     validates_acceptance_of :eula, :message => "must be abided"
     #   end
+    #
+    # Configuration options:
+    # 
+    #     * message - The message to add to the errors collection when the validation fails
+    #     * times - The number of times the validation applies
+    #     * level - The level at which the validation should occur
+    #     * if - A block that when executed must return true of the validation will not occur
     def validates_acceptance_of(*args)
       add_validations(args, ValidatesAcceptanceOf)
     end
@@ -64,6 +83,13 @@ module Validatable
     #   View:
     #     <%= password_field "person", "password" %>
     #     <%= password_field "person", "password_confirmation" %>
+    #
+    # Configuration options:
+    # 
+    #     * message - The message to add to the errors collection when the validation fails
+    #     * times - The number of times the validation applies
+    #     * level - The level at which the validation should occur
+    #     * if - A block that when executed must return true of the validation will not occur
     def validates_confirmation_of(*args)
       add_validations(args, ValidatesConfirmationOf)
     end
@@ -78,6 +104,13 @@ module Validatable
     #   end
     #
     # The first_name attribute must be in the object and it cannot be nil or empty.
+    #
+    # Configuration options:
+    # 
+    #     * message - The message to add to the errors collection when the validation fails
+    #     * times - The number of times the validation applies
+    #     * level - The level at which the validation should occur
+    #     * if - A block that when executed must return true of the validation will not occur
     def validates_presence_of(*args)
       add_validations(args, ValidatesPresenceOf)
     end
@@ -85,6 +118,11 @@ module Validatable
     # call-seq: include_validations_for(*args)
     # 
     # Validates the specified attributes.
+    #   class Person
+    #     include Validatable
+    #     validates_presence_of :name
+    #     attr_accessor :name
+    #   end
     # 
     #   class PersonPresenter
     #     include Validatable
@@ -95,6 +133,10 @@ module Validatable
     #       @person = person
     #     end
     #   end
+    #   
+    #   presenter = PersonPresenter.new(Person.new)
+    #   presenter.valid? #=> false
+    #   presenter.errors.on(:name) #=> "can't be blank"
     #
     # The person attribute will be validated.  If person is invalid the errors will be added to the PersonPresenter errors collection.
     def include_validations_for(*args)
@@ -123,6 +165,10 @@ module Validatable
       end
     end
 
+    def validations #:nodoc:
+      @validations ||= []
+    end
+
     protected
     def add_validations(args, klass) #:nodoc:
       options = args.last.is_a?(Hash) ? args.pop : {}
@@ -136,10 +182,6 @@ module Validatable
     def children_to_validate #:nodoc:
       @children_to_validate ||= []
     end
-    
-    def validations #:nodoc:
-      @validations ||= []
-    end
   end
   
   def self.included(klass) #:nodoc:
@@ -151,8 +193,8 @@ module Validatable
   # Returns true if no errors were added otherwise false.
   def valid?
     errors.clear
-    self.class.validate(self)
     self.class.validate_children(self)
+    self.validate
     errors.empty?
   end
   
@@ -162,4 +204,28 @@ module Validatable
   def errors
     @errors ||= Validatable::Errors.new
   end
+  
+  protected
+  def validate #:nodoc:
+    validation_levels.sort.each do |level|
+      validations_for_level(level).each do |validation|
+        if validation.should_validate?(self)
+          self.errors.add(validation.attribute, validation.message) unless validation.valid?(self)
+        end
+      end
+      return unless self.errors.empty?
+    end
+  end
+  
+  def validation_levels #:nodoc:
+    self.validations.collect { |validation| validation.level }.uniq
+  end
+  
+  def validations_for_level(level) #:nodoc:
+    self.validations.select { |validation| validation.level == level }
+  end
+  
+  def validations #:nodoc:
+    @validations ||= self.class.validations.collect { |validation| validation.dup }
+  end
 end

data/rakefile.rb

@@ -29,7 +29,7 @@ Gem::manage_gems
 specification = Gem::Specification.new do |s|
 	s.name   = "validatable"
   s.summary = "Validatable is a library for adding validations."
-	s.version = "1.1.0"
+	s.version = "1.1.1"
 	s.author = 'Jay Fields'
 	s.description = "Validatable is a library for adding validations."
 	s.email = 'validatable-developer@rubyforge.org'

data/test/functional/validatable_test.rb

@@ -33,6 +33,18 @@ module Functional
       instance.valid?
     end
     
+    expect false do
+      klass = Class.new do
+        include Validatable
+        validates_presence_of :name, :times => 1
+        attr_accessor :name
+      end
+      instance1 = klass.new
+      instance1.valid?
+      instance2 = klass.new
+      instance2.valid?
+    end
+    
     expect "name message" do
       klass = Class.new do
         include Validatable

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: validatable
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2007-02-11 00:00:00 -05:00
+  version: 1.1.1
+date: 2007-02-13 00:00:00 -05:00
 summary: Validatable is a library for adding validations.
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Jay Fields
 files: