Class: DateTime
- Includes:
- DateAndTime::Compatibility
- 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
-
.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.
-
.current ⇒ Object
Returns
Time.zone.now.to_datetime
whenTime.zone
orconfig.time_zone
are set, otherwise returnsTime.now.to_datetime
.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime.
-
#acts_like_date? ⇒ Boolean
Duck-types as a Date-like class.
-
#acts_like_time? ⇒ Boolean
Duck-types as a Time-like class.
-
#advance(options) ⇒ Object
Uses Date to provide precise Time calculations for years, months, and days.
-
#ago(seconds) ⇒ Object
Returns a new DateTime representing the time a number of seconds ago.
-
#as_json(options = nil) ⇒ Object
:nodoc:.
-
#beginning_of_day ⇒ Object
(also: #midnight, #at_midnight, #at_beginning_of_day)
Returns a new DateTime representing the start of the day (0:00).
-
#beginning_of_hour ⇒ Object
(also: #at_beginning_of_hour)
Returns a new DateTime representing the start of the hour (hh:00:00).
-
#beginning_of_minute ⇒ Object
(also: #at_beginning_of_minute)
Returns a new DateTime representing the start of the minute (hh:mm:00).
-
#blank? ⇒ false
No DateTime is ever blank:.
-
#change(options) ⇒ Object
Returns a new DateTime where one or more of the elements have been changed according to the
options
parameter. -
#end_of_day ⇒ Object
(also: #at_end_of_day)
Returns a new DateTime representing the end of the day (23:59:59).
-
#end_of_hour ⇒ Object
(also: #at_end_of_hour)
Returns a new DateTime representing the end of the hour (hh:59:59).
-
#end_of_minute ⇒ Object
(also: #at_end_of_minute)
Returns a new DateTime representing the end of the minute (hh:mm:59).
-
#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.
-
#localtime(utc_offset = nil) ⇒ Object
(also: #getlocal)
Returns a
Time
instance of the simultaneous time in the system timezone. -
#middle_of_day ⇒ Object
(also: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day)
Returns a new DateTime representing the middle of the day (12:00).
-
#nsec ⇒ Object
Returns the fraction of a second as nanoseconds.
-
#readable_inspect ⇒ Object
(also: #inspect)
Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005 14:30:00 +0000”.
-
#seconds_since_midnight ⇒ Object
Returns the number of seconds since 00:00:00.
-
#seconds_until_end_of_day ⇒ Object
Returns the number of seconds until 23:59:59.
-
#since(seconds) ⇒ Object
(also: #in)
Returns a new DateTime representing the time a number of seconds since the instance time.
-
#subsec ⇒ Object
Returns the fraction of a second as a
Rational
. -
#to_f ⇒ Object
Converts
self
to a floating-point number of seconds, including fractional microseconds, since the Unix epoch. -
#to_formatted_s(format = :default) ⇒ Object
(also: #to_s)
Convert to a formatted string.
-
#to_i ⇒ Object
Converts
self
to an integer number of seconds since the Unix epoch. -
#to_time ⇒ Object
Either return an instance of
Time
with the same UTC offset asself
or an instance ofTime
representing the same time in the local system timezone depending on the setting of on the setting ofActiveSupport.to_time_preserves_timezone
. -
#usec ⇒ Object
Returns the fraction of a second as microseconds.
-
#utc ⇒ Object
(also: #getgm, #getutc, #gmtime)
Returns a
Time
instance of the simultaneous time in the UTC timezone. -
#utc? ⇒ Boolean
Returns
true
ifoffset == 0
. -
#utc_offset ⇒ Object
Returns the offset value in seconds.
Class Method Details
.civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0) ⇒ Object
69 70 71 72 73 74 75 76 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 69 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 |
.current ⇒ Object
Returns Time.zone.now.to_datetime
when Time.zone
or config.time_zone
are set, otherwise returns Time.now.to_datetime
.
10 11 12 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 10 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.
204 205 206 207 208 209 210 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 204 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?.
8 9 10 |
# File 'activesupport/lib/active_support/core_ext/date_time/acts_like.rb', line 8 def acts_like_date? true end |
#acts_like_time? ⇒ Boolean
Duck-types as a Time-like class. See Object#acts_like?.
13 14 15 |
# File 'activesupport/lib/active_support/core_ext/date_time/acts_like.rb', line 13 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
.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 78 def advance() unless [:weeks].nil? [:weeks], partial_weeks = [:weeks].divmod(1) [:days] = .fetch(:days, 0) + 7 * partial_weeks end unless [:days].nil? [:days], partial_days = [:days].divmod(1) [:hours] = .fetch(:hours, 0) + 24 * partial_days end d = to_date.advance() datetime_advanced_by_date = change(year: d.year, month: d.month, day: d.day) seconds_to_advance = \ .fetch(:seconds, 0) + .fetch(:minutes, 0) * 60 + .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!
105 106 107 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 105 def ago(seconds) since(-seconds) end |
#as_json(options = nil) ⇒ Object
:nodoc:
197 198 199 200 201 202 203 |
# File 'activesupport/lib/active_support/core_ext/object/json.rb', line 197 def as_json( = 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_day ⇒ Object Also known as: midnight, at_midnight, at_beginning_of_day
Returns a new DateTime representing the start of the day (0:00).
118 119 120 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 118 def beginning_of_day change(hour: 0) end |
#beginning_of_hour ⇒ Object Also known as: at_beginning_of_hour
Returns a new DateTime representing the start of the hour (hh:00:00).
142 143 144 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 142 def beginning_of_hour change(min: 0) end |
#beginning_of_minute ⇒ Object Also known as: at_beginning_of_minute
Returns a new DateTime representing the start of the minute (hh:mm:00).
154 155 156 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 154 def beginning_of_minute change(sec: 0) end |
#blank? ⇒ false
No DateTime is ever blank:
DateTime.now.blank? # => false
11 12 13 |
# File 'activesupport/lib/active_support/core_ext/date_time/blank.rb', line 11 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)
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 51 def change() if new_nsec = [:nsec] raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{.inspect}" if [:usec] new_fraction = Rational(new_nsec, 1000000000) else new_usec = .fetch(:usec, ([:hour] || [:min] || [:sec]) ? 0 : Rational(nsec, 1000)) new_fraction = Rational(new_usec, 1000000) end raise ArgumentError, "argument out of range" if new_fraction >= 1 ::DateTime.civil( .fetch(:year, year), .fetch(:month, month), .fetch(:day, day), .fetch(:hour, hour), .fetch(:min, [:hour] ? 0 : min), .fetch(:sec, ([:hour] || [:min]) ? 0 : sec) + new_fraction, .fetch(:offset, offset), .fetch(:start, start) ) end |
#end_of_day ⇒ Object Also known as: at_end_of_day
Returns a new DateTime representing the end of the day (23:59:59).
136 137 138 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 136 def end_of_day change(hour: 23, min: 59, sec: 59, usec: Rational(999999999, 1000)) end |
#end_of_hour ⇒ Object Also known as: at_end_of_hour
Returns a new DateTime representing the end of the hour (hh:59:59).
148 149 150 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 148 def end_of_hour change(min: 59, sec: 59, usec: Rational(999999999, 1000)) end |
#end_of_minute ⇒ Object Also known as: at_end_of_minute
Returns a new DateTime representing the end of the minute (hh:mm:59).
160 161 162 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 160 def end_of_minute change(sec: 59, usec: Rational(999999999, 1000)) 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"
51 52 53 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 51 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.
166 167 168 169 170 171 172 173 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 166 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_day ⇒ Object 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)
126 127 128 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 126 def middle_of_day change(hour: 12) end |
#nsec ⇒ Object
Returns the fraction of a second as nanoseconds
94 95 96 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 94 def nsec (sec_fraction * 1_000_000_000).to_i end |
#readable_inspect ⇒ Object Also known as: inspect
Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005 14:30:00 +0000”.
56 57 58 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 56 def readable_inspect to_s(:rfc822) end |
#seconds_since_midnight ⇒ Object
20 21 22 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 20 def seconds_since_midnight sec + (min * 60) + (hour * 3600) end |
#seconds_until_end_of_day ⇒ Object
29 30 31 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 29 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!
112 113 114 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 112 def since(seconds) self + Rational(seconds, 86400) end |
#subsec ⇒ Object
Returns the fraction of a second as a Rational
DateTime.new(2012, 8, 29, 0, 0, 0.5).subsec # => (1/2)
36 37 38 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 36 def subsec sec_fraction end |
#to_f ⇒ Object
Converts self
to a floating-point number of seconds, including fractional microseconds, since the Unix epoch.
79 80 81 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 79 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}") }
35 36 37 38 39 40 41 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 35 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_i ⇒ Object
Converts self
to an integer number of seconds since the Unix epoch.
84 85 86 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 84 def to_i seconds_since_unix_epoch.to_i end |
#to_time ⇒ Object
Either return an instance of Time
with the same UTC offset as self
or an instance of Time
representing the same time in the local system timezone depending on the setting of on the setting of ActiveSupport.to_time_preserves_timezone
.
15 16 17 |
# File 'activesupport/lib/active_support/core_ext/date_time/compatibility.rb', line 15 def to_time preserve_timezone ? getlocal(utc_offset) : getlocal end |
#usec ⇒ Object
Returns the fraction of a second as microseconds
89 90 91 |
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 89 def usec (sec_fraction * 1_000_000).to_i end |
#utc ⇒ Object Also known as: getgm, getutc, gmtime
180 181 182 183 184 185 186 187 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 180 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
.
193 194 195 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 193 def utc? offset == 0 end |
#utc_offset ⇒ Object
Returns the offset value in seconds.
198 199 200 |
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 198 def utc_offset (offset * 86400).to_i end |