timecop 0.5.2 → 0.5.3

data/README.markdown

@@ -1,6 +1,8 @@
 # timecop
 
-- Source[http://github.com/jtrupiano/timecop]
+[![Build Status](https://secure.travis-ci.org/travisjeffery/timecop.png)](http://travis-ci.org/travisjeffery/timecop)
+
+- Source[http://github.com/travisjeffery/timecop]
 - Documentation[http://johntrupiano.rubyforge.org/timecop]
 
 ## DESCRIPTION
@@ -93,6 +95,8 @@ Time.now
 # => 2012-09-21 06:22:59 -0500
 ```
 
+See #42 for more information, thanks to Ken Mayer, David Holcomb, and Pivotal Labs.
+
 ## REFERENCES
 
 * {0.3.4 release}[http://blog.smartlogicsolutions.com/2009/12/07/timecop-0-3-4-released/]
@@ -102,8 +106,8 @@ Time.now
 
 ## Contribute
 
-timecop is maintained by [travisjeffery](http://github.com/travisjeffery), who
-you can also hit up on [Twitter](http://twitter.com/travisjeffery).
+timecop is maintained by [travisjeffery](http://github.com/travisjeffery), and
+was created by [jtrupiano](https://github.com/jtrupiano). 
 
 Here's the most direct way to get your work merged into the project.
 

data/lib/timecop/time_extensions.rb

@@ -1,29 +1,25 @@
 
 class Time #:nodoc:
   class << self
-    # Time we are behaving as
     def mock_time
       mocked_time_stack_item = Timecop.top_stack_item
       mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.time(self)
     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
 
     alias_method :new_without_mock_time, :new
 
-    def new_with_mock_time *args
+    def new_with_mock_time(*args)
       begin
         raise ArgumentError.new if args.size <= 0
-        new_without_mock_time *args
+        new_without_mock_time(*args)
       rescue ArgumentError
         now
       end
@@ -36,21 +32,17 @@ end
 if Object.const_defined?(:Date) && Date.respond_to?(:today)
   class Date #:nodoc:
     class << self
-      # Date we are behaving as
       def mock_date
         mocked_time_stack_item = Timecop.top_stack_item
         mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.date(self)
       end
       
-      # Alias the original today
       alias_method :today_without_mock_date, :today
     
-      # Define today_with_mock_date
       def today_with_mock_date
         mock_date || today_without_mock_date
       end
     
-      # Alias today to today_with_mock_date
       alias_method :today, :today_with_mock_date
     end
   end
@@ -59,26 +51,19 @@ end
 if Object.const_defined?(:DateTime) && DateTime.respond_to?(:now)
   class DateTime #:nodoc:
     class << self
-      # Time we are behaving as
       def mock_time
         mocked_time_stack_item = Timecop.top_stack_item
         mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.datetime(self)
       end
       
-      # Fake alias :now_without_mock_time :now
-      # It appears that the DateTime library itself references Time.now
-      # for it's interpretation of now which caused 
-      # DateTime.now_without_mock_time to incorrectly return the frozen time.
       def now_without_mock_time
-        Time.now_without_mock_time.send :to_datetime
+        Time.now_without_mock_time.to_datetime
       end
       
-      # 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
   end

data/lib/timecop/time_stack_item.rb

@@ -3,8 +3,8 @@ class Timecop
   # A data class for carrying around "time movement" objects.  Makes it easy to keep track of the time
   # movements on a simple stack.
   class TimeStackItem #:nodoc:
-  
     attr_reader :mock_type
+  
     def initialize(mock_type, *args)
       raise "Unknown mock_type #{mock_type}" unless [:freeze, :travel, :scale].include?(mock_type)
       @scaling_factor = args.shift if mock_type == :scale
@@ -51,13 +51,13 @@ class Timecop
       @scaling_factor
     end
     
-    def time(time_klass=Time) #:nodoc:
+    def time(time_klass = Time) #:nodoc:
       if travel_offset.nil?
-        time_klass.at( @time.to_f )
+        time_klass.at(@time.to_f)
       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).to_f)
       else
-        time_klass.at( scaled_time )
+        time_klass.at(scaled_time)
       end
     end
 
@@ -65,17 +65,16 @@ class Timecop
       (@time + (Time.now_without_mock_time - @time_was) * scaling_factor).to_f
     end
     
-    def date(date_klass=Date)
+    def date(date_klass = Date)
       date_klass.jd(time.__send__(:to_date).jd)
     end
     
-    def datetime(datetime_klass=DateTime)
-      # DateTime doesn't know about DST, so let's remove its presence
+    def datetime(datetime_klass = DateTime)
       our_offset = utc_offset + dst_adjustment
+
       if Float.method_defined?(:to_r)
         fractions_of_a_second = time.to_f % 1
-        datetime_klass.new(year, month, day, hour, min, sec + fractions_of_a_second,
-                           utc_offset_to_rational(our_offset))
+        datetime_klass.new(year, month, day, hour, min, sec + fractions_of_a_second, utc_offset_to_rational(our_offset))
       else
         our_offset = utc_offset + dst_adjustment
         datetime_klass.new(year, month, day, hour, min, sec, utc_offset_to_rational(our_offset))
@@ -140,6 +139,5 @@ class Timecop
         return nil if mock_type == :freeze
         time - Time.now_without_mock_time
       end
-      
   end
 end

data/lib/timecop/timecop.rb

@@ -47,11 +47,11 @@ class Timecop
     #   which will lead to files being generated with the timestamp set by the Timecop.freeze call
     #   in your dev environment
     #
-    # Returns the value of the block or nil.
+    # Returns the value of the block if one is given, or the mocked time.
     def freeze(*args, &block)
-      val = instance().send(:travel, :freeze, *args, &block)
+      val = instance.send(:travel, :freeze, *args, &block)
 
-      block_given? ? val : nil
+      block_given? ? val : Time.now
     end
 
     # Allows you to run a block of code and "fake" a time throughout the execution of that block.
@@ -60,11 +60,11 @@ class Timecop
     # * 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.
     #
-    # Returns the value of the block or nil.
+    # Returns the value of the block if one is given, or the mocked time.
     def travel(*args, &block)
-      val = instance().send(:travel, :travel, *args, &block)
+      val = instance.send(:travel, :travel, *args, &block)
 
-      block_given? ? val : nil
+      block_given? ? val : Time.now
     end
 
     # Allows you to run a block of code and "scale" a time throughout the execution of that block.
@@ -74,74 +74,87 @@ class Timecop
     #   end
     # See Timecop#freeze for exact usage of the other arguments
     #
-    # Returns the value of the block or nil.
+    # Returns the value of the block if one is given, or the mocked time.
     def scale(*args, &block)
-      val = instance().send(:travel, :scale, *args, &block)
+      val = instance.send(:travel, :scale, *args, &block)
 
-      block_given? ? val : nil
+      block_given? ? val : Time.now
     end
 
     def baseline
-      instance().send(:baseline)
+      instance.send(:baseline)
     end
 
     def baseline=(baseline)
-      instance().send(:baseline=, baseline)
+      instance.send(:baseline=, baseline)
     end
 
-    # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists).
-    def return
-      instance().send(:unmock!)
-      nil
+    # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists) permamently when
+    # no block argument is given, or temporarily reverts back to the system's time temporarily for
+    # the given block.
+    def return(&block)
+      if block_given?
+        instance.send(:return, &block)
+      else
+        instance.send(:unmock!)
+        nil
+      end
     end
 
     def return_to_baseline
-      instance().send(:return_to_baseline)
+      instance.send(:return_to_baseline)
       Time.now
     end
 
     def top_stack_item #:nodoc:
-      instance().instance_variable_get(:@_stack).last
+      instance.instance_variable_get(:@_stack).last
     end
   end
 
-  protected
+  private
 
-    def baseline=(baseline)
-      @baseline = baseline
-      @_stack << TimeStackItem.new(:travel, baseline)
-    end
+  def baseline=(baseline)
+    @baseline = baseline
+    @_stack << TimeStackItem.new(:travel, baseline)
+  end
 
-    def initialize #:nodoc:
-      @_stack = []
-    end
+  def initialize #:nodoc:
+    @_stack = []
+  end
 
-    def travel(mock_type, *args, &block) #:nodoc:
-      stack_item = TimeStackItem.new(mock_type, *args)
+  def travel(mock_type, *args, &block) #:nodoc:
+    stack_item = TimeStackItem.new(mock_type, *args)
 
-      # store this time traveling on our stack...
-      @_stack << stack_item
+    @_stack << stack_item
 
-      if block_given?
-        begin
-          yield stack_item.time
-        ensure
-          # pull it off the stack...
-          @_stack.pop
-        end
+    if block_given?
+      begin
+        yield stack_item.time
+      ensure
+        @_stack.pop
       end
     end
+  end
 
-    def unmock! #:nodoc:
-      @baseline = nil
-      @_stack = []
-    end
+  def return(&block)
+    current_stack = @_stack
+    current_baseline = @baseline
+    unmock!
+    yield
+    @_stack = current_stack
+    @baseline = current_baseline
+  end
 
-    def return_to_baseline
-      if @baseline
-        @_stack = [@_stack.shift]
-      else
-        unmock!
-      end
+  def unmock! #:nodoc:
+    @baseline = nil
+    @_stack = []
+  end
+
+  def return_to_baseline
+    if @baseline
+      @_stack = [@_stack.shift]
+    else
+      unmock!
     end
+  end
 end

data/lib/timecop/version.rb

@@ -1,3 +1,3 @@
 class Timecop
-  VERSION = "0.5.2"
-end
+  VERSION = "0.5.3"
+end

data/test/time_stack_item_test.rb

@@ -3,7 +3,6 @@ require 'test_helper'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
 
 class TestTimeStackItem < Test::Unit::TestCase
-  
   def teardown
     Timecop.active_support = nil
     Timecop.return
@@ -13,6 +12,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
@@ -25,6 +25,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
@@ -37,6 +38,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
@@ -49,6 +51,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
@@ -57,6 +60,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
@@ -72,6 +76,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
@@ -83,6 +88,7 @@ class TestTimeStackItem < Test::Unit::TestCase
   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
@@ -104,13 +110,13 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
-  
-  # Ensure DST adjustment is calculated properly for DateTime's
+
   def test_compute_dst_adjustment_for_dst_to_dst
     Timecop.freeze(DateTime.parse("2009-10-1 00:38:00 -0400"))
     t = DateTime.parse("2009-10-11 00:00:00 -0400")
     tsi = Timecop::TimeStackItem.new(:freeze, t)
     return if !(Time.now.dst? && tsi.time.dst?)
+
     assert_equal 0, tsi.send(:dst_adjustment)
   end
   
@@ -119,6 +125,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     t = DateTime.parse("2009-12-11 00:00:00 -0400")
     tsi = Timecop::TimeStackItem.new(:freeze, t)
     return if Time.now.dst? || tsi.time.dst?
+
     assert_equal 0, tsi.send(:dst_adjustment)    
   end
   
@@ -127,6 +134,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     t = DateTime.parse("2009-12-11 00:00:00 -0400")
     tsi = Timecop::TimeStackItem.new(:freeze, t)
     return if !Time.now.dst? || tsi.time.dst?
+
     assert_equal 60 * 60, tsi.send(:dst_adjustment)
   end
   
@@ -135,6 +143,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     t = DateTime.parse("2009-10-11 00:00:00 -0400")
     tsi = Timecop::TimeStackItem.new(:freeze, t)
     return if Time.now.dst? || !tsi.time.dst?
+
     assert_equal -1 * 60 * 60, tsi.send(:dst_adjustment)
   end
   
@@ -143,6 +152,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
   
@@ -151,17 +161,17 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
-  
-  # Ensure @travel_offset is set properly
+
   def test_set_travel_offset_for_travel
-    # Timecop.freeze(2009, 10, 1, 0, 0, 0)
     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
   
@@ -169,6 +179,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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
 
@@ -177,6 +188,7 @@ class TestTimeStackItem < Test::Unit::TestCase
     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

data/test/timecop_test.rb

@@ -3,25 +3,20 @@ require 'test_helper'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
 
 class TestTimecop < Test::Unit::TestCase
-
-  def setup
-
-  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.freeze(2008, 10, 10, 10, 10, 10) do
       assert_equal t, Time.now
     end
+
     assert_not_equal t, Time.now
   end
 
@@ -68,6 +63,7 @@ class TestTimecop < Test::Unit::TestCase
     custom_timeklass = Class.new(Time) do
       def custom_format_method() strftime('%F') end
     end
+
     Timecop.freeze(2008, 10, 10, 10, 10, 10) do
       assert custom_timeklass.now.is_a? custom_timeklass
       assert Time.now.eql? custom_timeklass.now
@@ -80,6 +76,7 @@ class TestTimecop < Test::Unit::TestCase
     custom_dateklass = Class.new(Date) do
       def custom_format_method() strftime('%F') end
     end
+
     Timecop.freeze(2008, 10, 10, 10, 10, 10) do
       assert custom_dateklass.today.is_a? custom_dateklass
       assert Date.today.eql? custom_dateklass.today
@@ -92,6 +89,7 @@ class TestTimecop < Test::Unit::TestCase
     custom_datetimeklass = Class.new(DateTime) do
       def custom_format_method() strftime('%F') end
     end
+
     Timecop.freeze(2008, 10, 10, 10, 10, 10) do
       assert custom_datetimeklass.now.is_a? custom_datetimeklass
       assert DateTime.now.eql? custom_datetimeklass.now
@@ -119,6 +117,7 @@ class TestTimecop < Test::Unit::TestCase
       assert_date_times_equal DateTime.new(2008, 10, 10, 10, 10, 10, local_offset), DateTime.now
       assert_equal Date.new(2008, 10, 10), Date.today
     end
+
     assert_not_equal t, Time.now
     assert_not_equal DateTime.new(2008, 10, 10, 10, 10, 10, local_offset), DateTime.now
     assert_not_equal Date.new(2008, 10, 10), Date.today
@@ -133,7 +132,6 @@ class TestTimecop < Test::Unit::TestCase
       Timecop.freeze(t) do
         assert_date_times_equal t, DateTime.now
       end
-      # Undo the original freeze
       Timecop.return
     end
   end
@@ -260,6 +258,11 @@ class TestTimecop < Test::Unit::TestCase
     end
   end
 
+  def test_scaling_returns_now_if_no_block_given
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    assert_times_effectively_equal t, Timecop.scale(4, t)
+  end
+
   def test_freeze_with_utc_time
     each_timezone do
       t = Time.utc(2008, 10, 10, 10, 10, 10)
@@ -334,9 +337,22 @@ class TestTimecop < Test::Unit::TestCase
     assert_nil Time.send(:mock_time)
   end
 
-  def test_travel_time_returns_nil
+  def test_travel_time_returns_now_if_no_block_given
     t_future = Time.local(2030, 10, 10, 10, 10, 10)
-    assert_nil Timecop.travel(t_future)
+    assert_times_effectively_equal t_future, Timecop.travel(t_future)
+  end
+
+  def test_return_temporarily_returns_to_current_time_in_given_block
+    time_after_travel = Time.local(1990, 7, 16)
+    now = Time.now
+
+    Timecop.travel(time_after_travel)
+
+    assert_times_effectively_equal(time_after_travel, Time.now)
+    Timecop.return do
+      assert_times_effectively_equal(now, Time.now)
+    end
+    assert_times_effectively_equal(time_after_travel, Time.now)
   end
 
   def test_travel_time_with_block_returns_the_value_of_the_block
@@ -347,9 +363,9 @@ class TestTimecop < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
-  def test_freeze_time_returns_nil
+  def test_freeze_time_returns_now_if_no_block_given
     t_future = Time.local(2030, 10, 10, 10, 10, 10)
-    assert_nil Timecop.freeze(t_future)
+    assert_times_effectively_equal t_future, Timecop.freeze(t_future)
   end
 
   def test_freeze_time_with_block_returns_the_value_of_the_block

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timecop
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -50,9 +50,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1525074573276164628
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -61,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: johntrupiano
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem providing "time travel" and "time freezing" capabilities, making it