Browse files

Better docs for Object extensions (closes #7002)

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6011 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent 5941861 commit 1e9ce3c6a123baf773c89ef2324e9f3d17e2be52 @jamis jamis committed Jan 22, 2007
Showing with 23 additions and 1 deletion.
  1. +2 −0 activesupport/CHANGELOG
  2. +21 −1 activesupport/lib/active_support/core_ext/object/misc.rb
View
2 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]
View
22 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 @@ def returning(value)
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

0 comments on commit 1e9ce3c

Please sign in to comment.