aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthew Stopa <matthew.p.stopa@gmail.com>2013-01-01 09:45:30 -0700
committerMatthew Stopa <matthew.p.stopa@gmail.com>2013-01-01 09:55:28 -0700
commita4eaecc83344897a3e6129be31ed622d255b1b20 (patch)
tree24fd708124e1231f21087b3d0a7aa725dcaa1f8c
parentdfc930b2b165f3fc13e0f931e152802ddf3c7c46 (diff)
downloadrails-a4eaecc83344897a3e6129be31ed622d255b1b20.tar.gz
rails-a4eaecc83344897a3e6129be31ed622d255b1b20.tar.bz2
rails-a4eaecc83344897a3e6129be31ed622d255b1b20.zip
Add more documentation to TimeWithZone
[ci skip]
-rw-r--r--activesupport/lib/active_support/time_with_zone.rb14
1 files changed, 14 insertions, 0 deletions
diff --git a/activesupport/lib/active_support/time_with_zone.rb b/activesupport/lib/active_support/time_with_zone.rb
index fdaaacf2fe..d3741845d2 100644
--- a/activesupport/lib/active_support/time_with_zone.rb
+++ b/activesupport/lib/active_support/time_with_zone.rb
@@ -109,6 +109,14 @@ module ActiveSupport
alias_method :gmt_offset, :utc_offset
alias_method :gmtoff, :utc_offset
+ # Returns a formatted string of the offset from UTC, or an alternative
+ # string if the time zone is already UTC.
+ #
+ # Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)"
+ # Time.zone.now.formatted_offset(true) # => "-05:00"
+ # Time.zone.now.formatted_offset(false) # => "-0500"
+ # Time.zone = 'UTC' # => "UTC"
+ # Time.zone.now.formatted_offset(true, "0") # => "0"
def formatted_offset(colon = true, alternate_utc_string = nil)
utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end
@@ -206,18 +214,24 @@ module ActiveSupport
utc <=> other
end
+ # Returns true if the current object's time is within the specified
+ # +min+ and +max+ time.
def between?(min, max)
utc.between?(min, max)
end
+ # Returns true if the current object's time is in the past.
def past?
utc.past?
end
+ # Returns true if the current object's time falls within
+ # the current day.
def today?
time.today?
end
+ # Returns true if the current object's time is in the future.
def future?
utc.future?
end