Class: DateTime

Inherits:
Object show all
Defined in:
lib/active_support/json/encoding.rb,
lib/active_support/core_ext/date_time/zones.rb,
lib/active_support/core_ext/date_time/acts_like.rb,
lib/active_support/core_ext/date_time/conversions.rb,
lib/active_support/core_ext/date_time/calculations.rb

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



63
64
65
66
67
68
69
70
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 63

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.



15
16
17
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 15

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

.local_offset ⇒ Object

DEPRECATED: Use DateTime.civil_from_format directly.



6
7
8
9
10
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 6

def local_offset
  ActiveSupport::Deprecation.warn 'DateTime.local_offset is deprecated. Use DateTime.civil_from_format directly.'

  ::Time.local(2012).utc_offset.to_r / 86400
end

Instance Method Details

#<=>(other) ⇒ Object

Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime.



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

def <=>(other)
  super other.to_datetime
end

#acts_like_date? ⇒ Boolean

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

Returns:

  • (Boolean) 


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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 72

def advance(options)
  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!



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

def ago(seconds)
  since(-seconds)
end

#as_json(options = nil) ⇒ Object

:nodoc:



331
332
333
334
335
336
337
 
# File 'lib/active_support/json/encoding.rb', line 331

def as_json(options = nil) #:nodoc:
  if ActiveSupport.use_standard_json_time_format
    xmlschema
  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).



102
103
104
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 102

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



116
117
118
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 116

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



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

def beginning_of_minute
  change(:sec => 0)
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)



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 55

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_day ⇒ Object Also known as: at_end_of_day

Returns a new DateTime representing the end of the day (23:59:59).



110
111
112
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 110

def end_of_day
  change(:hour => 23, :min => 59, :sec => 59)
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).



122
123
124
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 122

def end_of_hour
  change(:min => 59, :sec => 59)
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).



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

def end_of_minute
  change(:sec => 59)
end

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

datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))

datetime.formatted_offset         # => "-06:00"
datetime.formatted_offset(false)  # => "-0600"



45
46
47
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 45

def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

#future? ⇒ Boolean

Tells whether the DateTime object’s datetime lies in the future.

Returns:

  • (Boolean) 


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

def future?
  self > ::DateTime.current
end

#in_time_zone(zone = ::Time.zone) ⇒ Object

Returns the simultaneous time in Time.zone.

Time.zone = 'Hawaii'             # => 'Hawaii'
DateTime.new(2000).in_time_zone  # => Fri, 31 Dec 1999 14:00:00 HST -10:00

This method is similar to Time#localtime, except that it uses Time.zone as the local zone instead of the operating system’s time zone.

You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument, and the conversion will be based on that zone instead of Time.zone.

DateTime.new(2000).in_time_zone('Alaska') # => Fri, 31 Dec 1999 15:00:00 AKST -09:00



17
18
19
20
21
22
23
 
# File 'lib/active_support/core_ext/date_time/zones.rb', line 17

def in_time_zone(zone = ::Time.zone)
  if zone
    ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.find_zone!(zone))
  else
    self
  end
end

#nsec ⇒ Object

Returns the fraction of a second as nanoseconds



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

def nsec
  (sec_fraction * 1_000_000_000).to_i
end

#past? ⇒ Boolean

Tells whether the DateTime object’s datetime lies in the past.

Returns:

  • (Boolean) 


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

def past?
  self < ::DateTime.current
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”.



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

def readable_inspect
  to_s(:rfc822)
end

#seconds_since_midnight ⇒ Object

Seconds since midnight: DateTime.now.seconds_since_midnight.



31
32
33
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 31

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

#seconds_until_end_of_day ⇒ Object

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



40
41
42
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 40

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!



96
97
98
 
# File 'lib/active_support/core_ext/date_time/calculations.rb', line 96

def since(seconds)
  self + Rational(seconds.round, 86400)
end

#to_f ⇒ Object

Converts self to a floating-point number of seconds since the Unix epoch.



73
74
75
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 73

def to_f
  seconds_since_unix_epoch.to_f
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"

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}") }



31
32
33
34
35
36
37
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 31

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.



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

def to_i
  seconds_since_unix_epoch.to_i
end

#usec ⇒ Object

Returns the fraction of a second as microseconds



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

def usec
  (sec_fraction * 1_000_000).to_i
end

#utc ⇒ Object Also known as: getutc

Adjusts DateTime to UTC by adding its offset value; offset is set to 0.

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 +0000



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

def utc
  new_offset(0)
end

#utc? ⇒ Boolean

Returns true if offset == 0.

Returns:

  • (Boolean) 


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

def utc?
  offset == 0
end

#utc_offset ⇒ Object

Returns the offset value in seconds.



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

def utc_offset
  (offset * 86400).to_i
end