timecop 0.1.0 → 0.2.1

data/History.txt

@@ -1,3 +1,36 @@
+=== 0.2.1 / 2009-03-06
+* API Changes
+  
+  * Introduced a 5th style of arguments to be passed into #travel and #freeze.  Now, if you pass in a single integer value,
+    it will be interpreted as a relative offset in seconds from the current Time.now.  Previously this was interpreted as
+    only the year, similar to calling Time.local(2008) --> Jan. 1, 2008.  This is no longer the case.
+
+=== 0.2.0 / 2008-12-23
+
+* API Changes
+
+  * Timecop#travel no longer freezes time.  Rather, it computes the current offset between the new "now" and the real "now", and
+    returns times as if Time had continued to move forward
+    
+  * Timecop#freeze now behaves exactly as the old Timecop#travel behaved.  Unless you depended on the actual freezing of time
+    (which I think would be rare), you should be able to continue to use #travel without worry.
+    
+  * Timecop#return is now exposed (previously Timecop#unset_all, but not well advertised).  It will completely unmock time,
+    and will probably be rarely used outside of the actual implementation of this library.
+    
+* More Test Coverage
+
+  * Tests now explicitly cover the cases when the Date and DateTime objects are not loaded, and ensures proper functionality
+    in their absence and existence.
+    
+  * Still haven't done regression testing against anything other than a few version of 1.8.6 (including REE).  We should
+    probably try to get this tested on both 1.8.7 and 1.9.1.
+
+* Documentation
+
+  * Fixed up a lot of the poorly-formatted rdoc syntax.  The public API should now be properly published in the rdoc,
+    and the internals are omitted.
+    
 === 0.1.0 / 2008-11-09
 
 * Initial Feature Set

data/Manifest.txt

@@ -3,8 +3,12 @@ Manifest.txt
 README.txt
 Rakefile
 lib/timecop.rb
+lib/timecop/stack_item.rb
 lib/timecop/time_extensions.rb
 lib/timecop/timecop.rb
 lib/timecop/version.rb
+test/run_tests.sh
 test/test_timecop.rb
+test/test_timecop_internals.rb
+test/test_timecop_without_date.rb
 timecop.gemspec

data/{README.txt → README.textile}

@@ -1,19 +1,28 @@
-= timecop
+h1. timecop
 
 * http://github.com/jtrupiano/timecop
 
-== DESCRIPTION:
+h2. DESCRIPTION
 
-A gem providing simple ways to (temporarily) override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.
+A gem providing simple ways to mock Time.now, Date.today, and DateTime.now.  It provides "time travel" and "time freezing" capabilities, making it dead simple to test time-dependent code.
 
-== FEATURES/PROBLEMS:
+h2. FEATURES
 
-* Temporarily (or permanently if you prefer) change the concept of Time.now, DateTime.now (if defined), and Date.today (if defined)
-* Timecop#travel api allows an argument to be passed in as one of: 1) Time instance, 2) DateTime instance, 3) Date instance,
-  4) individual arguments (year, month, day, hour, minute, second)
-* Nested calls to Timecop#travel are supported -- each block will maintain it's interpretation of now.
+* Temporarily (or permanently if you prefer) change the concept of Time.now, DateTime.now, and Date.today
+* Timecop api allows arguments to be passed into #freeze and #travel as one of the following:
+  # Time instance
+  # DateTime instance
+  # Date instance
+  # individual arguments (year, month, day, hour, minute, second)
+  # a single integer argument that is interpreted as an offset in seconds from Time.now
+  
+* Nested calls to Timecop#travel and Timecop#freeze are supported -- each block will maintain it's interpretation of now.
+
+h2. SHORTCOMINGS
+
+* Only fully tested on the 1.8.6 Ruby implementations.  1.8.7 and 1.9.1 should be tested, as well as other flavors (jruby, etc.)
 
-== SYNOPSIS:
+h2. SYNOPSIS
 
 * Run a time-sensitive test:
 <code>
@@ -21,7 +30,7 @@ A gem providing simple ways to (temporarily) override Time.now, Date.today, and
   joe.purchase_home()
   assert !joe.mortgage_due?
   # move ahead a month and assert that the mortgage is due
-  Timecop.travel(Date.today + 30) do
+  Timecop.freeze(Date.today + 30) do
     assert joe.mortgage_due?
   end
 </code>
@@ -40,16 +49,21 @@ config.after_initialize do
 end
 </code>
 
-== REQUIREMENTS:
+h2. REQUIREMENTS
 
 * None
 
