timecop 0.8.0 → 0.9.8

data/lib/timecop/timecop.rb

@@ -1,5 +1,4 @@
 require 'singleton'
-require File.join(File.dirname(__FILE__), "time_extensions")
 require File.join(File.dirname(__FILE__), "time_stack_item")
 
 # Timecop
@@ -14,6 +13,8 @@ class Timecop
   include Singleton
 
   class << self
+    private :instance
+
     # 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:
@@ -75,11 +76,11 @@ class Timecop
     end
 
     def baseline
-      instance.send(:baseline)
+      instance.baseline
     end
 
     def baseline=(baseline)
-      instance.send(:baseline=, baseline)
+      instance.baseline = baseline
     end
 
     # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists) permamently when
@@ -87,20 +88,21 @@ class Timecop
     # the given block.
     def return(&block)
       if block_given?
-        instance.send(:return, &block)
+        instance.return(&block)
       else
-        instance.send(:unmock!)
+        instance.unmock!
         nil
       end
     end
+    alias :unfreeze :return
 
     def return_to_baseline
-      instance.send(:return_to_baseline)
+      instance.return_to_baseline
       Time.now
     end
 
     def top_stack_item #:nodoc:
-      instance.instance_variable_get(:@_stack).last
+      instance.stack.last
     end
 
     def safe_mode=(safe)
@@ -111,64 +113,117 @@ class Timecop
       @safe_mode ||= false
     end
 
-    # Returns whether or not Timecop is currently frozen/travelled
+    def thread_safe=(t)
+      instance.thread_safe = t
+    end
+
+    def thread_safe
+      instance.thread_safe
+    end
+
+    # Returns whether or not Timecop is currently frozen
     def frozen?
-      !instance.instance_variable_get(:@_stack).empty?
+      !instance.stack.empty? && instance.stack.last.mock_type == :freeze
     end
 
     private
     def send_travel(mock_type, *args, &block)
-      val = instance.send(:travel, mock_type, *args, &block)
+      val = instance.travel(mock_type, *args, &block)
       block_given? ? val : Time.now
     end
   end
 
-  private
+  def baseline=(b)
+    set_baseline(b)
+    stack << TimeStackItem.new(:travel, b)
+  end
+
+  def baseline
+    if @thread_safe
+      Thread.current[:timecop_baseline]
+    else
+      @baseline
+    end
+  end
 
-  def baseline=(baseline)
-    @baseline = baseline
-    @_stack << TimeStackItem.new(:travel, baseline)
+  def set_baseline(b)
+    if @thread_safe
+      Thread.current[:timecop_baseline] = b
+    else
+      @baseline = b
+    end
+  end
+
+  def stack
+    if @thread_safe
+      Thread.current[:timecop_stack] ||= []
+      Thread.current[:timecop_stack]
+    else
+      @stack
+    end
+  end
+
+  def set_stack(s)
+    if @thread_safe
+      Thread.current[:timecop_stack] = s
+    else
+      @stack = s
+    end
   end
 
   def initialize #:nodoc:
-    @_stack = []
+    @stack = []
+    @safe = nil
+    @thread_safe = false
+  end
+
+  def thread_safe=(t)
+    initialize
+    @thread_safe = t
+  end
+
+  def thread_safe
+    @thread_safe
   end
 
   def travel(mock_type, *args, &block) #:nodoc:
-    raise SafeModeException if Timecop.safe_mode? && !block_given?
+    raise SafeModeException if Timecop.safe_mode? && !block_given? && !@safe
 
     stack_item = TimeStackItem.new(mock_type, *args)
 
-    stack_backup = @_stack.dup
-    @_stack << stack_item
+    stack_backup = stack.dup
+    stack << stack_item
 
     if block_given?
+      safe_backup = @safe
+      @safe = true
       begin
         yield stack_item.time
       ensure
