instance method `travel`

Ruby on Rails 4.1.16

Since v4.1.16

Available in: v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

travel(duration, &block)

Changes current time to the time in the future or in the past by a given time difference by stubbing Time.now and Date.today.

Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel 1.day
Time.current # => Sun, 10 Nov 2013 15:34:49 EST -05:00
Date.current # => Sun, 10 Nov 2013

This method also accepts a block, which will return the current time back to its original state at the end of the block:

Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel 1.day do
  User.create.created_at # => Sun, 10 Nov 2013 15:34:49 EST -05:00
end
Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00

Parameters

duration req
block block

Source

# File activesupport/lib/active_support/testing/time_helpers.rb, line 60
      def travel(duration, &block)
        travel_to Time.now + duration, &block
      end

Defined in activesupport/lib/active_support/testing/time_helpers.rb line 60 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::Testing::TimeHelpers

Signature

Parameters