activesupport 4.2.0 → 5.2.0

data/lib/active_support/core_ext/date/zones.rb

@@ -1,5 +1,7 @@
-require 'date'
-require 'active_support/core_ext/date_and_time/zones'
+# frozen_string_literal: true
+
+require "date"
+require "active_support/core_ext/date_and_time/zones"
 
 class Date
   include DateAndTime::Zones

data/lib/active_support/core_ext/date_and_time/calculations.rb

@@ -1,23 +1,38 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/try"
+
 module DateAndTime
   module Calculations
     DAYS_INTO_WEEK = {
-      :monday    => 0,
-      :tuesday   => 1,
-      :wednesday => 2,
-      :thursday  => 3,
-      :friday    => 4,
-      :saturday  => 5,
-      :sunday    => 6
+      monday: 0,
+      tuesday: 1,
+      wednesday: 2,
+      thursday: 3,
+      friday: 4,
+      saturday: 5,
+      sunday: 6
     }
+    WEEKEND_DAYS = [ 6, 0 ]
 
     # Returns a new date/time representing yesterday.
     def yesterday
-      advance(:days => -1)
+      advance(days: -1)
+    end
+
+    # Returns a new date/time the specified number of days ago.
+    def prev_day(days = 1)
+      advance(days: -days)
     end
 
     # Returns a new date/time representing tomorrow.
     def tomorrow
-      advance(:days => 1)
+      advance(days: 1)
+    end
+
+    # Returns a new date/time the specified number of days in the future.
+    def next_day(days = 1)
+      advance(days: days)
     end
 
     # Returns true if the date/time is today.
@@ -35,90 +50,147 @@ module DateAndTime
       self > self.class.current
     end
 
+    # Returns true if the date/time falls on a Saturday or Sunday.
+    def on_weekend?
+      WEEKEND_DAYS.include?(wday)
+    end
+
+    # Returns true if the date/time does not fall on a Saturday or Sunday.
+    def on_weekday?
+      !WEEKEND_DAYS.include?(wday)
+    end
+
     # Returns a new date/time the specified number of days ago.
     def days_ago(days)
-      advance(:days => -days)
+      advance(days: -days)
     end
 
     # Returns a new date/time the specified number of days in the future.
     def days_since(days)
-      advance(:days => days)
+      advance(days: days)
     end
 
     # Returns a new date/time the specified number of weeks ago.
     def weeks_ago(weeks)
-      advance(:weeks => -weeks)
+      advance(weeks: -weeks)
     end
 
     # Returns a new date/time the specified number of weeks in the future.
     def weeks_since(weeks)
-      advance(:weeks => weeks)
+      advance(weeks: weeks)
     end
 
     # Returns a new date/time the specified number of months ago.
     def months_ago(months)
-      advance(:months => -months)
+      advance(months: -months)
     end
 
     # Returns a new date/time the specified number of months in the future.
     def months_since(months)
-      advance(:months => months)
+      advance(months: months)
     end
 
     # Returns a new date/time the specified number of years ago.
     def years_ago(years)
-      advance(:years => -years)
+      advance(years: -years)
     end
 
     # Returns a new date/time the specified number of years in the future.
     def years_since(years)
-      advance(:years => years)
+      advance(years: years)
     end
 
     # Returns a new date/time at the start of the month.
-    # DateTime objects will have a time set to 0:00.
+    #
+    #   today = Date.today # => Thu, 18 Jun 2015
+    #   today.beginning_of_month # => Mon, 01 Jun 2015
+    #
+    # +DateTime+ objects will have a time set to 0:00.
+    #
+    #   now = DateTime.current # => Thu, 18 Jun 2015 15:23:13 +0000
+    #   now.beginning_of_month # => Mon, 01 Jun 2015 00:00:00 +0000
     def beginning_of_month
-      first_hour(change(:day => 1))
+      first_hour(change(day: 1))
     end
     alias :at_beginning_of_month :beginning_of_month
 
     # Returns a new date/time at the start of the quarter.
