Class: Time

### Home Classes Methods

### In Files

- lib/active_support/core_ext/time/acts_like.rb
- lib/active_support/core_ext/time/calculations.rb
- lib/active_support/core_ext/time/conversions.rb
- lib/active_support/core_ext/time/marshal.rb
- lib/active_support/core_ext/time/publicize_conversion_methods.rb
- lib/active_support/core_ext/time/zones.rb
- lib/active_support/json/encoding.rb

### Parent

Object

### Methods

- ::===
- ::_load
- ::_load_without_utc_flag
- ::_load_without_zone
- ::at
- ::at_with_coercion
- ::at_without_coercion
- ::current
- ::days_in_month
- ::find_zone
- ::find_zone!
- ::local_time
- ::time_with_datetime_fallback
- ::use_zone
- ::utc_time
- ::zone
- ::zone=
- #-
- #<=>
- #_dump
- #_dump_without_utc_flag
- #_dump_without_zone
- #acts_like_time?
- #advance
- #ago
- #all_day
- #all_month
- #all_quarter
- #all_week
- #all_year
- #at_beginning_of_day
- #at_beginning_of_hour
- #at_beginning_of_month
- #at_beginning_of_quarter
- #at_beginning_of_week
- #at_beginning_of_year
- #at_end_of_month
- #at_end_of_quarter
- #at_end_of_week
- #at_end_of_year
- #at_midnight
- #beginning_of_day
- #beginning_of_hour
- #beginning_of_month
- #beginning_of_quarter
- #beginning_of_week
- #beginning_of_year
- #change
- #compare_with_coercion
- #compare_without_coercion
- #days_to_week_start
- #end_of_day
- #end_of_hour
- #end_of_month
- #end_of_quarter
- #end_of_week
- #end_of_year
- #eql?
- #eql_with_coercion
- #eql_without_coercion
- #formatted_offset
- #future?
- #in
- #in_time_zone
- #midnight
- #minus_with_coercion
- #minus_without_coercion
- #minus_without_duration
- #monday
- #months_ago
- #months_since
- #next_month
- #next_week
- #next_year
- #past?
- #prev_month
- #prev_week
- #prev_year
- #seconds_since_midnight
- #since
- #sunday
- #to_date
- #to_datetime
- #to_default_s
- #to_formatted_s
- #to_s
- #to_time
- #today?
- #tomorrow
- #weeks_ago
- #years_ago
- #years_since
- #yesterday

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# Time

### Constants

COMMON_YEAR_DAYS_IN_MONTH
DATE_FORMATS
DAYS_INTO_WEEK

### Attributes

zone_default[RW]

### Public Class Methods

===(other) click to toggle source

Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances

    # File lib/active_support/core_ext/time/calculations.rb, line 12
    def ===(other)
      super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone))
    end

_load(marshaled_time) click to toggle source

    # File lib/active_support/core_ext/time/marshal.rb, line 8
    def _load(marshaled_time)
      time = _load_without_utc_flag(marshaled_time)
      time.instance_eval do
        if defined?(@marshal_with_utc_coercion)
          val = remove_instance_variable("@marshal_with_utc_coercion")
        end
        val ? utc : self
      end
    end

Also aliased as: _load_without_utc_flag, _load_without_zone
_load_without_utc_flag(marshaled_time) click to toggle source
Alias for: _load
_load_without_zone(marshaled_time) click to toggle source
Alias for: _load
at(*args) click to toggle source
Also aliased as: at_without_coercion
Alias for: at_with_coercion
at_with_coercion(*args) click to toggle source

Layers additional behavior on Time.at so that ActiveSupport::TimeWithZone and DateTime instances can be used when called with a single argument

    # File lib/active_support/core_ext/time/calculations.rb, line 51
    def at_with_coercion(*args)
      return at_without_coercion(*args) if args.size != 1

      # Time.at can be called with a time or numerical value
      time_or_number = args.first

      if time_or_number.is_a?(ActiveSupport::TimeWithZone) || time_or_number.is_a?(DateTime)
        at_without_coercion(time_or_number.to_f).getlocal
      else
        at_without_coercion(time_or_number)
      end
    end

