time-warp 1.0.10 → 1.0.11

data/README.md

@@ -1,11 +1,11 @@
-### time_warp
+## time-warp
 
 When writing tests, it is often desirable to bend time in order to test limits and edges of the day.  It is especially useful to warp time to test results across the timezones of the world.  Manipulating time is also useful to assure a day of the week, month or year every time the test runs.
 
-Some may say "Why not just mock Time#now?"  I see the point, but I find mocking around with baseline Ruby classes to be asking for trouble.  Eventually unusual behavior will rear its head and a day will be lost debugging tests - the most excruciating debugging one can be subjected to.
+Some may say "Why not just mock `Time#now`?"  I see the point, but I find mocking around with baseline Ruby classes to be asking for trouble.  Eventually unusual behavior will rear its head and a day will be lost debugging tests - the most excruciating debugging one can be subjected to.
 
 
-### Installation
+## Installation
 
 Plugin:
 
@@ -13,15 +13,15 @@ Plugin:
 
 Gem:
 
-    $ sudo gem install time-warp
+    $ gem install time-warp
 
-Gem config in a Rails app.  environment.rb:
+Gem config for a Rails app in `config/environment.rb`:
 
     config.gem 'time-warp'
 
-### Example
+## Example
 
-And now a contrived example.  In this case, the goal is to let the full mechanics of Rails execute.  Yes, this test will even hit the database! The goal is to assure a particular day of week when each test method executes:
+And now, a contrived example.  In this case, the goal is to let the full mechanics of Rails execute.  Yes, this test will even hit the database! The goal is to assure a particular day of week when each test method executes:
 
     require File.dirname(__FILE__) + '/../test_helper'
     class CompanyTest < Test::Unit::TestCase
@@ -58,9 +58,9 @@ And now a contrived example.  In this case, the goal is to let the full mechanic
       end
     end
 
-### Notes
+## Notes
 
-The pretend\_now\_is method may also be called with the arguments for the Time#utc call, rather than a Time argument.  So:
+The `pretend_now_is` method may also be called with the arguments for the `Time#utc` call, rather than a `Time` argument.  So:
 
     pretend_now_is(Time.utc(2008,"jul",24,20)) do
       # Shifted code
@@ -72,16 +72,14 @@ Becomes:
       # Shifted code
     end
   
-Also, pretend\_now\_is should impact `ActiveSupport` generated `Date` extensions such as `Date.today`, `Date.tomorrow`, and so on.
+Also, `pretend_now_is` should impact `ActiveSupport` generated `Date` extensions such as `Date.today`, `Date.tomorrow`, and so on.
 
-Credits
-=======
+## Credits
+
+time-warp is maintained and funded by [Harvest](http://www.getHarvest.com). Want to work on projects like this? [We're hiring](http://www.getharvest.com/careers)!
 
 The creation of this plugin is a direct result of Jason M. Felice's snippet (and ensuing discussion).  The snippet can be found [at DZone](http://snippets.dzone.com/posts/show/1738).
 
 Further discussion of this snippet's evolution may be found [at Barry Hess's blog](http://bjhess.com/blog/2007/08/12/time-warp-for-rails-testing/).
 
-time_warp is maintained and funded by [Harvest](http://www.getHarvest.com).
-
-
 Copyright (c) 2008 [Barry Hess](http://bjhess.com), [Harvest](http://www.getHarvest.com).  Released under the MIT license.

data/lib/time_warp.rb

@@ -1,36 +1,44 @@
 require File.join File.dirname(__FILE__), 'core_ext'
 
-module Test # :nodoc:
-  module Unit # :nodoc:
-    class TestCase
+module TimeWarpAbility
+
+    def reset_to_real_time
+      Time.testing_offset = 0
+    end
 
-      ##
-      # Time warp to the specified time for the duration of the passed block.
-      def pretend_now_is(*args)
-        Time.testing_offset = Time.now - time_from(*args)
-        if block_given?
-          begin
-            yield
-          ensure
-            reset_to_real_time
-          end
+    def pretend_now_is(*args)
+      Time.testing_offset = Time.now - time_from(*args)
+      if block_given?
+        begin
+          yield
+        ensure
+          reset_to_real_time
         end
       end
-      
-      ##
-      # Reset to real time.
-      def reset_to_real_time
-        Time.testing_offset = 0
-      end
-    
-    private
-    
-      def time_from(*args)
-        return args[0] if 1 == args.size && args[0].is_a?(Time)
-        return args[0].to_time if 1 == args.size && args[0].respond_to?(:to_time)  # For example, if it's a Date.
-        Time.utc(*args)
-      end
+    end
+
+  private
+
+    def time_from(*args)
+      return args[0] if 1 == args.size && args[0].is_a?(Time)
+      return args[0].to_time if 1 == args.size && args[0].respond_to?(:to_time)  # For example, if it's a Date.
+      Time.utc(*args)
+    end
+end
+
+module Test # :nodoc:
+  module Unit # :nodoc:
+    class TestCase
+      include ::TimeWarpAbility
+    end
+  end
+end
 
+module RSpec
+  module Core
+    class ExampleGroup
+      include ::TimeWarpAbility
+     # Time warp to the specified time for the duration of the passed block.
     end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: time-warp
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 1
   - 0
-  - 10
-  version: 1.0.10
+  - 11
+  version: 1.0.11
 platform: ruby
 authors: 
 - Barry Hess
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-09 00:00:00 Z
+date: 2012-01-12 00:00:00 Z
 dependencies: []
 
 description: TimeWarp is a ruby library for manipulating times in automated tests.
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Warp time in your tests