activemodel 3.0.0.beta

data/lib/active_model/validations/presence.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext/object/blank'
+
+module ActiveModel
+  module Validations
+    class PresenceValidator < EachValidator
+      def validate(record)
+        record.errors.add_on_blank(attributes, options[:message])
+      end
+    end
+
+    module ClassMethods
+      # Validates that the specified attributes are not blank (as defined by Object#blank?). Happens by default on save. Example:
+      #
+      #   class Person < ActiveRecord::Base
+      #     validates_presence_of :first_name
+      #   end
+      #
+      # The first_name attribute must be in the object and it cannot be blank.
+      #
+      # If you want to validate the presence of a boolean field (where the real values are true and false),
+      # you will want to use <tt>validates_inclusion_of :field_name, :in => [true, false]</tt>.
+      #
+      # This is due to the way Object#blank? handles boolean values: <tt>false.blank? # => true</tt>.
+      #
+      # Configuration options:
+      # * <tt>message</tt> - A custom error message (default is: "can't be blank").
+      # * <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_presence_of(*attr_names)
+        validates_with PresenceValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/active_model/validations/validates.rb

@@ -0,0 +1,108 @@
+require 'active_support/core_ext/hash/slice'
+
+module ActiveModel
+  module Validations
+    module ClassMethods
+      # This method is a shortcut to all default validators and any custom
+      # validator classes ending in 'Validator'. Note that Rails default
+      # validators can be overridden inside specific classes by creating
+      # custom validator classes in their place such as PresenceValidator.
+      # 
+      # Examples of using the default rails validators:
+      #
+      #   validates :terms, :acceptance => true
+      #   validates :password, :confirmation => true
+      #   validates :username, :exclusion => { :in => %w(admin superuser) }
+      #   validates :email, :format => { :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :on => :create }
+      #   validates :age, :inclusion => { :in => 0..9 }
+      #   validates :first_name, :length => { :maximum => 30 }
+      #   validates :age, :numericality => true
+      #   validates :username, :presence => true
+      #   validates :username, :uniqueness => true
+      # 
+      # The power of the +validates+ method comes when using cusom validators
+      # and default validators in one call for a given attribute e.g.
+      #
+      #   class EmailValidator < ActiveModel::EachValidator
+      #     def validate_each(record, attribute, value)
+      #       record.errors[attribute] << (options[:message] || "is not an email") unless
+      #         value =~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+      #     end
+      #   end
+      # 
+      #   class Person
+      #     include ActiveModel::Validations
+      #     attr_accessor :name, :email
+      # 
+      #     validates :name, :presence => true, :uniqueness => true, :length => { :maximum => 100 }
+      #     validates :email, :presence => true, :email => true
+      #   end
+      # 
+      # Validator classes my also exist within the class being validated
+      # allowing custom modules of validators to be included as needed e.g.
+      #
+      #   class Film
+      #     include ActiveModel::Validations
+      #
+      #     class TitleValidator < ActiveModel::EachValidator
+      #       def validate_each(record, attribute, value)
+      #         record.errors[attribute] << "must start with 'the'" unless =~ /^the/i
+      #       end
+      #     end
+      #
+      #     validates :name, :title => true
+      #   end
+      #
+      # The validators hash can also handle regular expressions, ranges and arrays:
+      #
+      #   validates :email, :format => /@/
+      #   validates :gender, :inclusion => %w(male female)
+      #   validates :password, :length => 6..20
+      #
+      # Finally, the options :if, :unless, :on, :allow_blank and :allow_nil can be given
+      # to one specific validator:
+      #
+      #   validates :password, :presence => { :if => :password_required? }, :confirmation => true
+      #
+      # Or to all at the same time:
+      #
+      #   validates :password, :presence => true, :confirmation => true, :if => :password_required?
+      #
+      def validates(*attributes)
+        defaults = attributes.extract_options!
+        validations = defaults.slice!(:if, :unless, :on, :allow_blank, :allow_nil)
+
+        raise ArgumentError, "You need to supply at least one attribute" if attributes.empty?
+        raise ArgumentError, "Attribute names must be symbols" if attributes.any?{ |attribute| !attribute.is_a?(Symbol) }
+        raise ArgumentError, "You need to supply at least one validation" if validations.empty?
+
+        defaults.merge!(:attributes => attributes)
+
+        validations.each do |key, options|
+          begin
+            validator = const_get("#{key.to_s.camelize}Validator")
+          rescue NameError
+            raise ArgumentError, "Unknown validator: '#{key}'"
+          end
+
+          validates_with(validator, defaults.merge(_parse_validates_options(options)))
+        end
+      end
+
+    protected
+
+      def _parse_validates_options(options) #:nodoc:
+        case options
+        when TrueClass
+          {}
+        when Hash
+          options
+        when Regexp
+          { :with => options }
+        when Range, Array
+          { :in => options }
+        end
+      end
+    end
+  end
+end

