timecop 0.4.3 → 0.5.0

data/History.rdoc

@@ -1,4 +1,29 @@
-=== 0.4.1 / 2012-07-27
+=== 0.5.0 / 2012-09-12
+
+* Maintenance
+  * Timecop#travel, Timecop#freeze blocks return nil or block value
+
+=== 0.4.6 / 2012-09-05
+
+* Maintenance
+  * Fix rounding support for Ruby < 1.9
+
+=== 0.4.5 / 2012-08-09
+
+* Maintenance
+  * Subclasses of Time/Date/DateTime now return proper instances
+
+=== 0.4.4 / 2012-07-29
+
+* Maintenance
+  * Can now configure Timecop to not use ActiveSupport by setting Timecop.active_support = false
+
+=== 0.4.3 / 2012-07-27
+
+* Maintenance
+  * Fix alias of Time#new/Time#now when Time#new given with args
+
+=== 0.4.2 / 2012-07-27
 
 * Maintenance
   * Mock Time#new the same as Time#now since they're synonyms

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 3
+:patch: 0
 :major: 0
-:minor: 4
+:minor: 5

data/lib/timecop/time_extensions.rb

@@ -4,7 +4,7 @@ class Time #:nodoc:
     # 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
+      mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.time(self)
     end
     
     # Alias the original now
@@ -19,10 +19,12 @@ class Time #:nodoc:
     alias_method :now, :now_with_mock_time
 
     alias_method :new_without_mock_time, :new
+
     def new_with_mock_time *args
-      if args.size > 0
+      begin
+        raise ArgumentError.new if args.size <= 0
         new_without_mock_time *args
-      else
+      rescue ArgumentError
         now
       end
     end
@@ -37,7 +39,7 @@ if Object.const_defined?(:Date) && Date.respond_to?(:today)
       # 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
+        mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.date(self)
       end
       
       # Alias the original today
@@ -60,7 +62,7 @@ if Object.const_defined?(:DateTime) && DateTime.respond_to?(:now)
       # 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
+        mocked_time_stack_item.nil? ? nil : mocked_time_stack_item.datetime(self)
       end
       
       # Fake alias :now_without_mock_time :now

data/lib/timecop/time_stack_item.rb

@@ -45,24 +45,29 @@ class Timecop
       @travel_offset
     end
     
-    def time #:nodoc:
+    def time(time_klass=Time) #:nodoc:
       if travel_offset.nil?
-        @time.clone
+        time_klass.at( @time.to_f )
       else
-        Time.now_without_mock_time + travel_offset
+        time_klass.at( ( Time.now_without_mock_time + travel_offset ).to_f )
       end
     end
     
-    def date
-      time.send(:to_date)
+    def date(date_klass=Date)
+      date_klass.jd(time.__send__(:to_date).jd)
     end
     
-    def datetime
+    def datetime(datetime_klass=DateTime)
       # DateTime doesn't know about DST, so let's remove its presence
       our_offset = utc_offset + dst_adjustment
-      fractions_of_a_second = time.to_f % 1
-      DateTime.new(year, month, day, hour, min, sec + fractions_of_a_second,
-                   utc_offset_to_rational(our_offset))
+      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))
+      else
+        our_offset = utc_offset + dst_adjustment
+        datetime_klass.new(year, month, day, hour, min, sec, utc_offset_to_rational(our_offset))
+      end
     end
     
     def dst_adjustment
@@ -82,8 +87,8 @@ class Timecop
         time_klass = Time
         time_klass = Time.zone if Time.respond_to? :zone
         arg = args.shift
-        if arg.is_a?(Time)
-          if arg.respond_to?(:in_time_zone)
+        if arg.is_a?(Time) 
+          if Timecop.active_support != false && arg.respond_to?(:in_time_zone)
             arg.in_time_zone
           else
             arg.getlocal
@@ -99,7 +104,7 @@ class Timecop
         elsif arg.nil?
           Time.now
         else
-          if Time.respond_to?(:parse) && arg.is_a?(String)
+          if arg.is_a?(String) && Timecop.active_support != false && Time.respond_to?(:parse)
             Time.parse(arg)
           else
             # we'll just assume it's a list of y/m/d/h/m/s

data/lib/timecop/timecop.rb

@@ -13,78 +13,82 @@ require 'timecop/time_stack_item'
 class Timecop
   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
