Merge pull request rails#54303 from joshuay03/add-time-arg-to-freeze-time

Allow passing in a date or time to ActiveSupport::Testing::TimeHelpers#freeze_time

Author: byroot

activesupport/CHANGELOG.md

@@ -1,3 +1,14 @@
+*   Allow the `#freeze_time` testing helper to accept a date or time argument.
+
+    ```ruby
+    Time.current # => Sun, 09 Jul 2024 15:34:49 EST -05:00
+    freeze_time Time.current + 1.day
+    sleep 1
+    Time.current # => Mon, 10 Jul 2024 15:34:49 EST -05:00
+    ```
+
+    *Joshua Young*
+
 *   `ActiveSupport::JSON` now accepts options
 
     It is now possible to pass options to `ActiveSupport::JSON`:

activesupport/lib/active_support/testing/time_helpers.rb

@@ -238,12 +238,16 @@ def travel_back
       end
       alias_method :unfreeze_time, :travel_back
 
-      # Calls +travel_to+ with +Time.now+. Forwards optional <tt>with_usec</tt> argument.
+      # Calls +travel_to+ with +date_or_time+, which defaults to +Time.now+.
+      # Forwards optional <tt>with_usec</tt> argument.
       #
       #   Time.current # => Sun, 09 Jul 2017 15:34:49 EST -05:00
       #   freeze_time
       #   sleep(1)
       #   Time.current # => Sun, 09 Jul 2017 15:34:49 EST -05:00
+      #   freeze_time Time.current + 1.day
+      #   sleep(1)
+      #   Time.current # => Mon, 10 Jul 2017 15:34:49 EST -05:00
       #
       # This method also accepts a block, which will return the current time back to its original
       # state at the end of the block:
@@ -254,8 +258,8 @@ def travel_back
       #     User.create.created_at # => Sun, 09 Jul 2017 15:34:49 EST -05:00
       #   end
       #   Time.current # => Sun, 09 Jul 2017 15:34:50 EST -05:00
-      def freeze_time(with_usec: false, &block)
-        travel_to Time.now, with_usec: with_usec, &block
+      def freeze_time(date_or_time = Time.now, with_usec: false, &block)
+        travel_to date_or_time, with_usec: with_usec, &block
       end
 
       private

activesupport/test/time_travel_test.rb

@@ -487,6 +487,16 @@ def test_time_helper_freeze_time
     travel_back
   end
 
+  def test_time_helper_freeze_time_with_time_arg
+    expected_time = Time.now + 1.day
+    freeze_time expected_time
+    sleep(1)
+
+    assert_equal expected_time.to_fs(:db), Time.now.to_fs(:db)
+  ensure
+    travel_back
+  end
+
   def test_time_helper_freeze_time_with_block
     expected_time = Time.now