Class: Time

Inherits:
Object show all
Includes:
DateAndTime::Calculations, DateAndTime::Zones
Defined in:
lib/core_ext/object/blank.rb,
lib/core_ext/time/zones.rb,
lib/core_ext/object/json.rb,
lib/core_ext/time/acts_like.rb,
lib/core_ext/time/conversions.rb,
lib/core_ext/time/calculations.rb

Overview

:nodoc:

Constant Summary collapse

DATE_FORMATS = 
{
  :db           => '%Y-%m-%d %H:%M:%S',
  :number       => '%Y%m%d%H%M%S',
  :nsec         => '%Y%m%d%H%M%S%9N',
  :usec         => '%Y%m%d%H%M%S%6N',
  :time         => '%H:%M',
  :short        => '%d %b %H:%M',
  :long         => '%B %d, %Y %H:%M',
  :long_ordinal => lambda { |time|
    day_format = CoreExt::Inflector.ordinalize(time.day)
    time.strftime("%B #{day_format}, %Y %H:%M")
  },
  :rfc822       => lambda { |time|
    offset_format = time.formatted_offset(false)
    time.strftime("%a, %d %b %Y %H:%M:%S #{offset_format}")
  },
  :iso8601      => lambda { |time| time.iso8601 }
}
COMMON_YEAR_DAYS_IN_MONTH = 
[nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]

Constants included from DateAndTime::Calculations

DateAndTime::Calculations::DAYS_INTO_WEEK, DateAndTime::Calculations::WEEKEND_DAYS

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DateAndTime::Calculations

#all_month, #all_quarter, #all_week, #all_year, #beginning_of_month, #beginning_of_quarter, #beginning_of_week, #beginning_of_year, #days_ago, #days_since, #days_to_week_start, #end_of_month, #end_of_quarter, #end_of_week, #end_of_year, #future?, #monday, #months_ago, #months_since, #next_day, #next_month, #next_quarter, #next_week, #next_weekday, #next_year, #on_weekend?, #past?, #prev_day, #prev_month, #prev_quarter, #prev_week, #prev_weekday, #prev_year, #sunday, #today?, #tomorrow, #weeks_ago, #weeks_since, #years_ago, #years_since, #yesterday

Methods included from DateAndTime::Zones

#in_time_zone

Class Attribute Details

.zone_default ⇒ Object

Returns the value of attribute zone_default.



8
9
10
 
# File 'lib/core_ext/time/zones.rb', line 8

def zone_default
  @zone_default
end

Class Method Details

.===(other) ⇒ Object

Overriding case equality method so that it returns true for CoreExt::TimeWithZone instances



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

def ===(other)
  super || (self == Time && other.is_a?(CoreExt::TimeWithZone))
end

.at_with_coercion(*args) ⇒ Object Also known as: at

Layers additional behavior on Time.at so that CoreExt::TimeWithZone and DateTime instances can be used when called with a single argument



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/core_ext/time/calculations.rb', line 42

def at_with_coercion(*args)
  return at_without_coercion(*args) if args.size != 1

  # Time.at can be called with a time or numerical value
  time_or_number = args.first

  if time_or_number.is_a?(CoreExt::TimeWithZone) || time_or_number.is_a?(DateTime)
    at_without_coercion(time_or_number.to_f).getlocal
  else
    at_without_coercion(time_or_number)
  end
end

.current ⇒ Object

Returns Time.zone.now when Time.zone or config.time_zone are set, otherwise just returns Time.now.



36
37
38
 
# File 'lib/core_ext/time/calculations.rb', line 36

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

.days_in_month(month, year = current.year) ⇒ Object

Returns the number of days in the given month. If no year is specified, it will use the current year.



21
22
23
24
25
26
27
 
# File 'lib/core_ext/time/calculations.rb', line 21

def days_in_month(month, year = current.year)
  if month == 2 && ::Date.gregorian_leap?(year)
    29
  else
    COMMON_YEAR_DAYS_IN_MONTH[month]
  end
end

.days_in_year(year = current.year) ⇒ Object

Returns the number of days in the given year. If no year is specified, it will use the current year.



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

def days_in_year(year = current.year)
  days_in_month(2, year) + 337
end

.find_zone(time_zone) ⇒ Object

Returns a TimeZone instance matching the time zone provided. Accepts the time zone in any format supported by Time.zone=. Returns nil for invalid time zones.