-        @_stack.replace stack_backup
+        stack.replace stack_backup
+        @safe = safe_backup
       end
     end
   end
 
   def return(&block)
-    current_stack = @_stack
-    current_baseline = @baseline
+    current_stack = stack
+    current_baseline = baseline
     unmock!
     yield
   ensure
-    @_stack = current_stack
-    @baseline = current_baseline
+    set_stack current_stack
+    set_baseline current_baseline
   end
 
   def unmock! #:nodoc:
-    @baseline = nil
-    @_stack = []
+    set_baseline nil
+    set_stack []
   end
 
   def return_to_baseline
-    if @baseline
-      @_stack = [@_stack.shift]
+    if baseline
+      set_stack [stack.shift]
     else
       unmock!
     end
@@ -180,3 +235,6 @@ class Timecop
     end
   end
 end
+
+# This must be done after TimeCop is available
+require File.join(File.dirname(__FILE__), "time_extensions")

data/lib/timecop/version.rb

@@ -1,3 +1,3 @@
 class Timecop
-  VERSION = "0.8.0"
+  VERSION = "0.9.8"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: timecop
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.8
 platform: ruby
 authors:
 - Travis Jeffery
 - John Trupiano
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies: []
 description: A gem providing "time travel" and "time freezing" capabilities, making
   it dead simple to test time-dependent code.  It provides a unified method to mock
@@ -27,44 +27,32 @@ files:
 - lib/timecop.rb
 - lib/timecop/time_extensions.rb
 - lib/timecop/time_stack_item.rb
-- lib/timecop/version.rb
 - lib/timecop/timecop.rb
-- test/run_tests.sh
-- test/test_helper.rb
-- test/time_stack_item_test.rb
-- test/timecop_test.rb
-- test/timecop_without_date_test.rb
-- test/timecop_without_date_but_with_time_test.rb
+- lib/timecop/version.rb
 homepage: https://github.com/travisjeffery/timecop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: timecop
-rubygems_version: 2.0.14
-signing_key: 
-specification_version: 3
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
 summary: A gem providing "time travel" and "time freezing" capabilities, making it
   dead simple to test time-dependent code.  It provides a unified method to mock Time.now,
   Date.today, and DateTime.now in a single call.
-test_files:
-- test/test_helper.rb
-- test/time_stack_item_test.rb
-- test/timecop_test.rb
-- test/timecop_without_date_test.rb
-- test/timecop_without_date_but_with_time_test.rb
+test_files: []

data/test/run_tests.sh

@@ -1,10 +0,0 @@
-#!/bin/sh
-
-FAILEDCASES=0
-for f in *_test.rb; do
-  if ! ${RUBY:-ruby} -I../lib:. $f; then
-      FAILEDCASES=`expr "$FAILEDCASES" + 1`
-  fi
-done
-echo "$FAILEDCASES test cases had failures"
-exit $FAILEDCASES

data/test/test_helper.rb

