Changeset 7098 for trunk/activeresource/lib/active_resource/validations.rb

Timestamp:

06/23/07 17:29:54 (1 year ago)

Author:

david

Message:

Big documentation upgrade for ARes (closes #8694) [jeremymcanally]

Files:

• trunk/activeresource/lib/active_resource/validations.rb (modified) (12 diffs)

trunk/activeresource/lib/active_resource/validations.rb

@@ -15 +15 @@
-    end
-
+    # Add an error to the base Active Resource object rather than an attribute.
+    #
+    # ==== Examples
+    #   my_folder = Folder.find(1)
+    #   my_folder.errors.add_to_base("You can't edit an existing folder")
+    #   my_folder.errors.on_base
+    #   # => "You can't edit an existing folder"
+    #
+    #   my_folder.errors.add_to_base("This folder has been tagged as frozen")
+    #   my_folder.valid?
+    #   # => false
+    #   my_folder.errors.on_base
+    #   # => ["You can't edit an existing folder", "This folder has been tagged as frozen"]
+    #
-    def add_to_base(msg)
-      add(:base, msg)
-    end
-
+    # Adds an error to an Active Resource object's attribute (named for the +attribute+ parameter)
+    # with the error message in +msg+.
+    #
+    # ==== Examples
+    #   my_resource = Node.find(1)
+    #   my_resource.errors.add('name', 'can not be "base"') if my_resource.name == 'base'
+    #   my_resource.errors.on('name')
+    #   # => 'can not be "base"!'
+    #
+    #   my_resource.errors.add('desc', 'can not be blank') if my_resource.desc == ''
+    #   my_resource.valid?
+    #   # => false
+    #   my_resource.errors.on('desc')
+    #   # => 'can not be blank!'
+    #
-    def add(attribute, msg)
-      @errors[attribute.to_s] = [] if @errors[attribute.to_s].nil?
@@ -25 +54 @@
-
-    # Returns true if the specified +attribute+ has errors associated with it.
+    #
+    # ==== Examples
+    #   my_resource = Disk.find(1)
+    #   my_resource.errors.add('location', 'must be Main') unless my_resource.location == 'Main'
+    #   my_resource.errors.on('location')
+    #   # => 'must be Main!'
+    #
+    #   my_resource.errors.invalid?('location')
+    #   # => true
+    #   my_resource.errors.invalid?('name')
+    #   # => false
-    def invalid?(attribute)
-      !@errors[attribute.to_s].nil?
-    end
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def on(attribute)
-      errors = @errors[attribute.to_s]
@@ -40 +93 @@
-    alias :[] :on
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def on_base
-      on(:base)
@@ -46 +115 @@
-
-    # Yields each attribute and associated message per error added.
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   messages = ''
+    #   my_person.errors.each {|attr, msg| messages += attr.humanize + " " + msg + "<br />"}
+    #   messages
+    #   # => "Login can not be empty<br />Password can not be empty<br />"
+    #
-    def each
-      @errors.each_key { |attr| @errors[attr].each { |msg| yield attr, msg } }
@@ -52 +132 @@
-    # Yields each full error message added. So Person.errors.add("first_name", "can't be empty") will be returned
-    # through iteration as "First name can't be empty".
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   messages = ''
+    #   my_person.errors.each_full {|msg| messages += msg + "<br/>"}
+    #   messages
+    #   # => "Login can not be empty<br />Password can not be empty<br />"
+    #
-    def each_full
-      full_messages.each { |msg| yield msg }
@@ -57 +148 @@
-
-    # Returns all the full error messages in an array.
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   messages = ''
+    #   my_person.errors.full_messages.each {|msg| messages += msg + "<br/>"}
+    #   messages
+    #   # => "Login can not be empty<br />Password can not be empty<br />"
+    #
-    def full_messages
-      full_messages = []
@@ -80 +182 @@
-    # Returns the total number of errors added. Two errors added to the same attribute will be counted as such
-    # with this as well.
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #   my_person.errors.size
+    #   # => 0
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   my_person.error.size
+    #   # => 2
+    #
-    def size
-      @errors.values.inject(0) { |error_count, attribute| error_count + attribute.size }
@@ -87 +200 @@
-    alias_method :length, :size
-    
+    # Grabs errors from the XML response.
-    def from_xml(xml)
-      clear
@@ -103 +217 @@
-  end
-  
-
-
-
+
+
+
+
+
+
-  #
-  #   class Person < ActiveResource::Base
@@ -134 +251 @@
-  #   person.save                         # => true (and person is now saved to the remote service)
-  #
-  # An Errors object is automatically created for every resource.
-  module Validations
-    def self.included(base) # :nodoc:
@@ -142 +258 @@
-    end
-
+    # Validate a resource and save (POST) it to the remote web service.
-    def save_with_validation
-      save_without_validation
@@ -150 +267 @@
-    end
-
+    # Checks for errors on an object (i.e., is resource.errors empty?).
+    # 
+    # ==== Examples
+    #   my_person = Person.create(params[:person])
+    #   my_person.valid?
+    #   # => true
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.valid?
+    #   # => false
-    def valid?
-      errors.empty?