Class: DateTime

Inherits:
Object show all
Includes:
DateAndTime::Compatibility, DateAndTime::Zones
Defined in:
lib/active_support/core_ext/object/json.rb,
lib/active_support/core_ext/date_time/zones.rb,
lib/active_support/core_ext/date_time/acts_like.rb,
lib/active_support/core_ext/date_time/conversions.rb,
lib/active_support/core_ext/date_time/calculations.rb,
lib/active_support/core_ext/date_time/compatibility.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DateAndTime::Compatibility

included

Methods included from DateAndTime::Zones

#in_time_zone

Class Method Details

.civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0) ⇒ Object

Returns DateTime with local offset for given year if format is local else offset is zero.

DateTime.civil_from_format :local, 2012# => Sun, 01 Jan 2012 00:00:00 +0300

DateTime.civil_from_format :local, 2012, 12, 17# => Mon, 17 Dec 2012 00:00:00 +0000


65
66
67
68
69
70
71
72
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 65

def self.civil_from_format(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0)
  if utc_or_local.to_sym == :local
    offset = ::Time.local(year, month, day).utc_offset.to_r / 86400
  else
    offset = 0
  end
  civil(year, month, day, hour, min, sec, offset)
end

.currentObject

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


8
9
10
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 8

def current
  ::Time.zone ? ::Time.zone.now.to_datetime : ::Time.now.to_datetime
end

Instance Method Details

#<=>(other) ⇒ Object

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


188
189
190
191
192
193
194
195
196
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 188

def <=>(other)
  if other.kind_of?(Infinity)
    super
  elsif other.respond_to? :to_datetime
    super other.to_datetime rescue nil
  else
    nil
  end
end

#acts_like_date?Boolean

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

Returns:

  • (Boolean)

6
7
8
# File 'lib/active_support/core_ext/date_time/acts_like.rb', line 6

def acts_like_date?
  true
end

#acts_like_time?Boolean

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

Returns:

  • (Boolean)

11
12
13
# File 'lib/active_support/core_ext/date_time/acts_like.rb', line 11

def acts_like_time?
  true
end

#advance(options) ⇒ Object

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.


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 62

def advance(options)
  unless options[:weeks].nil?
    options[:weeks], partial_weeks = options[:weeks].divmod(1)
    options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
  end

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

  d = to_date.advance(options)
  datetime_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
  seconds_to_advance = \
    options.fetch(:seconds, 0) +
    options.fetch(:minutes, 0) * 60 +
    options.fetch(:hours, 0) * 3600

  if seconds_to_advance.zero?
    datetime_advanced_by_date
  else
    datetime_advanced_by_date.since(seconds_to_advance)
  end
end

#ago(seconds) ⇒ Object

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!


89
90
91
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 89

def ago(seconds)
  since(-seconds)
end

#as_json(options = nil) ⇒ Object

:nodoc:


184
185
186
187
188
189
190
# File 'lib/active_support/core_ext/object/json.rb', line 184

def as_json(options = nil) #:nodoc:
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema(ActiveSupport::JSON::Encoding.time_precision)
  else
    strftime('%Y/%m/%d %H:%M:%S %z')
  end
end

#beginning_of_dayObject Also known as: midnight, at_midnight, at_beginning_of_day

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


102
103
104
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 102

def beginning_of_day
  change(:hour => 0)
end

#beginning_of_hourObject Also known as: at_beginning_of_hour

Returns a new DateTime representing the start of the hour (hh:00:00).


126
127
128
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 126

def beginning_of_hour
  change(:min => 0)
end

#beginning_of_minuteObject Also known as: at_beginning_of_minute

Returns a new DateTime representing the start of the minute (hh:mm:00).


138
139
140
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 138

def beginning_of_minute
  change(:sec => 0)
end

#change(options) ⇒ Object

Returns a new DateTime where one or more of the elements have been changed according to the options parameter. The time options (:hour, :min, :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. The options parameter takes a hash with any of these keys: :year, :month, :day, :hour, :min, :sec, :offset, :start.

DateTime.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => DateTime.new(2012, 8, 1, 22, 35, 0)
DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => DateTime.new(1981, 8, 1, 22, 35, 0)
DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => DateTime.new(1981, 8, 29, 0, 0, 0)

45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 45

def change(options)
  ::DateTime.civil(
    options.fetch(:year, year),
    options.fetch(:month, month),
    options.fetch(:day, day),
    options.fetch(:hour, hour),
    options.fetch(:min, options[:hour] ? 0 : min),
    options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec + sec_fraction),
    options.fetch(:offset, offset),
    options.fetch(:start, start)
  )
