Improved docs for Hash#to_param method

This commit is contained in:
Dalibor Nasevic
2011-03-06 23:54:18 +01:00
parent 8e0affbd86
commit 55d2a211d3

View File

@@ -34,12 +34,11 @@ end
class Hash
# Converts a hash into a string suitable for use as a URL query string. An optional <tt>namespace</tt> can be
# passed to enclose the param names (see example below). The string pairs "key=value" that conform the query
# string are sorted lexicographically in ascending order.
# string are sorted lexicographically in ascending order. This method is also aliased as <tt>to_query</tt>.
#
# ==== Examples
# { :name => 'David', :nationality => 'Danish' }.to_param # => "name=David&nationality=Danish"
#
# { :name => 'David', :nationality => 'Danish' }.to_query('user') # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"
# { :name => 'David', :nationality => 'Danish' }.to_param('user') # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"
def to_param(namespace = nil)
collect do |key, value|
value.to_query(namespace ? "#{namespace}[#{key}]" : key)