Time.find_zone "America/New_York" # => #<CoreExt::TimeZone @name="America/New_York" ...>
Time.find_zone "NOT-A-TIMEZONE"   # => nil



91
92
93
 
# File 'lib/core_ext/time/zones.rb', line 91

def find_zone(time_zone)
  find_zone!(time_zone) rescue nil
end

.find_zone!(time_zone) ⇒ Object

Returns a TimeZone instance matching the time zone provided. Accepts the time zone in any format supported by Time.zone=. Raises an ArgumentError for invalid time zones.

Time.find_zone! "America/New_York" # => #<CoreExt::TimeZone @name="America/New_York" ...>
Time.find_zone! "EST"              # => #<CoreExt::TimeZone @name="EST" ...>
Time.find_zone! -5.hours           # => #<CoreExt::TimeZone @name="Bogota" ...>
Time.find_zone! nil                # => nil
Time.find_zone! false              # => false
Time.find_zone! "NOT-A-TIMEZONE"   # => ArgumentError: Invalid Timezone: NOT-A-TIMEZONE



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/core_ext/time/zones.rb', line 64

def find_zone!(time_zone)
  if !time_zone || time_zone.is_a?(CoreExt::TimeZone)
    time_zone
  else
    # Look up the timezone based on the identifier (unless we've been
    # passed a TZInfo::Timezone)
    unless time_zone.respond_to?(:period_for_local)
      time_zone = CoreExt::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone)
    end

    # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
    if time_zone.is_a?(CoreExt::TimeZone)
      time_zone
    else
      CoreExt::TimeZone.create(time_zone.name, nil, time_zone)
    end
  end
rescue TZInfo::InvalidTimezoneIdentifier
  raise ArgumentError, "Invalid Timezone: #{time_zone}"
end

.use_zone(time_zone) ⇒ Object

Allows override of Time.zone locally inside supplied block; resets Time.zone to existing value when done.



44
45
46
47
48
49
50
51
52
 
# File 'lib/core_ext/time/zones.rb', line 44

def use_zone(time_zone)
  new_zone = find_zone!(time_zone)
  begin
    old_zone, ::Time.zone = ::Time.zone, new_zone
    yield
  ensure
    ::Time.zone = old_zone
  end
end

.zone ⇒ Object

Returns the TimeZone for the current request, if this has been set (via Time.zone=). If Time.zone has not been set for the current request, returns the TimeZone specified in config.time_zone.



12
13
14
 
# File 'lib/core_ext/time/zones.rb', line 12

def zone
  Thread.current[:time_zone] || zone_default
end

.zone=(time_zone) ⇒ Object

Sets Time.zone to a TimeZone object for the current request/thread.

This method accepts any of the following:

  • A Rails TimeZone object.

  • An identifier for a Rails TimeZone object (e.g., “Eastern Time (US & Canada)”, -5.hours).

  • A TZInfo::Timezone object.

  • An identifier for a TZInfo::Timezone object (e.g., “America/New_York”).

Here’s an example of how you might set Time.zone on a per request basis and reset it when the request is done. current_user.time_zone just needs to return a string identifying the user’s preferred time zone:

class ApplicationController < ActionController::Base
  around_action :set_time_zone

  def set_time_zone
    if logged_in?
      Time.use_zone(current_user.time_zone) { yield }
    else
      yield
    end
  end
end



39
40
41
 
# File 'lib/core_ext/time/zones.rb', line 39

def zone=(time_zone)
  Thread.current[:time_zone] = find_zone!(time_zone)
end

Instance Method Details

#acts_like_time? ⇒ Boolean

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

Returns:

  • (Boolean) 


5
6
7
 
# File 'lib/core_ext/time/acts_like.rb', line 5

def acts_like_time?
  true
end

#advance(options) ⇒ Object

Uses Date to provide precise Time calculations for years, months, and days according to the proleptic Gregorian calendar. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days, :hours, :minutes, :seconds.

Time.new(2015, 8, 1, 14, 35, 0).advance(seconds: 1) # => 2015-08-01 14:35:01 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(minutes: 1) # => 2015-08-01 14:36:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(hours: 1)   # => 2015-08-01 15:35:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(days: 1)    # => 2015-08-02 14:35:00 -0700
Time.new(2015, 8, 1, 14, 35, 0).advance(weeks: 1)   # => 2015-08-08 14:35:00 -0700



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/core_ext/time/calculations.rb', line 124

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)
  d = d.gregorian if d.julian?
  time_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?
    time_advanced_by_date
  else
    time_advanced_by_date.since(seconds_to_advance)
  end
