From 0bb824b7152c0a745dbec8983014b77eedb09726 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Wed, 15 Dec 2004 01:36:05 +0000 Subject: Changed validate_* to validates_*_of, so validate_acceptance becomes validates_acceptance_of, and added :on as a configuration option instead of using _on_create/update git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@157 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- activerecord/CHANGELOG | 16 ++---- activerecord/lib/active_record/validations.rb | 83 +++++++++------------------ activerecord/test/validations_test.rb | 13 +++-- 3 files changed, 41 insertions(+), 71 deletions(-) diff --git a/activerecord/CHANGELOG b/activerecord/CHANGELOG index 78243608cd..4590f2c1a2 100644 --- a/activerecord/CHANGELOG +++ b/activerecord/CHANGELOG @@ -28,12 +28,12 @@ * Added Base.validate_presence as an alternative to implementing validate and doing errors.add_on_empty yourself. -* Added Base.validate_uniqueness that alidates whether the value of the specified attributes are unique across the system. +* Added Base.validates_uniqueness_of that alidates whether the value of the specified attributes are unique across the system. Useful for making sure that only one user can be named "davidhh". Model: class Person < ActiveRecord::Base - validate_uniqueness :user_name + validates_uniqueness_of :user_name end View: @@ -43,11 +43,11 @@ attribute (that maps to a column). When the record is updated, the same check is made but disregarding the record itself. -* Added Base.validate_confirmation that encapsulates the pattern of wanting to validate a password or email address field with a confirmation. Example: +* Added Base.validates_confirmation_of that encapsulates the pattern of wanting to validate a password or email address field with a confirmation. Example: Model: class Person < ActiveRecord::Base - validate_confirmation :password + validates_confirmation_of :password end View: @@ -56,23 +56,19 @@ The person has to already have a password attribute (a column in the people table), but the password_confirmation is virtual. It exists only as an in-memory variable for validating the password. This check is performed both on create and update. - See validate_confirmation_on_create and validate_confirmation_on_update if you want to restrict the validation to just one of the two - situations. -* Added Base.validate_confirmation that encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example: +* Added Base.validates_acceptance_of that encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example: Model: class Person < ActiveRecord::Base - validate_acceptance :terms_of_service + validates_acceptance_of :terms_of_service end View: <%= check_box "person", "terms_of_service" %> The terms_of_service attribute is entirely virtual. No database column is needed. This check is performed both on create and update. - See validate_acceptance_on_create and validate_acceptance_on_update if you want to restrict the validation to just one of the two - situations. NOTE: The agreement is considered valid if it's set to the string "1". This makes it easy to relate it to an HTML checkbox. diff --git a/activerecord/lib/active_record/validations.rb b/activerecord/lib/active_record/validations.rb index 0ae764936d..efb4368cc5 100755 --- a/activerecord/lib/active_record/validations.rb +++ b/activerecord/lib/active_record/validations.rb @@ -37,7 +37,7 @@ module ActiveRecord # # An +Errors+ object is automatically created for every Active Record. module Validations - VALIDATIONS = %w( validate validate_on_create validate_on_create ) + VALIDATIONS = %w( validate validate_on_create validate_on_update ) def self.append_features(base) # :nodoc: super @@ -60,8 +60,8 @@ module ActiveRecord # # Model: # class Person < ActiveRecord::Base - # validate_confirmation :user_name, :password - # validate_confirmation :email_address, :message => "should match confirmation" + # validates_confirmation_of :user_name, :password + # validates_confirmation_of :email_address, :message => "should match confirmation" # end # # View: @@ -70,101 +70,63 @@ module ActiveRecord # # The person has to already have a password attribute (a column in the people table), but the password_confirmation is virtual. # It exists only as an in-memory variable for validating the password. This check is performed both on create and update. - # See validate_confirmation_on_create and validate_confirmation_on_update if you want to restrict the validation to just one of the two - # situations. # # Configuration options: # ::message: Specifies a custom error message (default is: "doesn't match confirmation") - def validate_confirmation(*attr_names) - configuration = { :message => "doesn't match confirmation" } + # ::on: Specifies when this validation is active (default is :save, other options :create, :update) + def validates_confirmation_of(*attr_names) + configuration = { :message => "doesn't match confirmation", :on => :save } configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) - validation_method = block_given? ? yield : "validate" - for attr_name in attr_names attr_accessor "#{attr_name}_confirmation" - class_eval(%(#{validation_method} %{errors.add('#{attr_name}', "#{configuration[:message]}") unless #{attr_name} == #{attr_name}_confirmation})) + class_eval(%(#{validation_method(configuration[:on])} %{errors.add('#{attr_name}', "#{configuration[:message]}") unless #{attr_name} == #{attr_name}_confirmation})) end end - # Works like validate_confirmation, but only performs the validation on creation (for new records). - def validate_confirmation_on_create(*attr_names) - validate_confirmation(*attr_names) { "validate_on_create" } - end - - # Works like validate_confirmation, but only performs the validation on creation (for new records). - def validate_confirmation_on_update(*attr_names) - validate_confirmation(*attr_names) { "validate_on_update" } - end - # Encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example: # # Model: # class Person < ActiveRecord::Base - # validate_acceptance :terms_of_service - # validate_acceptance :eula, :message => "must be abided" + # validates_acceptance_of :terms_of_service + # validates_acceptance_of :eula, :message => "must be abided" # end # # View: # <%= check_box "person", "terms_of_service" %> # # The terms_of_service attribute is entirely virtual. No database column is needed. This check is performed both on create and update. - # See validate_acceptance_on_create and validate_acceptance_on_update if you want to restrict the validation to just one of the two - # situations. # # Configuration options: # ::message: Specifies a custom error message (default is: "must be accepted") + # ::on: Specifies when this validation is active (default is :save, other options :create, :update) # # NOTE: The agreement is considered valid if it's set to the string "1". This makes it easy to relate it to an HTML checkbox. - def validate_acceptance(*attr_names) - configuration = { :message => "must be accepted" } + def validates_acceptance_of(*attr_names) + configuration = { :message => "must be accepted", :on => :save } configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) - validation_method = block_given? ? yield : "validate" - for attr_name in attr_names attr_accessor(attr_name) - class_eval(%(#{validation_method} %{errors.add('#{attr_name}', '#{configuration[:message]}') unless #{attr_name} == "1"})) + class_eval(%(#{validation_method(configuration[:on])} %{errors.add('#{attr_name}', '#{configuration[:message]}') unless #{attr_name} == "1"})) end end - - # Works like validate_acceptance, but only performs the validation on creation (for new records). - def validate_acceptance_on_create(*attr_names) - validate_acceptance(*attr_names) { "validate_on_create" } - end - - # Works like validate_acceptance, but only performs the validation on update (for existing records). - def validate_acceptance_on_update(*attr_names) - validate_acceptance(*attr_names) { "validate_on_update" } - end - def validate_presence(*attr_names) - configuration = { :message => "can't be empty" } + def validates_presence_of(*attr_names) + configuration = { :message => "can't be empty", :on => :save } configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) - validation_method = block_given? ? yield : "validate" - for attr_name in attr_names - class_eval(%(#{validation_method} %{errors.add_on_empty('#{attr_name}', "#{configuration[:message]}")})) + class_eval(%(#{validation_method(configuration[:on])} %{errors.add_on_empty('#{attr_name}', "#{configuration[:message]}")})) end end - # Works like validate_presence, but only performs the validation on creation (for new records). - def validate_presence_on_create(*attr_names) - validate_presence(*attr_names) { "validate_on_create" } - end - - # Works like validate_presence, but only performs the validation on update (for existing records). - def validate_presence_on_update(*attr_names) - validate_presence(*attr_names) { "validate_on_update" } - end - # 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". # # Model: # class Person < ActiveRecord::Base - # validate_uniqueness :user_name + # validates_uniqueness_of :user_name # end # # View: @@ -175,7 +137,7 @@ module ActiveRecord # # Configuration options: # ::message: Specifies a custom error message (default is: "has already been taken") - def validate_uniqueness(*attr_names) + def validates_uniqueness_of(*attr_names) configuration = { :message => "has already been taken" } configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash) @@ -183,6 +145,15 @@ module ActiveRecord class_eval(%(validate %{errors.add("#{attr_name}", "#{configuration[:message]}") if self.class.find_first(new_record? ? ["#{attr_name} = ?", #{attr_name}] : ["#{attr_name} = ? AND id <> ?", #{attr_name}, id])})) end end + + private + def validation_method(on) + case on + when :save then :validate + when :create then :validate_on_create + when :update then :validate_on_update + end + end end # The validation process on save can be skipped by passing false. The regular Base#save method is diff --git a/activerecord/test/validations_test.rb b/activerecord/test/validations_test.rb index e104573c25..06b4740012 100755 --- a/activerecord/test/validations_test.rb +++ b/activerecord/test/validations_test.rb @@ -1,4 +1,7 @@ require 'abstract_unit' +require 'fixtures/topic' +require 'fixtures/reply' +require 'fixtures/developer' class ValidationsTest < Test::Unit::TestCase fixtures :topics, :developers @@ -123,7 +126,7 @@ class ValidationsTest < Test::Unit::TestCase end def test_title_confirmation - Topic.validate_confirmation(:title) + Topic.validates_confirmation_of(:title) t = Topic.create("title" => "We should be confirmed") assert !t.save @@ -133,7 +136,7 @@ class ValidationsTest < Test::Unit::TestCase end def test_terms_of_service_agreement - Topic.validate_acceptance_on_create(:terms_of_service) + Topic.validates_acceptance_of(:terms_of_service, :on => :create) t = Topic.create("title" => "We should be confirmed") assert !t.save @@ -145,7 +148,7 @@ class ValidationsTest < Test::Unit::TestCase def test_eula - Topic.validate_acceptance_on_create(:eula, :message => "must be abided") + Topic.validates_acceptance_of(:eula, :message => "must be abided", :on => :create) t = Topic.create("title" => "We should be confirmed") assert !t.save @@ -156,7 +159,7 @@ class ValidationsTest < Test::Unit::TestCase end def test_validate_presences - Topic.validate_presence(:title, :content) + Topic.validates_presence_of(:title, :content) t = Topic.create assert !t.save @@ -170,7 +173,7 @@ class ValidationsTest < Test::Unit::TestCase end def test_validate_uniqueness - Topic.validate_uniqueness(:title) + Topic.validates_uniqueness_of(:title) t = Topic.new("title" => "I'm unique!") assert t.save, "Should save t as unique" -- cgit v1.2.3