time-warp 1.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Barry Hess
+
+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.md

@@ -0,0 +1,88 @@
+### 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.
+
+
+### Installation
+
+Plugin:
+
+    $ script/plugin install git://github.com/iridesco/time_warp.git
+
+Gem:
+
+    $ gem sources -a http://gems.github.com
+    $ sudo gem install iridesco-time-warp
+
+Gem config in a Rails app.  environment.rb:
+
+    config.gem 'iridesco-time-warp', :lib => 'time_warp', :source => "http://gems.github.com"
+
+### 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:
+
+    require File.dirname(__FILE__) + '/../test_helper'
+    class CompanyTest < Test::Unit::TestCase
+
+      def setup
+        @company = companies(:acme)
+      end
+
+      def test_should_find_company_needing_reminded_today
+        pretend_now_is(Time.utc(2008,"jul",24,20)) do #=> Thu Jul 24 20:00:00 UTC 2008
+          @company.reminder_day = 'Thursday'
+          @company.save
+          companies = Company.find_companies_needing_reminded_today
+          assert_equal true, companies.include?(@company)
+        end
+      end
+
+      def test_should_not_find_company_needing_reminded_tomorrow
+        pretend_now_is(Time.utc(2008,"jul",24,20)) do #=> Thu Jul 24 20:00:00 UTC 2008
+          @company.reminder_day = 'Friday'
+          @company.save
+          companies = Company.find_companies_needing_reminded_today
+          assert_equal false, companies.include?(@company)
+        end
+      end
+
+      def test_should_not_find_company_needing_reminded_yesterday
+        pretend_now_is(Time.utc(2008,"jul",24,20)) do #=> Thu Jul 24 20:00:00 UTC 2008
+          @company.reminder_day = 'Wednesday'
+          @company.save
+          companies = Company.find_companies_needing_reminded_today
+          assert_equal false, companies.include?(@company)
+        end
+      end
+    end
+
+### Notes
+
+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
+    end
+  
+Becomes:
+
+    pretend_now_is(2008,"jul",24,20) do
+      # Shifted code
+    end
+  
+Also, pretend\_now\_is should impact `ActiveSupport` generated `Date` extensions such as `Date.today`, `Date.tomorrow`, and so on.
+
+Credits
+=======
+
+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 [Iridesco](http://iridesco.com).
+
+
+Copyright (c) 2008 [Barry Hess](http://bjhess.com), [Iridesco](http://iridesco.com).  Released under the MIT license.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the time_warp plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the time_warp plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TimeWarp'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/core_ext.rb

@@ -0,0 +1,20 @@
+## 
+# Extend Time class to offset the time that 'now' returns.  This
+# provides the opening to "warp time" for any tests checking for
+# time-based limitations.  Perhaps one needs to check hourly
+# limits, common time borders like midnight, etc.
+if !Time.respond_to?(:real_now)  # assures there is no infinite looping when aliasing #now
+  Time.class_eval do
+    class << self
+      attr_accessor :testing_offset
+      
+      alias_method :real_now, :now
+      def now
+        real_now - testing_offset
+      end
+      alias_method :new, :now
+      
+    end
+  end
+end
+Time.testing_offset = 0

data/lib/time_warp.rb

@@ -0,0 +1,27 @@
+require 'core_ext'
+
+module Test # :nodoc:
+  module Unit # :nodoc:
+    class TestCase
+
+      ##
+      # Time warp to the specified time for the duration of the passed block.
+      def pretend_now_is(*args)
+        begin
+          Time.testing_offset = Time.now - time_from(*args)
+          yield
+        ensure
+          Time.testing_offset = 0
+        end
+      end
+    
+    private
+    
+      def time_from(*args)
+        return args[0] if 1 == args.size && args[0].is_a?(Time)
+        Time.utc(*args)
+      end
+
+    end
+  end
+end

data/tasks/time_warp_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :time_warp do
+#   # Task goes here
+# end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../init.rb'

data/test/time_warp_test.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TimeWarpTest < Test::Unit::TestCase
+  def test_test_unit_test_case_should_respond_to_pretend_now_is
+    assert_equal true, self.respond_to?(:pretend_now_is)
+  end
+  
+  def test_pretend_now_is_should_set_now_back_in_time
+    pretend_now_is(Time.utc(2008,"jul",25,6,15)) do #=> Fri Jul 25 06:15:00 UTC 2008
+      assert_equal 2008, Time.now.utc.year
+      assert_equal    7, Time.now.utc.month
+      assert_equal   25, Time.now.utc.day
+      assert_equal    6, Time.now.utc.hour
+      assert_equal   15, Time.now.utc.min
+    end
+  end
+  
+  def test_pretend_now_is_should_set_now_forward_in_time
+    future_year = Time.now.year + 1
+    pretend_now_is(Time.utc(future_year,"jul",25,6,15)) do #=> Fri Jul 25 06:15:00 UTC future_year
+      assert_equal future_year, Time.now.utc.year
+      assert_equal           7, Time.now.utc.month
+      assert_equal          25, Time.now.utc.day
+      assert_equal           6, Time.now.utc.hour
+      assert_equal          15, Time.now.utc.min
+    end
+  end
+  
+  def test_pretend_now_should_revert_to_real_now_after_block
+    now        = Time.now
+    now_year   = now.year
+    now_month  = now.month
+    now_day    = now.day
+    now_hour   = now.hour
+    now_minute = now.min
+    
+    pretend_now_is(Time.utc(2008,"jul",25,6,15)) do #=> Fri Jul 25 06:15:00 UTC 2008
+      # block of code
+    end
+    
+    assert_equal   now_year, Time.now.year
+    assert_equal  now_month, Time.now.month
+    assert_equal    now_day, Time.now.day
+    assert_equal   now_hour, Time.now.hour
+    assert_equal now_minute, Time.now.min
+  end
+  
+  def test_pretend_now_resolves_to_the_same_value_regardless_of_setting_by_time_argument_or_time_utc_arguments
+    now_with_time_argument = now_with_time_utc_arguments = nil
+    pretend_now_is(Time.utc(2008,"jul",25,6,15)) do #=> Fri Jul 25 06:15:00 UTC 2008
+      now_with_time_argument = Time.now.utc
+    end
+    pretend_now_is(2008,"jul",25,6,15) do           #=> Fri Jul 25 06:15:00 UTC 2008
+      now_with_time_utc_arguments = Time.now.utc
+    end
+    assert_equal now_with_time_argument.to_s, now_with_time_utc_arguments.to_s
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: time-warp
+version: !ruby/object:Gem::Version 
+  version: 1.0.3
+platform: ruby
+authors: 
+- Barry Hess
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-08 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: TimeWarp is a ruby library for manipulating times in automated tests.
+email: barry@iridesco.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Rakefile
+- README.md
+- lib/core_ext.rb
+- lib/time_warp.rb
+- tasks/time_warp_tasks.rake
+has_rdoc: true
+homepage: http://github.com/iridesco/time_warp
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Warp time in your tests
+test_files: 
+- test/test_helper.rb
+- test/time_warp_test.rb