-== INSTALL:
+h2. INSTALL
 
 * sudo gem install timecop (latest stable version from rubyforge)
 * sudo gem install jtrupiano-timecop (HEAD of the repo from github)
 
-== LICENSE:
+h2. REFERENCES
+
+* http://blog.smartlogicsolutions.com/2008/11/19/timecop-freeze-time-in-ruby-for-better-testing/
+* http://blog.smartlogicsolutions.com/2008/12/24/timecop-2-released-freeze-and-rebase-time-ruby/
+
+h2. LICENSE
 
 (The MIT License)
 

data/Rakefile

@@ -1,33 +1,31 @@
-# -*- ruby -*-
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
 
-require 'rubygems'
-require 'hoe'
-require './lib/timecop/version.rb'
-
-PKG_NAME      = "timecop"
-PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-version = Timecop::Version::STRING.dup
-if ENV['SNAPSHOT'].to_i == 1
-  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "timecop"
+    s.rubyforge_project = 'johntrupiano' # if different than lowercase project name
+    s.description = %q(A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to test time-dependent code.)
+    s.summary = s.description # More details later??
+    s.email = "jtrupiano@gmail.com"
+    s.homepage = "http://github.com/jtrupiano/timecop"
+    s.authors = ["John Trupiano"]
+    s.files =  FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    #s.add_dependency 'schacon-git'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
-PKG_VERSION   = version
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
-Hoe.new(PKG_NAME, PKG_VERSION) do |p|
-  p.rubyforge_name = 'johntrupiano' # if different than lowercase project name
-  p.developer('John Trupiano', 'jtrupiano@gmail.com')
-  p.name = PKG_NAME
-  p.version = PKG_VERSION
-  #p.platform = Gem::Platform::RUBY
-  p.author = "John Trupiano"
-  p.email = "jtrupiano@gmail.com"
-  p.description = %q(A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.)
-  p.summary = p.description # More details later??
-  p.remote_rdoc_dir = PKG_NAME # Release to /PKG_NAME
-  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.need_zip = true
-  p.need_tar = false
+# Override the test task and instruct them how to actually run the tests.
+Rake.application.send(:eval, "@tasks.delete('test')")
+desc "Does not execute tests.  Manually run shell script ./run_tests.sh to execute tests."
+task :test do
+  puts <<-MSG
+    In order to run the test suite, run: cd test && ./run_tests.sh
+    The tests need to be run with different libraries loaded, which rules out using Rake
+    to automate them.
+  MSG
 end
-
-# vim: syntax=Ruby
-

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 1

data/lib/timecop/stack_item.rb

@@ -0,0 +1,11 @@
+
+# Simply a data class for carrying around "time movement" objects.  Makes it easy to keep track of the time
+# movements on a simple stack.
+class StackItem
+  
+  attr_reader :mock_type, :year, :month, :day, :hour, :minute, :second
+  def initialize(mock_type, year, month, day, hour, minute, second)
+    @mock_type, @year, @month, @day, @hour, @minute, @second = mock_type, year, month, day, hour, minute, second
+  end
+end
+

data/lib/timecop/time_extensions.rb

@@ -7,11 +7,33 @@
 class Time
   class << self
     # Time we might be behaving as
-    attr_reader :mock_time
+    #attr_reader :mock_time
+    
+    @@mock_offset = nil
+    @@mock_time = nil
+    
+    def mock_time
+      if !@@mock_offset.nil?
+        now_without_mock_time - @@mock_offset
+      else
+        @@mock_time
+      end
+    end
     
     # Set new time to pretend we are.
-    def mock_time=(new_now)
-      @mock_time = new_now
+    def freeze_time(new_now)
+      @@mock_time = new_now
+      @@mock_offset = nil
+    end
+    
+    def move_time(new_now)
+      @@mock_offset = new_now.nil? ? nil : (now_without_mock_time - new_now)
+      @@mock_time = nil
+    end
+    
+    # Restores Time to system clock
+    def unmock!
+      move_time(nil)
     end
     
     # Alias the original now
@@ -30,14 +52,12 @@ end
 if Object.const_defined?(:Date)
   class Date
     class << self
-      # Date we might be behaving as
-      attr_reader :mock_date
-    
-      # Set new date to pretend we are.
-      def mock_date=(new_date)
-        @mock_date = new_date
+      def mock_date
+        now = Time.mock_time
+        return nil if now.nil?
+        Date.new(now.year, now.month, now.day)
       end
-    
+        
       # Alias the original today
       alias_method :today_without_mock_date, :today
     
