Module ActiveSupport::CoreExtensions::Time::Calculations
In: vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb

Enables the use of time calculations within Time itself

Methods

Classes and Modules

Module ActiveSupport::CoreExtensions::Time::Calculations::ClassMethods

Constants

COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]

Public Instance methods

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.

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 85
85:         def advance(options)
86:           d = to_date.advance(options)
87:           time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
88:           seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
89:           seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance)
90:         end

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

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 93
93:         def ago(seconds)
94:           self.since(-seconds)
95:         end
at_beginning_of_day()

Alias for beginning_of_day

at_beginning_of_month()

Alias for beginning_of_month

at_beginning_of_quarter()
at_beginning_of_week()

Alias for beginning_of_week

at_beginning_of_year()

Alias for beginning_of_year

at_end_of_month()

Alias for end_of_month

at_end_of_quarter()

Alias for end_of_quarter

at_end_of_week()

Alias for end_of_week

at_end_of_year()

Alias for end_of_year

at_midnight()

Alias for beginning_of_day

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

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 176
176:         def beginning_of_day
177:           (self - self.seconds_since_midnight).change(:usec => 0)
178:         end

Returns a new Time representing the start of the month (1st of the month, 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 189
189:         def beginning_of_month
190:           #self - ((self.mday-1).days + self.seconds_since_midnight)
191:           change(:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0)
192:         end

Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 204
204:         def beginning_of_quarter
205:           beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
206:         end

Returns a new Time representing the "start" of this week (Monday, 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 155
155:         def beginning_of_week
156:           days_to_monday = self.wday!=0 ? self.wday-1 : 6
157:           (self - days_to_monday.days).midnight
158:         end

Returns a new Time representing the start of the year (1st of january, 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 216
216:         def beginning_of_year
217:           change(:month => 1,:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0)
218:         end

Returns a new Time where one or more of the elements have been changed according to the options parameter. The time options (hour, minute, sec, usec) reset cascadingly, so if only the hour is passed, then minute, sec, and usec is set to 0. If the hour and minute is passed, then sec and usec is set to 0.

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 68
68:         def change(options)
69:           ::Time.send(
70:             self.utc? ? :utc_time : :local_time,
71:             options[:year]  || self.year,
72:             options[:month] || self.month,
73:             options[:day]   || self.day,
74:             options[:hour]  || self.hour,
75:             options[:min]   || (options[:hour] ? 0 : self.min),
76:             options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
77:             options[:usec]  || ((options[:hour] || options[:min] || options[:sec]) ? 0 : self.usec)
78:           )
79:         end

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

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 263
263:         def compare_with_coercion(other)
264:           # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do <=> comparision
265:           other = other.comparable_time if other.respond_to?(:comparable_time)
266:           if other.acts_like?(:date)
267:             # other is a Date/DateTime, so coerce self #to_datetime and hand off to DateTime#<=>
268:             to_datetime.compare_without_coercion(other)
269:           else
270:             compare_without_coercion(other)
271:           end
272:         end

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

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 184
184:         def end_of_day
185:           change(:hour => 23, :min => 59, :sec => 59)
186:         end

Returns a new Time representing the end of the month (last day of the month, 0:00)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 196
196:         def end_of_month
197:           #self - ((self.mday-1).days + self.seconds_since_midnight)
198:           last_day = ::Time.days_in_month( self.month, self.year )
199:           change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => 0)
200:         end

Returns a new Time representing the end of the quarter (last day of march, june, september, december, 23:59:59)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 210
210:         def end_of_quarter
211:           change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
212:         end

Returns a new Time representing the end of this week (Sunday, 23:59:59)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 163
163:         def end_of_week
164:           days_to_sunday = self.wday!=0 ? 7-self.wday : 0
165:           (self + days_to_sunday.days).end_of_day
166:         end

Returns a new Time representing the end of the year (31st of december, 23:59:59)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 222
222:         def end_of_year
223:           change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59)
224:         end
in(seconds)

Alias for since

Short-hand for months_ago(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 145
145:         def last_month
146:           months_ago(1)
147:         end

Short-hand for years_ago(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 134
134:         def last_year
135:           years_ago(1)
136:         end
midnight()

Alias for beginning_of_day

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

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 256
256:         def minus_with_coercion(other)
257:           other = other.comparable_time if other.respond_to?(:comparable_time)
258:           minus_without_coercion(other)
259:         end
monday()

Alias for beginning_of_week

Returns a new Time representing the time a number of specified months ago

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 114
114:         def months_ago(months)
115:           advance(:months => -months)
116:         end

Returns a new Time representing the time a number of specified months in the future

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 119
119:         def months_since(months)
120:           advance(:months => months)
121:         end

Short-hand for months_since(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 150
150:         def next_month
151:           months_since(1)
152:         end

Returns a new Time representing the start of the given day in next week (default is Monday).

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 170
170:         def next_week(day = :monday)
171:           days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
172:           since(1.week).beginning_of_week.since(days_into_week[day].day).change(:hour => 0)
173:         end

Short-hand for years_since(1)

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 139
139:         def next_year
140:           years_since(1)
141:         end

Seconds since midnight: Time.now.seconds_since_midnight

[Source]

    # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 61
61:         def seconds_since_midnight
62:           self.to_i - self.change(:hour => 0).to_i + (self.usec/1.0e+6)
63:         end

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

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 99
 99:         def since(seconds)
100:           f = seconds.since(self)
101:           if ActiveSupport::Duration === seconds
102:             f
103:           else
104:             initial_dst = self.dst? ? 1 : 0
105:             final_dst   = f.dst? ? 1 : 0
106:             (seconds.abs >= 86400 && initial_dst != final_dst) ? f + (initial_dst - final_dst).hours : f
107:           end
108:         rescue
109:           self.to_datetime.since(seconds)          
110:         end

Convenience method which returns a new Time representing the time 1 day since the instance time

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 233
233:         def tomorrow
234:           advance(:days => 1)
235:         end

Returns a new Time representing the time a number of specified years ago

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 124
124:         def years_ago(years)
125:           advance(:years => -years)
126:         end

Returns a new Time representing the time a number of specified years in the future

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 129
129:         def years_since(years)
130:           advance(:years => years)
131:         end

Convenience method which returns a new Time representing the time 1 day ago

[Source]

     # File vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb, line 228
228:         def yesterday
229:           advance(:days => -1)
230:         end

[Validate]