validatable 1.0.0

data/README

@@ -0,0 +1,117 @@
+= Validatable
+
+Validatable is a library for adding validations.
+
+by Jay[http://jayfields.blogspot.com] Fields[http://jayfields.blogspot.com]
+
+== Download and Installation
+
+You can download Validatable from here[http://rubyforge.org/projects/validatable] or install it with the following command.
+
+ $ gem install validatable
+
+== License
+ 	
+You may use, copy and redistribute this library under the same terms as Ruby itself (see http://www.ruby-lang.org/en/LICENSE.txt).
+
+== Examples
+
+See the tests for more 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
+    end
+
+=== Functional Tests
+
+    require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+    
+    class FunctionalTest < 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
+    
+      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 no acceptance, when validated, then error is in the objects error collection" do
+        klass = Class.new do
+          include Validatable
+          attr_accessor :name
+          validates_acceptance_of :name
+        end
+        instance = klass.new
+        instance.valid?
+        assert_equal "must be accepted", instance.errors.on(:name)
+      end
+      
+      test "given non matching attributes, when validated, then error is in the objects error collection" do
+        klass = Class.new do
+          include Validatable
+          attr_accessor :name, :name_confirmation
+          validates_confirmation_of :name
+        end
+        instance = klass.new
+        instance.name = "foo"
+        instance.name_confirmation = "bar"
+        instance.valid?
+        assert_equal "doesn't match confirmation", instance.errors.on(:name)
+      end
+    
+      test "given short value, when validated, then error is in the objects error collection" do
+        klass = Class.new do
+          include Validatable
+          attr_accessor :name
+          validates_length_of :name, :minimum => 2
+        end
+        instance = klass.new
+        instance.valid?
+        assert_equal "is invalid", instance.errors.on(:name)
+      end
+      
+      test "given a child class with validations, when parent class is validated, then the error is in the parent objects error collection" do
+        child_class = Class.new do
+          include Validatable
+          attr_accessor :name, :address
+          validates_presence_of :name
+          validates_format_of :address, :with => /.+/
+        end
+        klass = Class.new do
+          include Validatable
+          include_validations_for :child 
+          define_method :child do
+            child_class.new
+          end
+        end
+        instance = klass.new
+        instance.valid?
+        assert_equal "is invalid", instance.errors.on(:address)
+        assert_equal "can't be empty", instance.errors.on(:name)
+      end
+    end

data/lib/base.rb

@@ -0,0 +1,125 @@
+module Validatable
+  module ClassMethods
+    # call-seq: validates_format_of(*args)
+    # 
+    # Validates whether the value of the specified attribute is of the correct form by matching it against the regular expression provided.
+    # 
+    #   class Person < ActiveRecord::Base
+    #     validates_format_of :first_name, :with => /[ A-Za-z]/
+    #   end
+    # 
+    # A regular expression must be provided or else an exception will be raised.
+    def validates_format_of(*args)
+      validate_all(args) do |attribute, message, options|
+        self.validations << ValidatesFormatOf.new(attribute, options[:with], message || "is invalid")
+      end
+    end
+    
+    def validates_length_of(*args)
+      validate_all(args) do |attribute, message, options|
+        self.validations << ValidatesLengthOf.new(attribute, options[:minimum], options[:maximum], message || "is invalid")
+      end
+    end
+    
+    def validates_acceptance_of(*args)
+      validate_all(args) do |attribute, message, options|
+        self.validations << ValidatesAcceptanceOf.new(attribute, message || "must be accepted")
+      end
+    end
+
+    def validates_confirmation_of(*args)
+      validate_all(args) do |attribute, message, options|
+        self.validations << ValidatesConfirmationOf.new(attribute, message || "doesn't match confirmation")
+      end
+    end
+
+  
+    # call-seq: validates_presence_of(*args)
+    # 
+    # Validates that the specified attributes are not nil or an empty string
+    # 
+    #   class Person
+    #     include Validatable
+    #     validates_presence_of :first_name
+    #   end
+    #
+    # The first_name attribute must be in the object and it cannot be nil or empty.
+    def validates_presence_of(*args)
+      validate_all(args) do |attribute, message, options|
+        self.validations << ValidatesPresenceOf.new(attribute, message || "can't be empty")
+      end
+    end
+    
+    # call-seq: include_validations_for(*args)
+    # 
+    # Validates the specified attributes.
+    # 
+    #   class PersonPresenter
+    #     include Validatable
+    #     include_validations_for :person
+    #     attr_accessor :person
+    #     
+    #     def initialize(person)
+    #       @person = person
+    #     end
+    #   end
+    #
+    # 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)
+      children_to_validate.concat args
+    end
+    
+    def validate(instance) #:nodoc:
+      self.validations.each do |validation|
+        instance.errors.add(validation.attribute, validation.message) unless validation.valid?(instance)
+      end
+    end
+    
+    def validate_children(instance) #:nodoc:
+      self.children_to_validate.each do |child_name|
+        child = instance.send child_name
+        child.valid?
+        child.errors.each do |attribute, message|
+          instance.errors.add(attribute, message)
+        end
+      end
+    end
+
+    protected
+    def validate_all(args, &block) #:nodoc:
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      args.each do |attribute|
+        yield attribute, options[:message], options
+      end
+    end
+    
+    def children_to_validate #:nodoc:
+      @children_to_validate ||= []
+    end
+    
+    def validations #:nodoc:
+      @validations ||= []
+    end
+  end
+  
+  def self.included(klass) #:nodoc:
+    klass.extend Validatable::ClassMethods
+  end
+  
+  # call-seq: valid?
+  #
+  # Returns true if no errors were added otherwise false.
+  def valid?
+    errors.clear
+    self.class.validate(self)
+    self.class.validate_children(self)
+    errors.empty?
+  end
+  
+  # call-seq: errors
+  #
+  # Returns the Errors object that holds all information about attribute error messages.
+  def errors
+    @errors ||= Validatable::Errors.new
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,23 @@
+module Validatable
+  class Errors
+    extend Forwardable
+    
+    def_delegators :errors, :empty?, :clear, :each
+    
+    # call-seq: on(attribute)
+    # 
+    # Returns nil, if no errors are associated with the specified attribute.
+    # Returns the error message, if one error is associated with the specified attribute.
+    def on(attribute)
+      errors[attribute.to_sym]
+    end
+    
+    def add(attribute, message) #:nodoc:
+      errors[attribute.to_sym] = message
+    end
+
+    def errors #:nodoc:
+      @errors ||= {}
+    end
+  end
+end

data/lib/validatable.rb

@@ -0,0 +1,9 @@
+require 'forwardable'
+require File.expand_path(File.dirname(__FILE__) + '/errors')
+require File.expand_path(File.dirname(__FILE__) + '/base')
+require File.expand_path(File.dirname(__FILE__) + '/validation_base')
+require File.expand_path(File.dirname(__FILE__) + '/validates_format_of')
+require File.expand_path(File.dirname(__FILE__) + '/validates_presence_of')
+require File.expand_path(File.dirname(__FILE__) + '/validates_acceptance_of')
+require File.expand_path(File.dirname(__FILE__) + '/validates_confirmation_of')
+require File.expand_path(File.dirname(__FILE__) + '/validates_length_of')

data/lib/validates_acceptance_of.rb

@@ -0,0 +1,7 @@
+module Validatable
+  class ValidatesAcceptanceOf < ValidationBase #:nodoc:
+    def valid?(instance)
+      instance.send(self.attribute) == "true"
+    end
+  end
+end

data/lib/validates_confirmation_of.rb

@@ -0,0 +1,7 @@
+module Validatable
+  class ValidatesConfirmationOf < ValidationBase #:nodoc:
+    def valid?(instance)
+      instance.send(self.attribute) == instance.send("#{self.attribute}_confirmation".to_sym)
+    end
+  end
+end

data/lib/validates_format_of.rb

@@ -0,0 +1,13 @@
+module Validatable
+  class ValidatesFormatOf < ValidationBase #:nodoc:
+    attr_accessor :regex
+    def initialize(attribute, regex, message)
+      self.regex = regex
+      super attribute, message
+    end
+  
+    def valid?(instance)
+      instance.send(self.attribute) =~ self.regex && true
+    end
+  end
+end

data/lib/validates_length_of.rb

@@ -0,0 +1,18 @@
+module Validatable
+  class ValidatesLengthOf < ValidationBase #:nodoc:
+    attr_accessor :attribute, :minimum, :maximum
+    def initialize(attribute, minimum, maximum, message)
+      self.minimum = minimum
+      self.maximum = maximum
+      super attribute, message
+    end
+    
+    def valid?(instance)
+      valid = true
+      value = instance.send(self.attribute) || ""
+      valid &&= value.length <= maximum unless maximum.nil? 
+      valid &&= value.length >= minimum unless minimum.nil?
+      valid
+    end
+  end
+end

data/lib/validates_presence_of.rb

@@ -0,0 +1,7 @@
+module Validatable 
+  class ValidatesPresenceOf < ValidationBase #:nodoc:
+    def valid?(instance)
+      (!instance.send(self.attribute).nil? && instance.send(self.attribute).strip.length != 0)
+    end
+  end
+end

data/lib/validation_base.rb

@@ -0,0 +1,9 @@
+module Validatable
+  class ValidationBase #:nodoc:
+    attr_accessor :attribute, :message
+    
+    def initialize(attribute, message)
+      @attribute, @message = attribute, message
+    end
+  end
+end

data/rakefile.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/sshpublisher'
+
+task :default => :test
+
+task :test do
+  require File.dirname(__FILE__) + '/test/all_tests.rb'
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new do |task|
+  task.main = 'README'
+  task.title = 'Validatable'
+  task.rdoc_dir = 'doc'
+  task.options << "--line-numbers" << "--inline-source"
+  task.rdoc_files.include('README', 'lib/**/*.rb')
+  %x[erb README_TEMPLATE > README]
+end
+
+desc "Upload RDoc to RubyForge"
+task :publish_rdoc => [:rdoc] do
+  Rake::SshDirPublisher.new("jaycfields@rubyforge.org", "/var/www/gforge-projects/validatable", "doc").upload
+end
+
+Gem::manage_gems
+
+specification = Gem::Specification.new do |s|
+	s.name   = "validatable"
+  s.summary = "Validatable is a library for adding validations."
+	s.version = "1.0.0"
+	s.author = 'Jay Fields'
+	s.description = "Validatable is a library for adding validations."
+	s.email = 'validatable-developer@rubyforge.org'
+  s.homepage = 'http://validatable.rubyforge.org'
+  s.rubyforge_project = 'validatable'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README']
+  s.rdoc_options << '--title' << 'SQL DSL' << '--main' << 'README' << '--line-numbers'
+
+  s.autorequire = 'validatable'
+  s.files = FileList['{lib,test}/**/*.rb', '[A-Z]*$', 'rakefile.rb'].to_a
+	s.test_file = "test/all_tests.rb"
+end
+
+Rake::GemPackageTask.new(specification) do |package|
+	 package.need_zip = true
+	 package.need_tar = true
+end

data/test/all_tests.rb

@@ -0,0 +1 @@
+Dir['**/*_test.rb'].each { |test_case| require test_case }

data/test/errors_test.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ErrorsTest < Test::Unit::TestCase
+  test "when an error is added, then it can be returned from on" do
+    errors = Validatable::Errors.new
+    errors.add(:attribute, "message")
+    assert_equal "message", errors.on(:attribute)
+  end
+end

data/test/functional_test.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class FunctionalTest < 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
+
+  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 no acceptance, when validated, then error is in the objects error collection" do
+    klass = Class.new do
+      include Validatable
+      attr_accessor :name
+      validates_acceptance_of :name
+    end
+    instance = klass.new
+    instance.valid?
+    assert_equal "must be accepted", instance.errors.on(:name)
+  end
+  
+  test "given non matching attributes, when validated, then error is in the objects error collection" do
+    klass = Class.new do
+      include Validatable
+      attr_accessor :name, :name_confirmation
+      validates_confirmation_of :name
+    end
+    instance = klass.new
+    instance.name = "foo"
+    instance.name_confirmation = "bar"
+    instance.valid?
+    assert_equal "doesn't match confirmation", instance.errors.on(:name)
+  end
+
+  test "given short value, when validated, then error is in the objects error collection" do
+    klass = Class.new do
+      include Validatable
+      attr_accessor :name
+      validates_length_of :name, :minimum => 2
+    end
+    instance = klass.new
+    instance.valid?
+    assert_equal "is invalid", instance.errors.on(:name)
+  end
+  
+  test "given a child class with validations, when parent class is validated, then the error is in the parent objects error collection" do
+    child_class = Class.new do
+      include Validatable
+      attr_accessor :name, :address
+      validates_presence_of :name
+      validates_format_of :address, :with => /.+/
+    end
+    klass = Class.new do
+      include Validatable
+      include_validations_for :child 
+      define_method :child do
+        child_class.new
+      end
+    end
+    instance = klass.new
+    instance.valid?
+    assert_equal "is invalid", instance.errors.on(:address)
+    assert_equal "can't be empty", instance.errors.on(:name)
+  end
+end

data/test/test_helper.rb

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

data/test/validatable_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ValidatableTest < Test::Unit::TestCase
+  test "given a validation that returns false when object is validated then valid returns false" do
+    validation = stub(:valid? => false, :attribute => "attribute", :message => "message")
+    klass = Class.new do
+      include Validatable
+      validations << validation
+    end
+    assert_equal false, klass.new.valid?
+  end
+  
+  test "when validations are included for a child, then the list is maintained as an array of args" do
+    klass = Class.new do
+      include Validatable
+      include_validations_for :anything, :else
+    end
+    assert_equal [:anything, :else], klass.send(:children_to_validate)
+  end
+  
+  test "when validate is executed, then messages are added for each validation that fails" do
+    klass = Class.new do
+      include Validatable
+    end
+    klass.send(:validations) << stub(:valid? => false, :attribute => 'attribute', :message => 'message')
+    klass.send(:validations) << stub(:valid? => false, :attribute => 'attribute2', :message => 'message2')
+    instance=mock
+    instance.expects(:errors).returns(errors=mock).times 2
+    errors.expects(:add).with('attribute', 'message')
+    errors.expects(:add).with('attribute2', 'message2')
+    klass.validate(instance)
+  end
+
+  test "when valid is called, then the errors collection is cleared and reinitialized" do
+    klass = Class.new do
+      include Validatable
+    end
+    instance = klass.new
+    instance.errors.add(:attribute, "message")
+    instance.valid?
+    assert_equal true, instance.errors.empty?
+  end
+  
+end

data/test/validates_acceptance_of_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ValidatesAcceptanceOfTest < Test::Unit::TestCase
+  test "valid acceptance" do
+    validation = Validatable::ValidatesAcceptanceOf.new(:acceptance, :message)
+    instance = stub(:acceptance=>'true')
+    assert_equal true, validation.valid?(instance)
+  end
+  
+  test "invalid acceptance" do
+    validation = Validatable::ValidatesAcceptanceOf.new(:acceptance, :message)
+    instance = stub(:acceptance=>'false')
+    assert_equal false, validation.valid?(instance)
+  end
+end

data/test/validates_confirmation_of_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ValidatesConfirmationOfTest < Test::Unit::TestCase
+  test "valid confirmation" do
+    validation = Validatable::ValidatesConfirmationOf.new(:username, :message)
+    instance = stub(:username=>"username", :username_confirmation=>"username")
+    assert_equal true, validation.valid?(instance)
+  end
+  
+  test "invalid confirmation" do
+    validation = Validatable::ValidatesConfirmationOf.new(:username, :message)
+    instance = stub(:username=>"username", :username_confirmation=>"usessrname")
+    assert_equal false, validation.valid?(instance)
+  end
+end

data/test/validates_format_of_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ValidatesFormatOfTest < Test::Unit::TestCase
+  test "when attribute value does not match the given regex, then valid is false" do
+    validation = Validatable::ValidatesFormatOf.new(:name, /book/, "message")
+    assert_equal false, validation.valid?(stub_everything)
+  end
+  
+  test "when attribute value does match the given regex, then valid is true" do
+    validation = Validatable::ValidatesFormatOf.new(:name, /book/, "message")
+    assert_equal true, validation.valid?(stub(:name=>"book"))
+  end
+end

data/test/validates_length_of_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ValidatesLengthOfTest < Test::Unit::TestCase
+  
+  test "max length" do
+    validation = Validatable::ValidatesLengthOf.new(:username,  nil, 8, :message)
+    instance = stub(:username=>"usernamefdfd")
+    assert_equal false, validation.valid?(instance)
+  end
+    
+  test "min length" do
+    validation = Validatable::ValidatesLengthOf.new(:username,  2, nil, :message)
+    instance = stub(:username=>"u")
+    assert_equal false, validation.valid?(instance)
+  end
+  
+  test "valid length" do
+    validation = Validatable::ValidatesLengthOf.new(:username,  2, 8, :message)
+    instance = stub(:username=>"udfgdf")
+    assert_equal true, validation.valid?(instance)
+  end
+end
+

data/test/validates_presence_of_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ValidatesPresenceOfTest < Test::Unit::TestCase
+  test "when attribute value does not match the given regex, then valid is false" do
+    validation = Validatable::ValidatesPresenceOf.new(:name, "message")
+    assert_equal false, validation.valid?(stub_everything)
+  end
+  
+  test "when attribute value does match the given regex, then valid is true" do
+    validation = Validatable::ValidatesPresenceOf.new(:name, "message")
+    assert_equal true, validation.valid?(stub(:name=>"book"))
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: validatable
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-02-03 00:00:00 -05:00
+summary: Validatable is a library for adding validations.
+require_paths: 
+- lib
+email: validatable-developer@rubyforge.org
+homepage: http://validatable.rubyforge.org
+rubyforge_project: validatable
+description: Validatable is a library for adding validations.
+autorequire: validatable
+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: 
+authors: 
+- Jay Fields
+files: 
+- lib/base.rb
+- lib/errors.rb
+- lib/validatable.rb
+- lib/validates_acceptance_of.rb
+- lib/validates_confirmation_of.rb
+- lib/validates_format_of.rb
+- lib/validates_length_of.rb
+- lib/validates_presence_of.rb
+- lib/validation_base.rb
+- test/all_tests.rb
+- test/errors_test.rb
+- test/functional_test.rb
+- test/test_helper.rb
+- test/validatable_test.rb
+- test/validates_acceptance_of_test.rb
+- test/validates_confirmation_of_test.rb
+- test/validates_format_of_test.rb
+- test/validates_length_of_test.rb
+- test/validates_presence_of_test.rb
+- rakefile.rb
+- README
+test_files: 
+- test/all_tests.rb
+rdoc_options: 
+- --title
+- SQL DSL
+- --main
+- README
+- --line-numbers
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+