aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMikel Lindsaar <raasdnil@gmail.com>2010-01-18 18:29:33 +1100
committerMikel Lindsaar <raasdnil@gmail.com>2010-01-18 18:29:33 +1100
commit9aee3659242766896d7d4727a7db425dcb86ded7 (patch)
tree5499d1de3645454a12924c9d5655daa241f80e98
parent91c38403be88a2a9a3485ddd58237445fa176a77 (diff)
downloadrails-9aee3659242766896d7d4727a7db425dcb86ded7.tar.gz
rails-9aee3659242766896d7d4727a7db425dcb86ded7.tar.bz2
rails-9aee3659242766896d7d4727a7db425dcb86ded7.zip
Adding ActiveModel::Validations documentation
-rw-r--r--activemodel/README19
-rw-r--r--activemodel/lib/active_model/validations.rb39
2 files changed, 56 insertions, 2 deletions
diff --git a/activemodel/README b/activemodel/README
index 6673427230..d2b51e2390 100644
--- a/activemodel/README
+++ b/activemodel/README
@@ -175,4 +175,21 @@ functionality from the following modules:
end
{Learn more}[link:classes/ActiveModel/Translation.html]
- \ No newline at end of file
+
+* Providing a full Validation stack for your objects...
+
+ class Person
+ include ActiveModel::Validations
+
+ attr_accessor :first_name, :last_name
+
+ validates_each :first_name, :last_name do |record, attr, value|
+ record.errors.add attr, 'starts with z.' if value.to_s[0] == ?z
+ end
+ end
+
+ person = Person.new(:first_name => 'zoolander')
+ person.valid? #=> false
+
+ {Learn more}[link:classes/ActiveModel/Validations.html]
+
diff --git a/activemodel/lib/active_model/validations.rb b/activemodel/lib/active_model/validations.rb
index 276472ea46..03733a9c89 100644
--- a/activemodel/lib/active_model/validations.rb
+++ b/activemodel/lib/active_model/validations.rb
@@ -3,6 +3,41 @@ require 'active_support/core_ext/hash/keys'
require 'active_model/errors'
module ActiveModel
+
+ # Provides a full validation framework to your objects.
+ #
+ # A minimal implementation could be:
+ #
+ # class Person
+ # include ActiveModel::Validations
+ #
+ # attr_accessor :first_name, :last_name
+ #
+ # validates_each :first_name, :last_name do |record, attr, value|
+ # record.errors.add attr, 'starts with z.' if value.to_s[0] == ?z
+ # end
+ # end
+ #
+ # Which provides you with the full standard validation stack that you
+ # know from ActiveRecord.
+ #
+ # person = Person.new
+ # person.valid?
+ # #=> true
+ # person.invalid?
+ # #=> false
+ # person.first_name = 'zoolander'
+ # person.valid?
+ # #=> false
+ # person.invalid?
+ # #=> true
+ # person.errors
+ # #=> #<OrderedHash {:first_name=>["starts with z."]}>
+ #
+ # Note that ActiveModel::Validations automatically adds an +errors+ method
+ # to your instances initialized with a new ActiveModel::Errors object, so
+ # there is no need for you to add this manually.
+ #
module Validations
extend ActiveSupport::Concern
include ActiveSupport::Callbacks
@@ -18,8 +53,10 @@ module ActiveModel
# class Person
# include ActiveModel::Validations
#
+ # attr_accessor :first_name, :last_name
+ #
# validates_each :first_name, :last_name do |record, attr, value|
- # record.errors.add attr, 'starts with z.' if value[0] == ?z
+ # record.errors.add attr, 'starts with z.' if value.to_s[0] == ?z
# end
# end
#