sorbet/rbi/gems/timecop@0.9.5.rbi
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `timecop` gem.
# Please instead update this file by running `bin/tapioca gem timecop`.
# Timecop
# * Wrapper class for manipulating the extensions to the Time, Date, and DateTime objects
# * Allows us to "freeze" time in our Ruby applications.
# * Optionally allows time travel to simulate a running clock, such time is not technically frozen.
#
# This is very useful when your app's functionality is dependent on time (e.g.
# anything that might expire). This will allow us to alter the return value of
# Date.today, Time.now, and DateTime.now, such that our application code _never_ has to change.
#
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:1
class Timecop
include ::Singleton
extend ::Singleton::SingletonClassMethods
# @return [Timecop] a new instance of Timecop
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:174
def initialize; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:141
def baseline; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:136
def baseline=(b); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:209
def return(&block); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:224
def return_to_baseline; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:149
def set_baseline(b); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:166
def set_stack(s); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:157
def stack; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:185
def thread_safe; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:180
def thread_safe=(t); end
# @raise [SafeModeException]
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:189
def travel(mock_type, *args, &block); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:219
def unmock!; end
class << self
# source://timecop-0.9.5/lib/timecop/timecop.rb:78
def baseline; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:82
def baseline=(baseline); end
# Allows you to run a block of code and "fake" a time throughout the execution of that block.
# This is particularly useful for writing test methods where the passage of time is critical to the business
# logic being tested. For example:
#
# joe = User.find(1)
# joe.purchase_home()
# assert !joe.mortgage_due?
# Timecop.freeze(2008, 10, 5) do
# assert joe.mortgage_due?
# end
#
# freeze and travel will respond to several different arguments:
# 1. Timecop.freeze(time_inst)
# 2. Timecop.freeze(datetime_inst)
# 3. Timecop.freeze(date_inst)
# 4. Timecop.freeze(offset_in_seconds)
# 5. Timecop.freeze(year, month, day, hour=0, minute=0, second=0)
# 6. Timecop.freeze() # Defaults to Time.now
#
# When a block is also passed, Time.now, DateTime.now and Date.today are all reset to their
# previous values after the block has finished executing. This allows us to nest multiple
# calls to Timecop.travel and have each block maintain it's concept of "now."
#
# * Note: Timecop.freeze will actually freeze time. This can cause unanticipated problems if
# benchmark or other timing calls are executed, which implicitly expect Time to actually move
# forward.
#
# * Rails Users: Be especially careful when setting this in your development environment in a
# rails project. Generators will load your environment, including the migration generator,
# which will lead to files being generated with the timestamp set by the Timecop.freeze call
# in your dev environment
#
# Returns the value of the block if one is given, or the mocked time.
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:51
def freeze(*args, &block); end
# Returns whether or not Timecop is currently frozen/travelled
#
# @return [Boolean]
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:125
def frozen?; end
# Reverts back to system's Time.now, Date.today and DateTime.now (if it exists) permamently when
# no block argument is given, or temporarily reverts back to the system's time temporarily for
# the given block.
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:89
def return(&block); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:99
def return_to_baseline; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:108
def safe_mode=(safe); end
# @return [Boolean]
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:112
def safe_mode?; end
# Allows you to run a block of code and "scale" a time throughout the execution of that block.
# The first argument is a scaling factor, for example:
# Timecop.scale(2) do
# ... time will 'go' twice as fast here
# end
# See Timecop#freeze for exact usage of the other arguments
#
# Returns the value of the block if one is given, or the mocked time.
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:74
def scale(*args, &block); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:120
def thread_safe; end
# source://timecop-0.9.5/lib/timecop/timecop.rb:116
def thread_safe=(t); end
# source://timecop-0.9.5/lib/timecop/timecop.rb:104
def top_stack_item; end
# Allows you to run a block of code and "fake" a time throughout the execution of that block.
# See Timecop#freeze for a sample of how to use (same exact usage syntax)
#
# * Note: Timecop.travel will not freeze time (as opposed to Timecop.freeze). This is a particularly
# good candidate for use in environment files in rails projects.
#
# Returns the value of the block if one is given, or the mocked time.
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:62
def travel(*args, &block); end
# Reverts back to system's Time.now, Date.today and DateTime.now (if it exists) permamently when
# no block argument is given, or temporarily reverts back to the system's time temporarily for
# the given block.
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:89
def unfreeze(&block); end
private
# source://timecop-0.9.5/lib/timecop/timecop.rb:130
def send_travel(mock_type, *args, &block); end
end
end
# source://timecop-0.9.5/lib/timecop/timecop.rb:232
class Timecop::SafeModeException < ::StandardError
# @return [SafeModeException] a new instance of SafeModeException
#
# source://timecop-0.9.5/lib/timecop/timecop.rb:233
def initialize; end
end
# A data class for carrying around "time movement" objects. Makes it easy to keep track of the time
# movements on a simple stack.
#
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:4
class Timecop::TimeStackItem
# @return [TimeStackItem] a new instance of TimeStackItem
#
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:7
def initialize(mock_type, *args); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:77
def date(date_klass = T.unsafe(nil)); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:81
def datetime(datetime_klass = T.unsafe(nil)); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:25
def day; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:29
def hour; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:33
def min; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:5
def mock_type; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:21
def month; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:73
def scaled_time; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:53
def scaling_factor; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:37
def sec; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:57
def time(time_klass = T.unsafe(nil)); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:45
def travel_offset; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:49
def travel_offset_days; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:41
def utc_offset; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:17
def year; end
private
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:128
def compute_travel_offset; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:100
def parse_time(*args); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:92
def rational_to_utc_offset(rational); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:136
def time_klass; end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:132
def times_are_equal_within_epsilon(t1, t2, epsilon_in_seconds); end
# source://timecop-0.9.5/lib/timecop/time_stack_item.rb:96
def utc_offset_to_rational(utc_offset); end
end
# source://timecop-0.9.5/lib/timecop/version.rb:2
Timecop::VERSION = T.let(T.unsafe(nil), String)