-    # Example: 1st January, 1st July, 1st October.
-    # DateTime objects will have a time set to 0:00.
+    #
+    #   today = Date.today # => Fri, 10 Jul 2015
+    #   today.beginning_of_quarter # => Wed, 01 Jul 2015
+    #
+    # +DateTime+ objects will have a time set to 0:00.
+    #
+    #   now = DateTime.current # => Fri, 10 Jul 2015 18:41:29 +0000
+    #   now.beginning_of_quarter # => Wed, 01 Jul 2015 00:00:00 +0000
     def beginning_of_quarter
       first_quarter_month = [10, 7, 4, 1].detect { |m| m <= month }
-      beginning_of_month.change(:month => first_quarter_month)
+      beginning_of_month.change(month: first_quarter_month)
     end
     alias :at_beginning_of_quarter :beginning_of_quarter
 
     # Returns a new date/time at the end of the quarter.
-    # Example: 31st March, 30th June, 30th September.
-    # DateTime objects will have a time set to 23:59:59.
+    #
+    #   today = Date.today # => Fri, 10 Jul 2015
+    #   today.end_of_quarter # => Wed, 30 Sep 2015
+    #
+    # +DateTime+ objects will have a time set to 23:59:59.
+    #
+    #   now = DateTime.current # => Fri, 10 Jul 2015 18:41:29 +0000
+    #   now.end_of_quarter # => Wed, 30 Sep 2015 23:59:59 +0000
     def end_of_quarter
       last_quarter_month = [3, 6, 9, 12].detect { |m| m >= month }
-      beginning_of_month.change(:month => last_quarter_month).end_of_month
+      beginning_of_month.change(month: last_quarter_month).end_of_month
     end
     alias :at_end_of_quarter :end_of_quarter
 
-    # Return a new date/time at the beginning of the year.
-    # Example: 1st January.
-    # DateTime objects will have a time set to 0:00.
+    # Returns a new date/time at the beginning of the year.
+    #
+    #   today = Date.today # => Fri, 10 Jul 2015
+    #   today.beginning_of_year # => Thu, 01 Jan 2015
+    #
+    # +DateTime+ objects will have a time set to 0:00.
+    #
+    #   now = DateTime.current # => Fri, 10 Jul 2015 18:41:29 +0000
+    #   now.beginning_of_year # => Thu, 01 Jan 2015 00:00:00 +0000
     def beginning_of_year
-      change(:month => 1).beginning_of_month
+      change(month: 1).beginning_of_month
     end
     alias :at_beginning_of_year :beginning_of_year
 
     # Returns a new date/time representing the given day in the next week.
+    #
+    #   today = Date.today # => Thu, 07 May 2015
+    #   today.next_week    # => Mon, 11 May 2015
+    #
     # 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.
-    def next_week(given_day_in_next_week = Date.beginning_of_week)
-      first_hour(weeks_since(1).beginning_of_week.days_since(days_span(given_day_in_next_week)))
+    # when set.
+    #
+    #   today = Date.today       # => Thu, 07 May 2015
+    #   today.next_week(:friday) # => Fri, 15 May 2015
+    #
+    # +DateTime+ objects have their time set to 0:00 unless +same_time+ is true.
+    #
+    #   now = DateTime.current # => Thu, 07 May 2015 13:31:16 +0000
+    #   now.next_week      # => Mon, 11 May 2015 00:00:00 +0000
+    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
+    end
+
+    # Returns a new date/time representing the next weekday.
+    def next_weekday
+      if next_day.on_weekend?
+        next_week(:monday, same_time: true)
+      else
+        next_day
+      end
     end
 
-    # Short-hand for months_since(1).
-    def next_month
-      months_since(1)
+    # Returns a new date/time the specified number of months in the future.
+    def next_month(months = 1)
+      advance(months: months)
     end
 
     # Short-hand for months_since(3)
@@ -126,25 +198,40 @@ module DateAndTime
       months_since(3)
     end
 
-    # Short-hand for years_since(1).
-    def next_year
-      years_since(1)
+    # Returns a new date/time the specified number of years in the future.
+    def next_year(years = 1)
+      advance(years: years)
     end
 
     # Returns a new date/time representing the given day in the previous week.
     # Week is assumed to start on +start_day+, default is
     # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