-  # logic being tested.  For example:
-  #
-  #   joe = User.find(1)
-  #   joe.purchase_home()
-  #   assert !joe.mortgage_due?
-  #   Timecop.freeze(2008, 10, 5) do
-  #     assert joe.mortgage_due?
-  #   end
-  #
-  # 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(offset_in_seconds)
-  # 5. Timecop.freeze(year, month, day, hour=0, minute=0, second=0)
-  #
-  # When a block is also passed, Time.now, DateTime.now and Date.today are all reset to their
-  # previous values after the block has finished executing.  This allows us to nest multiple
-  # calls to Timecop.travel and have each block maintain it's concept of "now."
-  #
-  # * 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
-  #
-  # Returns the frozen time.
-  def self.freeze(*args, &block)
-    instance().send(:travel, :freeze, *args, &block)
-    Time.now
-  end
+  class << self
+    attr_accessor :active_support
+
+    # Allows you to run a block of code and "fake" a time throughout the execution of that block.
+    # This is particularly useful for writing test methods where the passage of time is critical to the business
+    # logic being tested.  For example:
+    #
+    #   joe = User.find(1)
+    #   joe.purchase_home()
+    #   assert !joe.mortgage_due?
+    #   Timecop.freeze(2008, 10, 5) do
+    #     assert joe.mortgage_due?
+    #   end
+    #
+    # 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(offset_in_seconds)
+    # 5. Timecop.freeze(year, month, day, hour=0, minute=0, second=0)
+    #
+    # When a block is also passed, Time.now, DateTime.now and Date.today are all reset to their
+    # previous values after the block has finished executing.  This allows us to nest multiple
+    # calls to Timecop.travel and have each block maintain it's concept of "now."
+    #
+    # * 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
+    #
+    # Returns the value of the block or nil.
+    def freeze(*args, &block)
+      val = instance().send(:travel, :freeze, *args, &block)
+
+      block_given? ? val : nil
+    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.
-  #
-  # Returns the 'new' current Time.
-  def self.travel(*args, &block)
-    instance().send(:travel, :travel, *args, &block)
-    Time.now
-  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.
+    #
+    # Returns the value of the block or nil.
+    def travel(*args, &block)
+      val = instance().send(:travel, :travel, *args, &block)
+
+      block_given? ? val : nil
+    end
 
-  def self.baseline
-    instance().send(:baseline)
-  end
+    def baseline
+      instance().send(:baseline)
+    end
 
-  def self.baseline=(baseline)
-    instance().send(:baseline=, baseline)
-  end
+    def baseline=(baseline)
+      instance().send(:baseline=, baseline)
+    end
 
-  # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists).
-  #
-  # Returns Time.now, which is now the real current time.
-  def self.return
-    instance().send(:unmock!)
-    Time.now
-  end
+    # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists).
+    def return
+      instance().send(:unmock!)
+      nil
+    end
 
-  def self.return_to_baseline
-    instance().send(:return_to_baseline)
-    Time.now
-  end
+    def return_to_baseline
+      instance().send(:return_to_baseline)
+      Time.now
+    end
 
-  def self.top_stack_item #:nodoc:
-    instance().instance_variable_get(:@_stack).last
+    def top_stack_item #:nodoc:
+      instance().instance_variable_get(:@_stack).last
+    end
   end
 
   protected

data/test/time_stack_item_test.rb

@@ -5,6 +5,7 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'timecop')
 class TestTimeStackItem < Test::Unit::TestCase
   
   def teardown
+    Timecop.active_support = nil
     Timecop.return
   end
   
@@ -182,19 +183,22 @@ class TestTimeStackItem < Test::Unit::TestCase
     Timecop.freeze(2011, 01, 02, hour=0, minute=0, second=0)
   end
 
-  def test_integration_with_rails_time_zone
+  def test_parse_with_active_support_off
+    date = '2012-01-02'
+    Timecop.active_support = false
+    Time.expects(:parse).never
+    Timecop.freeze(date)
+  end
+
+  def test_uses_active_supports_in_time_zone
     time = Time.now
-    def time.in_time_zone
-      self - 3600
-    end
-    t = time - 3600
-    stack_item = Timecop::TimeStackItem.new(:freeze, time)
-    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
-    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
+    Time.any_instance.expects(:in_time_zone).returns(time)
+    Timecop::TimeStackItem.new(:freeze, time)
+  end
+
+  def test_configured_off_active_support_in_time_zone_xxx
+    Timecop.active_support = false
+    Time.any_instance.expects(:in_time_zone).never
+    Timecop::TimeStackItem.new(:freeze, Time.now)
   end
 end

data/test/timecop_test.rb

@@ -56,8 +56,47 @@ class TestTimecop < Test::Unit::TestCase
   end
 
   def test_travel_does_not_reduce_precision_of_datetime