@@ -55,22 +75,20 @@ end
 if Object.const_defined?(:DateTime)
   class DateTime
     class << self
-      # Time we might be behaving as
-      attr_reader :mock_time
-    
-      # Set new time to pretend we are.
-      def mock_time=(new_now)
-        @mock_time = new_now
+      def mock_time
+        t_now = Time.mock_time
+        return nil if t_now.nil?
+        DateTime.new(t_now.year, t_now.month, t_now.day, t_now.hour, t_now.min, t_now.sec)
       end
-    
+
       # Alias the original now
       alias_method :now_without_mock_time, :now
-    
+
       # Define now_with_mock_time
       def now_with_mock_time
         mock_time || now_without_mock_time
       end
-    
+
       # Alias now to now_with_mock_time
       alias_method :now, :now_with_mock_time
     end

data/lib/timecop/timecop.rb

@@ -1,39 +1,17 @@
+require 'singleton'
 require File.join(File.dirname(__FILE__), 'time_extensions')
+require File.join(File.dirname(__FILE__), 'stack_item')
 
-# 1. Wrapper class for manipulating the extensions to the Time, Date, and DateTime objects
-# 2. Allows us to "freeze" time in our Ruby applications.
-# 3. This is very useful when your app's functionality is dependent on time (e.g. 
+# 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.
 class Timecop
-  
-  # Re-bases Time.now, Date.today and DateTime.now (if it exists) to use the time passed in.
-  # When using this method directly, it is up to the developer to call unset_all to return us
-  # to sanity.
-  #
-  # * If being consumed in a rails app, Time.zone.local will be used to instantiate the time.
-  #   Otherwise, Time.local will be used.
-  def self.set_all(year, month, day, hour=0, minute=0, second=0)
-    if Time.respond_to?(:zone) && !Time.zone.nil?
-      # ActiveSupport loaded
-      time = Time.zone.local(year, month, day, hour, minute, second)
-    else 
-      # ActiveSupport not loaded
-      time = Time.local(year, month, day, hour, minute, second)
-    end
-    
-    Time.mock_time = time
-    Date.mock_date = Date.new(time.year, time.month, time.day) if Object.const_defined?(:Date)
-    DateTime.mock_time = DateTime.new(time.year, time.month, time.day, time.hour, time.min, time.sec) if Object.const_defined?(:DateTime)
-  end
-  
-  # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists). If set_all
-  # was never called in the first place, this method will have no effect.
-  def self.unset_all
-    Date.mock_date = nil
-    DateTime.mock_time = nil if Object.const_defined?(:Date)
-    Time.mock_time = nil if Object.const_defined?(:DateTime)
-  end
+  include Singleton
   
   # 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
@@ -43,49 +21,148 @@ class Timecop
   #   joe = User.find(1)
   #   joe.purchase_home()
   #   assert !joe.mortgage_due?
-  #   Timecop.travel(2008, 10, 5) do
+  #   Timecop.freeze(2008, 10, 5) do
   #     assert joe.mortgage_due?
   #   end
   # </code>
   #
-  # travel will respond to several different arguments:
-  # 1. Timecop.travel(time_inst)
-  # 2. Timecop.travel(datetime_inst)
-  # 3. Timecop.travel(date_inst)
-  # 4. Timecop.travel(year, month, day, hour=0, minute=0, second=0)
+  # 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(year, month, day, hour=0, minute=0, second=0)
   #
-  # When a block is also passed, the Time.now, DateTime.now and Date.today are all reset to their
+  # When a block is also passed, Time.now, DateTime.now and Date.today are all reset to their
   # previous values.  This allows us to nest multiple calls to Timecop.travel and have each block
   # maintain it's concept of "now."
-  #def self.travel(year, month, day, hour=0, minute=0, second=0, &block)
+  #
+  # * 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
+  def self.freeze(*args, &block)
+    instance().send(:travel, :freeze, *args, &block)
+  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.  
   def self.travel(*args, &block)
-    year, month, day, hour, minute, second = parse_travel_args(*args)
+    instance().send(:travel, :move, *args, &block)
+  end
+  
+  # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists). If freeze_all or rebase_all
+  # was never called in the first place, this method will have no effect.
+  def self.return
+    instance().send(:unmock!)
+  end
 