-    # DateTime objects have their time set to 0:00.
-    def prev_week(start_day = Date.beginning_of_week)
-      first_hour(weeks_ago(1).beginning_of_week.days_since(days_span(start_day)))
+    # DateTime objects have their time set to 0:00 unless +same_time+ is true.
+    def prev_week(start_day = Date.beginning_of_week, same_time: false)
+      result = first_hour(weeks_ago(1).beginning_of_week.days_since(days_span(start_day)))
+      same_time ? copy_time_to(result) : result
     end
     alias_method :last_week, :prev_week
 
+    # Returns a new date/time representing the previous weekday.
+    def prev_weekday
+      if prev_day.on_weekend?
+        copy_time_to(beginning_of_week(:friday))
+      else
+        prev_day
+      end
+    end
+    alias_method :last_weekday, :prev_weekday
+
+    # Returns a new date/time the specified number of months ago.
+    def prev_month(months = 1)
+      advance(months: -months)
+    end
+
     # Short-hand for months_ago(1).
-    def prev_month
+    def last_month
       months_ago(1)
     end
-    alias_method :last_month, :prev_month
 
     # Short-hand for months_ago(3).
     def prev_quarter
@@ -152,11 +239,15 @@ module DateAndTime
     end
     alias_method :last_quarter, :prev_quarter
 
+    # Returns a new date/time the specified number of years ago.
+    def prev_year(years = 1)
+      advance(years: -years)
+    end
+
     # Short-hand for years_ago(1).
-    def prev_year
+    def last_year
       years_ago(1)
     end
-    alias_method :last_year, :prev_year
 
     # Returns the number of days to the start of the week on the given day.
     # Week is assumed to start on +start_day+, default is
@@ -209,12 +300,17 @@ module DateAndTime
     # Returns a new date/time representing the end of the year.
     # DateTime objects will have a time set to 23:59:59.
     def end_of_year
-      change(:month => 12).end_of_month
+      change(month: 12).end_of_month
     end
     alias :at_end_of_year :end_of_year
 
+    # Returns a Range representing the whole day of the current date/time.
+    def all_day
+      beginning_of_day..end_of_day
+    end
+
     # Returns a Range representing the whole week of the current date/time.
-    # Week starts on start_day, default is <tt>Date.week_start</tt> or <tt>config.week_start</tt> when set.
+    # Week starts on start_day, default is <tt>Date.beginning_of_week</tt> or <tt>config.beginning_of_week</tt> when set.
     def all_week(start_day = Date.beginning_of_week)
       beginning_of_week(start_day)..end_of_week(start_day)
     end
@@ -234,18 +330,45 @@ module DateAndTime
       beginning_of_year..end_of_year
     end
 
-    private
-
-    def first_hour(date_or_time)
-      date_or_time.acts_like?(:time) ? date_or_time.beginning_of_day : date_or_time
+    # Returns a new date/time representing the next occurrence of the specified day of week.
+    #
+    #   today = Date.today               # => Thu, 14 Dec 2017
+    #   today.next_occurring(:monday)    # => Mon, 18 Dec 2017
+    #   today.next_occurring(:thursday)  # => Thu, 21 Dec 2017
+    def next_occurring(day_of_week)
+      current_day_number = wday != 0 ? wday - 1 : 6
+      from_now = DAYS_INTO_WEEK.fetch(day_of_week) - current_day_number
+      from_now += 7 unless from_now > 0
+      advance(days: from_now)
     end
 
-    def last_hour(date_or_time)
-      date_or_time.acts_like?(:time) ? date_or_time.end_of_day : date_or_time
+    # Returns a new date/time representing the previous occurrence of the specified day of week.
+    #
+    #   today = Date.today               # => Thu, 14 Dec 2017
+    #   today.prev_occurring(:monday)    # => Mon, 11 Dec 2017
+    #   today.prev_occurring(:thursday)  # => Thu, 07 Dec 2017
+    def prev_occurring(day_of_week)
+      current_day_number = wday != 0 ? wday - 1 : 6
+      ago = current_day_number - DAYS_INTO_WEEK.fetch(day_of_week)
+      ago += 7 unless ago > 0
+      advance(days: -ago)
     end
 
