Module: Tins::TimeFreezer

Defined in:

lib/tins/xt/time_freezer.rb

Overview

TimeFreezer provides a mechanism to temporarily freeze time across multiple time-related classes.

This module allows you to temporarily replace the behavior of Time, DateTime, and Date classes with dummy implementations that always return a specific time value. This is particularly useful for testing code that depends on current time values.

Examples:

Basic usage

Tins::TimeFreezer.freeze(Time.new(2023, 1, 1)) do
  # All Time, DateTime, and Date calls will return the frozen time
  puts Time.now  # => 2023-01-01 00:00:00 +0000
end

With DateTime and Date

Tins::TimeFreezer.freeze(Time.new(2023, 1, 1)) do
  puts DateTime.now  # => 2023-01-01T00:00:00+00:00
  puts Date.today    # => 2023-01-01
end

Using time string (will be parsed by Time.parse)

Tins::TimeFreezer.freeze("2023-01-01 12:00:00") do
  # Time.now will return the parsed time
  puts Time.now  # => 2023-01-01 12:00:00 +0000
end

Class Method Summary

• .freeze(time) { ... } ⇒ Object

  Freezes time for the duration of the given block.

Class Method Details

.freeze(time) { ... } ⇒ Object

Freezes time for the duration of the given block.

This method temporarily replaces the behavior of Time, DateTime, and Date classes with dummy implementations that always return the specified time value.

time-related classes to

Parameters:

• time (Time, DateTime, Date) —

  The time value to freeze all

Yields:

• The block of code to execute with frozen time

Returns:

• (Object) —

  The return value of the yielded block

# File 'lib/tins/xt/time_freezer.rb', line 42

def self.freeze(time)
  Time.dummy(time) do
    DateTime.dummy(time) do
      Date.dummy(time) do
        yield
      end
    end
  end
end