From 5dcbe933dfd34bb799ee370792b6066f6d6ceaac Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Fri, 18 Feb 2005 17:27:26 +0000 Subject: Added validates_each that validates each specified attribute against a block #610 [bitsweat]. Added :allow_nil as an explicit option for validates_length_of, so unless that's set to true having the attribute as nil will also return an error if a range is specified as :within #610 [bitsweat] git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@667 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- activerecord/lib/active_record/validations.rb | 435 +++++++++++++++----------- 1 file changed, 254 insertions(+), 181 deletions(-) (limited to 'activerecord/lib/active_record') diff --git a/activerecord/lib/active_record/validations.rb b/activerecord/lib/active_record/validations.rb index a7811e50ac..fc462bd4ae 100755 --- a/activerecord/lib/active_record/validations.rb +++ b/activerecord/lib/active_record/validations.rb @@ -1,4 +1,138 @@ module ActiveRecord + # Active Record validation is reported to and from this object, which is used by Base#save to + # determine whether the object in a valid state to be saved. See usage example in Validations. + class Errors + def initialize(base) # :nodoc: + @base, @errors = base, {} + end + + @@default_error_messages = { + :inclusion => "is not included in the list", + :invalid => "is invalid", + :confirmation => "doesn't match confirmation", + :accepted => "must be accepted", + :empty => "can't be empty", + :too_long => "is too long (max is %d characters)", + :too_short => "is too short (min is %d characters)", + :wrong_length => "is the wrong length (should be %d characters)", + :taken => "has already been taken", + } + cattr_accessor :default_error_messages + + + # Adds an error to the base object instead of any particular attribute. This is used + # to report errors that doesn't tie to any specific attribute, but rather to the object + # as a whole. These error messages doesn't get prepended with any field name when iterating + # with each_full, so they should be complete sentences. + def add_to_base(msg) + add(:base, msg) + end + + # Adds an error message (+msg+) to the +attribute+, which will be returned on a call to on(attribute) + # for the same attribute and ensure that this error object returns false when asked if +empty?+. More than one + # error can be added to the same +attribute+ in which case an array will be returned on a call to on(attribute). + # If no +msg+ is supplied, "invalid" is assumed. + def add(attribute, msg = @@default_error_messages[:invalid]) + @errors[attribute.to_s] = [] if @errors[attribute.to_s].nil? + @errors[attribute.to_s] << msg + end + + # Will add an error message to each of the attributes in +attributes+ that is empty (defined by attribute_present?). + def add_on_empty(attributes, msg = @@default_error_messages[:empty]) + for attr in [attributes].flatten + value = @base.respond_to?(attr.to_s) ? @base.send(attr.to_s) : @base[attr.to_s] + is_empty = value.respond_to?("empty?") ? value.empty? : false + add(attr, msg) unless !value.nil? && !is_empty + end + end + + # Will add an error message to each of the attributes in +attributes+ that has a length outside of the passed boundary +range+. + # If the length is above the boundary, the too_long_msg message will be used. If below, the too_short_msg. + def add_on_boundary_breaking(attributes, range, too_long_msg = @@default_error_messages[:too_long], too_short_msg = @@default_error_messages[:too_short]) + for attr in [attributes].flatten + value = @base.respond_to?(attr.to_s) ? @base.send(attr.to_s) : @base[attr.to_s] + add(attr, too_short_msg % range.begin) if value && value.length < range.begin + add(attr, too_long_msg % range.end) if value && value.length > range.end + end + end + + alias :add_on_boundry_breaking :add_on_boundary_breaking + + # Returns true if the specified +attribute+ has errors associated with it. + def invalid?(attribute) + !@errors[attribute.to_s].nil? + end + + # * Returns nil, if no errors are associated with the specified +attribute+. + # * Returns the error message, if one error is associated with the specified +attribute+. + # * Returns an array of error messages, if more than one error is associated with the specified +attribute+. + def on(attribute) + if @errors[attribute.to_s].nil? + nil + elsif @errors[attribute.to_s].length == 1 + @errors[attribute.to_s].first + else + @errors[attribute.to_s] + end + end + + alias :[] :on + + # Returns errors assigned to base object through add_to_base according to the normal rules of on(attribute). + def on_base + on(:base) + end + + # Yields each attribute and associated message per error added. + def each + @errors.each_key { |attr| @errors[attr].each { |msg| yield attr, msg } } + end + + # Yields each full error message added. So Person.errors.add("first_name", "can't be empty") will be returned + # through iteration as "First name can't be empty". + def each_full + full_messages.each { |msg| yield msg } + end + + # Returns all the full error messages in an array. + def full_messages + full_messages = [] + + @errors.each_key do |attr| + @errors[attr].each do |msg| + next if msg.nil? + + if attr == "base" + full_messages << msg + else + full_messages << @base.class.human_attribute_name(attr) + " " + msg + end + end + end + + return full_messages + end + + # Returns true if no errors have been added. + def empty? + return @errors.empty? + end + + # Removes all the errors that have been added. + def clear + @errors = {} + end + + # Returns the total number of errors added. Two errors added to the same attribute will be counted as such + # with this as well. + def count + error_count = 0 + @errors.each_value { |attribute| error_count += attribute.length } + error_count + end + end + + # Active Records implement validation by overwriting Base#validate (or the variations, +validate_on_create+ and # +validate_on_update+). Each of these methods can inspect the state of the object, which usually means ensuring # that a number of attributes have a certain value (such as not empty, within a given range, matching a certain regular expression). @@ -40,27 +174,38 @@ module ActiveRecord # Please do have a look at ActiveRecord::Validations::ClassMethods for a higher level of validations. module Validations VALIDATIONS = %w( validate validate_on_create validate_on_update ) - + def self.append_features(base) # :nodoc: super - + base.extend ClassMethods base.class_eval do alias_method :save_without_validation, :save alias_method :save, :save_with_validation alias_method :update_attribute_without_validation_skipping, :update_attribute alias_method :update_attribute, :update_attribute_with_validation_skipping - - VALIDATIONS.each { |vd| base.class_eval("def self.#{vd}(*methods, &block) write_inheritable_array(\"#{vd}\", methods + [block].compact - (read_inheritable_attribute(\"#{vd}\") || [])) end") } end - - base.extend(ClassMethods) end # All of the following validations are defined in the class scope of the model that you're interested in validating. # They offer a more declarative way of specifying when the model is valid and when it is not. It is recommended to use # these over the low-level calls to validate and validate_on_create when possible. module ClassMethods + def validate(*methods, &block) + methods << block if block_given? + write_inheritable_set(:validate, methods) + end + + def validate_on_create(*methods, &block) + methods << block if block_given? + write_inheritable_set(:validate_on_create, methods) + end + + def validate_on_update(*methods, &block) + methods << block if block_given? + write_inheritable_set(:validate_on_update, methods) + end + # Encapsulates the pattern of wanting to validate a password or email address field with a confirmation. Example: # # Model: @@ -128,12 +273,55 @@ module ActiveRecord class_eval(%(#{validation_method(configuration[:on])} %{errors.add_on_empty('#{attr_name}', "#{configuration[:message]}")})) end end - + + + DEFAULT_VALIDATION_OPTIONS = { + :on => :save, + :allow_nil => false, + :message => nil + }.freeze + + DEFAULT_SIZE_VALIDATION_OPTIONS = DEFAULT_VALIDATION_OPTIONS.merge( + :too_long => ActiveRecord::Errors.default_error_messages[:too_long], + :too_short => ActiveRecord::Errors.default_error_messages[:too_short], + :wrong_length => ActiveRecord::Errors.default_error_messages[:wrong_length] + ).freeze + + ALL_RANGE_OPTIONS = [ :is, :within, :in, :minimum, :maximum ].freeze + + + # Validates each attribute against a block. + # + # class Person < ActiveRecord::Base + # validates_each :first_name, :last_name do |record, attr| + # record.errors.add attr, 'starts with z.' if attr[0] == ?z + # end + # end + # + # Options: + # * on - Specifies when this validation is active (default is :save, other options :create, :update) + # * allow_nil - Skip validation if attribute is nil. + def validates_each(*attrs) + options = attrs.last.is_a?(Hash) ? attrs.pop.symbolize_keys : {} + attrs = attrs.flatten + + # Declare the validation. + send(validation_method(options[:on] || :save)) do |record| + attrs.each do |attr| + value = record.send(attr) + next if value.nil? && options[:allow_nil] + yield record, attr, value + end + end + end + + # Validates that the specified attribute matches the length restrictions supplied. Only one option can be used at a time: # # class Person < ActiveRecord::Base # validates_length_of :first_name, :maximum=>30 # validates_length_of :last_name, :maximum=>30, :message=>"less than %d if you don't mind" + # validates_length_of :fax, :in => 7..32, :allow_nil => true # validates_length_of :user_name, :within => 6..20, :too_long => "pick a shorter name", :too_short => "pick a longer name" # validates_length_of :fav_bra_size, :minimum=>1, :too_short=>"please enter at least %d character" # validates_length_of :smurf_leader, :is=>4, :message=>"papa is spelled with %d characters... don't play me." @@ -145,55 +333,68 @@ module ActiveRecord # * is - The exact size of the attribute # * within - A range specifying the minimum and maximum size of the attribute # * in - A synonym(or alias) for :within - # + # * allow_nil - Attribute may be nil; skip validation. + # # * too_long - The error message if the attribute goes over the maximum (default is: "is too long (max is %d characters)") # * too_short - The error message if the attribute goes under the minimum (default is: "is too short (min is %d characters)") # * wrong_length - The error message if using the :is method and the attribute is the wrong size (default is: "is the wrong length (should be %d characters)") # * message - The error message to use for a :minimum, :maximum, or :is violation. An alias of the appropriate too_long/too_short/wrong_length message # * on - Specifies when this validation is active (default is :save, other options :create, :update) - def validates_length_of(*attr_names) - configuration = { :too_long => ActiveRecord::Errors.default_error_messages[:too_long], :too_short => ActiveRecord::Errors.default_error_messages[:too_short], :wrong_length => ActiveRecord::Errors.default_error_messages[:wrong_length], :on => :save } - configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) + def validates_length_of(*attrs) + # Merge given options with defaults. + options = DEFAULT_SIZE_VALIDATION_OPTIONS.dup + options.update(attrs.pop.symbolize_keys) if attrs.last.is_a?(Hash) + + # Ensure that one and only one range option is specified. + range_options = ALL_RANGE_OPTIONS & options.keys + case range_options.size + when 0 + raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.' + when 1 + # Valid number of options; do nothing. + else + raise ArgumentError, 'Too many range options specified. Choose only one.' + end - # you must use one of 4 options, :within, :maximum, :minimum, or :is - within = configuration[:within] || configuration[:in] - maximum = configuration[:maximum] - minimum = configuration[:minimum] - is = configuration[:is] - - raise(ArgumentError, "The :within, :maximum, :minimum, or :is options must be passed in the configuration hash") unless within or maximum or minimum or is - # but not more than 1 of them at a time - options_used = 0 - options_used += 1 if within - options_used += 1 if maximum - options_used += 1 if minimum - options_used += 1 if is - raise(ArgumentError, "The :within, :maximum, :minimum, and :is options are mutually exclusive") if options_used > 1 - - option_to_use = within || maximum || minimum || is - for attr_name in attr_names - if within - raise(ArgumentError, "The :within option must be a Range") unless within.kind_of?(Range) - class_eval(%(#{validation_method(configuration[:on])} %{errors.add_on_boundary_breaking('#{attr_name}', #{within}, "#{configuration[:too_long]}", "#{configuration[:too_short]}")})) - elsif maximum - raise(ArgumentError, "The :maximum option must be a Fixnum") unless maximum.kind_of?(Fixnum) - msg = configuration[:message] || configuration[:too_long] - msg = (msg % maximum) rescue msg - class_eval(%(#{validation_method(configuration[:on])} %{errors.add( '#{attr_name}', '#{msg}') if #{attr_name}.to_s.length > #{maximum} })) - elsif minimum - raise(ArgumentError, "The :minimum option must be a Fixnum") unless minimum.kind_of?(Fixnum) - msg = configuration[:message] || configuration[:too_short] - msg = (msg % minimum) rescue msg - class_eval(%(#{validation_method(configuration[:on])} %{errors.add( '#{attr_name}', '#{msg}') if #{attr_name}.to_s.length < #{minimum} })) - else - raise(ArgumentError, "The :is option must be a Fixnum") unless is.kind_of?(Fixnum) - msg = configuration[:message] || configuration[:wrong_length] - msg = (msg % is) rescue msg - class_eval(%(#{validation_method(configuration[:on])} %{errors.add( '#{attr_name}', '#{msg}') if #{attr_name}.to_s.length != #{is} })) + # Get range option and value. + option = range_options.first + option_value = options[range_options.first] + + # Declare different validations per option. + case range_options.first + when :within, :in + raise ArgumentError, ':within must be a Range' unless option_value.is_a?(Range) + validates_each(attrs, options) do |record, attr| + next if record.send(attr).nil? and options[:allow_nil] + record.errors.add_on_boundary_breaking(attr, option_value, options[:too_long], options[:too_short]) + end + when :is + raise ArgumentError, ':is must be a nonnegative Integer' unless option_value.is_a?(Integer) and option_value >= 0 + message = options[:message] || options[:wrong_length] + message = (message % option_value) rescue message + validates_each(attrs, options) do |record, attr, value| + record.errors.add(attr, message) if value.nil? or value.size != option_value end - end + when :minimum + raise ArgumentError, ':minimum must be a nonnegative Integer' unless option_value.is_a?(Integer) and option_value >= 0 + message = options[:message] || options[:too_short] + message = (message % option_value) rescue message + validates_each(attrs, options) do |record, attr, value| + record.errors.add(attr, message) if value.nil? or value.size < option_value + end + when :maximum + raise ArgumentError, ':maximum must be a nonnegative Integer' unless option_value.is_a?(Integer) and option_value >= 0 + message = options[:message] || options[:too_long] + message = (message % option_value) rescue message + validates_each(attrs, options) do |record, attr, value| + record.errors.add(attr, message) if value.nil? or value.size > option_value + end + end end + alias_method :validates_size_of, :validates_length_of + + # Validates whether the value of the specified attributes are unique across the system. Useful for making sure that only one user # can be named "davidhh". # @@ -307,6 +508,11 @@ module ActiveRecord private + def write_inheritable_set(key, methods) + existing_methods = read_inheritable_attribute(key) || [] + write_inheritable_attribute(key, methods | existing_methods) + end + def validation_method(on) case on when :save then :validate @@ -369,7 +575,7 @@ module ActiveRecord private def run_validations(validation_method) - validations = self.class.read_inheritable_attribute(validation_method.to_s) + validations = self.class.read_inheritable_attribute(validation_method.to_sym) if validations.nil? then return end validations.each do |validation| if validation.is_a?(Symbol) @@ -398,137 +604,4 @@ module ActiveRecord validation.respond_to?(validation_method) end end - - # Active Record validation is reported to and from this object, which is used by Base#save to - # determine whether the object in a valid state to be saved. See usage example in Validations. - class Errors - def initialize(base) # :nodoc: - @base, @errors = base, {} - end - - @@default_error_messages = { - :inclusion => "is not included in the list", - :invalid => "is invalid", - :confirmation => "doesn't match confirmation", - :accepted => "must be accepted", - :empty => "can't be empty", - :too_long => "is too long (max is %d characters)", - :too_short => "is too short (min is %d characters)", - :wrong_length => "is the wrong length (should be %d characters)", - :taken => "has already been taken", - } - cattr_accessor :default_error_messages - - - # Adds an error to the base object instead of any particular attribute. This is used - # to report errors that doesn't tie to any specific attribute, but rather to the object - # as a whole. These error messages doesn't get prepended with any field name when iterating - # with each_full, so they should be complete sentences. - def add_to_base(msg) - add(:base, msg) - end - - # Adds an error message (+msg+) to the +attribute+, which will be returned on a call to on(attribute) - # for the same attribute and ensure that this error object returns false when asked if +empty?+. More than one - # error can be added to the same +attribute+ in which case an array will be returned on a call to on(attribute). - # If no +msg+ is supplied, "invalid" is assumed. - def add(attribute, msg = @@default_error_messages[:invalid]) - @errors[attribute.to_s] = [] if @errors[attribute.to_s].nil? - @errors[attribute.to_s] << msg - end - - # Will add an error message to each of the attributes in +attributes+ that is empty (defined by attribute_present?). - def add_on_empty(attributes, msg = @@default_error_messages[:empty]) - for attr in [attributes].flatten - value = @base.respond_to?(attr.to_s) ? @base.send(attr.to_s) : @base[attr.to_s] - is_empty = value.respond_to?("empty?") ? value.empty? : false - add(attr, msg) unless !value.nil? && !is_empty - end - end - - # Will add an error message to each of the attributes in +attributes+ that has a length outside of the passed boundary +range+. - # If the length is above the boundary, the too_long_msg message will be used. If below, the too_short_msg. - def add_on_boundary_breaking(attributes, range, too_long_msg = @@default_error_messages[:too_long], too_short_msg = @@default_error_messages[:too_short]) - for attr in [attributes].flatten - value = @base.respond_to?(attr.to_s) ? @base.send(attr.to_s) : @base[attr.to_s] - add(attr, too_short_msg % range.begin) if value && value.length < range.begin - add(attr, too_long_msg % range.end) if value && value.length > range.end - end - end - - alias :add_on_boundry_breaking :add_on_boundary_breaking - - # Returns true if the specified +attribute+ has errors associated with it. - def invalid?(attribute) - !@errors[attribute.to_s].nil? - end - - # * Returns nil, if no errors are associated with the specified +attribute+. - # * Returns the error message, if one error is associated with the specified +attribute+. - # * Returns an array of error messages, if more than one error is associated with the specified +attribute+. - def on(attribute) - if @errors[attribute.to_s].nil? - nil - elsif @errors[attribute.to_s].length == 1 - @errors[attribute.to_s].first - else - @errors[attribute.to_s] - end - end - - alias :[] :on - - # Returns errors assigned to base object through add_to_base according to the normal rules of on(attribute). - def on_base - on(:base) - end - - # Yields each attribute and associated message per error added. - def each - @errors.each_key { |attr| @errors[attr].each { |msg| yield attr, msg } } - end - - # Yields each full error message added. So Person.errors.add("first_name", "can't be empty") will be returned - # through iteration as "First name can't be empty". - def each_full - full_messages.each { |msg| yield msg } - end - - # Returns all the full error messages in an array. - def full_messages - full_messages = [] - - @errors.each_key do |attr| - @errors[attr].each do |msg| - next if msg.nil? - - if attr == "base" - full_messages << msg - else - full_messages << @base.class.human_attribute_name(attr) + " " + msg - end - end - end - - return full_messages - end - - # Returns true if no errors have been added. - def empty? - return @errors.empty? - end - - # Removes all the errors that have been added. - def clear - @errors = {} - end - - # Returns the total number of errors added. Two errors added to the same attribute will be counted as such - # with this as well. - def count - error_count = 0 - @errors.each_value { |attribute| error_count += attribute.length } - error_count - end - end end -- cgit v1.2.3