-    def days_span(day)
-      (DAYS_INTO_WEEK[day] - DAYS_INTO_WEEK[Date.beginning_of_week]) % 7
-    end
+    private
+      def first_hour(date_or_time)
+        date_or_time.acts_like?(:time) ? date_or_time.beginning_of_day : date_or_time
+      end
+
+      def last_hour(date_or_time)
+        date_or_time.acts_like?(:time) ? date_or_time.end_of_day : date_or_time
+      end
+
+      def days_span(day)
+        (DAYS_INTO_WEEK[day] - DAYS_INTO_WEEK[Date.beginning_of_week]) % 7
+      end
+
+      def copy_time_to(other)
+        other.change(hour: hour, min: min, sec: sec, nsec: try(:nsec))
+      end
   end
 end

data/lib/active_support/core_ext/date_and_time/compatibility.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/attribute_accessors"
+
+module DateAndTime
+  module Compatibility
+    # If true, +to_time+ preserves the timezone offset of receiver.
+    #
+    # NOTE: With Ruby 2.4+ the default for +to_time+ changed from
+    # converting to the local system time, to preserving the offset
+    # of the receiver. For backwards compatibility we're overriding
+    # this behavior, but new apps will have an initializer that sets
+    # this to true, because the new behavior is preferred.
+    mattr_accessor :preserve_timezone, instance_writer: false, default: false
+  end
+end

data/lib/active_support/core_ext/date_and_time/zones.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module DateAndTime
   module Zones
     # Returns the simultaneous time in <tt>Time.zone</tt> if a zone is given or
     # if Time.zone_default is set. Otherwise, it returns the current time.
     #
     #   Time.zone = 'Hawaii'        # => 'Hawaii'
-    #   DateTime.utc(2000).in_time_zone # => Fri, 31 Dec 1999 14:00:00 HST -10:00
-    #   Date.new(2000).in_time_zone  # => Sat, 01 Jan 2000 00:00:00 HST -10:00
+    #   Time.utc(2000).in_time_zone # => Fri, 31 Dec 1999 14:00:00 HST -10:00
+    #   Date.new(2000).in_time_zone # => Sat, 01 Jan 2000 00:00:00 HST -10:00
     #
     # This method is similar to Time#localtime, except that it uses <tt>Time.zone</tt> as the local zone
     # instead of the operating system's time zone.
@@ -14,8 +16,7 @@ module DateAndTime
     # and the conversion will be based on that zone instead of <tt>Time.zone</tt>.
     #
     #   Time.utc(2000).in_time_zone('Alaska') # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
-    #   DateTime.utc(2000).in_time_zone('Alaska') # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
-    #   Date.new(2000).in_time_zone('Alaska')  # => Sat, 01 Jan 2000 00:00:00 AKST -09:00
+    #   Date.new(2000).in_time_zone('Alaska') # => Sat, 01 Jan 2000 00:00:00 AKST -09:00
     def in_time_zone(zone = ::Time.zone)
       time_zone = ::Time.find_zone! zone
       time = acts_like?(:time) ? self : nil
@@ -23,19 +24,18 @@ module DateAndTime
       if time_zone
         time_with_zone(time, time_zone)
       else
-        time || self.to_time
+        time || to_time
       end
     end
 
     private
 
-    def time_with_zone(time, zone)
-      if time
-        ActiveSupport::TimeWithZone.new(time.utc? ? time : time.getutc, zone)
-      else
-        ActiveSupport::TimeWithZone.new(nil, zone, to_time(:utc))
+      def time_with_zone(time, zone)
+        if time
+          ActiveSupport::TimeWithZone.new(time.utc? ? time : time.getutc, zone)
+        else
+          ActiveSupport::TimeWithZone.new(nil, zone, to_time(:utc))
+        end
       end
-    end
   end
 end
-

data/lib/active_support/core_ext/date_time.rb

@@ -1,4 +1,7 @@
-require 'active_support/core_ext/date_time/acts_like'
-require 'active_support/core_ext/date_time/calculations'
-require 'active_support/core_ext/date_time/conversions'
-require 'active_support/core_ext/date_time/zones'
+# frozen_string_literal: true
+
+require "active_support/core_ext/date_time/acts_like"
+require "active_support/core_ext/date_time/blank"
+require "active_support/core_ext/date_time/calculations"
+require "active_support/core_ext/date_time/compatibility"
+require "active_support/core_ext/date_time/conversions"