activemodel 3.0.20 → 3.1.0.beta1

data/lib/active_model/translation.rb

@@ -18,12 +18,12 @@ module ActiveModel
   #
   # This also provides the required class methods for hooking into the
   # Rails internationalization API, including being able to define a
-  # class based i18n_scope and lookup_ancestors to find translations in
+  # class based +i18n_scope+ and +lookup_ancestors+ to find translations in
   # parent classes.
   module Translation
     include ActiveModel::Naming
 
-    # Returns the i18n_scope for the class. Overwrite if you want custom lookup.
+    # Returns the +i18n_scope+ for the class. Overwrite if you want custom lookup.
     def i18n_scope
       :activemodel
     end
@@ -44,9 +44,8 @@ module ActiveModel
     # Specify +options+ with additional translating options.
     def human_attribute_name(attribute, options = {})
       defaults = lookup_ancestors.map do |klass|
-        [:"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key}.#{attribute}",
-         :"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key.to_s.tr('.', '/')}.#{attribute}"]
-      end.flatten
+        :"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key}.#{attribute}"
+      end
 
       defaults << :"attributes.#{attribute}"
       defaults << options.delete(:default) if options[:default]
@@ -55,11 +54,5 @@ module ActiveModel
       options.reverse_merge! :count => 1, :default => defaults
       I18n.translate(defaults.shift, options)
     end
-
-    # Model.human_name is deprecated. Use Model.model_name.human instead.
-    def human_name(*args)
-      ActiveSupport::Deprecation.warn("human_name has been deprecated, please use model_name.human instead", caller[0,5])
-      model_name.human(*args)
-    end
   end
 end

data/lib/active_model/validations.rb

@@ -36,8 +36,8 @@ module ActiveModel
   #   person.invalid?                 # => true
   #   person.errors                   # => #<OrderedHash {:first_name=>["starts with z."]}>
   #
-  # Note that ActiveModel::Validations automatically adds an +errors+ method
-  # to your instances initialized with a new ActiveModel::Errors object, so
+  # Note that <tt>ActiveModel::Validations</tt> automatically adds an +errors+ method
+  # to your instances initialized with a new <tt>ActiveModel::Errors</tt> object, so
   # there is no need for you to do this manually.
   #
   module Validations
@@ -71,8 +71,8 @@ module ActiveModel
       #   end
       #
       # Options:
-      # * <tt>:on</tt> - Specifies when this validation is active (default is
-      #   <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
+      # * <tt>:on</tt> - Specifies the context where this validation is active
+      #   (e.g. <tt>:on => :create</tt> or <tt>:on => :custom_validation_context</tt>)
       # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+.
       # * <tt>:allow_blank</tt> - Skip validation if attribute is blank.
       # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
@@ -104,7 +104,7 @@ module ActiveModel
       #     end
       #   end
       #
-      # Or with a block which is passed with the current record to be validated:
+      # With a block which is passed with the current record to be validated:
       #
       #   class Comment
       #     include ActiveModel::Validations
@@ -114,7 +114,17 @@ module ActiveModel
       #     end
       #
       #     def must_be_friends
-      #       errors.add(:base, ("Must be friends to leave a comment") unless commenter.friend_of?(commentee)
+      #       errors.add(:base, "Must be friends to leave a comment") unless commenter.friend_of?(commentee)
+      #     end
+      #   end
+      #
+      # Or with a block where self points to the current record to be validated:
+      #
+      #   class Comment
+      #     include ActiveModel::Validations
+      #
+      #     validate do
+      #       errors.add(:base, "Must be friends to leave a comment") unless commenter.friend_of?(commentee)
       #     end
       #   end
       #
@@ -123,24 +133,12 @@ module ActiveModel
         if options.key?(:on)
           options = options.dup
           options[:if] = Array.wrap(options[:if])
-          options[:if] << "validation_context == :#{options[:on]}"
+          options[:if].unshift("validation_context == :#{options[:on]}")
         end
         args << options
         set_callback(:validate, *args, &block)
       end
 
-      [:create, :update].each do |type|
-        class_eval <<-RUBY
-          def validate_on_#{type}(*args, &block)
-            msg = "validate_on_#{type} is deprecated. Please use validate(args, :on => :#{type})"
-            ActiveSupport::Deprecation.warn(msg, caller)
-            options = args.extract_options!
-            options[:on] = :#{type}
-            validate(*args.push(options), &block)
-          end
-        RUBY
-      end
-
       # List all validators that are being used to validate the model using
       # +validates_with+ method.
       def validators
@@ -148,8 +146,10 @@ module ActiveModel
       end
 
       # List all validators that being used to validate a specific attribute.
