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

Instance Method Summary collapse

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

#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: :months, :days, :years.



50
51
52
53
54
55
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 50

def advance(options)
  d = ::Date.new(year + (options.delete(:years) || 0), month, day)
  d = d >> options.delete(:months) if options[:months]
  d = d +  options.delete(:days)   if options[:days]
  change(options.merge(:year => d.year, :month => d.month, :mday => d.day))
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 Do not use this method in combination with x.months, use months_ago instead!



59
60
61
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 59

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)



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

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)



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

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_quarter ⇒ Object Also known as: at_beginning_of_quarter

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



166
167
168
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 166

def beginning_of_quarter
  beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
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)



129
130
131
132
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 129

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)



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

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(options)
  ::Time.send(
    self.utc? ? :utc : :local, 
    options[:year]  || self.year, 
    options[:month] || self.month, 
    options[:mday]  || self.mday, 
    options[:hour]  || self.hour, 
    options[:min]   || (options[:hour] ? 0 : self.min),
    options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
    options[:usec]  || ((options[:hour] || options[:min] || options[:sec]) ? 0 : self.usec)
  )
end

#end_of_month ⇒ Object Also known as: at_end_of_month

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



158
159
160
161
162
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 158

def end_of_month
  #self - ((self.mday-1).days + self.seconds_since_midnight)
  last_day = ::Time.days_in_month( self.month, self.year )
  change(:mday => last_day,:hour => 0, :min => 0, :sec => 0, :usec => 0)
end

#last_month ⇒ Object

Short-hand for months_ago(1)



119
120
121
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 119

def last_month
  months_ago(1)
end

#last_year ⇒ Object

Short-hand for years_ago(1)



108
109
110
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 108

def last_year
  years_ago(1)
end

#months_ago(months) ⇒ Object

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



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

def months_ago(months)
  months_since(-months)
end

#months_since(months) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 75

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)



124
125
126
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 124

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



137
138
139
140
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 137

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)



113
114
115
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 113

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!



65
66
67
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 65

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



183
184
185
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 183

def tomorrow
  self.since(1.day)
end

#years_ago(years) ⇒ Object

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



99
100
101
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 99

def years_ago(years)
  change(:year => self.year - years)
end

#years_since(years) ⇒ Object 



103
104
105
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 103

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



178
179
180
 
# File 'lib/active_support/core_ext/time/calculations.rb', line 178

def yesterday
  self.ago(1.day)
end