Better docs for Object extensions (closes #7002)

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6011 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

2 files changed, 23 insertions, 1 deletions

diff --git a/activesupport/CHANGELOG b/activesupport/CHANGELOG
index 7d42bf9e5c..aab84054cc 100644
--- a/activesupport/CHANGELOG
+++ b/activesupport/CHANGELOG
@@ -1,5 +1,7 @@
 *SVN*
 
+* Better docs for Object extensions [zackchandler, Jamis Buck]
+
 * Fix that Dates couldn't be subtracted from Dates after [5940].  [Sam Stephenson]
 
 * Add Object#acts_like? and Time#acts_like_time? and Date#acts_like_date? to facilitate duck-typing. [Jamis Buck]
diff --git a/activesupport/lib/active_support/core_ext/object/misc.rb b/activesupport/lib/active_support/core_ext/object/misc.rb
index aae336e6f4..d82bb929a2 100644
--- a/activesupport/lib/active_support/core_ext/object/misc.rb
+++ b/activesupport/lib/active_support/core_ext/object/misc.rb
@@ -1,4 +1,4 @@
-class Object #:nodoc:
+class Object
   # A Ruby-ized realization of the K combinator, courtesy of Mikael Brockman.
   #
   #   def foo
@@ -24,10 +24,30 @@ class Object #:nodoc:
     value
   end
 
+  # An elegant way to refactor out common options
+  # 
+  #   with_options :order => 'created_at', :class_name => 'Comment' do |post|
+  #     post.has_many :comments, :conditions => ['approved = ?', true], :dependent => :delete_all
+  #     post.has_many :unapproved_comments, :conditions => ['approved = ?', false]
+  #     post.has_many :all_comments
+  #   end
+  #
+  # Can also be used with an explicit reciever:
+  #
+  #   map.with_options :controller => "people" do |people|
+  #     people.connect "/people",     :action => "index"
+  #     people.connect "/people/:id", :action => "show"
+  #   end
+  #
   def with_options(options)
     yield ActiveSupport::OptionMerger.new(self, options)
   end
   
+  # Dumps object in JSON (JavaScript Object Notation).  See www.json.org for more info.
+  #
+  #   Account.find(1).to_json
+  #   => "{attributes: {username: \"foo\", id: \"1\", password: \"bar\"}}"
+  #
   def to_json
     ActiveSupport::JSON.encode(self)
   end