123456789_123456789_123456789_123456789_123456789_

Class: DateTime

Class Method Summary

Instance Attribute Summary

Instance Method Summary

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.

<code>civil_from_format</code> :local, 2012
#### => Sun, 01 Jan 2012 00:00:00 +0300
<code>civil_from_format</code> :local, 2012, 12, 17
#### => Mon, 17 Dec 2012 00:00:00 +0000
[ GitHub ] 

  


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



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.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 11



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


  







Instance Attribute Details



  

    #acts_like_date?  ⇒ Boolean  (readonly)
  



  

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

  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/acts_like.rb', line 9



def acts_like_date?
  true
end


  








  

    #acts_like_time?  ⇒ Boolean  (readonly)
  



  

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

  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/acts_like.rb', line 14



def acts_like_time?
  true
end


  








  

    #blank?  ⇒ false  (readonly)
  

  

    This method is for internal use only.
  



  

    
No DateTime is ever blank:


{DateTime.now}.blank? # => false

  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/blank.rb', line 14



def blank?
  false
end


  








  

    #present?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/blank.rb', line 18



def present?
  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

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 196



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.

  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 209



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.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 220



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.

  



  [ GitHub ]


  

  


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



def advance(options)
  options = options.dup
  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)  
  



  

    
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!

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 119



def ago(seconds)
  since(-seconds)
end


  








  

    #as_json(options = nil)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/object/json.rb', line 222



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


  








  

    #at_beginning_of_day  
  



  

    
Alias for #beginning_of_day.

  



  [ GitHub ]


  

  


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



alias :at_beginning_of_day :beginning_of_day


  








  

    #at_beginning_of_hour  
  



  

    
Alias for #beginning_of_hour.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 159



alias :at_beginning_of_hour :beginning_of_hour


  








  

    #at_beginning_of_minute  
  



  

    
Alias for #beginning_of_minute.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 171



alias :at_beginning_of_minute :beginning_of_minute


  








  

    #at_end_of_day  
  



  

    
Alias for #end_of_day.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 153



alias :at_end_of_day :end_of_day


  








  

    #at_end_of_hour  
  



  

    
Alias for #end_of_hour.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 165



alias :at_end_of_hour :end_of_hour


  








  

    #at_end_of_minute  
  



  

    
Alias for #end_of_minute.

  



  [ GitHub ]


  

  


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



alias :at_end_of_minute :end_of_minute


  








  

    #at_midday  
  



  

    
Alias for #middle_of_day.

  



  [ GitHub ]


  

  


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



alias :at_midday :middle_of_day


  








  

    #at_middle_of_day  
  



  

    
Alias for #middle_of_day.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 147



alias :at_middle_of_day :middle_of_day


  








  

    #at_midnight  
  



  

    
Alias for #beginning_of_day.

  



  [ GitHub ]


  

  


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



alias :at_midnight :beginning_of_day


  








  

    #at_noon  
  



  

    
Alias for #middle_of_day.

  



  [ GitHub ]


  

  


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



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

  



  [ GitHub ]


  

  


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



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

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 156



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

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 168



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)

  





  
Raises:


    
  
  • 
    (ArgumentError)
  
    • 





  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 60



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


  








  

    #default_inspect  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 68



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

  



  [ GitHub ]


  

  


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



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

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 162



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

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 174



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"

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 60



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.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 204



alias_method :getgm, :utc


  








  

    #getlocal(utc_offset = nil)  
  



  

    
Alias for #localtime.

  



  [ GitHub ]


  

  


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



alias_method :getlocal, :localtime


  








  

    #getutc  
  



  

    
Alias for #utc.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 205



alias_method :getutc, :utc


  








  

    #gmtime  
  



  

    
Alias for #utc.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 206



alias_method :gmtime, :utc


  








  

    #in(seconds)  
  



  

    
Alias for #since.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 129



alias :in :since


  








  

    #inspect  
  



  

    
Alias for #readable_inspect.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 69



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.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 180



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


  








  

    #midday  
  



  

    
Alias for #middle_of_day.

  



  [ GitHub ]


  

  


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



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)

  



  [ GitHub ]


  

  


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



def middle_of_day
  change(hour: 12)
end


  








  

    #midnight  
  



  

    
Alias for #beginning_of_day.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 135



alias :midnight :beginning_of_day


  








  

    #noon  
  



  

    
Alias for #middle_of_day.

  



  [ GitHub ]


  

  


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



alias :noon :middle_of_day


  








  

    #nsec  
  



  

    
Returns the fraction of a second as nanoseconds

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 105



def nsec
  (sec_fraction * 1_000_000_000).to_i
end


  








  

    #offset_in_seconds   (private)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 110



def offset_in_seconds
  (offset * 86400).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".

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 65



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

  



  [ GitHub ]


  

  


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



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


  








  

    #seconds_since_unix_epoch   (private)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 114



def seconds_since_unix_epoch
  (jd - 2440588) * 86400 - offset_in_seconds + seconds_since_midnight
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

  



  [ GitHub ]


  

  


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



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!

  



  [ GitHub ]


  

  


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



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)

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 43



def subsec
  sec_fraction
end


  








  

    #to_f  
  



  

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

  



  [ GitHub ]


  

  


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



def to_f
  seconds_since_unix_epoch.to_f + sec_fraction
end


  








  

    #to_formatted_s(format = :default)  
  



  

    
Alias for #to_fs.

  



  [ GitHub ]


  

  


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



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 format using the
ActiveSupport::TimeFormats.register method. Use the format name as the key and
either a strftime string or Proc instance that takes a time or
datetime argument as the value.


#### config/initializers/time_formats.rb
{ActiveSupport::TimeFormats.register}(:month_and_year, '%B %Y')
{ActiveSupport::TimeFormats.register}(:short_ordinal, ->(date) { date.strftime("%B #{date.day.ordinalize}") })

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 42



def to_fs(format = :default)
  if formatter = ::ActiveSupport::TimeFormats.lookup(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.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 95



def to_i
  seconds_since_unix_epoch.to_i
end


  








  

    #to_time  
  



  

    
Return an instance of ::Time with the same UTC offset
as self.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/compatibility.rb', line 11



def to_time
  getlocal(utc_offset)
end


  








  

    #usec  
  



  

    
Returns the fraction of a second as microseconds

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/conversions.rb', line 100



def usec
  (sec_fraction * 1_000_000).to_i
end


  








  

    #utc_offset  
  



  

    
Returns the offset value in seconds.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/core_ext/date_time/calculations.rb', line 214



def utc_offset
  (offset * 86400).to_i
end