end

#ago(seconds) ⇒ Object

Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension



151
152
153
 
# File 'lib/core_ext/time/calculations.rb', line 151

def ago(seconds)
  since(-seconds)
end

#all_day ⇒ Object

Returns a Range representing the whole day of the current time.



225
226
227
 
# File 'lib/core_ext/time/calculations.rb', line 225

def all_day
  beginning_of_day..end_of_day
end

#as_json(options = nil) ⇒ Object

:nodoc:



166
167
168
169
170
171
172
 
# File 'lib/core_ext/object/json.rb', line 166

def as_json(options = nil) #:nodoc:
  if CoreExt::JSON::Encoding.use_standard_json_time_format
    xmlschema(CoreExt::JSON::Encoding.time_precision)
  else
    %(#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

#beginning_of_day ⇒ Object Also known as: midnight, at_midnight, at_beginning_of_day

Returns a new Time representing the start of the day (0:00)



164
165
166
167
 
# File 'lib/core_ext/time/calculations.rb', line 164

def beginning_of_day
  #(self - seconds_since_midnight).change(usec: 0)
  change(:hour => 0)
end

#beginning_of_hour ⇒ Object Also known as: at_beginning_of_hour

Returns a new Time representing the start of the hour (x:00)



194
195
196
 
# File 'lib/core_ext/time/calculations.rb', line 194

def beginning_of_hour
  change(:min => 0)
end

#beginning_of_minute ⇒ Object Also known as: at_beginning_of_minute

Returns a new Time representing the start of the minute (x:xx:00)



210
211
212
 
# File 'lib/core_ext/time/calculations.rb', line 210

def beginning_of_minute
  change(:sec => 0)
end

#blank? ⇒ false

No Time is blank:

Time.now.blank? # => false

Returns:

  • (false) 


137
138
139
 
# File 'lib/core_ext/object/blank.rb', line 137

def blank?
  false
end

#change(options) ⇒ Object

Returns a new Time where one or more of the elements have been changed according to the options parameter. The time options (:hour, :min, :sec, :usec, :nsec) reset cascadingly, so if only the hour is passed, then minute, sec, usec and nsec is set to 0. If the hour and minute is passed, then sec, usec and nsec is set to 0. The options parameter takes a hash with any of these keys: :year, :month, :day, :hour, :min, :sec, :usec :nsec. Pass either :usec or :nsec, not both.

Time.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => Time.new(2012, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => Time.new(1981, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => Time.new(1981, 8, 29, 0, 0, 0)



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/core_ext/time/calculations.rb', line 88

def change(options)
  new_year  = options.fetch(:year, year)
  new_month = options.fetch(:month, month)
  new_day   = options.fetch(:day, day)
  new_hour  = options.fetch(:hour, hour)
  new_min   = options.fetch(:min, options[:hour] ? 0 : min)
  new_sec   = options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec)

  if new_nsec = options[:nsec]
    raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
    new_usec = Rational(new_nsec, 1000)
  else
    new_usec  = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
  end

  if utc?
    ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  elsif zone
    ::Time.local(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  else
    raise ArgumentError, 'argument out of range' if new_usec >= 1000000
    ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec + (new_usec.to_r / 1000000), utc_offset)
  end
end

#compare_with_coercion(other) ⇒ Object Also known as: <=>

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



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/core_ext/time/calculations.rb', line 261

def compare_with_coercion(other)
  # we're avoiding Time#to_datetime and Time#to_time because they're expensive
  if other.class == Time
    compare_without_coercion(other)
  elsif other.is_a?(Time)
    compare_without_coercion(other.to_time)
  else
    to_datetime <=> other
  end
end

#end_of_day ⇒ Object Also known as: at_end_of_day

Returns a new Time representing the end of the day, 23:59:59.999999



183
184
185
186
187
188
189
190
 
# File 'lib/core_ext/time/calculations.rb', line 183

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 Time representing the end of the hour, x:59:59.999999



200
201
202
203
204
205
206
 
# File 'lib/core_ext/time/calculations.rb', line 200

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 Time representing the end of the minute, x:xx:59.999999



216
217
218
219
220
221
 
# File 'lib/core_ext/time/calculations.rb', line 216

def end_of_minute
  change(
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#eql_with_coercion(other) ⇒ Object Also known as: eql?

Layers additional behavior on Time#eql? so that CoreExt::TimeWithZone instances can be eql? to an equivalent Time



276
277
278
279
280
 
# File 'lib/core_ext/time/calculations.rb', line 276

def eql_with_coercion(other)
  # if other is an CoreExt::TimeWithZone, coerce a Time instance from it so we can do eql? comparison
  other = other.comparable_time if other.respond_to?(:comparable_time)
  eql_without_coercion(other)
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.

Time.local(2000).formatted_offset        # => "-06:00"
Time.local(2000).formatted_offset(false) # => "-0600"



63
64
65
 
# File 'lib/core_ext/time/conversions.rb', line 63

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

#middle_of_day ⇒ Object Also known as: midday, noon, at_midday, at_noon, at_middle_of_day

Returns a new Time representing the middle of the day (12:00)



173
174
175
 
# File 'lib/core_ext/time/calculations.rb', line 173

def middle_of_day
  change(:hour => 12)
end

#minus_with_coercion(other) ⇒ Object Also known as: -

Time#- can also be used to determine the number of seconds between two Time instances. We’re layering on additional behavior so that CoreExt::TimeWithZone instances are coerced into values that Time#- will recognize



252
253
254
255
 
# File 'lib/core_ext/time/calculations.rb', line 252

def minus_with_coercion(other)
  other = other.comparable_time if other.respond_to?(:comparable_time)
  other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other)
end

#minus_with_duration(other) ⇒ Object

:nodoc:



239
240
241
242
243
244
245
 
# File 'lib/core_ext/time/calculations.rb', line 239

def minus_with_duration(other) #:nodoc:
  if CoreExt::Duration === other
    other.until(self)
  else
    minus_without_duration(other)
  end
end

#plus_with_duration(other) ⇒ Object Also known as: +

:nodoc:



229
230
231
232
233
234
235
 
# File 'lib/core_ext/time/calculations.rb', line 229

def plus_with_duration(other) #:nodoc:
  if CoreExt::Duration === other
    other.since(self)
  else
    plus_without_duration(other)
  end
end

#seconds_since_midnight ⇒ Object

Returns the number of seconds since 00:00:00.

Time.new(2012, 8, 29,  0,  0,  0).seconds_since_midnight # => 0.0
Time.new(2012, 8, 29, 12, 34, 56).seconds_since_midnight # => 45296.0
Time.new(2012, 8, 29, 23, 59, 59).seconds_since_midnight # => 86399.0



63
64
65
 
# File 'lib/core_ext/time/calculations.rb', line 63

def seconds_since_midnight
  to_i - change(:hour => 0).to_i + (usec / 1.0e+6)
end

#seconds_until_end_of_day ⇒ Object

Returns the number of seconds until 23:59:59.

Time.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
Time.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
Time.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0



72
73
74
 
# File 'lib/core_ext/time/calculations.rb', line 72

def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

#since(seconds) ⇒ Object Also known as: in

Returns a new Time representing the time a number of seconds since the instance time



156
157
158
159
160
 
# File 'lib/core_ext/time/calculations.rb', line 156

def since(seconds)
  self + seconds
rescue
  to_datetime.since(seconds)
end

#to_formatted_s(format = :default) ⇒ Object Also known as: to_s

Converts to a formatted string. See DATE_FORMATS for built-in formats.

This method is aliased to to_s.

time = Time.now                    # => 2007-01-18 06:10:17 -06:00

time.to_formatted_s(:time)         # => "06:10"
time.to_s(:time)                   # => "06:10"

time.to_formatted_s(:db)           # => "2007-01-18 06:10:17"
time.to_formatted_s(:number)       # => "20070118061017"
time.to_formatted_s(:short)        # => "18 Jan 06:10"
time.to_formatted_s(:long)         # => "January 18, 2007 06:10"
time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10"
time.to_formatted_s(:rfc822)       # => "Thu, 18 Jan 2007 06:10:17 -0600"
time.to_formatted_s(:iso8601)      # => "2007-01-18T06:10:17-06:00"

Adding your own time formats to to_formatted_s

You can add your own formats 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 argument as the value.

# config/initializers/time_formats.rb
Time::DATE_FORMATS[:month_and_year] = '%B %Y'
Time::DATE_FORMATS[:short_ordinal]  = ->(time) { time.strftime("%B #{time.day.ordinalize}") }



48
49
50
51
52
53
54
 
# File 'lib/core_ext/time/conversions.rb', line 48

def to_formatted_s(format = :default)
  if formatter = DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_default_s
  end
end