@@ -1,58 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'minitest/autorun'
-
-$VERBOSE = true # enable ruby warnings
-
-begin
-  require 'mocha/setup'
-rescue LoadError
-  require 'mocha'
-end
-
-class Minitest::Unit::TestCase
-  private
-    # Tests to see that two times are within the given distance,
-    # in seconds, from each other.
-    def times_effectively_equal(time1, time2, seconds_interval = 1)
-      (time1 - time2).abs <= seconds_interval
-    end
-
-    def assert_times_effectively_equal(time1, time2, seconds_interval = 1, msg = nil)
-      assert times_effectively_equal(time1, time2, seconds_interval), "#{msg}: time1 = #{time1.to_s}, time2 = #{time2.to_s}"
-    end
-
-    def assert_times_effectively_not_equal(time1, time2, seconds_interval = 1, msg = nil)
-      assert !times_effectively_equal(time1, time2, seconds_interval), "#{msg}: time1 = #{time1.to_s}, time2 = #{time2.to_s}"
-    end
-
-    # Gets the local offset (supplied by ENV['TZ'] or your computer's clock)
-    # At the given timestamp, or Time.now if not time is given.
-    def local_offset(time = Time.now)
-      Time.at(time.to_i).to_datetime.offset
-    end
-
-    TIMEZONES = ["Europe/Paris", "UTC", "America/Chicago"]
-
-    def each_timezone
-      old_tz = ENV["TZ"]
-
-      begin
-        TIMEZONES.each do |timezone|
-          ENV["TZ"] = timezone
-          yield
-        end
-      ensure
-        ENV["TZ"] = old_tz
-      end
-    end
-
-    def a_time_stack_item
-      Timecop::TimeStackItem.new(:freeze, 2008, 1, 1, 0, 0, 0)
-    end
-
-    def assert_date_times_equal(dt1, dt2)
-      assert_in_delta dt1.to_time.to_f, dt2.to_time.to_f, 0.01, "Failed for timezone: #{ENV['TZ']}: #{dt1.to_s} not equal to #{dt2.to_s}"
-    end
-
-end

data/test/time_stack_item_test.rb