Also aliased as: at
at_without_coercion(*args) click to toggle source
Alias for: at
current() click to toggle source

Returns `Time.zone.now` when `Time.zone` or `config.time_zone` are set, otherwise just returns `Time.now`.

    # File lib/active_support/core_ext/time/calculations.rb, line 45
    def current
      ::Time.zone ? ::Time.zone.now : ::Time.now
    end

days_in_month(month, year = now.year) click to toggle source

Return the number of days in the given month. If no year is specified, it will use the current year.

    # File lib/active_support/core_ext/time/calculations.rb, line 18
    def days_in_month(month, year = now.year)
      return 29 if month == 2 && ::Date.gregorian_leap?(year)
      COMMON_YEAR_DAYS_IN_MONTH[month]
    end

find_zone(time_zone) click to toggle source

    # File lib/active_support/core_ext/time/zones.rb, line 64
    def find_zone(time_zone)
      find_zone!(time_zone) rescue nil
    end

find_zone!(time_zone) click to toggle source

Returns a TimeZone instance or nil, or raises an ArgumentError for invalid timezones.

    # File lib/active_support/core_ext/time/zones.rb, line 52
    def find_zone!(time_zone)
      return time_zone if time_zone.nil? || time_zone.is_a?(ActiveSupport::TimeZone)
      # lookup timezone based on identifier (unless we've been passed a TZInfo::Timezone)
      unless time_zone.respond_to?(:period_for_local)
        time_zone = ActiveSupport::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone)
      end
      # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
      time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone.create(time_zone.name, nil, time_zone)
    rescue TZInfo::InvalidTimezoneIdentifier
      raise ArgumentError, "Invalid Timezone: #{time_zone}"
    end

local_time(*args) click to toggle source

Wraps class method `time_with_datetime_fallback` with `utc_or_local` set to `:local`.

    # File lib/active_support/core_ext/time/calculations.rb, line 40
    def local_time(*args)
      time_with_datetime_fallback(:local, *args)
    end

time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0) click to toggle source

Returns a new Time if requested year can be accommodated by Ruby’s Time class (i.e., if year is within either 1970..2038 or 1902..2038, depending on system architecture); otherwise returns a DateTime.

    # File lib/active_support/core_ext/time/calculations.rb, line 26
    def time_with_datetime_fallback(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0, usec=0)
      time = ::Time.send(utc_or_local, year, month, day, hour, min, sec, usec)
      # This check is needed because Time.utc(y) returns a time object in the 2000s for 0 <= y <= 138.
      time.year == year ? time : ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec)
    rescue
      ::DateTime.civil_from_format(utc_or_local, year, month, day, hour, min, sec)
    end

use_zone(time_zone) click to toggle source

Allows override of `Time.zone` locally inside supplied block; resets `Time.zone` to existing value when done.

    # File lib/active_support/core_ext/time/zones.rb, line 41
    def use_zone(time_zone)
      new_zone = find_zone!(time_zone)
      begin
        old_zone, ::Time.zone = ::Time.zone, new_zone
        yield
      ensure
        ::Time.zone = old_zone
      end
    end

utc_time(*args) click to toggle source

Wraps class method `time_with_datetime_fallback` with `utc_or_local` set to `:utc`.

    # File lib/active_support/core_ext/time/calculations.rb, line 35
    def utc_time(*args)
      time_with_datetime_fallback(:utc, *args)
    end

zone() click to toggle source

Returns the TimeZone for the current request, if this has been set (via Time.zone=). If `Time.zone` has not been set for the current request, returns the TimeZone specified in `config.time_zone`.

    # File lib/active_support/core_ext/time/zones.rb, line 9
    def zone
      Thread.current[:time_zone] || zone_default
    end

zone=(time_zone) click to toggle source

Sets `Time.zone` to a TimeZone object for the current request/thread.

This method accepts any of the following:

- A Rails TimeZone object.