data/lib/active_model/validations/with.rb

@@ -0,0 +1,70 @@
+module ActiveModel
+  module Validations
+    module ClassMethods
+
+      # Passes the record off to the class or classes specified and allows them
+      # to add errors based on more complex conditions.
+      #
+      #   class Person
+      #     include ActiveModel::Validations
+      #     validates_with MyValidator
+      #   end
+      #
+      #   class MyValidator < ActiveModel::Validator
+      #     def validate(record)
+      #       if some_complex_logic
+      #         record.errors[:base] << "This record is invalid"
+      #       end
+      #     end
+      #
+      #     private
+      #       def some_complex_logic
+      #         # ...
+      #       end
+      #   end
+      #
+      # You may also pass it multiple classes, like so:
+      #
+      #   class Person
+      #     include ActiveModel::Validations
+      #     validates_with MyValidator, MyOtherValidator, :on => :create
+      #   end
+      #
+      # Configuration options:
+      # * <tt>on</tt> - Specifies when this validation is active
+      #   (<tt>:create</tt> or <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.
+      #
+      # If you pass any additional configuration options, they will be passed
+      # to the class and available as <tt>options</tt>:
+      #
+      #   class Person
+      #     include ActiveModel::Validations
+      #     validates_with MyValidator, :my_custom_key => "my custom value"
+      #   end
+      #
+      #   class MyValidator < ActiveModel::Validator
+      #     def validate(record)
+      #       options[:my_custom_key] # => "my custom value"
+      #     end
+      #   end
+      #
+      def validates_with(*args, &block)
+        options = args.extract_options!
+        args.each do |klass|
+          validator = klass.new(options, &block)
+          validator.setup(self) if validator.respond_to?(:setup)
+          validate(validator, options)
+        end
+      end
+    end
+  end
+end

data/lib/active_model/validator.rb

