timecop 0.8.1 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bfc685225a22109f897b68e3174608a4b6a16def
-  data.tar.gz: 66aee6ccc9dfd424502c3f3f149c175af3fa3fbc
+SHA256:
+  metadata.gz: 9e107de03899173505259909d8ec9e008082d8fa4cf551a2326a6bc98890285e
+  data.tar.gz: e50a9c462cafa4feb5a1b47fc720f853c1a7ac62bd5d404ecad3f2b749be0ef4
 SHA512:
-  metadata.gz: ac084a1428c7b528faa70aa321b1cb9db1f9f3f8eb45e4a94777f15b915662fc60ba9208091837903348348a1c902c109649aa7a471819cbec7ea1e0d8c1a377
-  data.tar.gz: 14082a5cba36b7f5238455d884025c5f9ce01ca0b81073f9b9860220286d13db10cce76b3da38465fb585976fd29782a1e0d81913d699814e4505790446e03b7
+  metadata.gz: 427b83dd2d0506193c3c4d947cb1281817a531a64f09f73f004d97c17339665311774e775bc7506e4447ed2c66636e0df2cd954447e079409aef347262ab3e30
+  data.tar.gz: 631df874968afa111e81b255d665972085ec64a6c315b424304148a75c3226eb7e0f259ed7d149c6829950394f340b4cd595fa21720149104b2c4c8e2448b586

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2012 — Travis Jeffery, John Trupiano
+Copyright (c) 2019 — Travis Jeffery, John Trupiano
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,6 +1,6 @@
 # timecop
 