- An identifier for a Rails TimeZone object (e.g., “Eastern Time (US & Canada)”, `-5.hours`).

- A TZInfo::Timezone object.

- An identifier for a TZInfo::Timezone object (e.g., “America/New_York”).

Here’s an example of how you might set `Time.zone` on a per request basis and reset it when the request is done. `current_user.time_zone` just needs to return a string identifying the user’s preferred time zone:

    class ApplicationController < ActionController::Base
      around_filter :set_time_zone

      def set_time_zone
        old_time_zone = Time.zone
        Time.zone = current_user.time_zone if logged_in?
        yield
      ensure
        Time.zone = old_time_zone
      end
    end

    # File lib/active_support/core_ext/time/zones.rb, line 36
    def zone=(time_zone)
      Thread.current[:time_zone] = find_zone!(time_zone)
    end

### Public Instance Methods

-(other) click to toggle source
Also aliased as: minus_without_duration, minus_without_coercion
Alias for: minus_with_coercion
<=>(other) click to toggle source
Also aliased as: compare_without_coercion
Alias for: compare_with_coercion
_dump(*args) click to toggle source

    # File lib/active_support/core_ext/time/marshal.rb, line 20
    def _dump(*args)
      obj = dup
      obj.instance_variable_set('@marshal_with_utc_coercion', utc?)
      obj.send :_dump_without_utc_flag, *args
    end

Also aliased as: _dump_without_utc_flag, _dump_without_zone
_dump_without_utc_flag(*args) click to toggle source
Alias for: _dump
_dump_without_zone(*args) click to toggle source
Alias for: _dump
acts_like_time?() click to toggle source

Duck-types as a Time-like class. See Object#acts_like?.

    # File lib/active_support/core_ext/time/acts_like.rb, line 5
    def acts_like_time?
      true
    end

advance(options) click to toggle source

Uses Date to provide precise Time calculations for years, months, and days. The `options` parameter takes a hash with any of these keys: `:years`, `:months`, `:weeks`, `:days`, `:hours`, `:minutes`, `:seconds`.

    # File lib/active_support/core_ext/time/calculations.rb, line 107
    def advance(options)
      unless options[:weeks].nil?
        options[:weeks], partial_weeks = options[:weeks].divmod(1)
        options[:days] = (options[:days] || 0) + 7 * partial_weeks
      end

      unless options[:days].nil?
        options[:days], partial_days = options[:days].divmod(1)
        options[:hours] = (options[:hours] || 0) + 24 * partial_days
      end

      d = to_date.advance(options)
      time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
      seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
      seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance)
    end

ago(seconds) click to toggle source

Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension

    # File lib/active_support/core_ext/time/calculations.rb, line 125
    def ago(seconds)
      since(-seconds)
    end

all_day() click to toggle source

Returns a Range representing the whole day of the current time.

    # File lib/active_support/core_ext/time/calculations.rb, line 301
    def all_day
      beginning_of_day..end_of_day
    end

all_month() click to toggle source

Returns a Range representing the whole month of the current time.

    # File lib/active_support/core_ext/time/calculations.rb, line 311
    def all_month
      beginning_of_month..end_of_month
    end

all_quarter() click to toggle source

Returns a Range representing the whole quarter of the current time.

    # File lib/active_support/core_ext/time/calculations.rb, line 316
    def all_quarter
      beginning_of_quarter..end_of_quarter
    end

all_week(start_day = :monday) click to toggle source

Returns a Range representing the whole week of the current time. Week starts on start_day (default is :monday, i.e. end of Sunday).

    # File lib/active_support/core_ext/time/calculations.rb, line 306
    def all_week(start_day = :monday)
      beginning_of_week(start_day)..end_of_week(start_day)
    end

all_year() click to toggle source

Returns a Range representing the whole year of the current time.

    # File lib/active_support/core_ext/time/calculations.rb, line 321
    def all_year
      beginning_of_year..end_of_year
    end

