Class: Time
- Defined in:
 - lib/active_support/core_ext/object/blank.rb,
lib/active_support/core_ext/time/zones.rb,
lib/active_support/core_ext/object/json.rb,
lib/active_support/core_ext/time/acts_like.rb,
lib/active_support/core_ext/time/conversions.rb,
lib/active_support/core_ext/time/calculations.rb,
lib/active_support/core_ext/time/compatibility.rb 
Overview
:nodoc:
Constant Summary collapse
- DATE_FORMATS =
 { db: "%Y-%m-%d %H:%M:%S", inspect: "%Y-%m-%d %H:%M:%S.%9N %z", 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 = ActiveSupport::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}") }, rfc2822: lambda { |time| time.rfc2822 }, 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
- 
  
    
      .zone_default  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute zone_default.
 
Class Method Summary collapse
- 
  
    
      .===(other)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances.
 - 
  
    
      .at_with_coercion(time_or_number, *args)  ⇒ Object 
    
    
      (also: at)
    
  
  
  
  
  
  
  
  
  
    
Layers additional behavior on Time.at so that ActiveSupport::TimeWithZone and DateTime instances can be used when called with a single argument.
 - 
  
    
      .current  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns
Time.zone.nowwhenTime.zoneorconfig.time_zoneare set, otherwise just returnsTime.now. - 
  
    
      .days_in_month(month, year = current.year)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns the number of days in the given month.
 - 
  
    
      .days_in_year(year = current.year)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns the number of days in the given year.
 - 
  
    
      .find_zone(time_zone)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a TimeZone instance matching the time zone provided.
 - 
  
    
      .find_zone!(time_zone)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a TimeZone instance matching the time zone provided.
 - 
  
    
      .rfc3339(str)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Creates a
Timeinstance from an RFC 3339 string. - 
  
    
      .use_zone(time_zone)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Allows override of
Time.zonelocally inside supplied block; resetsTime.zoneto existing value when done. - 
  
    
      .zone  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns the TimeZone for the current request, if this has been set (via Time.zone=).
 - 
  
    
      .zone=(time_zone)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Sets
Time.zoneto a TimeZone object for the current request/thread. 
Instance Method Summary collapse
- 
  
    
      #acts_like_time?  ⇒ Boolean 
    
    
  
  
  
  
  
  
  
  
  
    
Duck-types as a Time-like class.
 - 
  
    
      #advance(options)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Uses Date to provide precise Time calculations for years, months, and days according to the proleptic Gregorian calendar.
 - 
  
    
      #ago(seconds)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension.
 - 
  
    
      #as_json(options = nil)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