-[![Build Status](https://secure.travis-ci.org/travisjeffery/timecop.png)](http://travis-ci.org/travisjeffery/timecop)
+[![Build Status](https://secure.travis-ci.org/travisjeffery/timecop.svg)](http://travis-ci.org/travisjeffery/timecop)
 
 ## DESCRIPTION
 
@@ -104,7 +104,7 @@ being able to simulate activity via subsequent calls to your application.
 Timecop.scale(3600)
 Time.now
 # => 2012-09-20 21:23:25 -0500
-# seconds later, hours have past it's gone from 9pm at night to 6am in the morning
+# seconds later, hours have passed and it's gone from 9pm at night to 6am in the morning
 Time.now
 # => 2012-09-21 06:22:59 -0500
 ```
@@ -128,6 +128,12 @@ Timecop.freeze
 # => Timecop::SafeModeException: Safe mode is enabled, only calls passing a block are allowed.
 ```
 
+### Rails v Ruby Date/Time libraries
+
+Sometimes [Rails Date/Time methods don't play nicely with Ruby Date/Time methods.](https://rails.lighthouseapp.com/projects/8994/tickets/6410-dateyesterday-datetoday)
+
+Be careful mixing Ruby `Date.today` with Rails `Date.tomorrow` / `Date.yesterday` as things might break.
+
 ## Contribute
 
 timecop is maintained by [travisjeffery](http://github.com/travisjeffery), and

data/lib/timecop/time_extensions.rb

@@ -22,24 +22,15 @@ class Time #:nodoc:
       args.size <= 0 ? now : new_without_mock_time(*args)
     end
 
+    ruby2_keywords :new_with_mock_time if Module.private_method_defined?(:ruby2_keywords)
+
     alias_method :new, :new_with_mock_time
   end
 end
 
 class Date #:nodoc:
-  WEEKDAYS = {
-    "sunday"    => 0,
-    "monday"    => 1,
-    "tuesday"   => 2,
-    "wednesday" => 3,
-    "thursday"  => 4,
-    "friday"    => 5,
-    "saturday"  => 6
-  }
-
   class << self
     def mock_date
-      mocked_time_stack_item = Timecop.top_stack_item
       mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.date(self)
     end
 
@@ -59,32 +50,67 @@ class Date #:nodoc:
           "supports Date::ITALY for the start argument."
       end
 
-      Time.strptime(str, fmt).to_date
+      d = Date._strptime(str, fmt) || Date.strptime_without_mock_date(str, fmt)
+      now = Time.now.to_date
+      year = d[:year] || now.year
+      mon = d[:mon] || now.mon
+      if d[:mday]
+        Date.new(year, mon, d[:mday])
+      elsif d[:wday]
+        Date.new(year, mon, now.mday) + (d[:wday] - now.wday)
+      elsif d[:yday]
+        Date.new(year).next_day(d[:yday] - 1)
+      elsif d[:cwyear] && d[:cweek]
+        if d[:cwday]
+          Date.commercial(d[:cwyear], d[:cweek], d[:cwday])
+        else
+          Date.commercial(d[:cwyear], d[:cweek])
+        end
+      elsif d[:seconds]
+        Time.at(d[:seconds]).to_date
+      else
+        Date.new(year, mon)
+      end
     end
 
     alias_method :strptime, :strptime_with_mock_date
 
     def parse_with_mock_date(*args)
-      str = args.first
-      if str && WEEKDAYS.keys.include?(str.downcase)
-        offset = WEEKDAYS[str.downcase] - Date.today.wday
-
-        Date.today + offset
+      parsed_date = parse_without_mock_date(*args)
+      return parsed_date unless mocked_time_stack_item
+      date_hash = Date._parse(*args)
+
+      case
+      when date_hash[:year] && date_hash[:mon]
+        parsed_date
+      when date_hash[:mon] && date_hash[:mday]
+        Date.new(mocked_time_stack_item.year, date_hash[:mon], date_hash[:mday])
+      when date_hash[:wday]
+        closest_wday(date_hash[:wday])
       else
-        parse_without_mock_date(*args)
+        parsed_date + mocked_time_stack_item.travel_offset_days
       end
     end
 
     alias_method :parse_without_mock_date, :parse
     alias_method :parse, :parse_with_mock_date
 
+    def mocked_time_stack_item
+      Timecop.top_stack_item
+    end
+
+    def closest_wday(wday)
+      today = Date.today
+      result = today - today.wday
+      result += 1 until wday == result.wday
+      result
+    end
   end
 end
 
 class DateTime #:nodoc:
   class << self
     def mock_time
-      mocked_time_stack_item = Timecop.top_stack_item
       mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.datetime(self)
     end
 
@@ -97,19 +123,28 @@ class DateTime #:nodoc:
     alias_method :now, :now_with_mock_time
 
     def parse_with_mock_date(*args)
-      str = args.first
-      if str && Date::WEEKDAYS.keys.include?(str.downcase)
-        offset = Date::WEEKDAYS[str.downcase] - DateTime.now.wday
-
-        parsed_weekday =(DateTime.now + offset)
-
-        DateTime.new(parsed_weekday.year, parsed_weekday.month, parsed_weekday.day, 0, 0, 0, 0)
+      date_hash = Date._parse(*args)
+      parsed_date = parse_without_mock_date(*args)
+      return parsed_date unless mocked_time_stack_item
+      date_hash = DateTime._parse(*args)
+
+      case
+      when date_hash[:year] && date_hash[:mon]
+        parsed_date
+      when date_hash[:mon] && date_hash[:mday]
+        DateTime.new(mocked_time_stack_item.year, date_hash[:mon], date_hash[:mday])
+      when date_hash[:wday]
+        Date.closest_wday(date_hash[:wday]).to_datetime
       else
-        parse_without_mock_date(*args)
+        parsed_date + mocked_time_stack_item.travel_offset_days
       end
     end
 
     alias_method :parse_without_mock_date, :parse
     alias_method :parse, :parse_with_mock_date
+
+    def mocked_time_stack_item
+      Timecop.top_stack_item
+    end
   end
 end

data/lib/timecop/time_stack_item.rb

@@ -43,7 +43,11 @@ class Timecop
       end
 
       def travel_offset
-        @travel_offset
+        @travel_offset unless mock_type == :freeze
+      end
+
+      def travel_offset_days
+        (@travel_offset / 60 / 60 / 24).round
       end
 
       def scaling_factor
@@ -52,7 +56,7 @@ class Timecop
 
       def time(time_klass = Time) #:nodoc:
         if @time.respond_to?(:in_time_zone)
-          time = time_klass.at(@time.dup.utc.to_r)
+          time = time_klass.at(@time.dup.localtime)
         else
           time = time_klass.at(@time)
         end
@@ -60,7 +64,7 @@ class Timecop
         if travel_offset.nil?
           time
         elsif scaling_factor.nil?
-          time_klass.at((Time.now_without_mock_time + travel_offset).to_f)
+          time_klass.at(Time.now_without_mock_time + travel_offset)
         else
           time_klass.at(scaled_time)
         end
@@ -102,12 +106,12 @@ class Timecop
         elsif Object.const_defined?(:Date) && arg.is_a?(Date)
           time_klass.local(arg.year, arg.month, arg.day, 0, 0, 0)
         elsif args.empty? && (arg.kind_of?(Integer) || arg.kind_of?(Float))
-          Time.now + arg
+          time_klass.now + arg
         elsif arg.nil?
-          Time.now
+          time_klass.now
         else
           if arg.is_a?(String) && Time.respond_to?(:parse)
-            Time.parse(arg)
+            time_klass.parse(arg)
           else
             # we'll just assume it's a list of y/m/d/h/m/s
             year   = arg        || 2000
@@ -122,7 +126,6 @@ class Timecop
       end
 
       def compute_travel_offset
-        return nil if mock_type == :freeze
         time - Time.now_without_mock_time
       end
 

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
@@ -93,6 +92,7 @@ class Timecop
         nil
       end
     end
+    alias :unfreeze :return
 
     def return_to_baseline
       instance.send(:return_to_baseline)
@@ -100,7 +100,7 @@ class Timecop
     end
 
     def top_stack_item #:nodoc:
-      instance.instance_variable_get(:@_stack).last
+      instance.send(:stack).last
     end
 
     def safe_mode=(safe)
@@ -111,9 +111,17 @@ class Timecop
       @safe_mode ||= false
     end
 
+    def thread_safe=(t)
+      instance.send(:thread_safe=, t)
+    end
+
+    def thread_safe
+      instance.send(:thread_safe)
+    end
+
     # Returns whether or not Timecop is currently frozen/travelled
     def frozen?
-      !instance.instance_variable_get(:@_stack).empty?
+      !instance.send(:stack).empty?
     end
 
     private
@@ -125,50 +133,97 @@ class Timecop
 
   private
 
-  def baseline=(baseline)
-    @baseline = baseline
-    @_stack << TimeStackItem.new(:travel, baseline)
+  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 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.1"
+  VERSION = "0.9.4"
 end

data/test/test_helper.rb

@@ -1,10 +1,11 @@
 require 'bundler/setup'
 require 'minitest/autorun'
 require 'minitest/rg'
+require 'pry'
 
 $VERBOSE = true # enable ruby warnings
 
-require 'mocha/setup'
+require 'mocha/minitest'
 
 class Minitest::Test
   private
@@ -28,7 +29,7 @@ class Minitest::Test
       Time.at(time.to_i).to_datetime.offset
     end
 
-    TIMEZONES = ["Europe/Paris", "UTC", "America/Chicago"]
+    TIMEZONES = ["Pacific/Midway", "Europe/Paris", "UTC", "America/Chicago"]
 
     def each_timezone
       old_tz = ENV["TZ"]
@@ -51,4 +52,8 @@ class Minitest::Test
       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
 
+    def jruby?
+      RUBY_PLATFORM == "java"
+    end
+
 end

data/test/time_stack_item_test.rb

@@ -1,6 +1,7 @@
 require 'date'
 require_relative "test_helper"
 require 'timecop'
+
 require 'active_support/all'
 
 class TestTimeStackItem < Minitest::Test
@@ -180,7 +181,7 @@ class TestTimeStackItem < Minitest::Test
     t = Time.local(2009, 10, 1, 0, 0, 30)
     tsi = Timecop::TimeStackItem.new(:freeze, t)
 
-    assert_equal nil, tsi.send(:travel_offset)
+    assert_nil tsi.send(:travel_offset)
   end
 
   def test_timezones
@@ -191,12 +192,21 @@ class TestTimeStackItem < Minitest::Test
     end
   end
 
+  def test_timezones_with_parsed_string
+    Time.zone = "Europe/Zurich"
+    time_string = "2012-12-27 12:12"
+    expected_time = Time.zone.parse(time_string)
+    Timecop.freeze(time_string) do |frozen_time|
+      assert_equal expected_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
+      assert_equal time.to_date, Time.zone.now.to_date
     end
   end
 

data/test/timecop_test.rb

@@ -37,6 +37,12 @@ class TestTimecop < Minitest::Test
     assert_nil Time.send(:mock_time)
   end
 
+  def test_freeze_then_unfreeze_unsets_mock_time
+    Timecop.freeze(1)
+    Timecop.unfreeze
+    assert_nil Time.send(:mock_time)
+  end
+
   def test_travel_then_return_unsets_mock_time
     Timecop.travel(1)
     Timecop.return
@@ -251,7 +257,7 @@ class TestTimecop < Minitest::Test
       new_now = Time.now
       assert_times_effectively_equal(new_now, t, 1, "Looks like we failed to actually travel time")
       sleep(0.25)
-      assert_times_effectively_not_equal new_now, Time.now, 0.25, "Looks like time is not moving"
+      assert_times_effectively_not_equal new_now, Time.now, 0.24, "Looks like time is not moving"
     end
   end
 
@@ -495,6 +501,18 @@ class TestTimecop < Minitest::Test
     end
   end
 
+  def test_raises_when_safe_mode_and_no_block_though_previously_block_given
+    Timecop.freeze do
+      Timecop.freeze
+    end
+
+    with_safe_mode do
+      assert_raises Timecop::SafeModeException do
+        Timecop.freeze
+      end
+    end
+  end
+
   def test_no_raise_when_safe_mode_and_block_used
     with_safe_mode do
       Timecop.freeze {}
@@ -507,15 +525,11 @@ class TestTimecop < Minitest::Test
     end
   end
 
-  def test_date_strptime_without_year
-    Timecop.freeze(Time.new(1984,2,28)) do
-      assert_equal Date.strptime('04-14', '%m-%d'), Date.new(1984, 4, 14)
-    end
-  end
-
-  def test_date_strptime_without_specifying_format
-    Timecop.freeze(Time.new(1984,2,28)) do
-      assert_equal Date.strptime('1999-04-14'), Date.new(1999, 4, 14)
+  def test_no_raise_when_safe_mode_and_no_block_and_in_block_context
+    with_safe_mode do
+      Timecop.freeze do
+        Timecop.freeze
+      end
     end
   end
 
@@ -536,6 +550,33 @@ class TestTimecop < Minitest::Test
     assert !Timecop.frozen?
   end
 
+  def test_thread_safe_timecop_in_parallel
+    Timecop.thread_safe = true
+    date = Time.local(2011, 01, 02)
+    thread = Thread.new do
+      Timecop.freeze(date) do
+        sleep 1 #give main thread time to run
+        assert_equal date, Time.now
+      end
+    end
+
+    sleep 0.25
+    assert Time.now != date
+    thread.join
+  ensure
+    Timecop.thread_safe = false
+  end
+
+  def test_thread_safe_timecop_returns_after_block
+    Timecop.thread_safe = true
+    date = Time.local(2017, 10, 8)
+
+    Timecop.freeze(date) { }
+    assert Time.now != date
+  ensure
+    Timecop.thread_safe = false
+  end
+
   private
 
   def with_safe_mode(enabled=true)

data/test/timecop_without_date_test.rb

@@ -70,7 +70,7 @@ class TestTimecopWithoutDate < Minitest::Test
       new_now = Time.now
       assert_times_effectively_equal new_now, t, 1, "Looks like we failed to actually travel time" # 0.1 seconds
       sleep(0.25)
-      assert_times_effectively_not_equal new_now, Time.now, 0.25, "Looks like time is not moving"
+      assert_times_effectively_not_equal new_now, Time.now, 0.24, "Looks like time is not moving"
     end
   end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: timecop
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.4
 platform: ruby
 authors:
 - Travis Jeffery
 - John Trupiano
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2021-02-09 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
@@ -38,7 +38,7 @@ homepage: https://github.com/travisjeffery/timecop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -54,9 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: timecop
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 3
 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,
@@ -67,4 +66,3 @@ test_files:
 - test/timecop_test.rb
 - test/timecop_without_date_test.rb
 - test/timecop_without_date_but_with_time_test.rb
-has_rdoc: