delorean 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,11 @@
 = Delorean
 
-Delorean let you time-travel in Ruby by mocking <code>Time.now</code>
+Delorean lets you travel in time with Ruby by mocking <tt>Time.now</tt>
+
+http://dl.dropbox.com/u/645329/delorean.png
+
+Marty:: Wait a minute, Doc. Ah... Are you telling me that you built a time machine... out of a DeLorean? 
+Doc:: The way I see it, if you're gonna build a time machine into a car, why not do it with some style?
 
 == Install
 
@@ -8,24 +13,61 @@ Delorean let you time-travel in Ruby by mocking <code>Time.now</code>
 
 == Usage
 
-  # Time.now => Wed Feb 24 00:33:09 +0100 2010
-  Delorean.time_travel_to "1 month ago" 
-  # Time.now => Sun Jan 24 00:33:09 +0100 2010
-  Delorean.back_to_the_present
-  # Time.now => Wed Feb 24 00:33:09 +0100 2010
+Let's travel in time!
+
+  require 'delorean'
+
+  # Date.today => Wed Feb 24
+  Delorean.time_travel_to "1 month ago" # Date.today => Sun Jan 24
+  Delorean.back_to_the_present          # Date.today => Wed Feb 24
+  
+With a block:
   
   Delorean.time_travel_to("1 month ago") do 
-    # Inside the block: 
-    # Time.now => Sun Jan 24 00:34:32 +0100 2010
+    # Inside the block, Time.now => Sun Jan 24 00:34:32 +0100 2010
     sleep(5)
-    # And the time still goes on... Time.now => Sun Jan 24 00:34:37 +0100 2010
+    # And the time still goes by... Time.now => Sun Jan 24 00:34:37 +0100 2010
   end
-  # Outside the block: 
-  # Time.now => Wed Feb 24 00:34:35 +0100 2010
+  
+  # Outside the block, Time.now => Wed Feb 24 00:34:35 +0100 2010
+  
+You can also <tt>jump</tt> which is like <tt>sleep</tt> but without losing time
   
   # Time.now => Wed Feb 24 00:34:04 +0100 2010
   Delorean.jump 30
   # Time.now => Wed Feb 24 00:34:34 +0100 2010
   
+=== Testing
+
+Time-travelling can be extremely useful when you're testing your application.
+
+For example, in RSpec you may find convenient to include Delorean's DSL in your <tt>spec_helper.rb</tt>:
+
+  Spec::Runner.configure do |config|
+    include Delorean
+    ...
+    
+Now you can time-travel in your examples, like this:
+
+  it "should show latest created user" do
+  
+    time_travel_to(3.minutes.ago) { create_user :name => "John"  }
+    time_travel_to(5.minutes.ago) { create_user :name => "Chris" }
+    
+    get 'show'
+    
+    response.should have_text("John")
+    response.should_not have_text("Chris")
+    
+  end
+  
+Don't forget to go back to the present after each example:
+
+  after(:each) { back_to_the_present }
+  
+== Credits
+
+Delorean image based on an original[http://www.gocarlo.com/lagalerie/archives/march05.htm] by {Giancarlo Pitocco}[http://www.gocarlo.com/]
+  
 Copyright (c) 2010 Luismi Cavallé, Sergio Gil and BeBanjo S.L. released under the MIT license
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: delorean
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Luismi Cavall\xC3\xA9"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-24 00:00:00 +01:00
+date: 2010-02-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ post_install_message:
 rdoc_options: 
 - --main
 - README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,6 +73,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Time-travel in Ruby
+summary: Delorean lets you travel in time with Ruby by mocking Time.now
 test_files: []