Module: ActiveSupport::CoreExtensions::Time::Calculations
- Included in:
- Time
- Defined in:
- lib/active_support/core_ext/time/calculations.rb
Overview
Enables the use of time calculations within Time itself
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
-
.append_features(base) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#ago(seconds) ⇒ Object
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension Do not use this method in combination with x.months, use months_ago instead!.
-
#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_month ⇒ Object
(also: #at_beginning_of_month)
Returns a new Time representing the start of the month (1st of the month, 0:00).
-
#beginning_of_week ⇒ Object
(also: #monday, #at_beginning_of_week)
Returns a new Time representing the “start” of this week (Monday, 0:00).
-
#beginning_of_year ⇒ Object
(also: #at_beginning_of_year)
Returns a new Time representing the start of the year (1st of january, 0:00).
-
#change(options) ⇒ Object
Returns a new Time where one or more of the elements have been changed according to the
options
parameter. -
#last_month ⇒ Object
Short-hand for months_ago(1).
-
#last_year ⇒ Object
Short-hand for years_ago(1).
-
#months_ago(months) ⇒ Object
Returns a new Time representing the time a number of specified months ago.
- #months_since(months) ⇒ Object
-
#next_month ⇒ Object
Short-hand for months_since(1).
-
#next_week(day = :monday) ⇒ Object
Returns a new Time representing the start of the given day in next week (default is Monday).
-
#next_year ⇒ Object
Short-hand for years_since(1).
-
#seconds_since_midnight ⇒ Object
Seconds since midnight: Time.now.seconds_since_midnight.
-
#since(seconds) ⇒ Object
(also: #in)
Returns a new Time representing the time a number of seconds since the instance time, this is basically a wrapper around the Numeric extension.
-
#tomorrow ⇒ Object
Convenience method which returns a new Time representing the time 1 day since the instance time.
-
#years_ago(years) ⇒ Object
Returns a new Time representing the time a number of specified years ago.
- #years_since(years) ⇒ Object
-
#yesterday ⇒ Object
Convenience method which returns a new Time representing the time 1 day ago.
Class Method Details
.append_features(base) ⇒ Object
:nodoc:
6 7 8 9 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 6 def self.append_features(base) #:nodoc: super base.extend(ClassMethods) end |
Instance Method Details
#ago(seconds) ⇒ Object
Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension Do not use this method in combination with x.months, use months_ago instead!
50 51 52 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 50 def ago(seconds) seconds.until(self) 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)
134 135 136 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 134 def beginning_of_day (self - self.seconds_since_midnight).change(:usec => 0) end |
#beginning_of_month ⇒ Object Also known as: at_beginning_of_month
Returns a new Time representing the start of the month (1st of the month, 0:00)
142 143 144 145 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 142 def beginning_of_month #self - ((self.mday-1).days + self.seconds_since_midnight) change(:mday => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0) end |
#beginning_of_week ⇒ Object Also known as: monday, at_beginning_of_week
Returns a new Time representing the “start” of this week (Monday, 0:00)
120 121 122 123 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 120 def beginning_of_week days_to_monday = self.wday!=0 ? self.wday-1 : 6 (self - days_to_monday.days).midnight end |
#beginning_of_year ⇒ Object Also known as: at_beginning_of_year
Returns a new Time representing the start of the year (1st of january, 0:00)
149 150 151 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 149 def beginning_of_year change(:month => 1,:mday => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0) 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, 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.
35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 35 def change() ::Time.send( self.utc? ? :utc : :local, [:year] || self.year, [:month] || self.month, [:mday] || self.mday, [:hour] || self.hour, [:min] || ([:hour] ? 0 : self.min), [:sec] || (([:hour] || [:min]) ? 0 : self.sec), [:usec] || (([:hour] || [:min] || [:sec]) ? 0 : self.usec) ) end |
#last_month ⇒ Object
Short-hand for months_ago(1)
110 111 112 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 110 def last_month months_ago(1) end |
#last_year ⇒ Object
Short-hand for years_ago(1)
99 100 101 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 99 def last_year years_ago(1) end |
#months_ago(months) ⇒ Object
Returns a new Time representing the time a number of specified months ago
62 63 64 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 62 def months_ago(months) months_since(-months) end |
#months_since(months) ⇒ Object
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 66 def months_since(months) year, month, mday = self.year, self.month, self.mday month += months # in case months is negative while month < 1 month += 12 year -= 1 end # in case months is positive while month > 12 month -= 12 year += 1 end max = ::Time.days_in_month(month, year) mday = max if mday > max change(:year => year, :month => month, :mday => mday) end |
#next_month ⇒ Object
Short-hand for months_since(1)
115 116 117 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 115 def next_month months_since(1) end |
#next_week(day = :monday) ⇒ Object
Returns a new Time representing the start of the given day in next week (default is Monday).
128 129 130 131 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 128 def next_week(day = :monday) days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6} since(1.week).beginning_of_week.since(days_into_week[day].day).change(:hour => 0) end |
#next_year ⇒ Object
Short-hand for years_since(1)
104 105 106 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 104 def next_year years_since(1) end |
#seconds_since_midnight ⇒ Object
Seconds since midnight: Time.now.seconds_since_midnight
28 29 30 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 28 def seconds_since_midnight self.hour.hours + self.min.minutes + self.sec + (self.usec/1.0e+6) end |
#since(seconds) ⇒ Object Also known as: in
Returns a new Time representing the time a number of seconds since the instance time, this is basically a wrapper around the Numeric extension. Do not use this method in combination with x.months, use months_since instead!
56 57 58 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 56 def since(seconds) seconds.since(self) end |
#tomorrow ⇒ Object
Convenience method which returns a new Time representing the time 1 day since the instance time
160 161 162 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 160 def tomorrow self.since(1.day) end |
#years_ago(years) ⇒ Object
Returns a new Time representing the time a number of specified years ago
90 91 92 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 90 def years_ago(years) change(:year => self.year - years) end |
#years_since(years) ⇒ Object
94 95 96 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 94 def years_since(years) change(:year => self.year + years) end |
#yesterday ⇒ Object
Convenience method which returns a new Time representing the time 1 day ago
155 156 157 |
# File 'lib/active_support/core_ext/time/calculations.rb', line 155 def yesterday self.ago(1.day) end |