-    old_time = Time.mock_time
-    old_date = Date.mock_date if Object.const_defined?(:Date)
-    old_datetime = DateTime.mock_time if Object.const_defined?(:DateTime)
+  # [Deprecated]: See Timecop#return instead.
+  def self.unset_all
+    $stderr.puts "Timecop#unset_all is deprecated.  Please use Timecop#return instead."
+    $stderr.flush
+    self.return
+  end
+  
+  protected
+  
+    def initialize
+      @_stack = []
+    end
+    
+    def travel(mock_type, *args, &block)
+      # parse the arguments, build our base time units
+      year, month, day, hour, minute, second = parse_travel_args(*args)
 
-    set_all(year, month, day, hour, minute, second)
+      # perform our action
+      if mock_type == :freeze
+        freeze_all(year, month, day, hour, minute, second)
+      else
+        move_all(year, month, day, hour, minute, second)
+      end
+      # store this time traveling on our stack...
+      @_stack << StackItem.new(mock_type, year, month, day, hour, minute, second)
     
-    if block_given?
-      begin
-        yield
-      ensure
-        Time.mock_time = old_time
-        Date.mock_date = old_date if Object.const_defined?(:Date)
-        DateTime.mock_time = old_datetime if Object.const_defined?(:DateTime)
+      if block_given?
+        begin
+          yield
+        ensure
+          # pull it off the stack...
+          stack_item = @_stack.pop
+          if @_stack.size == 0
+            # completely unmock if there's nothing to revert back to 
+            unmock!
+          else
+            # or reinstantiate the new the top of the stack (could be a :freeze or a :move)
+            new_top = @_stack.last
+            if new_top.mock_type == :freeze
+              freeze_all(new_top.year, new_top.month, new_top.day, new_top.hour, new_top.minute, new_top.second)
+            else
+              move_all(new_top.year, new_top.month, new_top.day, new_top.hour, new_top.minute, new_top.second)
+            end
+          end
+        end
       end
     end
-  end
+  
+    def unmock!
+      Time.unmock!
+    end
   
   private
-    def self.parse_travel_args(*args)
+  
+    # Re-bases Time.now, Date.today and DateTime.now (if it exists) to use the time passed in.
+    # When using this method directly, it is up to the developer to call unset_all to return us
+    # to sanity.
+    #
+    # * If being consumed in a rails app, Time.zone.local will be used to instantiate the time.
+    #   Otherwise, Time.local will be used.
+    def freeze_all(year, month, day, hour=0, minute=0, second=0)
+      if Time.respond_to?(:zone) && !Time.zone.nil?
+        # ActiveSupport loaded
+        time = Time.zone.local(year, month, day, hour, minute, second)
+      else 
+        # ActiveSupport not loaded
+        time = Time.local(year, month, day, hour, minute, second)
+      end
+    
+      Time.freeze_time(time)
+    end
+
+    # Re-bases Time.now, Date.today and DateTime.now to use the time passed in and to continue moving time
+    # forward.  When using this method directly, it is up to the developer to call return to return us to
+    # sanity.
+    #
+    # * If being consumed in a rails app, Time.zone.local will be used to instantiate the time.
+    #   Otherwise, Time.local will be used.
+    def move_all(year, month, day, hour=0, minute=0, second=0)
+      if Time.respond_to?(:zone) && !Time.zone.nil?
+        # ActiveSupport loaded
+        time = Time.zone.local(year, month, day, hour, minute, second)
+      else 
+        # ActiveSupport not loaded
+        time = Time.local(year, month, day, hour, minute, second)
+      end
+    
+      Time.move_time(time)
+    end
+    
+    def parse_travel_args(*args)
       arg = args.shift
       if arg.is_a?(Time) || (Object.const_defined?(:DateTime) && arg.is_a?(DateTime))
         year, month, day, hour, minute, second = arg.year, arg.month, arg.day, arg.hour, arg.min, arg.sec
       elsif Object.const_defined?(:Date) && arg.is_a?(Date)
         year, month, day, hour, minute, second = arg.year, arg.month, arg.day, 0, 0, 0
-        puts "#{year}-#{month}-#{day} #{hour}:#{minute}:#{second}"
+        #puts "#{year}-#{month}-#{day} #{hour}:#{minute}:#{second}"
+      elsif args.empty? && arg.kind_of?(Integer)
+        t = Time.now + arg
+        year, month, day, hour, minute, second = t.year, t.month, t.day, t.hour, t.min, t.sec
       else # we'll just assume it's a list of y/m/h/d/m/s
         year   = arg        || 0
         month  = args.shift || 1

data/lib/timecop/version.rb

@@ -11,7 +11,7 @@ module Timecop
     end
 
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")

