Skip to content
Browse files

Add documentation for TimeWithZone methods

  • Loading branch information...
1 parent 6d5385a commit f42c0893112e4411f9f1469c019e41968bcbe0e5 @MattStopa MattStopa committed Dec 31, 2012
Showing with 19 additions and 3 deletions.
  1. +19 −3 activesupport/lib/active_support/time_with_zone.rb
View
22 activesupport/lib/active_support/time_with_zone.rb
@@ -83,19 +83,27 @@ def localtime
# Returns true if the the current time is within Daylight Savings Time for the
# specified time zone.
#
- # Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
- # Time.zone.parse("2012-5-30").dst? # => true
- # Time.zone.parse("2012-11-30").dst? # => false
+ # Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
+ # Time.zone.parse("2012-5-30").dst? # => true
+ # Time.zone.parse("2012-11-30").dst? # => false
def dst?
period.dst?
end
alias_method :isdst, :dst?
+ # Returns true if the the current time zone is set to UTC.
+ #
+ # Time.zone = 'UTC' # => 'UTC'
+ # Time.zone.now.utc? # => true
+ # Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
+ # Time.zone.now.utc? # => false
def utc?
time_zone.name == 'UTC'
end
alias_method :gmt?, :utc?
+ # Returns a +Fixnum+ of the offset from current time zone to UTC time
+ # in seconds.
def utc_offset
period.utc_total_offset
end
@@ -153,10 +161,18 @@ def encode_with(coder)
end
end
+ # Returns a string of the object's date and time in the format used by
+ # HTTP requests.
+ #
+ # Time.zone.now.httpdate # => "Tue, 01 Jan 2013 04:39:43 GMT"
def httpdate
utc.httpdate
end
+ # Returns a string of the object's date and time in the RFC 2822 standard
+ # format.
+ #
+ # Time.zone.now.rfc2822 # => "Tue, 01 Jan 2013 04:51:39 +0000"
def rfc2822
to_s(:rfc822)
end

0 comments on commit f42c089

Please sign in to comment.
Something went wrong with that request. Please try again.