module DataMapper::Validations::AutoValidations
Attributes
TODO: why are there 3 entry points to this ivar? disable_auto_validations
, disabled_auto_validations?
, auto_validations_disabled?
Public Class Methods
Auto-generate validations for a given property. This will only occur if the option :auto_validation is either true or left undefined.
Triggers that generate validator creation :required => true Setting the option :required to true causes a validates_presence_of validator to be automatically created on the property :length => 20 Setting the option :length causes a validates_length_of validator to be automatically created on the property. If the value is a Integer the validation will set :maximum => value if the value is a Range the validation will set :within => value :format => :predefined / lambda / Proc Setting the :format option causes a validates_format_of validator to be automatically created on the property :set => ["foo", "bar", "baz"] Setting the :set option causes a validates_within validator to be automatically created on the property Integer type Using a Integer type causes a validates_numericality_of validator to be created for the property. integer_only is set to true BigDecimal or Float type Using a Integer type causes a validates_numericality_of validator to be created for the property. integer_only is set to false, and precision/scale match the property Messages :messages => {..} Setting :messages hash replaces standard error messages with custom ones. For instance: :messages => {:presence => "Field is required", :format => "Field has invalid format"} Hash keys are: :presence, :format, :length, :is_unique, :is_number, :is_primitive :message => "Some message" It is just shortcut if only one validation option is set
@api private
# File lib/dm-validations/auto_validate.rb, line 101 def self.generate_for_property(property) return if (property.model.disabled_auto_validations? || skip_auto_validation_for?(property)) # all auto-validations (aside from presence) should skip # validation when the value is nil opts = { :allow_nil => true } if property.options.key?(:validates) opts[:context] = property.options[:validates] end infer_presence_validation_for(property, opts.dup) infer_length_validation_for(property, opts.dup) infer_format_validation_for(property, opts.dup) infer_uniqueness_validation_for(property, opts.dup) infer_within_validation_for(property, opts.dup) infer_type_validation_for(property, opts.dup) end
Private Class Methods
@api private
# File lib/dm-validations/auto_validate.rb, line 170 def self.infer_format_validation_for(property, options) return unless property.options.key?(:format) options[:with] = property.options[:format] validation_options = options_with_message(options, property, :format) property.model.validates_format_of property.name, validation_options end
@api private
# File lib/dm-validations/auto_validate.rb, line 151 def self.infer_length_validation_for(property, options) return unless (property.kind_of?(DataMapper::Property::String) || property.kind_of?(DataMapper::Property::Text)) length = property.options.fetch(:length, DataMapper::Property::String::DEFAULT_LENGTH) if length.is_a?(Range) raise ArgumentError, "Infinity is no valid upper bound for a length range" if length.last == Infinity options[:within] = length else options[:maximum] = length end validation_options = options_with_message(options, property, :length) property.model.validates_length_of property.name, validation_options end
@api private
# File lib/dm-validations/auto_validate.rb, line 138 def self.infer_presence_validation_for(property, options) return if skip_presence_validation?(property) validation_options = options_with_message(options, property, :presence) property.model.validates_presence_of property.name, validation_options end
@api private
# File lib/dm-validations/auto_validate.rb, line 206 def self.infer_type_validation_for(property, options) return if property.respond_to?(:custom?) && property.custom? if property.kind_of?(Property::Numeric) options[:gte] = property.min if property.min options[:lte] = property.max if property.max end if Integer == property.primitive options[:integer_only] = true validation_options = options_with_message(options, property, :is_number) property.model.validates_numericality_of property.name, validation_options elsif (BigDecimal == property.primitive || Float == property.primitive) options[:precision] = property.precision options[:scale] = property.scale validation_options = options_with_message(options, property, :is_number) property.model.validates_numericality_of property.name, validation_options else # We only need this in the case we don't already # have a numeric validator, because otherwise # it will cause duplicate validation errors validation_options = options_with_message(options, property, :is_primitive) property.model.validates_primitive_type_of property.name, validation_options end end
@api private
# File lib/dm-validations/auto_validate.rb, line 180 def self.infer_uniqueness_validation_for(property, options) return unless property.options.key?(:unique) case value = property.options[:unique] when Array, Symbol options[:scope] = Array(value) validation_options = options_with_message(options, property, :is_unique) property.model.validates_uniqueness_of property.name, validation_options when TrueClass validation_options = options_with_message(options, property, :is_unique) property.model.validates_uniqueness_of property.name, validation_options end end
@api private
# File lib/dm-validations/auto_validate.rb, line 196 def self.infer_within_validation_for(property, options) return unless property.options.key?(:set) options[:set] = property.options[:set] validation_options = options_with_message(options, property, :within) property.model.validates_within property.name, validation_options end
adds message for validator
@api private
# File lib/dm-validations/auto_validate.rb, line 238 def self.options_with_message(base_options, property, validator_name) options = base_options.clone opts = property.options if opts.key?(:messages) options[:message] = opts[:messages][validator_name] elsif opts.key?(:message) options[:message] = opts[:message] end options end
Checks whether or not property should be auto validated. It is the case for properties with :auto_validation option given and it’s value evaluates to true
@return [TrueClass, FalseClass]
true for properties with :auto_validation option that has positive value
@api private
# File lib/dm-validations/auto_validate.rb, line 132 def self.skip_auto_validation_for?(property) (property.options.key?(:auto_validation) && !property.options[:auto_validation]) end
@api private
# File lib/dm-validations/auto_validate.rb, line 146 def self.skip_presence_validation?(property) property.allow_blank? || property.serial? end
Public Instance Methods
TODO: deprecate all but one of these 3 variants
Checks whether auto validations are currently disabled (see disable_auto_validations
method that takes a block)
@return [TrueClass, FalseClass]
true if auto validation is currently disabled
@api semipublic
# File lib/dm-validations/auto_validate.rb, line 33 def disabled_auto_validations? @disable_auto_validations || false end
disables generation of validations for duration of given block
@api public
# File lib/dm-validations/auto_validate.rb, line 44 def without_auto_validations previous, @disable_auto_validations = @disable_auto_validations, true yield ensure @disable_auto_validations = previous end