data/test/run_tests.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+echo "\033[1;81m Running test_timecop_internals...\033[0m"
+ruby test_timecop_internals.rb || (echo "FAILED!!!!!!!!!!!!")
+
+echo "\033[1;81m Running test_timecop_without_date...\033[0m"
+ruby test_timecop_without_date.rb || (echo "FAILED!!!!!!!!!!!!")
+
+echo "\033[1;81m Running test_timecop...\033[0m"
+ruby test_timecop.rb || (echo "FAILED!!!!!!!!!!!!")

data/test/test_timecop.rb

@@ -11,37 +11,37 @@ class TestTimecop < Test::Unit::TestCase
   
   # just in case...let's really make sure that Timecop is disabled between tests...
   def teardown
-    Timecop.unset_all
+    Timecop.return
   end
   
-  def test_travel_changes_and_resets_time
+  def test_freeze_changes_and_resets_time
     # depending on how we're invoked (individually or via the rake test suite)
     assert !Time.respond_to?(:zone) || Time.zone.nil?
     
     t = Time.local(2008, 10, 10, 10, 10, 10)
     assert_not_equal t, Time.now
-    Timecop.travel(2008, 10, 10, 10, 10, 10) do
+    Timecop.freeze(2008, 10, 10, 10, 10, 10) do
       assert_equal t, Time.now
     end
     assert_not_equal t, Time.now
   end
   
-  def test_recursive_travel
+  def test_recursive_freeze
     t = Time.local(2008, 10, 10, 10, 10, 10)
-    Timecop.travel(2008, 10, 10, 10, 10, 10) do 
+    Timecop.freeze(2008, 10, 10, 10, 10, 10) do 
       assert_equal t, Time.now
       t2 = Time.local(2008, 9, 9, 9, 9, 9)
-      Timecop.travel(2008, 9, 9, 9, 9, 9) do
+      Timecop.freeze(2008, 9, 9, 9, 9, 9) do
         assert_equal t2, Time.now
       end
       assert_equal t, Time.now
     end
-    assert_nil Time.send(:mock_time)
+    assert_not_equal t, Time.now
   end
   
-  def test_travel_with_time_instance_works_as_expected
+  def test_freeze_with_time_instance_works_as_expected
     t = Time.local(2008, 10, 10, 10, 10, 10)
-    Timecop.travel(t) do 
+    Timecop.freeze(t) do 
       assert_equal t, Time.now
       assert_equal DateTime.new(2008, 10, 10, 10, 10, 10), DateTime.now
       assert_equal Date.new(2008, 10, 10), Date.today
@@ -51,9 +51,9 @@ class TestTimecop < Test::Unit::TestCase
     assert_not_equal Date.new(2008, 10, 10), Date.today
   end
   
-  def test_travel_with_datetime_instance_works_as_expected
+  def test_freeze_with_datetime_instance_works_as_expected
     t = DateTime.new(2008, 10, 10, 10, 10, 10)
-    Timecop.travel(t) do 
+    Timecop.freeze(t) do 
       assert_equal t, DateTime.now
       assert_equal Time.local(2008, 10, 10, 10, 10, 10), Time.now
       assert_equal Date.new(2008, 10, 10), Date.today
@@ -63,9 +63,9 @@ class TestTimecop < Test::Unit::TestCase
     assert_not_equal Date.new(2008, 10, 10), Date.today
   end
   
-  def test_travel_with_date_instance_works_as_expected
+  def test_freeze_with_date_instance_works_as_expected
     d = Date.new(2008, 10, 10)
-    Timecop.travel(d) do
+    Timecop.freeze(d) do
       assert_equal d, Date.today
       assert_equal Time.local(2008, 10, 10, 0, 0, 0), Time.now
       assert_equal DateTime.new(2008, 10, 10, 0, 0, 0), DateTime.now
@@ -75,10 +75,27 @@ class TestTimecop < Test::Unit::TestCase
     assert_not_equal DateTime.new(2008, 10, 10, 0, 0, 0), DateTime.now    
   end
   
-  def test_exception_thrown_in_travel_block_properly_resets_time
+  def test_freeze_with_integer_instance_works_as_expected
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.freeze(t) do
+      assert_equal t, Time.now
+      assert_equal DateTime.new(2008, 10, 10, 10, 10, 10), DateTime.now
+      assert_equal Date.new(2008, 10, 10), Date.today
+      Timecop.freeze(10) do
+        assert_equal t + 10, Time.now
+        assert_equal Time.local(2008, 10, 10, 10, 10, 20), Time.now
+        assert_equal Date.new(2008, 10, 10), Date.today
+      end
+    end
+    assert_not_equal t, Time.now
+    assert_not_equal DateTime.new(2008, 10, 10, 10, 10, 10), DateTime.now
+    assert_not_equal Date.new(2008, 10, 10), Date.today
+  end
+
+  def test_exception_thrown_in_freeze_block_properly_resets_time
     t = Time.local(2008, 10, 10, 10, 10, 10)
     begin