@@ -1,277 +0,0 @@
-require 'date'
-require File.join(File.dirname(__FILE__), "test_helper")
-require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
-
-require 'active_support/all'
-
-class TestTimeStackItem < Minitest::Unit::TestCase
-  def teardown
-    Timecop.return
-    Time.zone = nil
-  end
-
-  def test_new_with_time
-    t = Time.now
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    stack_item = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_equal y,   stack_item.year
-    assert_equal m,   stack_item.month
-    assert_equal d,   stack_item.day
-    assert_equal h,   stack_item.hour
-    assert_equal min, stack_item.min
-    assert_equal s,   stack_item.sec
-  end
-
-  def test_new_with_time_and_arguments
-    t = Time.new(2012, 7, 28, 20, 0)
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    stack_item = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_equal y,   stack_item.year
-    assert_equal m,   stack_item.month
-    assert_equal d,   stack_item.day
-    assert_equal h,   stack_item.hour
-    assert_equal min, stack_item.min
-    assert_equal s,   stack_item.sec
-  end
-
-  def test_new_with_datetime_now
-    t = DateTime.now
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    stack_item = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_equal y,   stack_item.year
-    assert_equal m,   stack_item.month
-    assert_equal d,   stack_item.day
-    assert_equal h,   stack_item.hour
-    assert_equal min, stack_item.min
-    assert_equal s,   stack_item.sec
-  end
-
-  def test_new_with_datetime_in_different_timezone
-    each_timezone do
-      t = DateTime.parse("2009-10-11 00:38:00 +0200")
-      stack_item = Timecop::TimeStackItem.new(:freeze, t)
-
-      assert_date_times_equal(t, stack_item.datetime)
-    end
-  end
-
-  def test_new_with_date
-    date = Date.today
-    y, m, d, h, min, s = date.year, date.month, date.day, 0, 0, 0
-    stack_item = Timecop::TimeStackItem.new(:freeze, date)
-
-    assert_equal y,   stack_item.year
-    assert_equal m,   stack_item.month
-    assert_equal d,   stack_item.day
-    assert_equal h,   stack_item.hour
-    assert_equal min, stack_item.min
-    assert_equal s,   stack_item.sec
-  end
-
-  # Due to the nature of this test (calling Time.now once in this test and
-  # once in #new), this test may fail when two subsequent calls
-  # to Time.now return a different second.
-  def test_new_with_integer
-    t = Time.now
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    stack_item = Timecop::TimeStackItem.new(:freeze, 0)
-
-    assert_equal y,   stack_item.year
-    assert_equal m,   stack_item.month
-    assert_equal d,   stack_item.day
-    assert_equal h,   stack_item.hour
-    assert_equal min, stack_item.min
-    assert_equal s,   stack_item.sec
-  end
-
-  def test_new_with_individual_arguments
-    y, m, d, h, min, s = 2008, 10, 10, 10, 10, 10
-    stack_item = Timecop::TimeStackItem.new(:freeze, y, m, d, h, min, s)
-
-    assert_equal y,   stack_item.year
-    assert_equal m,   stack_item.month
-    assert_equal d,   stack_item.day
-    assert_equal h,   stack_item.hour
-    assert_equal min, stack_item.min
-    assert_equal s,   stack_item.sec
-  end
-
-  def test_rational_to_utc_offset
-    assert_equal -14400, a_time_stack_item.send(:rational_to_utc_offset, Rational(-1, 6))
-    assert_equal -18000, a_time_stack_item.send(:rational_to_utc_offset, Rational(-5, 24))
-    assert_equal 0,      a_time_stack_item.send(:rational_to_utc_offset, Rational(0, 1))
-    assert_equal 3600,   a_time_stack_item.send(:rational_to_utc_offset, Rational(1, 24))
-  end
-
-  def test_utc_offset_to_rational
-    assert_equal Rational(-1, 6),  a_time_stack_item.send(:utc_offset_to_rational, -14400)
-    assert_equal Rational(-5, 24), a_time_stack_item.send(:utc_offset_to_rational, -18000)
-    assert_equal Rational(0, 1),   a_time_stack_item.send(:utc_offset_to_rational, 0)
-    assert_equal Rational(1, 24),  a_time_stack_item.send(:utc_offset_to_rational, 3600)
-  end
-
-  def test_datetime_in_presence_of_activesupport_timezone
-    skip('requires ActiveSupport') unless Time.respond_to? :zone
-    backed_up_zone, backed_up_tzvar = Time.zone, ENV['TZ']
-
-    Time.zone = ENV['TZ'] = 'America/Los_Angeles'
-    t = DateTime.new(2001, 2, 28, 23, 59, 59.5)
-    tsi = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_date_times_equal t, tsi.datetime
-  ensure
-    Time.zone, ENV['TZ'] = backed_up_zone, backed_up_tzvar
-  end
-
-  # Ensure DateTimes handle changing DST properly
-  def test_datetime_for_dst_to_non_dst
-    Timecop.freeze(DateTime.parse("2009-12-1 00:38:00 -0500"))
-    t = DateTime.parse("2009-10-11 00:00:00 -0400")
-    tsi = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_date_times_equal t, tsi.datetime
-  end
-
-  # Ensure DateTimes handle changing DST properly when changing from DateTime to Time
-  def test_datetime_for_dst_to_time_for_non_dst
-    Timecop.freeze(DateTime.parse("2009-12-1 00:38:00 -0500"))
-    t = DateTime.parse("2009-10-11 00:00:00 -0400")
-    tsi = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_date_times_equal t.to_time, tsi.time
-  end
-
-  def test_datetime_for_non_dst_to_dst
-    Timecop.freeze(DateTime.parse("2009-10-11 00:00:00 -0400"))
-    t = DateTime.parse("2009-11-30 23:38:00 -0500")
-    tsi = Timecop::TimeStackItem.new(:freeze, t)
-    return if !tsi.time.dst?
-
-    assert_date_times_equal t, tsi.datetime
-    assert_equal Date.new(2009, 12, 1), tsi.date
-  end
-
-  def test_set_travel_offset_for_travel
-    t_now = Time.now
-    t = Time.local(2009, 10, 1, 0, 0, 30)
-    expected_offset = t - t_now
-    tsi = Timecop::TimeStackItem.new(:travel, t)
-
-    assert_times_effectively_equal expected_offset, tsi.send(:travel_offset), 1, "Offset not calculated correctly"
-  end
-
-  def test_set_travel_offset_for_freeze
-    Timecop.freeze(2009, 10, 1, 0, 0, 0)
-    t = Time.local(2009, 10, 1, 0, 0, 30)
-    tsi = Timecop::TimeStackItem.new(:freeze, t)
-
-    assert_equal nil, tsi.send(:travel_offset)
-  end
-
-  def test_timezones
-    Time.zone = "Europe/Zurich"
-    time = Time.zone.parse("2012-12-27T12:12:12+08:00")
-    Timecop.freeze(time) do |frozen_time|
-      assert_equal time, frozen_time
-    end
-  end
-
-  def test_timezones_apply_dates
-    Time.zone = "Central Time (US & Canada)"
-    time = Time.zone.local(2013,1,3)
-
-    Timecop.freeze(time) do
-      assert_equal time.to_date, Time.now.to_date
-    end
-  end
-
-  def test_set_scaling_factor_for_scale
-    t_now = Time.now
-    t = Time.local(2009, 10, 1, 0, 0, 30)
-    expected_offset = t - t_now
-    tsi = Timecop::TimeStackItem.new(:scale, 4, t)
-
-    assert_times_effectively_equal expected_offset, tsi.send(:travel_offset), 1, "Offset not calculated correctly"
-    assert_equal tsi.send(:scaling_factor), 4, "Scaling factor not set"
-  end
-
-  def test_parse_only_string_with_active_support
-    Time.expects(:parse).never
-    Timecop.freeze(2011, 01, 02, hour=0, minute=0, second=0)
-  end
-
-  def test_parse_date
-    Timecop.freeze(Date.new(2012, 6, 9))
-  end
-
-  def test_time_zone_returns_nil
-    Time.zone = nil
-    Timecop.freeze
-  end
-
-  def test_nsecs_are_set
-    time = Time.now
-    Timecop.freeze time
-    assert_equal time, Time.now
-    assert_equal time.nsec, Time.now.nsec if (Time.now.respond_to?(:nsec))
-  end
-
-  def test_time_with_different_timezone_keeps_nsec
-    Time.zone = "Tokyo"
-    t = Time.now
-    Timecop.freeze(t) do
-      assert_equal t, Time.now
-      assert_equal t.nsec, Time.now.nsec if (Time.now.respond_to?(:nsec))
-    end
-  end
-
-  def test_time_now_always_returns_local_time
-    Time.zone = "Tokyo"
-    t = Time.utc(2000, 1, 1)
-    Timecop.freeze(t) do
-      assert_equal t.getlocal.zone, Time.now.zone
-    end
-  end
-
-  def test_time_zone_now_returns_time_in_that_zone
-    Time.zone = "Hawaii"
-    t = Time.utc(2000, 1, 1)
-    Timecop.freeze(t) do
-      assert_equal t, Time.zone.now
-      assert_equal 'HST', Time.zone.now.zone
-    end
-  end
-
-  def test_freezing_a_time_leaves_timezone_intact
-    Time.zone = "Tokyo"
-    t = Time.now
-    t_dup = t.dup
-    Timecop.freeze(t) {}
-    assert_equal t_dup.zone, t.zone
-  end
-
-  def test_freezing_a_time_with_zone_returns_proper_zones
-    Time.zone = "Hawaii"
-    t = ActiveSupport::TimeWithZone.new(Time.utc(2000, 1, 1), ActiveSupport::TimeZone['Tokyo'])
-    Timecop.freeze(t) do
-      local_now = Time.now
-      assert_equal t, local_now
-      assert_equal t.getlocal.zone, local_now.zone
-
-      zoned_now = Time.zone.now
-      assert_equal t, zoned_now
-      assert_equal 'HST', zoned_now.zone
-    end
-  end
-
-  def test_datetime_timezones
-    dt = DateTime.new(2011,1,3,15,25,0,"-6")
-    Timecop.freeze(dt) do
-      now = DateTime.now
-      assert_equal dt, now, "#{dt.to_f}, #{now.to_f}"
-    end
-  end
-end