-      def validators_on(attribute)
-        _validators[attribute.to_sym]
+      def validators_on(*attributes)
+        attributes.map do |attribute|
+          _validators[attribute.to_sym]
+        end.flatten
       end
 
       # Check if method is an attribute method or not.
@@ -165,7 +165,7 @@ module ActiveModel
       end
     end
 
-    # Returns the Errors object that holds all information about attribute error messages.
+    # Returns the +Errors+ object that holds all information about attribute error messages.
     def errors
       @errors ||= Errors.new(self)
     end
@@ -209,7 +209,7 @@ module ActiveModel
   protected
 
     def run_validations!
-      _run_validate_callbacks
+      run_callbacks :validate
       errors.empty?
     end
   end

data/lib/active_model/validations/acceptance.rb

@@ -14,8 +14,6 @@ module ActiveModel
       end
 
       def setup(klass)
-        # Note: instance_methods.map(&:to_s) is important for 1.9 compatibility
-        # as instance_methods returns symbols unlike 1.8 which returns strings.
         attr_readers = attributes.reject { |name| klass.attribute_method?(name) }
         attr_writers = attributes.reject { |name| klass.attribute_method?("#{name}=") }
         klass.send(:attr_reader, *attr_readers)
@@ -39,9 +37,9 @@ module ActiveModel
       # Configuration options:
       # * <tt>:message</tt> - A custom error message (default is: "must be
       #   accepted").
-      # * <tt>:on</tt> - Specifies when this validation is active (default is
-      #   <tt>:save</tt>, other options are <tt>:create</tt> and
-      #   <tt>:update</tt>).
+      # * <tt>:on</tt> - Specifies when this validation is active. Runs in all
+      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
+      #   and <tt>:update</tt>.
       # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default
       #   is true).
       # * <tt>:accept</tt> - Specifies value that is considered accepted.

data/lib/active_model/validations/callbacks.rb

@@ -28,12 +28,12 @@ module ActiveModel
 
       module ClassMethods
         def before_validation(*args, &block)
-          options = args.extract_options!
+          options = args.last
           if options.is_a?(Hash) && options[:on]
             options[:if] = Array.wrap(options[:if])
-            options[:if] << "self.validation_context == :#{options[:on]}"
+            options[:if].unshift("self.validation_context == :#{options[:on]}")
           end
-          set_callback(:validation, :before, *(args << options), &block)
+          set_callback(:validation, :before, *args, &block)
         end
 
         def after_validation(*args, &block)
@@ -41,30 +41,16 @@ module ActiveModel
           options[:prepend] = true
           options[:if] = Array.wrap(options[:if])
           options[:if] << "!halted"
-          options[:if] << "self.validation_context == :#{options[:on]}" if options[:on]
+          options[:if].unshift("self.validation_context == :#{options[:on]}") if options[:on]
           set_callback(:validation, :after, *(args << options), &block)
         end
-
-        [:before, :after].each do |type|
-          [:create, :update].each do |on|
-            class_eval <<-RUBY
-              def #{type}_validation_on_#{on}(*args, &block)
-                msg = "#{type}_validation_on_#{on} is deprecated. Please use #{type}_validation(arguments, :on => :#{on}"
-                ActiveSupport::Deprecation.warn(msg, caller)
-                options = args.extract_options!
-                options[:on] = :#{on}
-                before_validation(*args.push(options), &block)
-              end
-            RUBY
-          end
-        end
       end
 
     protected
 
       # Overwrite run validations to include callbacks.
       def run_validations!
-        _run_validation_callbacks { super }
+        run_callbacks(:validation) { super }
       end
     end
   end

data/lib/active_model/validations/confirmation.rb

@@ -4,9 +4,9 @@ module ActiveModel
   module Validations
     class ConfirmationValidator < EachValidator
       def validate_each(record, attribute, value)
-        confirmed = record.send(:"#{attribute}_confirmation")
-        return if confirmed.nil? || value == confirmed
-        record.errors.add(attribute, :confirmation, options)
+        if (confirmed = record.send("#{attribute}_confirmation")) && (value != confirmed)
+          record.errors.add(attribute, :confirmation, options)
+        end
       end
 
       def setup(klass)
@@ -45,8 +45,9 @@ module ActiveModel
       # Configuration options:
       # * <tt>:message</tt> - A custom error message (default is: "doesn't match
       #   confirmation").
-      # * <tt>:on</tt> - Specifies when this validation is active (default is
-      #   <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
+      # * <tt>:on</tt> - Specifies when this validation is active. Runs in all
+      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
+      #   and <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

data/lib/active_model/validations/exclusion.rb