at_beginning_of_day() click to toggle source
Alias for: beginning_of_day
at_beginning_of_hour() click to toggle source
Alias for: beginning_of_hour
at_beginning_of_month() click to toggle source
Alias for: beginning_of_month
at_beginning_of_quarter() click to toggle source
Alias for: beginning_of_quarter
at_beginning_of_week(start_day = :monday) click to toggle source
Alias for: beginning_of_week
at_beginning_of_year() click to toggle source
Alias for: beginning_of_year
at_end_of_month() click to toggle source
Alias for: end_of_month
at_end_of_quarter() click to toggle source
Alias for: end_of_quarter
at_end_of_week(start_day = :monday) click to toggle source
Alias for: end_of_week
at_end_of_year() click to toggle source
Alias for: end_of_year
at_midnight() click to toggle source
Alias for: beginning_of_day
beginning_of_day() click to toggle source

Returns a new Time representing the start of the day (0:00)

    # File lib/active_support/core_ext/time/calculations.rb, line 227
    def beginning_of_day
      #(self - seconds_since_midnight).change(:usec => 0)
      change(:hour => 0)
    end

Also aliased as: midnight, at_midnight, at_beginning_of_day
beginning_of_hour() click to toggle source

Returns a new Time representing the start of the hour (x:00)

    # File lib/active_support/core_ext/time/calculations.rb, line 241
    def beginning_of_hour
      change(:min => 0)
    end

Also aliased as: at_beginning_of_hour
beginning_of_month() click to toggle source

Returns a new Time representing the start of the month (1st of the month, 0:00)

    # File lib/active_support/core_ext/time/calculations.rb, line 252
    def beginning_of_month
      #self - ((self.mday-1).days + self.seconds_since_midnight)
      change(:day => 1, :hour => 0)
    end

Also aliased as: at_beginning_of_month
beginning_of_quarter() click to toggle source

Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00)

    # File lib/active_support/core_ext/time/calculations.rb, line 267
    def beginning_of_quarter
      beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= month })
    end

Also aliased as: at_beginning_of_quarter
beginning_of_week(start_day = :monday) click to toggle source

Returns a new Time representing the “start” of this week, week starts on start_day (default is :monday, i.e. Monday, 0:00).

    # File lib/active_support/core_ext/time/calculations.rb, line 191
    def beginning_of_week(start_day = :monday)
      days_to_start = days_to_week_start(start_day)
      (self - days_to_start.days).midnight
    end

Also aliased as: at_beginning_of_week
beginning_of_year() click to toggle source

Returns a new Time representing the start of the year (1st of january, 0:00)

    # File lib/active_support/core_ext/time/calculations.rb, line 279
    def beginning_of_year
      change(:month => 1, :day => 1, :hour => 0)
    end

Also aliased as: at_beginning_of_year
change(options) click to toggle source

Returns a new Time where one or more of the elements have been changed according to the `options` parameter. The time options (hour, min, sec, usec) reset cascadingly, so if only the hour is passed, then minute, sec, and usec is set to 0. If the hour and minute is passed, then sec and usec is set to 0.

    # File lib/active_support/core_ext/time/calculations.rb, line 90
    def change(options)
      ::Time.send(
        utc? ? :utc_time : :local_time,
        options[:year]  || year,
        options[:month] || month,
        options[:day]   || day,
        options[:hour]  || hour,
        options[:min]   || (options[:hour] ? 0 : min),
        options[:sec]   || ((options[:hour] || options[:min]) ? 0 : sec),
        options[:usec]  || ((options[:hour] || options[:min] || options[:sec]) ? 0 : usec)
      )
    end

compare_with_coercion(other) click to toggle source

Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time

    # File lib/active_support/core_ext/time/calculations.rb, line 357
    def compare_with_coercion(other)
      # we're avoiding Time#to_datetime cause it's expensive
      other.is_a?(Time) ? compare_without_coercion(other.to_time) : to_datetime <=> other
    end

Also aliased as: <=>
compare_without_coercion(other) click to toggle source
Alias for: <=>
days_to_week_start(start_day = :monday) click to toggle source

