Merge branch 'master' of git://github.com/lifo/docrails

3 files changed, 22 insertions, 10 deletions

diff --git a/activeresource/lib/active_resource/http_mock.rb b/activeresource/lib/active_resource/http_mock.rb
index e085a05f6d..3bfd536b29 100644
--- a/activeresource/lib/active_resource/http_mock.rb
+++ b/activeresource/lib/active_resource/http_mock.rb
@@ -9,8 +9,8 @@ module ActiveResource
   # requests.
   #
   # To test your Active Resource model, you simply call the ActiveResource::HttpMock.respond_to
-  # method with an attached block.  The block declares a set of URIs with expected input, and the output
-  # each request should return.  The passed in block has any number of entries in the following generalized
+  # method with an attached block. The block declares a set of URIs with expected input, and the output
+  # each request should return. The passed in block has any number of entries in the following generalized
   # format:
   #
   #   mock.http_method(path, request_headers = {}, body = nil, status = 200, response_headers = {})
@@ -29,7 +29,7 @@ module ActiveResource
   #   <tt>request_headers</tt> listed above.
   #
   # In order for a mock to deliver its content, the incoming request must match by the <tt>http_method</tt>,
-  # +path+ and <tt>request_headers</tt>.  If no match is found an InvalidRequestError exception
+  # +path+ and <tt>request_headers</tt>. If no match is found an +InvalidRequestError+ exception
   # will be raised showing you what request it could not find a response for and also what requests and response
   # pairs have been recorded so you can create a new mock for that request.
   #
@@ -80,7 +80,7 @@ module ActiveResource
 
     class << self
 
-      # Returns an array of all request objects that have been sent to the mock.  You can use this to check
+      # Returns an array of all request objects that have been sent to the mock. You can use this to check
       # if your model actually sent an HTTP request.
       #
       # ==== Example
@@ -105,7 +105,7 @@ module ActiveResource
       end
 
       # Returns the list of requests and their mocked responses. Look up a
-      # response for a request using responses.assoc(request).
+      # response for a request using <tt>responses.assoc(request)</tt>.
       def responses
         @@responses ||= []
       end
@@ -299,6 +299,8 @@ module ActiveResource
       end
     end
 
+    # Returns true if code is 2xx,
+    # false otherwise.
     def success?
       code.in?(200..299)
     end
@@ -311,6 +313,8 @@ module ActiveResource
       headers[key] = value
     end
 
+    # Returns true if the other is a Response with an equal body, equal message
+    # and equal headers. Otherwise it returns false.
     def ==(other)
       if (other.is_a?(Response))
         other.body == body && other.message == message && other.headers == headers
diff --git a/activeresource/lib/active_resource/observing.rb b/activeresource/lib/active_resource/observing.rb
index 3c74d49c80..1bfceb8dc8 100644
--- a/activeresource/lib/active_resource/observing.rb
+++ b/activeresource/lib/active_resource/observing.rb
@@ -5,6 +5,14 @@ module ActiveResource
 
     included do
       %w( create save update destroy ).each do |method|
+        # def create_with_notifications(*args, &block)
+        #   notify_observers(:before_create)
+        #   if result = create_without_notifications(*args, &block)
+        #     notify_observers(:after_create)
+        #   end
+        #   result
+        # end
+        # alias_method_chain(create, :notifications)
         class_eval(<<-EOS, __FILE__, __LINE__ + 1)
           def #{method}_with_notifications(*args, &block)
             notify_observers(:before_#{method})
diff --git a/activeresource/lib/active_resource/validations.rb b/activeresource/lib/active_resource/validations.rb
index a373e53f11..ca265d053e 100644
--- a/activeresource/lib/active_resource/validations.rb
+++ b/activeresource/lib/active_resource/validations.rb
@@ -8,9 +8,9 @@ module ActiveResource
   # Active Resource validation is reported to and from this object, which is used by Base#save
   # to determine whether the object in a valid state to be saved. See usage example in Validations.
   class Errors < ActiveModel::Errors
-    # Grabs errors from an array of messages (like ActiveRecord::Validations)
+    # Grabs errors from an array of messages (like ActiveRecord::Validations).
     # The second parameter directs the errors cache to be cleared (default)
-    # or not (by passing true)
+    # or not (by passing true).
     def from_array(messages, save_cache = false)
       clear unless save_cache
       humanized_attributes = Hash[@base.attributes.keys.map { |attr_name| [attr_name.humanize, attr_name] }]
@@ -73,7 +73,7 @@ module ActiveResource
 
       # clear the remote validations so they don't interfere with the local
       # ones. Otherwise we get an endless loop and can never change the
-      # fields so as to make the resource valid
+      # fields so as to make the resource valid.
       @remote_errors = nil
       if perform_validation && valid? || !perform_validation
         save_without_validation
@@ -84,7 +84,7 @@ module ActiveResource
     rescue ResourceInvalid => error
       # cache the remote errors because every call to <tt>valid?</tt> clears
       # all errors. We must keep a copy to add these back after local
-      # validations
+      # validations.
       @remote_errors = error
       load_remote_errors(@remote_errors, true)
       false
@@ -92,7 +92,7 @@ module ActiveResource
 
 
     # Loads the set of remote errors into the object's Errors based on the
-    # content-type of the error-block received
+    # content-type of the error-block received.
     def load_remote_errors(remote_errors, save_cache = false ) #:nodoc:
       case self.class.format
       when ActiveResource::Formats[:xml]