Class: Timecop::Rspec::ExampleDecorator

Inherits:

SimpleDelegator

show all

Overview

Decorates an RSpec example to interpret timecop metadata.

Recognized metadata keys:

:freeze => Time/Date/DateTime/String/Proc to freeze time to
:travel => Time/Date/DateTime/String/Proc to travel to (and optionally continue)
:skip_global_timecop => when present, disables global time for this example

#global_timecop? ⇒ Boolean

Whether a global time is configured and not skipped by the example.
#local_timecop? ⇒ Boolean

Whether the example has local timecop metadata.
#skip_global_timecop? ⇒ Boolean

Whether the example requested skipping global timecop behavior.
#timecop? ⇒ Boolean

Whether any timecop behavior applies to the example.
#timecop_method ⇒ Symbol^?

Determines the timecop method to invoke.
#timecop_time ⇒ Object^?

Determines the time to use for the chosen timecop method.

Whether a global time is configured and not skipped by the example.



38
39
40

# File 'lib/timecop/rspec/example_decorator.rb', line 38

def global_timecop?
  Rspec.global_time_configured? && !skip_global_timecop?
end

Whether the example has local timecop metadata.



32
33
34

# File 'lib/timecop/rspec/example_decorator.rb', line 32

def local_timecop?
  !local_timecop_method.nil?
end

Whether the example requested skipping global timecop behavior.



44
45
46

# File 'lib/timecop/rspec/example_decorator.rb', line 44

def skip_global_timecop?
  metadata.key?(:skip_global_timecop)
end



14
15
16

# File 'lib/timecop/rspec/example_decorator.rb', line 14

def timecop?
  local_timecop? || global_timecop?
end

Determines the timecop method to invoke.



20
21
22

# File 'lib/timecop/rspec/example_decorator.rb', line 20

def timecop_method
  local_timecop_method || global_timecop_method
end

Determines the time to use for the chosen timecop method.



26
27
28

# File 'lib/timecop/rspec/example_decorator.rb', line 26

def timecop_time
  local_timecop_time || global_timecop_time
end