@@ -1,18 +1,35 @@
+require 'active_support/core_ext/range.rb'
+
 module ActiveModel
 
   # == Active Model Exclusion Validator
   module Validations
     class ExclusionValidator < EachValidator
+      ERROR_MESSAGE = "An object with the method #include? or a proc or lambda is required, " <<
+                      "and must be supplied as the :in option of the configuration hash"
+
       def check_validity!
-        raise ArgumentError, "An object with the method include? is required must be supplied as the " <<
-                             ":in option of the configuration hash" unless options[:in].respond_to?(:include?)
+        unless [:include?, :call].any? { |method| options[:in].respond_to?(method) }
+          raise ArgumentError, ERROR_MESSAGE
+        end
       end
 
       def validate_each(record, attribute, value)
-        if options[:in].include?(value)
+        delimiter = options[:in]
+        exclusions = delimiter.respond_to?(:call) ? delimiter.call(record) : delimiter
+        if exclusions.send(inclusion_method(exclusions), value)
           record.errors.add(attribute, :exclusion, options.except(:in).merge!(:value => value))
         end
       end
+
+    private
+
+      # In Ruby 1.9 <tt>Range#include?</tt> on non-numeric ranges checks all possible values in the
+      # range for equality, so it may be slow for large ranges. The new <tt>Range#cover?</tt>
+      # uses the previous logic of comparing a value with the range endpoints.
+      def inclusion_method(enumerable)
+        enumerable.is_a?(Range) ? :cover? : :include?
+      end
     end
 
     module HelperMethods
@@ -22,13 +39,20 @@ module ActiveModel
       #     validates_exclusion_of :username, :in => %w( admin superuser ), :message => "You don't belong here"
       #     validates_exclusion_of :age, :in => 30..60, :message => "This site is only for under 30 and over 60"
       #     validates_exclusion_of :format, :in => %w( mov avi ), :message => "extension %{value} is not allowed"
+      #     validates_exclusion_of :password, :in => lambda { |p| [p.username, p.first_name] }, :message => "should not be the same as your username or first name"
       #   end
       #
       # Configuration options:
       # * <tt>:in</tt> - An enumerable object of items that the value shouldn't be part of.
+      #   This can be supplied as a proc or lambda which returns an enumerable. If the enumerable
+      #   is a range the test is performed with <tt>Range#cover?</tt>
+      #   (backported in Active Support for 1.8), otherwise with <tt>include?</tt>.
       # * <tt>:message</tt> - Specifies a custom error message (default is: "is reserved").
       # * <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. Runs in all
+      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
+      #   and <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.

data/lib/active_model/validations/format.rb

@@ -4,10 +4,12 @@ module ActiveModel
   module Validations
     class FormatValidator < EachValidator
       def validate_each(record, attribute, value)
-        if options[:with] && value.to_s !~ options[:with]
-          record.errors.add(attribute, :invalid, options.except(:with).merge!(:value => value))
-        elsif options[:without] && value.to_s =~ options[:without]
-          record.errors.add(attribute, :invalid, options.except(:without).merge!(:value => value))
+        if options[:with]
+          regexp = option_call(record, :with)
+          record_error(record, attribute, :with, value) if value.to_s !~ regexp
+        elsif options[:without]
+          regexp = option_call(record, :without)
+          record_error(record, attribute, :without, value) if value.to_s =~ regexp
         end
       end
 
@@ -16,12 +18,25 @@ module ActiveModel
           raise ArgumentError, "Either :with or :without must be supplied (but not both)"
         end
 
-        if options[:with] && !options[:with].is_a?(Regexp)
-          raise ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash"
-        end
+        check_options_validity(options, :with)
+        check_options_validity(options, :without)
+      end
+
+      private
 
-        if options[:without] && !options[:without].is_a?(Regexp)
-          raise ArgumentError, "A regular expression must be supplied as the :without option of the configuration hash"
+      def option_call(record, name)
+        option = options[name]
+        option.respond_to?(:call) ? option.call(record) : option
+      end
+
+      def record_error(record, attribute, name, value)
+        record.errors.add(attribute, :invalid, options.except(name).merge!(:value => value))
+      end
+
+      def check_options_validity(options, name)
+        option = options[name]
+        if option && !option.is_a?(Regexp) && !option.respond_to?(:call)
+          raise ArgumentError, "A regular expression or a proc or lambda must be supplied as :#{name}"
         end
       end
     end
@@ -40,18 +55,29 @@ module ActiveModel
       #     validates_format_of :email, :without => /NOSPAM/
       #   end
       #
