Class: DateTime

Inherits:
Object show all
Defined in:
activesupport/lib/active_support/core_ext/date_time/blank.rb,
activesupport/lib/active_support/core_ext/object/json.rb,
activesupport/lib/active_support/core_ext/date_time/acts_like.rb,
activesupport/lib/active_support/core_ext/date_time/conversions.rb,
activesupport/lib/active_support/core_ext/date_time/calculations.rb,
activesupport/lib/active_support/core_ext/date_time/compatibility.rb

Overview

:nodoc:

Class Method Summary collapse

Instance Method Summary collapse

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


67
68
69
70
71
72
73
74
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 67

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 'activesupport/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.


192
193
194
195
196
197
198
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 192

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

#acts_like_date?Boolean

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

Returns:

  • (Boolean)

6
7
8
# File 'activesupport/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 'activesupport/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.


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 66

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!


93
94
95
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 93

def ago(seconds)
  since(-seconds)
end

#as_json(options = nil) ⇒ Object

:nodoc:


186
187
188
189
190
191
192
# File 'activesupport/lib/active_support/core_ext/object/json.rb', line 186

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).


106
107
108
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 106

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).


130
131
132
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 130

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).


142
143
144
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 142

def beginning_of_minute
  change(:sec => 0)
end

#blank?false

No DateTime is ever blank:

DateTime.now.blank? # => false

Returns:

  • (false)

9
10
11
# File 'activesupport/lib/active_support/core_ext/date_time/blank.rb', line 9

def blank?
  false
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)

49
50
51
52
53
54
55
56
57
58
59
60
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 49

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).


124
125
126
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 124

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).


136
137
138
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 136

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).


148
149
150
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 148

def end_of_minute
  change(:sec => 59)
end

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

Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.

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

49
50
51
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 49

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.


154
155
156
157
158
159
160
161
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 154

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)


114
115
116
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 114

def middle_of_day
  change(:hour => 12)
end

#nsecObject

Returns the fraction of a second as nanoseconds


92
93
94
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 92

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”.


54
55
56
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 54

def readable_inspect
  to_s(:rfc822)
end

#seconds_since_midnightObject

Returns the number of seconds since 00:00:00.

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

18
19
20
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 18

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

27
28
29
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 27

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!


100
101
102
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 100

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)

34
35
36
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 34

def subsec
  sec_fraction
end

#to_fObject

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


77
78
79
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 77

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 'activesupport/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.


82
83
84
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 82

def to_i
  seconds_since_unix_epoch.to_i
end

#usecObject

Returns the fraction of a second as microseconds


87
88
89
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 87

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

168
169
170
171
172
173
174
175
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 168

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)

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

def utc?
  offset == 0
end

#utc_offsetObject

Returns the offset value in seconds.


186
187
188
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 186

def utc_offset
  (offset * 86400).to_i
end