-      Timecop.travel(t) do
+      Timecop.freeze(t) do
         assert_equal t, Time.now
         raise "blah exception"
       end
@@ -88,51 +105,71 @@ class TestTimecop < Test::Unit::TestCase
     end
   end
   
+  def test_freeze_freezes_time
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    now = Time.now
+    Timecop.freeze(t) do
+      #assert Time.now < now, "If we had failed to freeze, time would have proceeded, which is what appears to have happened."
+      new_t, new_d, new_dt = Time.now, Date.today, DateTime.now
+      assert_equal t, new_t, "Failed to freeze time." # 2 seconds
+      #sleep(10)
+      assert_equal new_t, Time.now
+      assert_equal new_d, Date.today
+      assert_equal new_dt, DateTime.now
+    end
+  end
   
-  def test_parse_travel_args_with_time
-    t = Time.now
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    ty, tm, td, th, tmin, ts = Timecop.send(:parse_travel_args, t)
-    assert_equal y, ty
-    assert_equal m, tm
-    assert_equal d, td
-    assert_equal h, th
-    assert_equal min, tmin
-    assert_equal s, ts
+  def test_travel_keeps_time_moving
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    now = Time.now
+    Timecop.travel(t) do
+      #assert Time.now < now, "If we had failed to freeze, time would have proceeded, which is what appears to have happened."
+      assert Time.now - t < 2000, "Looks like we failed to actually travel time" # 2 seconds
+      new_t = Time.now
+      #sleep(10)
+      assert_not_equal new_t, Time.now
+    end
   end
   
-  def test_parse_travel_args_with_datetime
-    t = DateTime.now
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    ty, tm, td, th, tmin, ts = Timecop.send(:parse_travel_args, t)
-    assert_equal y, ty
-    assert_equal m, tm
-    assert_equal d, td
-    assert_equal h, th
-    assert_equal min, tmin
-    assert_equal s, ts
+  def test_recursive_rebasing_maintains_each_context
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.travel(2008, 10, 10, 10, 10, 10) do 
+      assert((t - Time.now).abs < 50, "Failed to travel time.")
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.travel(2008, 9, 9, 9, 9, 9) do
+        assert((t2 - Time.now) < 50, "Failed to travel time.")
+        assert((t - Time.now) > 1000, "Failed to travel time.")
+      end
+      assert((t - Time.now).abs < 2000, "Failed to restore previously-traveled time.")
+    end
+    assert_nil Time.send(:mock_time)
   end
   
-  def test_parse_travel_args_with_date
-    date = Date.today
-    y, m, d, h, min, s = date.year, date.month, date.day, 0, 0, 0
-    ty, tm, td, th, tmin, ts = Timecop.send(:parse_travel_args, date)
-    assert_equal y, ty
-    assert_equal m, tm
-    assert_equal d, td
-    assert_equal h, th
-    assert_equal min, tmin
-    assert_equal s, ts
+  def test_recursive_travel_then_freeze
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.travel(2008, 10, 10, 10, 10, 10) do 
+      assert((t - Time.now).abs < 50, "Failed to travel time.")
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.freeze(2008, 9, 9, 9, 9, 9) do
+        assert_equal t2, Time.now
+      end
+      assert((t - Time.now).abs < 2000, "Failed to restore previously-traveled time.")
+    end
+    assert_nil Time.send(:mock_time)
   end
   
-  def test_parse_travel_args_with_individual_arguments
-    y, m, d, h, min, s = 2008, 10, 10, 10, 10, 10
-    ty, tm, td, th, tmin, ts = Timecop.send(:parse_travel_args, y, m, d, h, min, s)
-    assert_equal y, ty
-    assert_equal m, tm
-    assert_equal d, td
-    assert_equal h, th
-    assert_equal min, tmin
-    assert_equal s, ts
+  def test_recursive_freeze_then_travel
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.freeze(t) do 
+      assert_equal t, Time.now
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.travel(t2) do
+        assert((t2 - Time.now) < 50, "Failed to travel time.")
+        assert((t - Time.now) > 1000, "Failed to travel time.")
+      end
+      assert_equal t, Time.now
+    end
+    assert_nil Time.send(:mock_time)    
   end