Returns number of days to start of this week, week starts on start_day (default is :monday).

    # File lib/active_support/core_ext/time/calculations.rb, line 183
    def days_to_week_start(start_day = :monday)
      start_day_number = DAYS_INTO_WEEK[start_day]
      current_day_number = wday != 0 ? wday - 1 : 6
      days_span = current_day_number - start_day_number
      days_span >= 0 ? days_span : 7 + days_span
    end

end_of_day() click to toggle source

Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9)

    # File lib/active_support/core_ext/time/calculations.rb, line 236
    def end_of_day
      change(:hour => 23, :min => 59, :sec => 59, :usec => Rational(999999999, 1000))
    end

end_of_hour() click to toggle source

Returns a new Time representing the end of the hour, x:59:59.999999 (.999999999 in ruby1.9)

    # File lib/active_support/core_ext/time/calculations.rb, line 247
    def end_of_hour
      change(:min => 59, :sec => 59, :usec => Rational(999999999, 1000))
    end

end_of_month() click to toggle source

Returns a new Time representing the end of the month (end of the last day of the month)

    # File lib/active_support/core_ext/time/calculations.rb, line 259
    def end_of_month
      #self - ((self.mday-1).days + self.seconds_since_midnight)
      last_day = ::Time.days_in_month(month, year)
      change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => Rational(999999999, 1000))
    end

Also aliased as: at_end_of_month
end_of_quarter() click to toggle source

Returns a new Time representing the end of the quarter (end of the last day of march, june, september, december)

    # File lib/active_support/core_ext/time/calculations.rb, line 273
    def end_of_quarter
      beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= month }).end_of_month
    end

Also aliased as: at_end_of_quarter
end_of_week(start_day = :monday) click to toggle source

Returns a new Time representing the end of this week, week starts on start_day (default is :monday, i.e. end of Sunday).

    # File lib/active_support/core_ext/time/calculations.rb, line 204
    def end_of_week(start_day = :monday)
      days_to_end =  6 - days_to_week_start(start_day)
      (self + days_to_end.days).end_of_day
    end

Also aliased as: at_end_of_week
end_of_year() click to toggle source

Returns a new Time representing the end of the year (end of the 31st of december)

    # File lib/active_support/core_ext/time/calculations.rb, line 285
    def end_of_year
      change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59, :usec => Rational(999999999, 1000))
    end

Also aliased as: at_end_of_year
eql?(other) click to toggle source
Also aliased as: eql_without_coercion
Alias for: eql_with_coercion
eql_with_coercion(other) click to toggle source

Layers additional behavior on Time#eql? so that ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time

    # File lib/active_support/core_ext/time/calculations.rb, line 366
    def eql_with_coercion(other)
      # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do eql? comparison
      other = other.comparable_time if other.respond_to?(:comparable_time)
      eql_without_coercion(other)
    end

Also aliased as: eql?
eql_without_coercion(other) click to toggle source
Alias for: eql?
formatted_offset(colon = true, alternate_utc_string = nil) click to toggle source

Returns the UTC offset as an +HH:MM formatted string.

    Time.local(2000).formatted_offset         # => "-06:00"
    Time.local(2000).formatted_offset(false)  # => "-0600"

    # File lib/active_support/core_ext/time/conversions.rb, line 56
    def formatted_offset(colon = true, alternate_utc_string = nil)
      utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
    end

future?() click to toggle source

Tells whether the Time object’s time lies in the future

    # File lib/active_support/core_ext/time/calculations.rb, line 78
    def future?
      self > ::Time.current
    end

in(seconds) click to toggle source
Alias for: since
in_time_zone(zone = ::Time.zone) click to toggle source

Returns the simultaneous time in `Time.zone`.

    Time.zone = 'Hawaii'         # => 'Hawaii'
    Time.utc(2000).in_time_zone  # => Fri, 31 Dec 1999 14:00:00 HST -10:00

This method is similar to Time#localtime, except that it uses `Time.zone` as the local zone instead of the operating system’s time zone.

