diff options
author | John D. Hume <duelin.markers@gmail.com> | 2008-09-08 10:31:25 -0400 |
---|---|---|
committer | John D. Hume <duelin.markers@gmail.com> | 2008-09-08 23:42:34 -0400 |
commit | 3b22fb30b0030e9d97410d24e302afe5404a42d4 (patch) | |
tree | 34205bc54b8606231145dd53805dfc5964364747 /activerecord | |
parent | a849d1d9261cc76d48472952ea5ed4854a857fb5 (diff) | |
download | rails-3b22fb30b0030e9d97410d24e302afe5404a42d4.tar.gz rails-3b22fb30b0030e9d97410d24e302afe5404a42d4.tar.bz2 rails-3b22fb30b0030e9d97410d24e302afe5404a42d4.zip |
Move the orphaned method RDoc of ActiveRecord::Validations::ClassMethods#validate into the module RDoc and rewrite the first bit.
Diffstat (limited to 'activerecord')
-rw-r--r-- | activerecord/lib/active_record/validations.rb | 64 |
1 files changed, 33 insertions, 31 deletions
diff --git a/activerecord/lib/active_record/validations.rb b/activerecord/lib/active_record/validations.rb index c438543d3a..9219d87f5a 100644 --- a/activerecord/lib/active_record/validations.rb +++ b/activerecord/lib/active_record/validations.rb @@ -313,9 +313,39 @@ module ActiveRecord base.define_callbacks *VALIDATIONS 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. + # Active Record models can implement validations using three styles. The most high-level, easiest to read, + # and recommended approach is to use the declarative <tt>validates_...</tt> class methods documented below. + # At a lower level, a model can use the class methods +validate+, +validate_on_create+ and +validate_on_update+. + # The lowest level style is to define the instance methods +validate+, +validate_on_create+ and +validate_on_update+ + # as documented in ActiveRecord::Validations. + # + # == +validate+, +validate_on_create+ and +validate_on_update+ Class Methods + # + # Calls to these methods add a validation method or block to the class. + # + # This can be done with a symbol pointing to a method: + # + # class Comment < ActiveRecord::Base + # validate :must_be_friends + # + # def must_be_friends + # errors.add_to_base("Must be friends to leave a comment") unless commenter.friend_of?(commentee) + # end + # end + # + # Or with a block which is passed the current record to be validated: + # + # class Comment < ActiveRecord::Base + # validate do |comment| + # comment.must_be_friends + # end + # + # def must_be_friends + # errors.add_to_base("Must be friends to leave a comment") unless commenter.friend_of?(commentee) + # end + # end + # + # This usage applies to +validate_on_create+ and +validate_on_update+ as well. module ClassMethods DEFAULT_VALIDATION_OPTIONS = { :on => :save, @@ -329,34 +359,6 @@ module ActiveRecord :equal_to => '==', :less_than => '<', :less_than_or_equal_to => '<=', :odd => 'odd?', :even => 'even?' }.freeze - # Adds a validation method or block to the class. This is useful when - # overriding the +validate+ instance method becomes too unwieldy and - # you're looking for more descriptive declaration of your validations. - # - # This can be done with a symbol pointing to a method: - # - # class Comment < ActiveRecord::Base - # validate :must_be_friends - # - # def must_be_friends - # errors.add_to_base("Must be friends to leave a comment") unless commenter.friend_of?(commentee) - # end - # end - # - # Or with a block which is passed the current record to be validated: - # - # class Comment < ActiveRecord::Base - # validate do |comment| - # comment.must_be_friends - # end - # - # def must_be_friends - # errors.add_to_base("Must be friends to leave a comment") unless commenter.friend_of?(commentee) - # end - # end - # - # This usage applies to +validate_on_create+ and +validate_on_update+ as well. - # Validates each attribute against a block. # # class Person < ActiveRecord::Base |