Ticket #7308: activeresource_update_attributes_patch.diff

test/base_test.rb

@@ -220 +220 @@
-    assert_raises(ActiveResource::ResourceConflict) { Person.find(2).save }
-  end
-
+  def test_update_attribute
+    matz = Person.find(:first)
+    assert matz.update_attribute("name", "David")
+    assert_equal "David", matz.name
+    assert_equal 1, matz.id   # make sure don't wipe out other attrs.
+    
+    # Test exceptions get raised
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.put    "/people/1.xml",             {}, nil, 409
+    end
+    assert_raise(ActiveResource::ResourceConflict) { matz.update_attribute("name", "David") }
+  end
+
+  def test_update_attributes
+    matz = Person.find(:first)
+    matz.sex = 'male'
+    assert matz.update_attributes("name" => "David", "sex" => "female")
+    assert_equal "David", matz.name
+    assert_equal "female", matz.sex
+    assert_equal 1, matz.id   # make sure don't wipe out other attrs.
+    
+    # Test exceptions get raised
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.put    "/people/1.xml",             {}, nil, 409
+    end
+    assert_raise(ActiveResource::ResourceConflict) { matz.update_attributes("name" => "David", "sex" => "") }
+  end
+
-  def test_destroy
-    assert Person.find(1).destroy
-    ActiveResource::HttpMock.respond_to do |mock|

lib/active_resource/base.rb

@@ -186 +186 @@
-      new? ? create : update
-    end
-
+    # Updates a single attribute and requests that the resource be saved.
+    #
+    # Note: Unlike ActiveRecord::Base.update_attribute, this method <b>is</b> subject to normal validation
+    # routines as an update sends the whole body of the resource in the request.  (See Validations).
+    # As such, this method is equivalent to calling update_attributes with a single attribute/value pair.
+    #
+    # Note: Also unlike ActiveRecord::Base, ActiveResource currently uses string versions of attribute
+    # names, so use <tt>update_attribute("name", "ryan")</tt> <em>instead of</em> <tt>update_attribute(:name, "ryan")</tt>.
+    #
+    # If the saving fails because of a connection or remote service error, an exception will be raised.  If saving
+    # fails because the resource is invalid then <tt>false</tt> will be returned.
+    #    
+    def update_attribute(name, value); update_attributes(name => value); end
+
+    # Updates this resource withe all the attributes from the passed-in Hash and requests that
+    # the record be saved.
+    #
+    # If the saving fails because of a connection or remote service error, an exception will be raised.  If saving
+    # fails because the resource is invalid then <tt>false</tt> will be returned.
+    #
+    # Note: Though this request can be made with a partial set of the resource's attributes, the full body
+    # of the request will still be sent in the save request to the remote service.  Also note that
+    # ActiveResource currently uses string versions of attribute
+    # names, so use <tt>update_attributes("name" => "ryan")</tt> <em>instead of</em> <tt>update_attribute(:name => "ryan")</tt>.
+    #    
+    def update_attributes(attributes)
+      load(attributes) && save
+    end
+
-    # Delete the resource.
-    def destroy
-      connection.delete(element_path)

README

@@ -43 +43 @@
-   ryan.first = 'Rizzle'
-   ryan.save  #=> true
-
+   # Or
+   ryan = Person.find(1)
+   ryan.update_attribute('first', 'Rizzle')  #=> true
+
-   # And destruction
-   # DELETE http://api.people.com:3000/people/1.xml
-   #
@@ -146 +150 @@
-  ryan.first = 'Rizzle'
-  ryan.save  #=> true
-
+<tt>update_attribute</tt> and <tt>update_attributes</tt> work very similarly to ActiveRecord except that both
+are subject to validation errors and the string attribute name is expected:
+
+  # <person><first>Ryan</first></person>
+  #
+  # is submitted as the body on
+  #
+  # PUT http://api.people.com:3000/people/1.xml
+  #
+  # when save is called on an existing Person object.  An empty response is
+  # is expected with code (204)
+  #
+  ryan = Person.find(1)
+  ryan.update_attribute('first', 'Ryan')  #=> true
+
-==== Delete
-
-Destruction of a resource can be invoked as a class and instance method of the resource.