Class: DateTime
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
| Instance Chain: | |
| Inherits: | Object | 
| Defined in: | 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/blank.rb, activesupport/lib/active_support/core_ext/date_time/calculations.rb, activesupport/lib/active_support/core_ext/date_time/compatibility.rb, activesupport/lib/active_support/core_ext/date_time/conversions.rb | 
Class Method Summary
- 
    
      .civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0)  
    
    Returns DateTime with local offset for given year if format is local else offset is zero. 
- 
    
      .current  
    
    Returns Time.zone.now.to_datetimewhen Time.zone orconfig.time_zoneare set, otherwise returnsTime.now.to_datetime.
Instance Attribute Summary
- 
    
      #acts_like_date?  ⇒ Boolean 
    
    readonly
    Duck-types as a Date-like class. 
- 
    
      #acts_like_time?  ⇒ Boolean 
    
    readonly
    Duck-types as a Time-like class. 
- 
    
      #utc  
      (also: #getgm, #getutc, #gmtime)
    
    readonly
    Returns a ::Timeinstance of the simultaneous time in the UTC timezone.
- 
    
      #utc?  ⇒ Boolean 
    
    readonly
    Returns trueifoffset == 0.
::DateAndTime::Compatibility - Included
Instance Method Summary
- 
    
      #<=>(other)  
    
    Layers additional behavior on <=>so that::Timeand::ActiveSupport::TimeWithZoneinstances can be compared with aDateTime.
- 
    
      #advance(options)  
    
    Uses Date to provide precise ::Timecalculations for years, months, and days.
- 
    
      #ago(seconds)  
    
    Returns a new DateTimerepresenting the time a number of seconds ago.
- 
    
      #at_beginning_of_day  
    
    Alias for #beginning_of_day. 
- 
    
      #at_beginning_of_hour  
    
    Alias for #beginning_of_hour. 
- 
    
      #at_beginning_of_minute  
    
    Alias for #beginning_of_minute. 
- 
    
      #at_end_of_day  
    
    Alias for #end_of_day. 
- 
    
      #at_end_of_hour  
    
    Alias for #end_of_hour. 
- 
    
      #at_end_of_minute  
    
    Alias for #end_of_minute. 
- 
    
      #at_midday  
    
    Alias for #middle_of_day. 
- 
    
      #at_middle_of_day  
    
    Alias for #middle_of_day. 
- 
    
      #at_midnight  
    
    Alias for #beginning_of_day. 
- 
    
      #at_noon  
    
    Alias for #middle_of_day. 
- 
    
      #beginning_of_day  
      (also: #midnight, #at_midnight, #at_beginning_of_day)
    
    Returns a new DateTimerepresenting the start of the day (0:00).
- 
    
      #beginning_of_hour  
      (also: #at_beginning_of_hour)
    
    Returns a new DateTimerepresenting the start of the hour (hh:00:00).
- 
    
      #beginning_of_minute  
      (also: #at_beginning_of_minute)
    
    Returns a new DateTimerepresenting the start of the minute (hh:mm:00).
- 
    
      #change(options)  
    
    Returns a new DateTimewhere one or more of the elements have been changed according to theoptionsparameter.
- #default_inspect
- 
    
      #end_of_day  
      (also: #at_end_of_day)
    
    Returns a new DateTimerepresenting the end of the day (23:59:59).
- 
    
      #end_of_hour  
      (also: #at_end_of_hour)
    
    Returns a new DateTimerepresenting the end of the hour (hh:59:59).
- 
    
      #end_of_minute  
      (also: #at_end_of_minute)
    
    Returns a new DateTimerepresenting the end of the minute (hh:mm:59).
- 
    
      #formatted_offset(colon = true, alternate_utc_string = nil)  
    
    Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC. 
- 
    
      #getgm  
    
    Alias for #utc. 
- 
    
      #getlocal(utc_offset = nil)  
    
    Alias for #localtime. 
- 
    
      #getutc  
    
    Alias for #utc. 
- 
    
      #gmtime  
    
    Alias for #utc. 
- 
    
      #in(seconds)  
    
    Alias for #since. 
- 
    
      #inspect  
    
    Alias for #readable_inspect. 
- 
    
      #localtime(utc_offset = nil)  
      (also: #getlocal)
    
    Returns a ::Timeinstance of the simultaneous time in the system timezone.
- 
    
      #midday  
    
    Alias for #middle_of_day. 
- 
    
      #middle_of_day  
      (also: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day)
    
    Returns a new DateTimerepresenting the middle of the day (12:00).
- 
    
      #midnight  
    
    Alias for #beginning_of_day. 
- 
    
      #noon  
    
    Alias for #middle_of_day. 
- 
    
      #nsec  
    
    Returns the fraction of a second as nanoseconds. 
- 
    
      #readable_inspect  
      (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  
    
    Returns the number of seconds since 00:00:00. 
- 
    
      #seconds_until_end_of_day  
    
    Returns the number of seconds until 23:59:59. 
- 
    
      #since(seconds)  
      (also: #in)
    
    Returns a new DateTimerepresenting the time a number of seconds since the instance time.
- 
    
      #subsec  
    
    Returns the fraction of a second as a Rational
- 
    
      #to_f  
    
    Converts selfto a floating-point number of seconds, including fractional microseconds, since the Unix epoch.
- 
    
      #to_formatted_s(format = :default)  
    
    Alias for #to_fs. 
- 
    
      #to_fs(format = :default)  
      (also: #to_formatted_s)
    
    Convert to a formatted string. 
- 
    
      #to_i  
    
    Converts selfto an integer number of seconds since the Unix epoch.
- 
    
      #to_time  
    
    Either return an instance of ::Timewith the same UTC offset asselfor an instance of::Timerepresenting the same time in the local system timezone depending on the setting of on the setting of ActiveSupport.to_time_preserves_timezone.
- 
    
      #usec  
    
    Returns the fraction of a second as microseconds. 
- 
    
      #utc_offset  
    
    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)
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
Returns Time.zone.now.to_datetime when Time.zone or config.time_zone are set, otherwise returns Time.now.to_datetime.
Instance Attribute Details
    #acts_like_date?  ⇒ Boolean  (readonly)
  
Duck-types as a Date-like class. See Object#acts_like?.
# File 'activesupport/lib/active_support/core_ext/date_time/acts_like.rb', line 8
def acts_like_date? true end
    #acts_like_time?  ⇒ Boolean  (readonly)
  
Duck-types as a Time-like class. See Object#acts_like?.
# File 'activesupport/lib/active_support/core_ext/date_time/acts_like.rb', line 13
def acts_like_time? true end
#utc (readonly) 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# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 184
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  (readonly)
  
Returns true if offset == 0.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 197
def utc? offset == 0 end
Instance Method Details
#<=>(other)
Layers additional behavior on <=> so that ::Time and ::ActiveSupport::TimeWithZone instances can be compared with a DateTime.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 208
def <=>(other) if other.respond_to? :to_datetime super other.to_datetime rescue nil else super end end
#advance(options)
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() 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)
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 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 109
def ago(seconds) since(-seconds) end
#at_beginning_of_day
Alias for #beginning_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 127
alias :at_beginning_of_day :beginning_of_day
#at_beginning_of_hour
Alias for #beginning_of_hour.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 149
alias :at_beginning_of_hour :beginning_of_hour
#at_beginning_of_minute
Alias for #beginning_of_minute.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 161
alias :at_beginning_of_minute :beginning_of_minute
#at_end_of_day
Alias for #end_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 143
alias :at_end_of_day :end_of_day
#at_end_of_hour
Alias for #end_of_hour.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 155
alias :at_end_of_hour :end_of_hour
#at_end_of_minute
Alias for #end_of_minute.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 167
alias :at_end_of_minute :end_of_minute
#at_midday
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 135
alias :at_midday :middle_of_day
#at_middle_of_day
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 137
alias :at_middle_of_day :middle_of_day
#at_midnight
Alias for #beginning_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 126
alias :at_midnight :beginning_of_day
#at_noon
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 136
alias :at_noon :middle_of_day
#beginning_of_day Also known as: #midnight, #at_midnight, #at_beginning_of_day
Returns a new DateTime representing the start of the day (0:00).
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 122
def beginning_of_day change(hour: 0) end
#beginning_of_hour Also known as: #at_beginning_of_hour
Returns a new DateTime representing the start of the hour (hh:00:00).
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 146
def beginning_of_hour change(min: 0) end
#beginning_of_minute Also known as: #at_beginning_of_minute
Returns a new DateTime representing the start of the minute (hh:mm:00).
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 158
def beginning_of_minute change(sec: 0) end
#change(options)
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() 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
#default_inspect
[ GitHub ]# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 61
alias_method :default_inspect, :inspect
#end_of_day Also known as: #at_end_of_day
Returns a new DateTime representing the end of the day (23:59:59).
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 140
def end_of_day change(hour: 23, min: 59, sec: 59, usec: Rational(999999999, 1000)) end
#end_of_hour Also known as: #at_end_of_hour
Returns a new DateTime representing the end of the hour (hh:59:59).
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 152
def end_of_hour change(min: 59, sec: 59, usec: Rational(999999999, 1000)) end
#end_of_minute Also known as: #at_end_of_minute
Returns a new DateTime representing the end of the minute (hh:mm:59).
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 164
def end_of_minute change(sec: 59, usec: Rational(999999999, 1000)) end
#formatted_offset(colon = true, alternate_utc_string = nil)
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"# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 53
def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon) end
#getgm
Alias for #utc.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 192
alias_method :getgm, :utc
#getlocal(utc_offset = nil)
Alias for #localtime.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 178
alias_method :getlocal, :localtime
#getutc
Alias for #utc.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 193
alias_method :getutc, :utc
#gmtime
Alias for #utc.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 194
alias_method :gmtime, :utc
#in(seconds)
Alias for #since.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 119
alias :in :since
#inspect
Alias for #readable_inspect.
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 62
alias_method :inspect, :readable_inspect
#localtime(utc_offset = nil) Also known as: #getlocal
Returns a ::Time instance of the simultaneous time in the system timezone.
#midday
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 133
alias :midday :middle_of_day
#middle_of_day 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)
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 130
def middle_of_day change(hour: 12) end
#midnight
Alias for #beginning_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 125
alias :midnight :beginning_of_day
#noon
Alias for #middle_of_day.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 134
alias :noon :middle_of_day
#nsec
Returns the fraction of a second as nanoseconds
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 96
def nsec (sec_fraction * 1_000_000_000).to_i end
#readable_inspect Also known as: #inspect
Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005 14:30:00 +0000”.
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 58
def readable_inspect to_fs(:rfc822) end
#seconds_since_midnight
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# 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
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# 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) 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!
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 116
def since(seconds) self + Rational(seconds, 86400) end
#subsec
Returns the fraction of a second as a Rational
DateTime.new(2012, 8, 29, 0, 0, 0.5).subsec # => (1/2)# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 36
def subsec sec_fraction end
#to_f
Converts self to a floating-point number of seconds, including fractional microseconds, since the Unix epoch.
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 81
def to_f seconds_since_unix_epoch.to_f + sec_fraction end
#to_formatted_s(format = :default)
Alias for #to_fs.
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 44
alias_method :to_formatted_s, :to_fs
#to_fs(format = :default) Also known as: #to_formatted_s
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}") }# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 37
def to_fs(format = :default) if formatter = ::Time::DATE_FORMATS[format] formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter) else to_s end end
#to_i
Converts self to an integer number of seconds since the Unix epoch.
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 86
def to_i seconds_since_unix_epoch.to_i end
#to_time
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.
# File 'activesupport/lib/active_support/core_ext/date_time/compatibility.rb', line 15
def to_time preserve_timezone ? getlocal(utc_offset) : getlocal end
#usec
Returns the fraction of a second as microseconds
# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 91
def usec (sec_fraction * 1_000_000).to_i end
#utc_offset
Returns the offset value in seconds.
# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 202
def utc_offset (offset * 86400).to_i end