+      # You can also provide a proc or lambda which will determine the regular expression that will be used to validate the attribute
+      #
+      #   class Person < ActiveRecord::Base
+      #     # Admin can have number as a first letter in their screen name
+      #     validates_format_of :screen_name, :with => lambda{ |person| person.admin? ? /\A[a-z0-9][a-z0-9_\-]*\Z/i : /\A[a-z][a-z0-9_\-]*\Z/i }
+      #   end
+      #
       # Note: use <tt>\A</tt> and <tt>\Z</tt> to match the start and end of the string, <tt>^</tt> and <tt>$</tt> match the start/end of a line.
       #
-      # You must pass either <tt>:with</tt> or <tt>:without</tt> as an option. In addition, both must be a regular expression,
-      # or else an exception will be raised.
+      # You must pass either <tt>:with</tt> or <tt>:without</tt> as an option. In addition, both must be a regular expression
+      # or a proc or lambda, or else an exception will be raised.
       #
       # Configuration options:
       # * <tt>:message</tt> - A custom error message (default is: "is invalid").
       # * <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>:with</tt> - Regular expression that if the attribute matches will result in a successful validation.
+      #   This can be provided as a proc or lambda returning regular expression which will be called at runtime.
       # * <tt>:without</tt> - Regular expression that if the attribute does not match will result in a successful validation.
-      # * <tt>:on</tt> - Specifies when this validation is active (default is <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
+      #   This can be provided as a proc or lambda returning regular expression which will be called at runtime.
+      # * <tt>:on</tt> - Specifies when this validation is active. Runs in all
+      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
+      #   and <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.

data/lib/active_model/validations/inclusion.rb

@@ -1,35 +1,35 @@
+require 'active_support/core_ext/range.rb'
+
 module ActiveModel
 
   # == Active Model Inclusion Validator
   module Validations
     class InclusionValidator < EachValidator
+      ERROR_MESSAGE = "An object with the method #include? or a proc or lambda is required, " <<
+                      "and must be supplied as the :in option of the configuration hash"
+
       def check_validity!
-         raise ArgumentError, "An object with the method include? is required must be supplied as the " <<
-                              ":in option of the configuration hash" unless options[:in].respond_to?(:include?)
+        unless [:include?, :call].any?{ |method| options[:in].respond_to?(method) }
+          raise ArgumentError, ERROR_MESSAGE
+        end
       end
 
-      # On Ruby 1.9 Range#include? checks all possible values in the range for equality,
-      # so it may be slow for large ranges. The new Range#cover? uses the previous logic
-      # of comparing a value with the range endpoints.
-      if (1..2).respond_to?(:cover?)
-        def validate_each(record, attribute, value)
-          included = if options[:in].is_a?(Range)
-            options[:in].cover?(value)
-          else
-            options[:in].include?(value)
-          end
-
-          unless included
-            record.errors.add(attribute, :inclusion, options.except(:in).merge!(:value => value))
-          end
-        end
-      else
-        def validate_each(record, attribute, value)
-          unless options[:in].include?(value)
-            record.errors.add(attribute, :inclusion, options.except(:in).merge!(:value => value))
-          end
+      def validate_each(record, attribute, value)
+        delimiter = options[:in]
+        exclusions = delimiter.respond_to?(:call) ? delimiter.call(record) : delimiter
+        unless exclusions.send(inclusion_method(exclusions), value)
+          record.errors.add(attribute, :inclusion, options.except(:in).merge!(:value => value))
         end
       end
+
+    private
+
+      # In Ruby 1.9 <tt>Range#include?</tt> on non-numeric ranges checks all possible values in the
+      # range for equality, so it may be slow for large ranges. The new <tt>Range#cover?</tt>
+      # uses the previous logic of comparing a value with the range endpoints.
+      def inclusion_method(enumerable)
+        enumerable.is_a?(Range) ? :cover? : :include?
+      end
     end
 
     module HelperMethods
@@ -39,13 +39,20 @@ module ActiveModel
       #     validates_inclusion_of :gender, :in => %w( m f )
       #     validates_inclusion_of :age, :in => 0..99
       #     validates_inclusion_of :format, :in => %w( jpg gif png ), :message => "extension %{value} is not included in the list"
+      #     validates_inclusion_of :states, :in => lambda{ |person| STATES[person.country] }
       #   end
       #
       # Configuration options:
-      # * <tt>:in</tt> - An enumerable object of available items.
+      # * <tt>:in</tt> - An enumerable object of available items. This can be
+      #   supplied as a proc or lambda which returns an enumerable. If the enumerable
+      #   is a range the test is performed with <tt>Range#cover?</tt>
+      #   (backported in Active Support for 1.8), otherwise with <tt>include?</tt>.
       # * <tt>:message</tt> - Specifies a custom error message (default is: "is not included in the list").
       # * <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. Runs in all
+      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
+      #   and <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.