DateTime

Public Class Methods

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

    # File lib/active_support/core_ext/date_time/conversions.rb, line 77
77:   def self.civil_from_format(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0)
78:     offset = utc_or_local.to_sym == :local ? local_offset : 0
79:     civil(year, month, day, hour, min, sec, offset)
80:   end

current() click to toggle source

    # File lib/active_support/core_ext/date_time/calculations.rb, line 12
12:     def current
13:       ::Time.zone_default ? ::Time.zone.now.to_datetime : ::Time.now.to_datetime
14:     end

local_offset() click to toggle source

DateTimes aren’t aware of DST rules, so use a consistent non-DST offset when creating a DateTime with an offset in the local zone

    # File lib/active_support/core_ext/date_time/calculations.rb, line 8
 8:     def local_offset
 9:       ::Time.local(2007).utc_offset.to_r / 86400
10:     end

Public Instance Methods

<=>(other) click to toggle source

Also aliased as: compare_without_coercion

Alias for: compare_with_coercion

acts_like_date?() click to toggle source

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

   # File lib/active_support/core_ext/date_time/acts_like.rb, line 5
5:   def acts_like_date?
6:     true
7:   end

acts_like_time?() click to toggle source

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

    # File lib/active_support/core_ext/date_time/acts_like.rb, line 10
10:   def acts_like_time?
11:     true
12:   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/date_time/calculations.rb, line 52
52:   def advance(options)
53:     d = to_date.advance(options)
54:     datetime_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
55:     seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
56:     seconds_to_advance == 0 ? datetime_advanced_by_date : datetime_advanced_by_date.since(seconds_to_advance)
57:   end

ago(seconds) click to toggle source

Returns a new DateTime representing the time a number of seconds ago Do not use this method in combination with x.months, use months_ago instead!

    # File lib/active_support/core_ext/date_time/calculations.rb, line 61
61:   def ago(seconds)
62:     since(-seconds)
63:   end

at_beginning_of_day() click to toggle source

Alias for: beginning_of_day

at_midnight() click to toggle source

Alias for: beginning_of_day

beginning_of_day() click to toggle source

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

    # File lib/active_support/core_ext/date_time/calculations.rb, line 73
73:   def beginning_of_day
74:     change(:hour => 0)
75:   end

Also aliased as: midnight, at_midnight, at_beginning_of_day

change(options) click to toggle source

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

    # File lib/active_support/core_ext/date_time/calculations.rb, line 35
35:   def change(options)
36:     ::DateTime.civil(
37:       options[:year]  || year,
38:       options[:month] || month,
39:       options[:day]   || day,
40:       options[:hour]  || hour,
41:       options[:min]   || (options[:hour] ? 0 : min),
42:       options[:sec]   || ((options[:hour] || options[:min]) ? 0 : sec),
43:       options[:offset]  || offset,
44:       options[:start]  || start
45:     )
46:   end

compare_with_coercion(other) click to toggle source

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

     # File lib/active_support/core_ext/date_time/calculations.rb, line 107
107:   def compare_with_coercion(other)
108:     other = other.comparable_time if other.respond_to?(:comparable_time)
109:     other = other.to_datetime unless other.acts_like?(:date)
110:     compare_without_coercion(other)
111:   end

Also aliased as: <=>

compare_without_coercion(other) click to toggle source

Alias for: <=>

default_inspect() click to toggle source

Alias for: inspect

end_of_day() click to toggle source

Returns a new DateTime representing the end of the day (23:59:59)

    # File lib/active_support/core_ext/date_time/calculations.rb, line 81
81:   def end_of_day
82:     change(:hour => 23, :min => 59, :sec => 59)
83:   end

formatted_offset(colon = true, alternate_utc_string = nil) click to toggle source

Returns the utc_offset as an +HH:MM formatted string. Examples:

  datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
  datetime.formatted_offset         # => "-06:00"
  datetime.formatted_offset(false)  # => "-0600"

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

future?() click to toggle source

Tells whether the DateTime object’s datetime lies in the future

    # File lib/active_support/core_ext/date_time/calculations.rb, line 23
23:   def future?
24:     self > ::DateTime.current
25:   end

getutc() click to toggle source

Alias for: utc

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'
  DateTime.new(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.

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

    # File lib/active_support/core_ext/date_time/zones.rb, line 16
16:   def in_time_zone(zone = ::Time.zone)
17:     return self unless zone
18: 
19:     ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.__send__(:get_zone, zone))
20:   end

inspect() click to toggle source

Also aliased as: default_inspect

Alias for: readable_inspect

midnight() click to toggle source

Alias for: beginning_of_day

past?() click to toggle source

Tells whether the DateTime object’s datetime lies in the past

    # File lib/active_support/core_ext/date_time/calculations.rb, line 18
18:   def past?
19:     self < ::DateTime.current
20:   end

readable_inspect() click to toggle source

Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005 14:30:00 +0000“

    # File lib/active_support/core_ext/date_time/conversions.rb, line 55
