time_travel 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Peter Yandell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,44 @@
+= TimeTravel
+
+Time Travel is a Rails plugin that makes it easy to write tests or specs for time-dependent code. It provides the at_time function:
+
+  at_time("9 March 2018 2:32") do
+    ...
+  end
+
+Inside the block, Time.now will return the given time. The time will
+be restored to normal system time when the block exits.
+
+The at_time function can take a Time object, a Date, or a String to parse them into a time.
+
+If the time is given as a String, it is parsed using Time.zone.parse (in Rails 2.1)
+or Time.parse (in Rails 2.0 and earlier). That means it will be interpreted as being
+in the current timezone, unless you provide an explicit timezone in the string.
+
+If the time is given as a Date, it is converted to a String and then parsed in the described way.
+
+You can also access the current time inside of the block via a block parameter, eg:
+
+  at_time Time.now do |time|
+    ...
+  end
+
+== closest_second
+
+The +closest_second+ method is useful when you need to compare an ActiveRecord datetime value with a Ruby Time.
+
+Times are normally stored in your database with 1 second resolution, but Ruby's Time class has microsecond resolution. That means that this will usually fail:
+
+  at_time(Time.now) do  # Freeze the time to a single value for the block.
+    @post = Post.create(:title => 'Example')
+    @post.reload
+    @post.created_at.should == Time.now  # Time.now has some number of microseconds, but @post.created_at doesn't.
+  end
+	
+The +closest_second+ method returns the time without the microseconds, so the following will succeed:
+
+  @post.created_at.should == Time.now.closest_second
+
+== Installation
+
+ruby script/plugin install git://github.com/notahat/time_travel.git

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc "Default: run specs"
+task :default => :spec
+
+desc "Run all the specs for the time_travel plugin."
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--colour']
+  t.rcov = true
+  t.rcov_opts = ["--exclude \"spec/*,gems/*\""]
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "time_travel"
+    gemspec.summary = "A Rails plugin that makes it easy to write tests or specs for time-dependent code"
+    gemspec.email = "pete@notahat.com"
+    gemspec.homepage = "http://github.com/notahat/time_travel"
+    gemspec.authors = ["Pete Yandell"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'time_travel' if ENV["RAILS_ENV"] == "test"

data/lib/time_travel.rb

@@ -0,0 +1,16 @@
+require 'time_travel/time_extensions'
+require 'time_travel/string_extensions'
+require 'time_travel/date_extensions'
+
+Time.send(:include, TimeTravel::TimeExtensions)
+String.send(:include, TimeTravel::StringExtensions)
+Date.send(:include, TimeTravel::DateExtensions)
+
+def at_time(time)
+  Time.now = time
+  begin
+    yield Time.now
+  ensure
+    Time.now = nil
+  end
+end

data/lib/time_travel/date_extensions.rb

@@ -0,0 +1,9 @@
+module TimeTravel
+  module DateExtensions
+    
+    def parse_to_time
+      to_s.parse_to_time
+    end
+    
+  end
+end

data/lib/time_travel/string_extensions.rb

@@ -0,0 +1,13 @@
+module TimeTravel
+  module StringExtensions
+    
+    def parse_to_time
+      if Time.respond_to?(:zone) && Time.zone
+        Time.zone.parse(self).utc
+      else
+        Time.parse(self)
+      end
+    end
+    
+  end
+end

data/lib/time_travel/time_extensions.rb

@@ -0,0 +1,36 @@
+require 'time'
+
+module TimeTravel
+  module TimeExtensions
+  
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        class << self
+          alias_method :immutable_now, :now
+          alias_method :now, :mutable_now
+        end
+      end
+      base.now = nil
+    end
+  
+    def closest_second
+      Time.gm(year, month, day, hour, min, sec)
+    end
+
+    module ClassMethods
+
+      @@now = nil
+
+      def now=(value)
+        @@now = value.respond_to?(:parse_to_time) ? value.parse_to_time : value
+      end
+
+      def mutable_now #:nodoc:
+        @@now || immutable_now
+      end
+    
+    end
+  
+  end
+end

data/spec/time_travel_spec.rb

@@ -0,0 +1,131 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'time_travel'
+require 'time'
+require 'active_support'
+
+describe TimeTravel, "assigning to Time.now" do
+
+  before do
+    @future = Time.parse("1 April 2020")
+  end
+
+  it "should set the time" do
+    Time.now = @future
+    Time.now.should == @future
+  end
+  
+  it "should return time to system time assigning nil" do
+    Time.now = @future
+    Time.now = nil
+    Time.now.should_not be_nil
+    Time.now.should_not == @future
+  end
+  
+  it "should accept a string" do
+    Time.now = "1 April 2020"
+    Time.now.should == Time.parse("1 April 2020")
+  end
+  
+  it "should accept a date" do
+    Time.now = @future.to_date
+    Time.now.should == Time.parse("1 April 2020")
+  end
+  
+  context "in the current timezone as set in ActiveSupport" do
+    
+    before do
+      Time.zone = "Perth"
+    end
+  
+    it "should accept a date" do
+      Time.now = Date.civil(2020, 7, 1)
+      Time.now.should == Time.parse("30 June 2020 4:00 PM UTC")
+    end
+    
+    it "should accept a string" do
+      Time.now = "1 July 2020 11:00 AM"
+      Time.now.should == Time.parse("1 July 2020 3:00 AM UTC")
+    end
+    
+  end
+  
+  context "in the current timezone as set in the environment" do
+    
+    before do
+      Time.zone = nil
+      ENV['TZ'] = "Australia/Perth"
+    end
+  
+    it "should accept a date" do
+      Time.now = Date.civil(2020, 7, 1)
+      Time.now.should == Time.parse("30 June 2020 4:00 PM UTC")
+    end
+  
+    it "should accept a string" do
+      Time.now = "1 July 2020 11:00 AM"
+      Time.now.should == Time.parse("1 July 2020 3:00 AM UTC")
+    end
+    
+  end
+  
+  after do
+    Time.now = nil
+  end
+  
+end
+
+describe TimeTravel, "at_time method" do
+  
+  before do
+    @future = Time.parse("1 April 2020")
+  end
+  
+  it "should change the time within the block" do
+    at_time(@future) do
+      Time.now.should == @future
+    end
+  end
+  
+  it "should change the date within the block" do
+    at_time(@future.to_date) do
+      Date.today.should == @future.to_date
+    end
+  end
+  
+  it "should pass the time into the block" do
+    at_time(@future) do |time|
+      time.should == @future
+    end
+  end
+  
+  it "should pass the time into the block being given a date" do
+    at_time(@future.to_date) do |time|
+      time.should == @future
+    end
+  end
+  
+  it "should restore the system time after the block" do
+    at_time(@future) do
+    end
+    Time.now.should_not == @future
+  end
+  
+  it "should restore the system time after an exception" do
+    begin
+      at_time(@future) do
+        raise "Uh oh"
+      end
+    rescue
+    end
+    Time.now.should_not == @future
+  end
+  
+end
+
+describe TimeTravel, "closest_second method" do
+  
+  it "should return the time with no microseconds" do
+    Time.utc(2020, 4, 1, 9, 0, 0, 500).closest_second.should == Time.utc(2020, 4, 1, 9, 0, 0)
+  end
+    
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: time_travel
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Yandell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-08 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: 
+email: pete@notahat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/time_travel.rb
+- lib/time_travel/date_extensions.rb
+- lib/time_travel/string_extensions.rb
+- lib/time_travel/time_extensions.rb
+- spec/time_travel_spec.rb
+has_rdoc: true
+homepage: http://github.com/notahat/time_travel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails plugin that makes it easy to write tests or specs for time-dependent code
+test_files: 
+- spec/time_travel_spec.rb