end

#end_of_dayObject Also known as: at_end_of_day

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


120
121
122
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 120

def end_of_day
  change(:hour => 23, :min => 59, :sec => 59)
end

#end_of_hourObject Also known as: at_end_of_hour

Returns a new DateTime representing the end of the hour (hh:59:59).


132
133
134
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 132

def end_of_hour
  change(:min => 59, :sec => 59)
end

#end_of_minuteObject Also known as: at_end_of_minute

Returns a new DateTime representing the end of the minute (hh:mm:59).


144
145
146
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 144

def end_of_minute
  change(:sec => 59)
end

#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object

datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))

datetime.formatted_offset         # => "-06:00"
datetime.formatted_offset(false)  # => "-0600"

47
48
49
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 47

def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

#localtime(utc_offset = nil) ⇒ Object Also known as: getlocal

Returns a Time instance of the simultaneous time in the system timezone.


150
151
152
153
154
155
156
157
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 150

def localtime(utc_offset = nil)
  utc = new_offset(0)

  Time.utc(
    utc.year, utc.month, utc.day,
    utc.hour, utc.min, utc.sec + utc.sec_fraction
  ).getlocal(utc_offset)
end

#middle_of_dayObject Also known as: midday, noon, at_midday, at_noon, at_middle_of_day

Returns a new DateTime representing the middle of the day (12:00)


110
111
112
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 110

def middle_of_day
  change(:hour => 12)
end

#nsecObject

Returns the fraction of a second as nanoseconds


90
91
92
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 90

def nsec
  (sec_fraction * 1_000_000_000).to_i
end

#readable_inspectObject Also known as: inspect

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


52
53
54
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 52

def readable_inspect
  to_s(:rfc822)
end

#seconds_since_midnightObject

Seconds since midnight: DateTime.now.seconds_since_midnight.


14
15
16
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 14

def seconds_since_midnight
  sec + (min * 60) + (hour * 3600)
end

#seconds_until_end_of_dayObject

Returns the number of seconds until 23:59:59.

DateTime.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
DateTime.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
DateTime.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0

23
24
25
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 23

def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

#since(seconds) ⇒ Object Also known as: in

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!


96
97
98
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 96

def since(seconds)
  self + Rational(seconds.round, 86400)
end

#subsecObject

Returns the fraction of a second as a Rational

DateTime.new(2012, 8, 29, 0, 0, 0.5).subsec # => (1/2)

30
31
32
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 30

def subsec
  sec_fraction
end

#to_fObject

Converts self to a floating-point number of seconds, including fractional microseconds, since the Unix epoch.


75
76
77
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 75

def to_f
  seconds_since_unix_epoch.to_f + sec_fraction
end

#to_formatted_s(format = :default) ⇒ Object Also known as: to_s

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"
datetime.to_formatted_s(:iso8601)       # => "2007-12-04T00:00:00+00:00"

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}") }

33
34
35
36
37
38
39
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 33

def to_formatted_s(format = :default)
  if formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_default_s
  end
end

#to_iObject

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


80
81
82
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 80

def to_i
  seconds_since_unix_epoch.to_i
end

#usecObject

Returns the fraction of a second as microseconds


85
86
87
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 85

def usec
  (sec_fraction * 1_000_000).to_i
end

#utcObject Also known as: getgm, getutc, gmtime

Returns a Time instance of the simultaneous time in the UTC timezone.

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 UTC

164
165
166
167
168
169
170
171
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 164

def utc
  utc = new_offset(0)

  Time.utc(
    utc.year, utc.month, utc.day,
    utc.hour, utc.min, utc.sec + utc.sec_fraction
  )
end

#utc?Boolean

Returns true if offset == 0.

Returns:

  • (Boolean)

177
178
179
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 177

def utc?
  offset == 0
end

#utc_offsetObject

Returns the offset value in seconds.


182
183
184
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 182

def utc_offset
  (offset * 86400).to_i
end