Module | ActiveSupport::CoreExtensions::Date::Calculations |
In: |
vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb
|
Enables the use of time calculations within Date itself
Provides precise Date calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days.
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 94 94: def advance(options) 95: options = options.dup 96: d = self 97: d = d >> options.delete(:years) * 12 if options[:years] 98: d = d >> options.delete(:months) if options[:months] 99: d = d + options.delete(:weeks) * 7 if options[:weeks] 100: d = d + options.delete(:days) if options[:days] 101: d 102: end
Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then subtracts the specified number of seconds
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 52 52: def ago(seconds) 53: to_time.since(-seconds) 54: end
Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 64 64: def beginning_of_day 65: to_time 66: end
Returns a new ; DateTime objects will have time set to 0:00DateTime representing the start of the month (1st of the month; DateTime objects will have time set to 0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 183 183: def beginning_of_month 184: self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1) 185: end
Returns a new Date/DateTime representing the start of the quarter (1st of january, april, july, october; DateTime objects will have time set to 0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 196 196: def beginning_of_quarter 197: beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month }) 198: end
Returns a new Date/DateTime representing the "start" of this week (i.e, Monday; DateTime objects will have time set to 0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 159 159: def beginning_of_week 160: days_to_monday = self.wday!=0 ? self.wday-1 : 6 161: result = self - days_to_monday 162: self.acts_like?(:time) ? result.midnight : result 163: end
Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 208 208: def beginning_of_year 209: self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0) : change(:month => 1, :day => 1) 210: end
Returns a new Date where one or more of the elements have been changed according to the options parameter.
Examples:
Date.new(2007, 5, 12).change(:day => 1) # => Date.new(2007, 5, 1) Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 110 110: def change(options) 111: ::Date.new( 112: options[:year] || self.year, 113: options[:month] || self.month, 114: options[:day] || self.day 115: ) 116: end
Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 72 72: def end_of_day 73: to_time.end_of_day 74: end
Returns a new Date/DateTime representing the end of the month (last day of the month; DateTime objects will have time set to 0:00)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 189 189: def end_of_month 190: last_day = ::Time.days_in_month( self.month, self.year ) 191: self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day) 192: end
Returns a new Date/DateTime representing the end of the quarter (last day of march, june, september, december; DateTime objects will have time set to 23:59:59)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 202 202: def end_of_quarter 203: beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month 204: end
Returns a new Date/DateTime representing the end of this week (Sunday, DateTime objects will have time set to 23:59:59)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 168 168: def end_of_week 169: days_to_sunday = self.wday!=0 ? 7-self.wday : 0 170: result = self + days_to_sunday.days 171: self.acts_like?(:time) ? result.end_of_day : result 172: end
Returns a new Time representing the end of the year (31st of december; DateTime objects will have time set to 23:59:59)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 214 214: def end_of_year 215: self.acts_like?(:time) ? change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59) : change(:month => 12, :day => 31) 216: end
Short-hand for months_ago(1)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 149 149: def last_month 150: months_ago(1) 151: end
Short-hand for months_since(1)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 154 154: def next_month 155: months_since(1) 156: end
Returns a new Date/DateTime representing the start of the given day in next week (default is Monday).
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 176 176: def next_week(day = :monday) 177: days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6} 178: result = (self + 7).beginning_of_week + days_into_week[day] 179: self.acts_like?(:time) ? result.change(:hour => 0) : result 180: end
Short-hand for years_since(1)
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 144 144: def next_year 145: years_since(1) 146: end
Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then adds the specified number of seconds
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 58 58: def since(seconds) 59: to_time.since(seconds) 60: end
Tells whether the Date object‘s date is today
# File vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb, line 41 41: def today? 42: self.to_date == ::Date.current # we need the to_date because of DateTime 43: end