-    Timecop.travel(1)
-    assert_not_equal DateTime.now, DateTime.now
+    # requires to_r on Float (>= 1.9)
+    if Float.method_defined?(:to_r)
+      Timecop.travel(1)
+      assert_not_equal DateTime.now, DateTime.now
+    end
+  end
+
+  def test_freeze_in_time_subclass_returns_mocked_subclass
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    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
+      assert custom_timeklass.now.respond_to? :custom_format_method
+    end
+  end
+
+  def test_freeze_in_date_subclass_returns_mocked_subclass
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    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
+      assert custom_dateklass.today.respond_to? :custom_format_method
+    end
+  end
+
+  def test_freeze_in_datetime_subclass_returns_mocked_subclass
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    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
+      assert custom_datetimeklass.now.respond_to? :custom_format_method
+    end
   end
 
   def test_recursive_freeze
@@ -285,29 +324,34 @@ class TestTimecop < Test::Unit::TestCase
     assert_nil Time.send(:mock_time)
   end
 
-  def test_return_values_are_Time_instances
-    assert Timecop.freeze.is_a?(Time)
-    assert Timecop.travel.is_a?(Time)
-    assert Timecop.return.is_a?(Time)
+  def test_travel_time_returns_nil
+    t_future = Time.local(2030, 10, 10, 10, 10, 10)
+    assert_nil Timecop.travel(t_future)
+  end
+
+  def test_travel_time_with_block_returns_the_value_of_the_block
+    t_future = Time.local(2030, 10, 10, 10, 10, 10)
+    expected = :foo
+    actual = Timecop.travel(t_future) { expected }
+
+    assert_equal expected, actual
   end
 
-  def test_travel_time_returns_passed_value
+  def test_freeze_time_returns_nil
     t_future = Time.local(2030, 10, 10, 10, 10, 10)
-    t_travel = Timecop.travel t_future
-    assert times_effectively_equal(t_future, t_travel)
+    assert_nil Timecop.freeze(t_future)
   end
 
-  def test_freeze_time_returns_passed_value
+  def test_freeze_time_with_block_returns_the_value_of_the_block
     t_future = Time.local(2030, 10, 10, 10, 10, 10)
-    t_frozen = Timecop.freeze t_future
-    assert times_effectively_equal(t_future, t_frozen)
+    expected = :foo
+    actual = Timecop.freeze(t_future) { expected }
+
+    assert_equal expected, actual
   end
 
-  def test_return_time_returns_actual_time
-    t_real = Time.now
-    Timecop.freeze Time.local(2030, 10, 10, 10, 10, 10)
-    t_return = Timecop.return
-    assert times_effectively_equal(t_real, t_return)
+  def test_return_returns_nil
+    assert_nil Timecop.return
   end
 
   def test_freeze_without_params
@@ -319,6 +363,13 @@ class TestTimecop < Test::Unit::TestCase
     end
   end
 
+  def test_freeze_with_new_date
+    date = Date.new(2012, 6, 9)
+    Timecop.freeze(Date.new(2012, 6, 9)) do
+      assert_equal date, Time.now.__send__(:to_date)
+    end
+  end
+
   def test_return_to_baseline_without_a_baseline_set_returns_to_current_time
     time_before_travel = Time.now
     Timecop.travel Time.now - 60

metadata

@@ -1,27 +1,35 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: timecop
-version: !ruby/object:Gem::Version
-  version: 0.4.3
+version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
-authors:
+authors: 
 - Travis Jeffery
 - John Trupiano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-28 00:00:00.000000000 Z
+
+date: 2012-09-05 00:00:00 -05:00
+default_executable: 
 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
-  Time.now, Date.today, and DateTime.now in a single call.
+
+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 Time.now, Date.today, and DateTime.now in a single call.
 email: travisjeffery@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.markdown
-files:
+files: 
 - History.rdoc
 - LICENSE
 - README.markdown
@@ -37,37 +45,43 @@ files:
 - test/timecop_test.rb
 - test/timecop_without_date_test.rb
 - test/timecop_without_date_but_with_time_test.rb
+has_rdoc: true
 homepage: http://github.com/jtrupiano/timecop
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: johntrupiano
-rubygems_version: 1.8.19
+rubygems_version: 1.6.2
 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,
-  Date.today, and DateTime.now in a single call.
-test_files:
+summary: A gem providing "time travel" and "time freezing" capabilities, making it dead simple to test time-dependent code.  It provides a unified method to mock Time.now, Date.today, and DateTime.now in a single call.
+test_files: 
 - test/test_helper.rb
 - test/time_stack_item_test.rb
 - test/timecop_test.rb
 - test/timecop_without_date_test.rb
 - test/timecop_without_date_but_with_time_test.rb
-has_rdoc: