aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport
diff options
context:
space:
mode:
authorJay Hayes <jay@bignerdranch.com>2015-05-06 11:16:36 -0500
committerJay Hayes <ur@iamvery.com>2015-05-07 08:47:25 -0500
commitc1025bdff02a200d07ece5539829ea1591d2f4b4 (patch)
tree8747d0af5fb9e996050afd285365baef9ff2f933 /activesupport
parent2164646eb4abac76712520f3a0afb9a4438727c2 (diff)
downloadrails-c1025bdff02a200d07ece5539829ea1591d2f4b4.tar.gz
rails-c1025bdff02a200d07ece5539829ea1591d2f4b4.tar.bz2
rails-c1025bdff02a200d07ece5539829ea1591d2f4b4.zip
Add examples of Date and Time `next_week` usage
[skip ci]
Diffstat (limited to 'activesupport')
-rw-r--r--activesupport/lib/active_support/core_ext/date_and_time/calculations.rb7
1 files changed, 7 insertions, 0 deletions
diff --git a/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb b/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
index 9525c10112..40a252f776 100644
--- a/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
+++ b/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
@@ -128,6 +128,13 @@ module DateAndTime
# The +given_day_in_next_week+ defaults to the beginning of the week
# which is determined by +Date.beginning_of_week+ or +config.beginning_of_week+
# when set. +DateTime+ objects have their time set to 0:00 unless +same_time+ is true.
+ #
+ # ==== Examples
+ # today = Date.today # => Thu, 07 May 2015
+ # today.next_week # => Mon, 11 May 2015
+ #
+ # now = Time.current # => Thu, 07 May 2015 13:31:16 UTC +00:00
+ # now.next_week(:friday) # => Fri, 15 May 2015 00:00:00 UTC +00:00
def next_week(given_day_in_next_week = Date.beginning_of_week, same_time: false)
result = first_hour(weeks_since(1).beginning_of_week.days_since(days_span(given_day_in_next_week)))
same_time ? copy_time_to(result) : result