55:   def readable_inspect
56:     to_s(:rfc822)
57:   end

Also aliased as: inspect

seconds_since_midnight() click to toggle source

Seconds since midnight: DateTime.now.seconds_since_midnight

    # File lib/active_support/core_ext/date_time/calculations.rb, line 28
28:   def seconds_since_midnight
29:     sec + (min * 60) + (hour * 3600)
30:   end

since(seconds) click to toggle source

Returns a new DateTime representing the time a number of seconds since the instance time Do not use this method in combination with x.months, use months_since instead!

    # File lib/active_support/core_ext/date_time/calculations.rb, line 67
67:   def since(seconds)
68:     self + Rational(seconds.round, 86400)
69:   end

Also aliased as: in

to_date() click to toggle source

Converts self to a Ruby Date object; time portion is discarded

    # File lib/active_support/core_ext/date_time/conversions.rb, line 62
62:   def to_date
63:     ::Date.new(year, month, day)
64:   end

to_datetime() click to toggle source

To be able to keep Times, Dates and DateTimes interchangeable on conversions

    # File lib/active_support/core_ext/date_time/conversions.rb, line 73
73:   def to_datetime
74:     self
75:   end

to_default_s(format = :default) click to toggle source

Alias for: to_s

to_f() click to toggle source

Converts self to a floating-point number of seconds since the Unix epoch

    # File lib/active_support/core_ext/date_time/conversions.rb, line 88
88:   def to_f
89:     seconds_since_unix_epoch.to_f
90:   end

to_formatted_s(format = :default) click to toggle source

Convert to a formatted string. See Time::DATE_FORMATS for predefined formats.

This method is aliased to to_s.

Examples

  datetime = DateTime.civil(2007, 12, 4, 0, 0, 0, 0)   # => Tue, 04 Dec 2007 00:00:00 +0000

  datetime.to_formatted_s(:db)            # => "2007-12-04 00:00:00"
  datetime.to_s(:db)                      # => "2007-12-04 00:00:00"
  datetime.to_s(:number)                  # => "20071204000000"
  datetime.to_formatted_s(:short)         # => "04 Dec 00:00"
  datetime.to_formatted_s(:long)          # => "December 04, 2007 00:00"
  datetime.to_formatted_s(:long_ordinal)  # => "December 4th, 2007 00:00"
  datetime.to_formatted_s(:rfc822)        # => "Tue, 04 Dec 2007 00:00:00 +0000"

Adding your own datetime formats to to_formatted_s

DateTime formats are shared with Time. You can add your own 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 or datetime 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/date_time/conversions.rb, line 35
35:   def to_formatted_s(format = :default)
36:     if formatter = ::Time::DATE_FORMATS[format]
37:       formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
38:     else
39:       to_default_s
40:     end
41:   end

Also aliased as: to_s

to_i() click to toggle source

Converts self to an integer number of seconds since the Unix epoch

    # File lib/active_support/core_ext/date_time/conversions.rb, line 93
93:   def to_i
94:     seconds_since_unix_epoch.to_i
95:   end

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

Attempts to convert self to a Ruby Time object; returns self if out of range of Ruby Time class If self has an offset other than 0, self will just be returned unaltered, since there’s no clean way to map it to a Time

    # File lib/active_support/core_ext/date_time/conversions.rb, line 68
68:   def to_time
69:     self.offset == 0 ? ::Time.utc_time(year, month, day, hour, min, sec) : self
70:   end

utc() click to toggle source

Adjusts DateTime to UTC by adding its offset value; offset is set to 0

Example:

  DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))       # => Mon, 21 Feb 2005 10:11:12 -0600
  DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc   # => Mon, 21 Feb 2005 16:11:12 +0000

    # File lib/active_support/core_ext/date_time/calculations.rb, line 91
91:   def utc
92:     new_offset(0)
93:   end

Also aliased as: getutc

utc?() click to toggle source

Returns true if offset == 0

    # File lib/active_support/core_ext/date_time/calculations.rb, line 97
97:   def utc?
98:     offset == 0
99:   end

utc_offset() click to toggle source

Returns the offset value in seconds

     # File lib/active_support/core_ext/date_time/calculations.rb, line 102
102:   def utc_offset
103:     (offset * 86400).to_i
104:   end

xmlschema() click to toggle source

Converts datetime to an appropriate format for use in XML

    # File lib/active_support/core_ext/date_time/conversions.rb, line 83
83:   def xmlschema
84:     strftime("%Y-%m-%dT%H:%M:%S%Z")
85:   end

Private Instance Methods

seconds_since_unix_epoch() click to toggle source

     # File lib/active_support/core_ext/date_time/conversions.rb, line 99
 99:   def seconds_since_unix_epoch
100:     seconds_per_day = 86_400
101:     (self - ::DateTime.civil(1970)) * seconds_per_day
102:   end

Home Classes Methods

In Files

Parent

Methods

Class Index

DateTime

Public Class Methods

Public Instance Methods

Examples

Adding your own datetime formats to to_formatted_s

Private Instance Methods