+  
 end

data/test/test_timecop_internals.rb

@@ -0,0 +1,69 @@
+
+require 'date'
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
+
+class TestTimecopInternals < Test::Unit::TestCase
+  
+  def test_parse_travel_args_with_time
+    t = Time.now
+    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
+    ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, t)
+    assert_equal y, ty
+    assert_equal m, tm
+    assert_equal d, td
+    assert_equal h, th
+    assert_equal min, tmin
+    assert_equal s, ts
+  end
+
+  def test_parse_travel_args_with_datetime
+    t = DateTime.now
+    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
+    ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, t)
+    assert_equal y, ty
+    assert_equal m, tm
+    assert_equal d, td
+    assert_equal h, th
+    assert_equal min, tmin
+    assert_equal s, ts
+  end
+
+  def test_parse_travel_args_with_date
+    date = Date.today
+    y, m, d, h, min, s = date.year, date.month, date.day, 0, 0, 0
+    ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, date)
+    assert_equal y, ty
+    assert_equal m, tm
+    assert_equal d, td
+    assert_equal h, th
+    assert_equal min, tmin
+    assert_equal s, ts
+  end
+
+  # Due to the nature of this test (calling Time.now once in this test and
+  # once in #parse_travel_args), this test may fail when two subsequent calls
+  # to Time.now return a different second.
+  def test_parse_travel_args_with_integer
+    t = Time.now
+    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
+    ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, 0)
+    assert_equal y, ty
+    assert_equal m, tm
+    assert_equal d, td
+    assert_equal h, th
+    assert_equal min, tmin
+    assert_equal s, ts
+  end
+
+  def test_parse_travel_args_with_individual_arguments
+    y, m, d, h, min, s = 2008, 10, 10, 10, 10, 10
+    ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, y, m, d, h, min, s)
+    assert_equal y, ty
+    assert_equal m, tm
+    assert_equal d, td
+    assert_equal h, th
+    assert_equal min, tmin
+    assert_equal s, ts
+  end
+end

data/test/test_timecop_without_date.rb

@@ -2,20 +2,119 @@
 require 'test/unit'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
 
-class TestTimecopWithoutDate < Test::Unit::TestCase
+class TestTimecopWithouDate < Test::Unit::TestCase
   
-  def test_travel_changes_and_resets_time
-    # depending on how we're invoked (individually or via the rake test suite)
-    assert Object.const_defined?(:Time)
-    #assert !Object.const_defined?(:Date)
+  def setup
+    assert !Object.const_defined?(:Date)
     assert !Object.const_defined?(:DateTime)
+  end
+  
+  # just in case...let's really make sure that Timecop is disabled between tests...
+  def teardown
+    Timecop.return
+  end
+  
+  def test_freeze_changes_and_resets_time
+    # depending on how we're invoked (individually or via the rake test suite)
+    assert !Time.respond_to?(:zone) || Time.zone.nil?
     
     t = Time.local(2008, 10, 10, 10, 10, 10)
     assert_not_equal t, Time.now
-    Timecop.travel(2008, 10, 10, 10, 10, 10) do
+    Timecop.freeze(2008, 10, 10, 10, 10, 10) do
       assert_equal t, Time.now
     end
     assert_not_equal t, Time.now
   end
   
