From 58594be680e8712c9e7352f184e15972d02cd4af Mon Sep 17 00:00:00 2001 From: Prem Sichanugrist Date: Fri, 11 Mar 2011 13:35:23 +0800 Subject: Add support for proc or lambda as an option for InclusionValidator, ExclusionValidator, and FormatValidator You can now use a proc or lambda in :in option for InclusionValidator and ExclusionValidator, and :with, :without option for FormatValidator --- activemodel/CHANGELOG | 9 +++++ .../lib/active_model/validations/exclusion.rb | 28 +++++++++++++-- activemodel/lib/active_model/validations/format.rb | 41 ++++++++++++++++------ .../lib/active_model/validations/inclusion.rb | 27 ++++++++++---- .../cases/validations/exclusion_validation_test.rb | 21 +++++++++++ .../cases/validations/format_validation_test.rb | 40 +++++++++++++++++++++ .../cases/validations/inclusion_validation_test.rb | 21 +++++++++++ 7 files changed, 167 insertions(+), 20 deletions(-) diff --git a/activemodel/CHANGELOG b/activemodel/CHANGELOG index 3082c7186a..03287fac7a 100644 --- a/activemodel/CHANGELOG +++ b/activemodel/CHANGELOG @@ -1,5 +1,14 @@ *Rails 3.1.0 (unreleased)* +* Add support for proc or lambda as an option for InclusionValidator, + ExclusionValidator, and FormatValidator [Prem Sichanugrist] + + You can now supply Proc, lambda, or anything that respond to #call in those + validations, and it will be called with current record as an argument. + That given proc or lambda must returns an object which respond to #include? for + InclusionValidator and ExclusionValidator, and returns a regular expression + object for FormatValidator. + * Added ActiveModel::SecurePassword to encapsulate dead-simple password usage with BCrypt encryption and salting [DHH] * ActiveModel::AttributeMethods allows attributes to be defined on demand [Alexander Uvarov] diff --git a/activemodel/lib/active_model/validations/exclusion.rb b/activemodel/lib/active_model/validations/exclusion.rb index e38e565d09..abc1bfae78 100644 --- a/activemodel/lib/active_model/validations/exclusion.rb +++ b/activemodel/lib/active_model/validations/exclusion.rb @@ -1,17 +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) + exclusions = options[:in].respond_to?(:call) ? options[:in].call(record) : options[:in] + if exclusions.send(inclusion_method(exclusions), value) record.errors.add(attribute, :exclusion, options.except(:in).merge!(:value => value)) end + rescue NoMethodError + raise ArgumentError, "Exclusion validation for :#{attribute} in #{record.class.name}: #{ERROR_MESSAGE}" + end + + private + + # In Ruby 1.9 Range#include? on non-numeric ranges 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. + def inclusion_method(enumerable) + enumerable.is_a?(Range) ? :cover? : :include? end end @@ -22,10 +40,14 @@ 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: # * :in - 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 Range#cover? + # (backported in Active Support for 1.8), otherwise with include?. # * :message - Specifies a custom error message (default is: "is reserved"). # * :allow_nil - If set to true, skips this validation if the attribute is +nil+ (default is +false+). # * :allow_blank - If set to true, skips this validation if the attribute is blank (default is +false+). diff --git a/activemodel/lib/active_model/validations/format.rb b/activemodel/lib/active_model/validations/format.rb index 541f53a834..2ec052c74b 100644 --- a/activemodel/lib/active_model/validations/format.rb +++ b/activemodel/lib/active_model/validations/format.rb @@ -4,11 +4,23 @@ 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 = options[:with].respond_to?(:call) ? options[:with].call(record) : options[:with] + if regexp.is_a?(Regexp) + record.errors.add(attribute, :invalid, options.except(:with).merge!(:value => value)) if value.to_s !~ regexp + else + raise ArgumentError, "A proc or lambda given to :with option must returns a regular expression" + end + elsif options[:without] + regexp = options[:without].respond_to?(:call) ? options[:without].call(record) : options[:without] + if regexp.is_a?(Regexp) + record.errors.add(attribute, :invalid, options.except(:without).merge!(:value => value)) if value.to_s =~ regexp + else + raise ArgumentError, "A proc or lambda given to :without option must returns a regular expression" + end end + rescue TypeError + raise ArgumentError, "A proc or lambda given to :with or :without option must returns a regular expression" end def check_validity! @@ -16,12 +28,12 @@ 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" + if options[:with] && !options[:with].is_a?(Regexp) && !options[:with].respond_to?(:call) + raise ArgumentError, "A regular expression or a proc or lambda must be supplied as the :with option of the configuration hash" end - if options[:without] && !options[:without].is_a?(Regexp) - raise ArgumentError, "A regular expression must be supplied as the :without option of the configuration hash" + if options[:without] && !options[:without].is_a?(Regexp) && !options[:without].respond_to?(:call) + raise ArgumentError, "A regular expression or a proc or lambda must be supplied as the :without option of the configuration hash" end end end @@ -40,17 +52,26 @@ 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 \A and \Z to match the start and end of the string, ^ and $ match the start/end of a line. # - # You must pass either :with or :without as an option. In addition, both must be a regular expression, - # or else an exception will be raised. + # You must pass either :with or :without 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: # * :message - A custom error message (default is: "is invalid"). # * :allow_nil - If set to true, skips this validation if the attribute is +nil+ (default is +false+). # * :allow_blank - If set to true, skips this validation if the attribute is blank (default is +false+). # * :with - 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. # * :without - Regular expression that if the attribute does not match will result in a successful validation. + # This can be provided as a proc or lambda returning regular expression which will be called at runtime. # * :on - Specifies when this validation is active. Runs in all # validation contexts by default (+nil+), other options are :create # and :update. diff --git a/activemodel/lib/active_model/validations/inclusion.rb b/activemodel/lib/active_model/validations/inclusion.rb index 92ac940f36..cb46547e92 100644 --- a/activemodel/lib/active_model/validations/inclusion.rb +++ b/activemodel/lib/active_model/validations/inclusion.rb @@ -5,20 +5,31 @@ 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 def validate_each(record, attribute, value) - record.errors.add(attribute, :inclusion, options.except(:in).merge!(:value => value)) unless options[:in].send(include?, value) + exclusions = options[:in].respond_to?(:call) ? options[:in].call(record) : options[:in] + unless exclusions.send(inclusion_method(exclusions), value) + record.errors.add(attribute, :inclusion, options.except(:in).merge!(:value => value)) + end + rescue NoMethodError + raise ArgumentError, "Exclusion validation for :#{attribute} in #{record.class.name}: #{ERROR_MESSAGE}" end + private + # In Ruby 1.9 Range#include? on non-numeric ranges 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. - def include? - options[:in].is_a?(Range) ? :cover? : :include? + def inclusion_method(enumerable) + enumerable.is_a?(Range) ? :cover? : :include? end end @@ -29,11 +40,13 @@ 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: - # * :in - An enumerable object of available items. - # If the enumerable is a range the test is performed with Range#cover? + # * :in - 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 Range#cover? # (backported in Active Support for 1.8), otherwise with include?. # * :message - Specifies a custom error message (default is: "is not included in the list"). # * :allow_nil - If set to true, skips this validation if the attribute is +nil+ (default is +false+). diff --git a/activemodel/test/cases/validations/exclusion_validation_test.rb b/activemodel/test/cases/validations/exclusion_validation_test.rb index be9d98d644..fe0d13ec33 100644 --- a/activemodel/test/cases/validations/exclusion_validation_test.rb +++ b/activemodel/test/cases/validations/exclusion_validation_test.rb @@ -42,4 +42,25 @@ class ExclusionValidationTest < ActiveModel::TestCase ensure Person.reset_callbacks(:validate) end + + def test_validates_exclusion_of_with_lambda + Topic.validates_exclusion_of :title, :in => lambda{ |topic| topic.author_name == "sikachu" ? %w( monkey elephant ) : %w( abe wasabi ) } + + p = Topic.new + p.title = "elephant" + p.author_name = "sikachu" + assert p.invalid? + + p.title = "wasabi" + assert p.valid? + end + + def test_validates_exclustion_with_invalid_lambda_return + Topic.validates_exclusion_of :title, :in => lambda{ |topic| false } + + p = Topic.new + p.title = "wasabi" + p.author_name = "sikachu" + assert_raise(ArgumentError){ p.valid? } + end end diff --git a/activemodel/test/cases/validations/format_validation_test.rb b/activemodel/test/cases/validations/format_validation_test.rb index 6c4fb36d52..1ff29134ee 100644 --- a/activemodel/test/cases/validations/format_validation_test.rb +++ b/activemodel/test/cases/validations/format_validation_test.rb @@ -98,6 +98,46 @@ class PresenceValidationTest < ActiveModel::TestCase assert_raise(ArgumentError) { Topic.validates_format_of(:title, :without => "clearly not a regexp") } end + def test_validates_format_of_with_lambda + Topic.validates_format_of :content, :with => lambda{ |topic| topic.title == "digit" ? /\A\d+\Z/ : /\A\S+\Z/ } + + p = Topic.new + p.title = "digit" + p.content = "Pixies" + assert p.invalid? + + p.content = "1234" + assert p.valid? + end + + def test_validates_format_of_without_lambda + Topic.validates_format_of :content, :without => lambda{ |topic| topic.title == "characters" ? /\A\d+\Z/ : /\A\S+\Z/ } + + p = Topic.new + p.title = "characters" + p.content = "1234" + assert p.invalid? + + p.content = "Pixies" + assert p.valid? + end + + def test_validates_format_of_with_lambda_not_returns_regexp + Topic.validates_format_of :content, :with => lambda{ |topic| false } + + p = Topic.new + p.content = "Pixies" + assert_raise(ArgumentError){ p.valid? } + end + + def test_validates_format_of_without_lambda_not_returns_regexp + Topic.validates_format_of :content, :without => lambda{ |topic| false } + + p = Topic.new + p.content = "Pixies" + assert_raise(ArgumentError){ p.valid? } + end + def test_validates_format_of_for_ruby_class Person.validates_format_of :karma, :with => /\A\d+\Z/ diff --git a/activemodel/test/cases/validations/inclusion_validation_test.rb b/activemodel/test/cases/validations/inclusion_validation_test.rb index 62f2ec785d..e6adb6d187 100644 --- a/activemodel/test/cases/validations/inclusion_validation_test.rb +++ b/activemodel/test/cases/validations/inclusion_validation_test.rb @@ -74,4 +74,25 @@ class InclusionValidationTest < ActiveModel::TestCase ensure Person.reset_callbacks(:validate) end + + def test_validates_inclusion_of_with_lambda + Topic.validates_inclusion_of :title, :in => lambda{ |topic| topic.author_name == "sikachu" ? %w( monkey elephant ) : %w( abe wasabi ) } + + p = Topic.new + p.title = "wasabi" + p.author_name = "sikachu" + assert p.invalid? + + p.title = "elephant" + assert p.valid? + end + + def test_validates_inclustion_with_invalid_lambda_return + Topic.validates_inclusion_of :title, :in => lambda{ |topic| false } + + p = Topic.new + p.title = "monkey" + p.author_name = "sikachu" + assert_raise(ArgumentError){ p.valid? } + end end -- cgit v1.2.3