You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument, and the conversion will be based on that zone instead of `Time.zone`.

    Time.utc(2000).in_time_zone('Alaska')  # => Fri, 31 Dec 1999 15:00:00 AKST -09:00

    # File lib/active_support/core_ext/time/zones.rb, line 81
    def in_time_zone(zone = ::Time.zone)
      return self unless zone

      ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.find_zone!(zone))
    end

midnight() click to toggle source
Alias for: beginning_of_day
minus_with_coercion(other) click to toggle source

Time#- can also be used to determine the number of seconds between two Time instances. We’re layering on additional behavior so that ActiveSupport::TimeWithZone instances are coerced into values that Time#- will recognize

    # File lib/active_support/core_ext/time/calculations.rb, line 348
    def minus_with_coercion(other)
      other = other.comparable_time if other.respond_to?(:comparable_time)
      other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other)
    end

Also aliased as: -
minus_without_coercion(other) click to toggle source
Alias for: -
minus_without_duration(other) click to toggle source
Alias for: -
monday() click to toggle source

Returns a new `Date`/`DateTime` representing the start of this week. Week is assumed to start on a Monday. `DateTime` objects have their time set to 0:00.

    # File lib/active_support/core_ext/time/calculations.rb, line 199
    def monday
      beginning_of_week
    end

months_ago(months) click to toggle source

Returns a new Time representing the time a number of specified months ago

    # File lib/active_support/core_ext/time/calculations.rb, line 143
    def months_ago(months)
      advance(:months => -months)
    end

months_since(months) click to toggle source

Returns a new Time representing the time a number of specified months in the future

    # File lib/active_support/core_ext/time/calculations.rb, line 148
    def months_since(months)
      advance(:months => months)
    end

next_month() click to toggle source

Short-hand for months_since(1)

    # File lib/active_support/core_ext/time/calculations.rb, line 178
    def next_month
      months_since(1)
    end

next_week(day = :monday) click to toggle source

Returns a new Time representing the start of the given day in next week (default is :monday).

    # File lib/active_support/core_ext/time/calculations.rb, line 222
    def next_week(day = :monday)
      since(1.week).beginning_of_week.since(DAYS_INTO_WEEK[day].day).change(:hour => 0)
    end

next_year() click to toggle source

Short-hand for years_since(1)

    # File lib/active_support/core_ext/time/calculations.rb, line 168
    def next_year
      years_since(1)
    end

past?() click to toggle source

Tells whether the Time object’s time lies in the past

    # File lib/active_support/core_ext/time/calculations.rb, line 68
    def past?
      self < ::Time.current
    end

prev_month() click to toggle source

Short-hand for months_ago(1)

    # File lib/active_support/core_ext/time/calculations.rb, line 173
    def prev_month
      months_ago(1)
    end

prev_week(day = :monday) click to toggle source

Returns a new Time representing the start of the given day in the previous week (default is :monday).

    # File lib/active_support/core_ext/time/calculations.rb, line 217
    def prev_week(day = :monday)
      ago(1.week).beginning_of_week.since(DAYS_INTO_WEEK[day].day).change(:hour => 0)
    end

prev_year() click to toggle source

Short-hand for years_ago(1)

    # File lib/active_support/core_ext/time/calculations.rb, line 163
    def prev_year
      years_ago(1)
    end

seconds_since_midnight() click to toggle source

Seconds since midnight: Time.now.seconds_since_midnight

    # File lib/active_support/core_ext/time/calculations.rb, line 83
    def seconds_since_midnight
      to_i - change(:hour => 0).to_i + (usec / 1.0e+6)
    end

since(seconds) click to toggle source

Returns a new Time representing the time a number of seconds since the instance time

    # File lib/active_support/core_ext/time/calculations.rb, line 130
    def since(seconds)
      self + seconds
    rescue
      to_datetime.since(seconds)
    end

Also aliased as: in
sunday() click to toggle source

Returns a new `Date`/`DateTime` representing the end of this week. Week is assumed to start on a Monday. `DateTime` objects have their time set to 23:59:59.

    # File lib/active_support/core_ext/time/calculations.rb, line 212
    def sunday
      end_of_week
    end

