- #
- A
- B
- C
- D
- E
- F
- G
- I
- L
- M
- N
- R
- S
- T
- U
-
- usec,
- utc,
- utc?,
- utc_offset
Class Public methods
civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0) Link
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
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 71 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() Link
Returns Time.zone.now.to_datetime when Time.zone or config.time_zone are set, otherwise returns Time.now.to_datetime.
Instance Public methods
<=>(other) Link
Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime.
acts_like_date?() Link
Duck-types as a Date-like class. See Object#acts_like?.
acts_like_time?() Link
Duck-types as a Time-like class. See Object#acts_like?.
advance(options) Link
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.
Just like Date#advance, increments are applied in order of time units from largest to smallest. This order can affect the result around the end of a month.
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 82 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) Link
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!
beginning_of_hour() Link
Returns a new DateTime representing the start of the hour (hh:00:00).
beginning_of_minute() Link
Returns a new DateTime representing the start of the minute (hh:mm:00).
change(options) Link
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)
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 51 def change(options) if new_nsec = options[:nsec] raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec] new_fraction = Rational(new_nsec, 1000000000) else new_usec = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000)) new_fraction = Rational(new_usec, 1000000) end raise ArgumentError, "argument out of range" if new_fraction >= 1 ::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) + new_fraction, options.fetch(:offset, offset), options.fetch(:start, start) ) end
end_of_day() Link
Returns a new DateTime representing the end of the day (23:59:59).
end_of_hour() Link
Returns a new DateTime representing the end of the hour (hh:59:59).
end_of_minute() Link
Returns a new DateTime representing the end of the minute (hh:mm:59).
formatted_offset(colon = true, alternate_utc_string = nil) Link
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"
localtime(utc_offset = nil) Link
Returns a Time instance of the simultaneous time in the system timezone.
nsec() Link
Returns the fraction of a second as nanoseconds
readable_inspect() Link
Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005 14:30:00 +0000”.
seconds_since_midnight() Link
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
seconds_until_end_of_day() Link
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
since(seconds) Link
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!
subsec() Link
Returns the fraction of a second as a Rational
DateTime.new(2012, 8, 29, 0, 0, 0.5).subsec # => (1/2)
to_f() Link
Converts self to a floating-point number of seconds, including fractional microseconds, since the Unix epoch.
to_fs(format = :default) Link
Convert to a formatted string. See Time::DATE_FORMATS for predefined formats.
This method is aliased to to_formatted_s.
Examples¶ ↑
datetime = DateTime.civil(2007, 12, 4, 0, 0, 0, 0) # => Tue, 04 Dec 2007 00:00:00 +0000 datetime.to_fs(:db) # => "2007-12-04 00:00:00" datetime.to_formatted_s(:db) # => "2007-12-04 00:00:00" datetime.to_fs(:number) # => "20071204000000" datetime.to_fs(:short) # => "04 Dec 00:00" datetime.to_fs(:long) # => "December 04, 2007 00:00" datetime.to_fs(:long_ordinal) # => "December 4th, 2007 00:00" datetime.to_fs(:rfc822) # => "Tue, 04 Dec 2007 00:00:00 +0000" datetime.to_fs(:iso8601) # => "2007-12-04T00:00:00+00:00"
Adding your own datetime formats to to_fs¶ ↑
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}") }
to_i() Link
Converts self to an integer number of seconds since the Unix epoch.
usec() Link
Returns the fraction of a second as microseconds
utc() Link
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
utc?() Link
Returns true if offset == 0.