timecop 0.7.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20cb6846c9eed771ecb4652d95a568e0fe53066a
-  data.tar.gz: 887873c54cc4dc84fc1b01c0da708289d67e8c76
+  metadata.gz: 580525a47a6026f3d83689807d96949dd5269fa5
+  data.tar.gz: ffb9cc8cf58489f231f3348656f99597b3c79989
 SHA512:
-  metadata.gz: bde686bc5c574e8901c82ce9b66cd45649b03da6a55fedb6cab3dc71a730d0f42bcf23f1da70a410222f8fe2cfc39c23f4ce72bd8a535dce3f3b7bb3feb8a0b7
-  data.tar.gz: 78fef5abf78c22bec175382563eb4fc3d92d87fbb107de4d1a24ece25c85b40bcb52d1dad7d174b59a15493abf128af0ac53e9cab820f4f4abfd26d540fa43bc
+  metadata.gz: dc3c024856bf2bbaab09a0734aa1d87712e26c8b1e47774edf2d65153ceb22ae6bbe3b04499a4f12c68acf5f9352fb26e614c8c4996c80e14353f75049899598
+  data.tar.gz: c759c9cc704c61d2bd1cf13b4d44a6ad8a1b36a03fc398b4796f1dd1bc0d055a6ddda86aa0a31addc753eb6accc57049648d3fd5334477ccb0cc8cbc594076b7

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
 
@@ -51,7 +51,8 @@ describe "some set of tests to mock" do
     Timecop.return
   end
 
-  it "should do blah blah blah" {}
+  it "should do blah blah blah" do
+  end
 end
 ```
 
@@ -103,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
 ```
@@ -127,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/Rakefile

@@ -3,8 +3,6 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rdoc/task'
 
-$LOAD_PATH.unshift("lib")
-
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION')
     version = File.read('VERSION')
@@ -21,7 +19,15 @@ Rake::RDocTask.new do |rdoc|
 end
 
 task :test do
-  system "cd test && ./run_tests.sh" or fail
+  failed = Dir["test/*_test.rb"].map do |test|
+    command = "ruby #{test}"
+    puts
+    puts command
+    command unless system(command)
+  end.compact
+  if failed.any?
+    abort "#{failed.count} Tests failed\n#{failed.join("\n")}"
+  end
 end
 
 desc 'Default: run tests'

data/lib/timecop/time_extensions.rb

@@ -27,19 +27,8 @@ class Time #:nodoc:
 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
 
@@ -65,26 +54,41 @@ class Date #:nodoc:
     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] && date_hash[:mday]
+        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 +101,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] && date_hash[:mday]
+        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
@@ -101,13 +105,13 @@ class Timecop
           time_klass.at(arg.to_time.to_f).getlocal
         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)
-          Time.now + arg
+        elsif args.empty? && (arg.kind_of?(Integer) || arg.kind_of?(Float))
+          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

@@ -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,6 +111,19 @@ 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.send(:stack).empty?
+    end
+
     private
     def send_travel(mock_type, *args, &block)
       val = instance.send(:travel, mock_type, *args, &block)
@@ -120,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

data/lib/timecop/version.rb

@@ -1,3 +1,3 @@
 class Timecop
-  VERSION = "0.7.4"
+  VERSION = "0.9.0"
 end

data/test/test_helper.rb

@@ -1,16 +1,12 @@
-require 'rubygems'
 require 'bundler/setup'
 require 'minitest/autorun'
+require 'minitest/rg'
 
 $VERBOSE = true # enable ruby warnings
 
-begin
-  require 'mocha/setup'
-rescue LoadError
-  require 'mocha'
-end
+require 'mocha/setup'
 
-class Minitest::Unit::TestCase
+class Minitest::Test
   private
     # Tests to see that two times are within the given distance,
     # in seconds, from each other.
@@ -55,4 +51,8 @@ class Minitest::Unit::TestCase
       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,10 +1,10 @@
 require 'date'
