Permalink
Browse files

revised conventions in cookie.rb

  • Loading branch information...
1 parent 08cac39 commit 7e8b2b6bf28fdb4b3a92ba93286ec8b77ef0b6c1 @fxn fxn committed May 21, 2008
Showing with 17 additions and 18 deletions.
  1. +17 −18 actionpack/lib/action_controller/cgi_ext/cookie.rb
View
35 actionpack/lib/action_controller/cgi_ext/cookie.rb
@@ -6,25 +6,24 @@ class Cookie < DelegateClass(Array)
attr_accessor :name, :value, :path, :domain, :expires
attr_reader :secure, :http_only
- # Create a new CGI::Cookie object.
+ # Creates a new CGI::Cookie object.
#
# The contents of the cookie can be specified as a +name+ and one
# or more +value+ arguments. Alternatively, the contents can
# be specified as a single hash argument. The possible keywords of
# this hash are as follows:
#
- # name:: the name of the cookie. Required.
- # value:: the cookie's value or list of values.
- # path:: the path for which this cookie applies. Defaults to the
- # base directory of the CGI script.
- # domain:: the domain for which this cookie applies.
- # expires:: the time at which this cookie expires, as a Time object.
- # secure:: whether this cookie is a secure cookie or not (default to
- # false). Secure cookies are only transmitted to HTTPS
- # servers.
- # http_only:: whether this cookie can be accessed by client side scripts (e.g. document.cookie) or only over HTTP
- # More details: http://msdn2.microsoft.com/en-us/library/system.web.httpcookie.httponly.aspx
- # Defaults to false.
+ # * <tt>:name</tt> - The name of the cookie. Required.
+ # * <tt>:value</tt> - The cookie's value or list of values.
+ # * <tt>:path</tt> - The path for which this cookie applies. Defaults to the
+ # base directory of the CGI script.
+ # * <tt>:domain</tt> - The domain for which this cookie applies.
+ # * <tt>:expires</tt> - The time at which this cookie expires, as a Time object.
+ # * <tt>:secure</tt> - Whether this cookie is a secure cookie or not (defaults to
+ # +false+). Secure cookies are only transmitted to HTTPS servers.
+ # * <tt>:http_only</tt> - Whether this cookie can be accessed by client side scripts (e.g. document.cookie) or only over HTTP.
+ # More details in http://msdn2.microsoft.com/en-us/library/system.web.httpcookie.httponly.aspx. Defaults to +false+.
+ #
# These keywords correspond to attributes of the cookie object.
def initialize(name = '', *value)
if name.kind_of?(String)
@@ -56,17 +55,17 @@ def initialize(name = '', *value)
super(@value)
end
- # Set whether the Cookie is a secure cookie or not.
+ # Sets whether the Cookie is a secure cookie or not.
def secure=(val)
@secure = val == true
end
- # Set whether the Cookie is an HTTP only cookie or not.
+ # Sets whether the Cookie is an HTTP only cookie or not.
def http_only=(val)
@http_only = val == true
end
- # Convert the Cookie to its string representation.
+ # Converts the Cookie to its string representation.
def to_s
buf = ''
buf << @name << '='
@@ -79,11 +78,11 @@ def to_s
buf
end
- # Parse a raw cookie string into a hash of cookie-name=>Cookie
+ # Parses a raw cookie string into a hash of <tt>cookie-name => cookie-object</tt>
# pairs.
#
# cookies = CGI::Cookie::parse("raw_cookie_string")
- # # { "name1" => cookie1, "name2" => cookie2, ... }
+ # # => { "name1" => cookie1, "name2" => cookie2, ... }
#
def self.parse(raw_cookie)
cookies = Hash.new([])

0 comments on commit 7e8b2b6

Please sign in to comment.