+  def test_recursive_freeze
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.freeze(2008, 10, 10, 10, 10, 10) do 
+      assert_equal t, Time.now
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.freeze(2008, 9, 9, 9, 9, 9) do
+        assert_equal t2, Time.now
+      end
+      assert_equal t, Time.now
+    end
+    assert_nil Time.send(:mock_time)
+  end
+  
+  def test_exception_thrown_in_freeze_block_properly_resets_time
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    begin
+      Timecop.freeze(t) do
+        assert_equal t, Time.now
+        raise "blah exception"
+      end
+    rescue
+      assert_not_equal t, Time.now
+      assert_nil Time.send(:mock_time)
+    end
+  end
+  
+  def test_freeze_freezes_time
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    now = Time.now
+    Timecop.freeze(t) do
+      #assert Time.now < now, "If we had failed to freeze, time would have proceeded, which is what appears to have happened."
+      new_t = Time.now
+      assert_equal t, new_t, "Failed to change move time." # 2 seconds
+      #sleep(10)
+      assert_equal new_t, Time.now
+    end
+  end
+  
+  def test_travel_keeps_time_moving
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    now = Time.now
+    Timecop.travel(t) do
+      #assert Time.now < now, "If we had failed to freeze, time would have proceeded, which is what appears to have happened."
+      assert Time.now - t < 2000, "Looks like we failed to actually travel time" # 2 seconds
+      new_t = Time.now
+      #sleep(10)
+      assert_not_equal new_t, Time.now
+    end
+  end
+  
+  def test_recursive_rebasing_maintains_each_context
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.travel(2008, 10, 10, 10, 10, 10) do 
+      assert((t - Time.now).abs < 50, "Failed to travel time.")
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.travel(2008, 9, 9, 9, 9, 9) do
+        assert((t2 - Time.now) < 50, "Failed to travel time.")
+        assert((t - Time.now) > 1000, "Failed to travel time.")
+      end
+      assert((t - Time.now).abs < 2000, "Failed to restore previously-traveled time.")
+    end
+    assert_nil Time.send(:mock_time)
+  end
+  
+  def test_recursive_travel_then_freeze
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.travel(2008, 10, 10, 10, 10, 10) do 
+      assert((t - Time.now).abs < 50, "Failed to travel time.")
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.freeze(2008, 9, 9, 9, 9, 9) do
+        assert_equal t2, Time.now
+      end
+      assert((t - Time.now).abs < 2000, "Failed to restore previously-traveled time.")
+    end
+    assert_nil Time.send(:mock_time)
+  end
+  
+  def test_recursive_freeze_then_travel
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.freeze(t) do 
+      assert_equal t, Time.now
+      t2 = Time.local(2008, 9, 9, 9, 9, 9)
+      Timecop.travel(t2) do
+        assert((t2 - Time.now) < 50, "Failed to travel time.")
+        assert((t - Time.now) > 1000, "Failed to travel time.")
+      end
+      assert_equal t, Time.now
+    end
+    assert_nil Time.send(:mock_time)    
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: timecop
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - John Trupiano
@@ -9,46 +9,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-09 00:00:00 -05:00
+date: 2009-03-06 00:00:00 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
-    version: 
-description: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.
+dependencies: []
+
+description: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to test time-dependent code.
 email: jtrupiano@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+extra_rdoc_files: []
+
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
 - Rakefile
-- lib/timecop.rb
+- README.textile
+- VERSION.yml
+- lib/timecop
+- lib/timecop/stack_item.rb
 - lib/timecop/time_extensions.rb
 - lib/timecop/timecop.rb
 - lib/timecop/version.rb
+- lib/timecop.rb
+- test/run_tests.sh
 - test/test_timecop.rb
-- timecop.gemspec
+- test/test_timecop_internals.rb
+- test/test_timecop_without_date.rb
 has_rdoc: true
 homepage: http://github.com/jtrupiano/timecop
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,8 +63,6 @@ rubyforge_project: johntrupiano
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.
-test_files: 
-- test/test_timecop.rb
-- test/test_timecop_with_rails.rb
-- test/test_timecop_without_date.rb
+summary: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to test time-dependent code.
+test_files: []
+

data/test/test_timecop_with_rails.rb

@@ -1,22 +0,0 @@
-
-require 'test/unit'
-
-require 'rubygems'
-gem "activesupport", ">= 2.1.0"
-require 'activesupport'
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
-
-class TestTimecopWithRails < Test::Unit::TestCase
-  
-  def test_travel_changes_and_resets_time
-    Time.zone = 'Eastern Time (US & Canada)'
-    t = Time.zone.local(2008, 10, 10, 10, 10, 10)
-    assert_not_equal t, Time.now
-    Timecop.travel(2008, 10, 10, 10, 10, 10) do
-      assert_equal t, Time.now
-    end
-    assert_not_equal t, Time.now
-  end
-    
-end

data/timecop.gemspec

@@ -1,35 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{timecop}
-  s.version = "0.1.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Trupiano"]
-  s.date = %q{2008-11-09}
-  s.description = %q{A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.}
-  s.email = %q{jtrupiano@gmail.com}
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/timecop.rb", "lib/timecop/time_extensions.rb", "lib/timecop/timecop.rb", "lib/timecop/version.rb", "test/test_timecop.rb", "timecop.gemspec", "test/test_timecop_with_rails.rb", "test/test_timecop_without_date.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/jtrupiano/timecop}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{johntrupiano}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.}
-  s.test_files = ["test/test_timecop.rb", "test/test_timecop_with_rails.rb", "test/test_timecop_without_date.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
-    else
-      s.add_dependency(%q<hoe>, [">= 1.8.2"])
-    end
-  else
-    s.add_dependency(%q<hoe>, [">= 1.8.2"])
-  end
-end