:nodoc:.
 - 
  
    
      #beginning_of_day  ⇒ Object 
    
    
      (also: #midnight, #at_midnight, #at_beginning_of_day)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the start of the day (0:00).
 - 
  
    
      #beginning_of_hour  ⇒ Object 
    
    
      (also: #at_beginning_of_hour)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the start of the hour (x:00).
 - 
  
    
      #beginning_of_minute  ⇒ Object 
    
    
      (also: #at_beginning_of_minute)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the start of the minute (x:xx:00).
 - 
  
    
      #blank?  ⇒ false 
    
    
  
  
  
  
  
  
  
  
  
    
No Time is blank:.
 - 
  
    
      #change(options)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time where one or more of the elements have been changed according to the
optionsparameter. - 
  
    
      #compare_with_coercion(other)  ⇒ Object 
    
    
      (also: #<=>)
    
  
  
  
  
  
  
  
  
  
    
Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time.
 - 
  
    
      #end_of_day  ⇒ Object 
    
    
      (also: #at_end_of_day)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the end of the day, 23:59:59.999999.
 - 
  
    
      #end_of_hour  ⇒ Object 
    
    
      (also: #at_end_of_hour)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the end of the hour, x:59:59.999999.
 - 
  
    
      #end_of_minute  ⇒ Object 
    
    
      (also: #at_end_of_minute)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the end of the minute, x:xx:59.999999.
 - 
  
    
      #eql_with_coercion(other)  ⇒ Object 
    
    
      (also: #eql?)
    
  
  
  
  
  
  
  
  
  
    
Layers additional behavior on Time#eql? so that ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time.
 - 
  
    
      #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.
 - 
  
    
      #middle_of_day  ⇒ Object 
    
    
      (also: #midday, #noon, #at_midday, #at_noon, #at_middle_of_day)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the middle of the day (12:00).
 - 
  
    
      #minus_with_coercion(other)  ⇒ Object 
    
    
      (also: #-)
    
  
  
  
  
  
  
  
  
  
    
Time#- can also be used to determine the number of seconds between two Time instances.
 - 
  
    
      #minus_with_duration(other)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
:nodoc:.
 - 
  
    
      #next_day(days = 1)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new time the specified number of days in the future.
 - 
  
    
      #next_month(months = 1)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new time the specified number of months in the future.
 - 
  
    
      #next_year(years = 1)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new time the specified number of years in the future.
 - 
  
    
      #plus_with_duration(other)  ⇒ Object 
    
    
      (also: #+)
    
  
  
  
  
  
  
  
  
  
    
:nodoc:.
 - #present? ⇒ Boolean
 - 
  
    
      #prev_day(days = 1)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new time the specified number of days ago.
 - 
  
    
      #prev_month(months = 1)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new time the specified number of months ago.
 - 
  
    
      #prev_year(years = 1)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a new time the specified number of years ago.
 - 
  
    
      #sec_fraction  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns the fraction of a second as a
Rational. - 
  
    
      #seconds_since_midnight  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns the number of seconds since 00:00:00.
 - 
  
    
      #seconds_until_end_of_day  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Returns the number of seconds until 23:59:59.
 - 
  
    
      #since(seconds)  ⇒ Object 
    
    
      (also: #in)
    
  
  
  
  
  
  
  
  
  
    
Returns a new Time representing the time a number of seconds since the instance time.
 - 
  
    
      #to_fs(format = :default)  ⇒ Object 
    
    
      (also: #to_formatted_s)
    
  
  
  
  
  
  
  
  
  
    
Converts to a formatted string.
 - 
  
    
      #to_time  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Return
self. 
Methods included from DateAndTime::Calculations
#after?, #all_day, #all_month, #all_quarter, #all_week, #all_year, #before?, #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?, #last_month, #last_year, #monday, #months_ago, #months_since, #next_occurring, #next_quarter, #next_week, #next_weekday, #on_weekday?, #on_weekend?, #past?, #prev_occurring, #prev_quarter, #prev_week, #prev_weekday, #quarter, #sunday, #today?, #tomorrow, #tomorrow?, #weeks_ago, #weeks_since, #years_ago, #years_since, #yesterday, #yesterday?
Methods included from DateAndTime::Zones
Class Attribute Details
.zone_default ⇒ Object
Returns the value of attribute zone_default.
      10 11 12  | 
    
      # File 'lib/active_support/core_ext/time/zones.rb', line 10 def zone_default @zone_default end  | 
  
Class Method Details
.===(other) ⇒ Object
Overriding case equality method so that it returns true for ActiveSupport::TimeWithZone instances
      18 19 20  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 18 def ===(other) super || (self == Time && other.is_a?(ActiveSupport::TimeWithZone)) end  | 
  
.at_with_coercion(time_or_number, *args) ⇒ Object Also known as: at
Layers additional behavior on Time.at so that ActiveSupport::TimeWithZone and DateTime instances can be used when called with a single argument
      45 46 47 48 49 50 51 52 53 54 55 56 57  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 45 def at_with_coercion(time_or_number, *args) if args.empty? if time_or_number.is_a?(ActiveSupport::TimeWithZone) at_without_coercion(time_or_number.to_r).getlocal elsif time_or_number.is_a?(DateTime) at_without_coercion(time_or_number.to_f).getlocal else at_without_coercion(time_or_number) end else at_without_coercion(time_or_number, *args) end end  | 
  
.current ⇒ Object
Returns Time.zone.now when Time.zone or config.time_zone are set, otherwise just returns Time.now.
      39 40 41  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 39 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.
      24 25 26 27 28 29 30  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 24 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.
      34 35 36  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 34 def days_in_year(year = current.year) days_in_month(2, year) + 337 end  | 
  
.find_zone(time_zone) ⇒ Object
      93 94 95  | 
    
      # File 'lib/active_support/core_ext/time/zones.rb', line 93 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" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
Time.find_zone! "EST"              # => #<ActiveSupport::TimeZone @name="EST" ...>
Time.find_zone! -5.hours           # => #<ActiveSupport::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
  
      81 82 83 84 85  | 
    
      # File 'lib/active_support/core_ext/time/zones.rb', line 81 def find_zone!(time_zone) return time_zone unless time_zone ActiveSupport::TimeZone[time_zone] || raise(ArgumentError, "Invalid Timezone: #{time_zone}") end  | 
  
.rfc3339(str) ⇒ Object
      69 70 71 72 73 74 75 76 77 78 79 80 81 82 83  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 69 def rfc3339(str) parts = Date._rfc3339(str) raise ArgumentError, "invalid date" if parts.empty? Time.new( parts.fetch(:year), parts.fetch(:mon), parts.fetch(:mday), parts.fetch(:hour), parts.fetch(:min), parts.fetch(:sec) + parts.fetch(:sec_fraction, 0), parts.fetch(:offset) ) end  | 
  
.use_zone(time_zone) ⇒ Object
Allows override of Time.zone locally inside supplied block; resets Time.zone to existing value when done.
class ApplicationController < ActionController::Base
  around_action :set_time_zone
  private
    def set_time_zone
      Time.use_zone(current_user.timezone) { yield }
    end
end
NOTE: This won’t affect any ActiveSupport::TimeWithZone objects that have already been created, e.g. any model timestamp attributes that have been read before the block will remain in the application’s default timezone.
      61 62 63 64 65 66 67 68 69  | 
    
      # File 'lib/active_support/core_ext/time/zones.rb', line 61 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.
      14 15 16  | 
    
      # File 'lib/active_support/core_ext/time/zones.rb', line 14 def zone ::ActiveSupport::IsolatedExecutionState[: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::Timezoneobject. - 
An identifier for a
TZInfo::Timezoneobject (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
  
      41 42 43  | 
    
      # File 'lib/active_support/core_ext/time/zones.rb', line 41 def zone=(time_zone) ::ActiveSupport::IsolatedExecutionState[: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?.
      7 8 9  | 
    
      # File 'lib/active_support/core_ext/time/acts_like.rb', line 7 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
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.
      194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 194 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.gregorian.advance() time_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? 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
      220 221 222  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 220 def ago(seconds) since(-seconds) end  | 
  
#as_json(options = nil) ⇒ Object
:nodoc:
      201 202 203 204 205 206 207  | 
    
      # File 'lib/active_support/core_ext/object/json.rb', line 201 def as_json( = 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")} #{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)
      231 232 233  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 231 def beginning_of_day 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)
      260 261 262  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 260 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)
      276 277 278  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 276 def beginning_of_minute change(sec: 0) end  | 
  
#blank? ⇒ false
No Time is blank:
Time.now.blank? # => false
  
      192 193 194  | 
    
      # File 'lib/active_support/core_ext/object/blank.rb', line 192 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, :offset. 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)
  
      123 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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 123 def change() new_year = .fetch(:year, year) new_month = .fetch(:month, month) new_day = .fetch(:day, day) new_hour = .fetch(:hour, hour) new_min = .fetch(:min, [:hour] ? 0 : min) new_sec = .fetch(:sec, ([:hour] || [:min]) ? 0 : sec) new_offset = .fetch(:offset, nil) if new_nsec = [:nsec] raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{.inspect}" if [:usec] new_usec = Rational(new_nsec, 1000) else new_usec = .fetch(:usec, ([:hour] || [:min] || [:sec]) ? 0 : Rational(nsec, 1000)) end raise ArgumentError, "argument out of range" if new_usec >= 1000000 new_sec += Rational(new_usec, 1000000) if new_offset ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, new_offset) elsif utc? ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec) elsif zone.respond_to?(:utc_to_local) new_time = ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, zone) # Some versions of Ruby have a bug where Time.new with a zone object and # fractional seconds will end up with a broken utc_offset. # This is fixed in Ruby 3.3.1 and 3.2.4 unless new_time.utc_offset.integer? new_time += 0 end # When there are two occurrences of a nominal time due to DST ending, # `Time.new` chooses the first chronological occurrence (the one with a # larger UTC offset). However, for `change`, we want to choose the # occurrence that matches this time's UTC offset. # # If the new time's UTC offset is larger than this time's UTC offset, the # new time might be a first chronological occurrence. So we add the offset # difference to fast-forward the new time, and check if the result has the # desired UTC offset (i.e. is the second chronological occurrence). offset_difference = new_time.utc_offset - utc_offset if offset_difference > 0 && (new_time_2 = new_time + offset_difference).utc_offset == utc_offset new_time_2 else new_time end elsif zone ::Time.local(new_sec, new_min, new_hour, new_day, new_month, new_year, nil, nil, isdst, nil) else ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec, utc_offset) end end  | 
  
#compare_with_coercion(other) ⇒ Object Also known as: <=>
Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time
      322 323 324 325 326 327 328 329 330 331 332 333 334 335 336  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 322 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) # also avoid ActiveSupport::TimeWithZone#to_time before Rails 8.0 if other.respond_to?(:comparable_time) compare_without_coercion(other.comparable_time) else compare_without_coercion(other.to_time) end 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
      249 250 251 252 253 254 255 256  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 249 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
      266 267 268 269 270 271 272  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 266 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
      282 283 284 285 286 287  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 282 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 ActiveSupport::TimeWithZone instances can be eql? to an equivalent Time
      342 343 344 345 346  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 342 def eql_with_coercion(other) # if other is an ActiveSupport::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
      69 70 71  | 
    
      # File 'lib/active_support/core_ext/time/conversions.rb', line 69 def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || ActiveSupport::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)
      239 240 241  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 239 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 ActiveSupport::TimeWithZone instances are coerced into values that Time#- will recognize
      313 314 315 316  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 313 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:
      300 301 302 303 304 305 306  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 300 def minus_with_duration(other) # :nodoc: if ActiveSupport::Duration === other other.until(self) else minus_without_duration(other) end end  | 
  
#next_day(days = 1) ⇒ Object
Returns a new time the specified number of days in the future.
      356 357 358  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 356 def next_day(days = 1) advance(days: days) end  | 
  
#next_month(months = 1) ⇒ Object
Returns a new time the specified number of months in the future.
      366 367 368  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 366 def next_month(months = 1) advance(months: months) end  | 
  
#next_year(years = 1) ⇒ Object
Returns a new time the specified number of years in the future.
      376 377 378  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 376 def next_year(years = 1) advance(years: years) end  | 
  
#plus_with_duration(other) ⇒ Object Also known as: +
:nodoc:
      290 291 292 293 294 295 296  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 290 def plus_with_duration(other) # :nodoc: if ActiveSupport::Duration === other other.since(self) else plus_without_duration(other) end end  | 
  
#present? ⇒ Boolean
      196 197 198  | 
    
      # File 'lib/active_support/core_ext/object/blank.rb', line 196 def present? true end  | 
  
#prev_day(days = 1) ⇒ Object
Returns a new time the specified number of days ago.
      351 352 353  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 351 def prev_day(days = 1) advance(days: -days) end  | 
  
#prev_month(months = 1) ⇒ Object
Returns a new time the specified number of months ago.
      361 362 363  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 361 def prev_month(months = 1) advance(months: -months) end  | 
  
#prev_year(years = 1) ⇒ Object
Returns a new time the specified number of years ago.
      371 372 373  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 371 def prev_year(years = 1) advance(years: -years) end  | 
  
#sec_fraction ⇒ Object
Returns the fraction of a second as a Rational
Time.new(2012, 8, 29, 0, 0, 0.5).sec_fraction # => (1/2)
  
      107 108 109  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 107 def sec_fraction subsec end  | 
  
#seconds_since_midnight ⇒ Object
      91 92 93  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 91 def seconds_since_midnight to_i - change(hour: 0).to_i + (usec / 1.0e+6) end  | 
  
#seconds_until_end_of_day ⇒ Object
      100 101 102  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 100 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
      225 226 227  | 
    
      # File 'lib/active_support/core_ext/time/calculations.rb', line 225 def since(seconds) self + seconds end  | 
  
#to_fs(format = :default) ⇒ Object Also known as: to_formatted_s
Converts to a formatted string. See DATE_FORMATS for built-in formats.
This method is aliased to to_formatted_s.
time = Time.now                    # => 2007-01-18 06:10:17 -06:00
time.to_fs(:time)                  # => "06:10"
time.to_formatted_s(:time)         # => "06:10"
time.to_fs(:db)           # => "2007-01-18 06:10:17"
time.to_fs(:number)       # => "20070118061017"
time.to_fs(:short)        # => "18 Jan 06:10"
time.to_fs(:long)         # => "January 18, 2007 06:10"
time.to_fs(:long_ordinal) # => "January 18th, 2007 06:10"
time.to_fs(:rfc822)       # => "Thu, 18 Jan 2007 06:10:17 -0600"
time.to_fs(:rfc2822)       # => "Thu, 18 Jan 2007 06:10:17 -0600"
time.to_fs(:iso8601)      # => "2007-01-18T06:10:17-06:00"
Adding your own time formats to to_fs
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}") }
  
      55 56 57 58 59 60 61  | 
    
      # File 'lib/active_support/core_ext/time/conversions.rb', line 55 def to_fs(format = :default) if formatter = DATE_FORMATS[format] formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter) else to_s end end  | 
  
#to_time ⇒ Object
Return self.
      12 13 14  | 
    
      # File 'lib/active_support/core_ext/time/compatibility.rb', line 12 def to_time self end  |