to_date() click to toggle source

Converts a Time object to a Date, dropping hour, minute, and second precision.

    my_time = Time.now  # => Mon Nov 12 22:59:51 -0500 2007
    my_time.to_date     # => Mon, 12 Nov 2007

    your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
    your_time.to_date                                 # => Tue, 13 Jan 2009

    # File lib/active_support/core_ext/time/conversions.rb, line 67
    def to_date
      ::Date.new(year, month, day)
    end

to_datetime() click to toggle source

Converts a Time instance to a Ruby DateTime instance, preserving UTC offset.

    my_time = Time.now    # => Mon Nov 12 23:04:21 -0500 2007
    my_time.to_datetime   # => Mon, 12 Nov 2007 23:04:21 -0500

    your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
    your_time.to_datetime                             # => Tue, 13 Jan 2009 13:13:03 -0500

    # File lib/active_support/core_ext/time/conversions.rb, line 84
    def to_datetime
      ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400))
    end

to_default_s(format = :default) click to toggle source
Alias for: to_s
to_formatted_s(format = :default) click to toggle source

Converts to a formatted string. See DATE_FORMATS for builtin formats.

This method is aliased to `to_s`.

    time = Time.now                     # => Thu Jan 18 06:10:17 CST 2007

    time.to_formatted_s(:time)          # => "06:10"
    time.to_s(:time)                    # => "06:10"

    time.to_formatted_s(:db)            # => "2007-01-18 06:10:17"
    time.to_formatted_s(:number)        # => "20070118061017"
    time.to_formatted_s(:short)         # => "18 Jan 06:10"
    time.to_formatted_s(:long)          # => "January 18, 2007 06:10"
    time.to_formatted_s(:long_ordinal)  # => "January 18th, 2007 06:10"
    time.to_formatted_s(:rfc822)        # => "Thu, 18 Jan 2007 06:10:17 -0600"

## Adding your own time formats to `to_formatted_s`

You can add your own formats to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time argument as the value.

    # config/initializers/time_formats.rb
    Time::DATE_FORMATS[:month_and_year] = "%B %Y"
    Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }

    # File lib/active_support/core_ext/time/conversions.rb, line 42
    def to_formatted_s(format = :default)
      if formatter = DATE_FORMATS[format]
        formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
      else
        to_default_s
      end
    end

Also aliased as: to_s
to_s(format = :default) click to toggle source
Also aliased as: to_default_s
Alias for: to_formatted_s
to_time() click to toggle source

A method to keep Time, Date and DateTime instances interchangeable on conversions. In this case, it simply returns `self`.

    # File lib/active_support/core_ext/time/conversions.rb, line 73
    def to_time
      self
    end

today?() click to toggle source

Tells whether the Time object’s time is today

    # File lib/active_support/core_ext/time/calculations.rb, line 73
    def today?
      to_date == ::Date.current
    end

tomorrow() click to toggle source

Convenience method which returns a new Time representing the time 1 day since the instance time

    # File lib/active_support/core_ext/time/calculations.rb, line 296
    def tomorrow
      advance(:days => 1)
    end

weeks_ago(weeks) click to toggle source

Returns a new Time representing the time a number of specified weeks ago.

    # File lib/active_support/core_ext/time/calculations.rb, line 138
    def weeks_ago(weeks)
      advance(:weeks => -weeks)
    end

years_ago(years) click to toggle source

Returns a new Time representing the time a number of specified years ago

    # File lib/active_support/core_ext/time/calculations.rb, line 153
    def years_ago(years)
      advance(:years => -years)
    end

years_since(years) click to toggle source

Returns a new Time representing the time a number of specified years in the future

    # File lib/active_support/core_ext/time/calculations.rb, line 158
    def years_since(years)
      advance(:years => years)
    end

yesterday() click to toggle source

Convenience method which returns a new Time representing the time 1 day ago

    # File lib/active_support/core_ext/time/calculations.rb, line 291
    def yesterday
      advance(:days => -1)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.