-require File.join(File.dirname(__FILE__), "test_helper")
-require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
+require_relative "test_helper"
+require 'timecop'
 
 require 'active_support/all'
 
-class TestTimeStackItem < Minitest::Unit::TestCase
+class TestTimeStackItem < Minitest::Test
   def teardown
     Timecop.return
     Time.zone = nil
@@ -87,6 +87,19 @@ class TestTimeStackItem < Minitest::Unit::TestCase
     assert_equal s,   stack_item.sec
   end
 
+  def test_new_with_float
+    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.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)
@@ -179,6 +192,15 @@ class TestTimeStackItem < Minitest::Unit::TestCase
     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)

data/test/timecop_test.rb

@@ -1,7 +1,7 @@
-require File.join(File.dirname(__FILE__), "test_helper")
-require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
+require_relative "test_helper"
+require 'timecop'
 
-class TestTimecop < Minitest::Unit::TestCase
+class TestTimecop < Minitest::Test
   def teardown
     Timecop.return
   end
@@ -251,7 +251,7 @@ class TestTimecop < Minitest::Unit::TestCase
       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
 
@@ -293,7 +293,7 @@ class TestTimecop < Minitest::Unit::TestCase
       end
     end
   end
-  
+
   def test_freeze_without_arguments_instance_works_as_expected
     t = Time.local(2008, 10, 10, 10, 10, 10)
     Timecop.freeze(t) do
@@ -495,6 +495,18 @@ class TestTimecop < Minitest::Unit::TestCase
     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,6 +519,14 @@ class TestTimecop < Minitest::Unit::TestCase
     end
   end
 
+  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
+
   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)
@@ -519,6 +539,40 @@ class TestTimecop < Minitest::Unit::TestCase
     end
   end
 
+  def test_frozen_after_freeze
+    Timecop.freeze
+    assert Timecop.frozen?
+  end
+
+  def test_frozen_inside_freeze
+    Timecop.freeze do
+      assert Timecop.frozen?
+    end
+  end
+
+  def test_not_frozen_after_return
+    Timecop.freeze
+    Timecop.return
+    assert !Timecop.frozen?
+  end
+
+  def test_thread_safe_timecop
+    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
+
   private
 
   def with_safe_mode(enabled=true)

data/test/timecop_without_date_but_with_time_test.rb

@@ -1,10 +1,8 @@
-require File.join(File.dirname(__FILE__), "test_helper")
-
-class TestTimecopWithoutDateButWithTime < Minitest::Unit::TestCase
-  TIMECOP_LIB = File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
+require_relative "test_helper"
+require "time"
 
+class TestTimecopWithoutDateButWithTime < Minitest::Test
   def test_loads_properly_when_time_is_required_instead_of_date
-    require "time"
-    require TIMECOP_LIB
+    require 'timecop'
   end
 end

data/test/timecop_without_date_test.rb

@@ -1,7 +1,7 @@
-require File.join(File.dirname(__FILE__), "test_helper")
-require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
+require_relative "test_helper"
+require 'timecop'
 
-class TestTimecopWithoutDate < Minitest::Unit::TestCase
+class TestTimecopWithoutDate < Minitest::Test
 
   def setup
     Object.send(:remove_const, :Date) if Object.const_defined?(:Date)
@@ -70,7 +70,7 @@ class TestTimecopWithoutDate < Minitest::Unit::TestCase
       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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timecop
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Travis Jeffery
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2017-06-22 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
@@ -29,7 +29,6 @@ files:
 - lib/timecop/time_stack_item.rb
 - lib/timecop/timecop.rb
 - lib/timecop/version.rb
-- test/run_tests.sh
 - test/test_helper.rb
 - test/time_stack_item_test.rb
 - test/timecop_test.rb
@@ -56,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: timecop
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 3
 summary: A gem providing "time travel" and "time freezing" capabilities, making it
@@ -68,3 +67,4 @@ test_files:
 - test/timecop_test.rb
 - test/timecop_without_date_test.rb
 - test/timecop_without_date_but_with_time_test.rb
+has_rdoc: 

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