@@ -0,0 +1,160 @@
+module ActiveModel #:nodoc:
+  # A simple base class that can be used along with 
+  # +ActiveModel::Validations::ClassMethods.validates_with+
+  #
+  #   class Person
+  #     include ActiveModel::Validations
+  #     validates_with MyValidator
+  #   end
+  #
+  #   class MyValidator < ActiveModel::Validator
+  #     def validate(record)
+  #       if some_complex_logic
+  #         record.errors[:base] = "This record is invalid"
+  #       end
+  #     end
+  #
+  #     private
+  #       def some_complex_logic
+  #         # ...
+  #       end
+  #   end
+  #
+  # Any class that inherits from ActiveModel::Validator must implement a method
+  # called <tt>validate</tt> which accepts a <tt>record</tt>.
+  #
+  #   class Person
+  #     include ActiveModel::Validations
+  #     validates_with MyValidator
+  #   end
+  #
+  #   class MyValidator < ActiveModel::Validator
+  #     def validate(record)
+  #       record # => The person instance being validated
+  #       options # => Any non-standard options passed to validates_with
+  #     end
+  #   end
+  #
+  # To cause a validation error, you must add to the <tt>record<tt>'s errors directly
+  # from within the validators message
+  #
+  #   class MyValidator < ActiveModel::Validator
+  #     def validate(record)
+  #       record.errors[:base] << "This is some custom error message"
+  #       record.errors[:first_name] << "This is some complex validation"
+  #       # etc...
+  #     end
+  #   end
+  #
+  # To add behavior to the initialize method, use the following signature:
+  #
+  #   class MyValidator < ActiveModel::Validator
+  #     def initialize(record, options)
+  #       super
+  #       @my_custom_field = options[:field_name] || :first_name
+  #     end
+  #   end
+  # 
+  # The easiest way to add custom validators for validating individual attributes
+  # is with the convenient ActiveModel::EachValidator for example:
+  # 
+  #   class TitleValidator < ActiveModel::EachValidator
+  #     def validate_each(record, attribute, value)
+  #       record.errors[attribute] << 'must be Mr. Mrs. or Dr.' unless ['Mr.', 'Mrs.', 'Dr.'].include?(value)
+  #     end
+  #   end
+  # 
+  # This can now be used in combination with the +validates+ method
+  # (see ActiveModel::Validations::ClassMethods.validates for more on this)
+  # 
+  #   class Person
+  #     include ActiveModel::Validations
+  #     attr_accessor :title
+  # 
+  #     validates :title, :presence => true, :title => true
+  #   end
+  # 
+  # Validator may also define a +setup+ instance method which will get called
+  # with the class that using that validator as it's argument. This can be
+  # useful when there are prerequisites such as an attr_accessor being present
+  # for example:
+  # 
+  #   class MyValidator < ActiveModel::Validator
+  #     def setup(klass)
+  #       klass.send :attr_accessor, :custom_attribute
+  #     end
+  #   end
+  # 
+  class Validator
+    attr_reader :options
+
+    # Accepts options that will be made availible through the +options+ reader.
+    def initialize(options)
+      @options = options
+    end
+
+    # Override this method in subclasses with validation logic, adding errors
+    # to the records +errors+ array where necessary.
+    def validate(record)
+      raise NotImplementedError
+    end
+  end
+
+  # EachValidator is a validator which iterates through the attributes given
+  # in the options hash invoking the validate_each method passing in the
+  # record, attribute and value.
+  #
+  # All ActiveModel validations are built on top of this Validator.
+  class EachValidator < Validator
+    attr_reader :attributes
+    
+    # Returns a new validator instance. All options will be available via the
+    # +options+ reader, however the <tt>:attributes</tt> option will be removed
+    # and instead be made available through the +attributes+ reader.
+    def initialize(options)
+      @attributes = Array(options.delete(:attributes))
+      raise ":attributes cannot be blank" if @attributes.empty?
+      super
+      check_validity!
+    end
+
+    # Performs validation on the supplied record. By default this will call
+    # +validates_each+ to determine validity therefore subclasses should
+    # override +validates_each+ with validation logic.
+    def validate(record)
+      attributes.each do |attribute|
+        value = record.read_attribute_for_validation(attribute)
+        next if (value.nil? && options[:allow_nil]) || (value.blank? && options[:allow_blank])
+        validate_each(record, attribute, value)
+      end
+    end
+
+    # Override this method in subclasses with the validation logic, adding
+    # errors to the records +errors+ array where necessary.
+    def validate_each(record, attribute, value)
+      raise NotImplementedError
+    end
+
+    # Hook method that gets called by the initializer allowing verification
+    # that the arguments supplied are valid. You could for example raise an
+    # ArgumentError when invalid options are supplied.
+    def check_validity!
+    end
+  end
+
+  # BlockValidator is a special EachValidator which receives a block on initialization
+  # and call this block for each attribute being validated. +validates_each+ uses this
+  # Validator.
+  class BlockValidator < EachValidator
+    def initialize(options, &block)
+      @block = block
+      super
+    end
+
+    private
+
+    def validate_each(record, attribute, value)
+      @block.call(record, attribute, value)
+    end
+  end
+end

data/lib/active_model/version.rb

@@ -0,0 +1,9 @@
+module ActiveModel
+  module VERSION #:nodoc:
+    MAJOR = 3
+    MINOR = 0
+    TINY  = "0.beta"
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: activemodel
+version: !ruby/object:Gem::Version 
+  version: 3.0.0.beta
+platform: ruby
+authors: 
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-03 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0.beta
+    version: 
+description: Extracts common modeling concerns from ActiveRecord to share between similar frameworks like ActiveResource.
+email: david@loudthinking.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- README
+- lib/active_model/attribute_methods.rb
+- lib/active_model/callbacks.rb
+- lib/active_model/conversion.rb
+- lib/active_model/deprecated_error_methods.rb
+- lib/active_model/dirty.rb
+- lib/active_model/errors.rb
+- lib/active_model/lint.rb
+- lib/active_model/locale/en.yml
+- lib/active_model/naming.rb
+- lib/active_model/observing.rb
+- lib/active_model/railtie.rb
+- lib/active_model/serialization.rb
+- lib/active_model/serializers/json.rb
+- lib/active_model/serializers/xml.rb
+- lib/active_model/test_case.rb
+- lib/active_model/translation.rb
+- lib/active_model/validations/acceptance.rb
+- lib/active_model/validations/confirmation.rb
+- lib/active_model/validations/exclusion.rb
+- lib/active_model/validations/format.rb
+- lib/active_model/validations/inclusion.rb
+- lib/active_model/validations/length.rb
+- lib/active_model/validations/numericality.rb
+- lib/active_model/validations/presence.rb
+- lib/active_model/validations/validates.rb
+- lib/active_model/validations/with.rb
+- lib/active_model/validations.rb
+- lib/active_model/validator.rb
+- lib/active_model/version.rb
+- lib/active_model.rb
+has_rdoc: true
+homepage: http://www.rubyonrails.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: activemodel
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A toolkit for building other modeling frameworks like ActiveRecord
+test_files: []
+