freeze_time 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wes Oldenbeuving
+
+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/Rakefile

@@ -0,0 +1,49 @@
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require 'rubygems'
+
+################################################################################
+### Gem
+################################################################################
+
+begin
+  # Parse gemspec using the github safety level.
+  file = Dir['*.gemspec'].first
+  data = File.read(file)
+  spec = nil
+  # FIXME: Lowered SAFE from 3 to 2 to work with Ruby 1.9 due to rubygems
+  # performing a require internally
+  Thread.new { spec = eval("$SAFE = 2\n%s" % data)}.join
+
+  # Create the gem tasks
+  Rake::GemPackageTask.new(spec) do |package|
+    package.gem_spec = spec
+  end
+rescue Exception => e
+  printf "WARNING: Error caught (%s): %s\n%s", e.class.name, e.message, e.backtrace[0...5].map {|l| '  %s' % l}.join("\n")
+end
+
+desc 'Package and install the gem for the current version'
+task :install => :gem do
+  system "sudo gem install -l pkg/%s-%s.gem" % [spec.name, spec.version]
+end
+
+desc 'Show files missing from gemspec'
+task :diff do
+  files = %w[
+    Rakefile
+    *README* *readme*
+    *LICENSE*
+    *.gemspec deps.rip
+    bin/*
+    lib/**/*
+    spec/**/*
+  ].map {|pattern| Dir.glob(pattern)}.flatten.select{|f| File.file?(f)}
+  missing_files = files - spec.files
+  extra_files = spec.files - files
+  puts "Missing files:"
+  puts missing_files.join(" ")
+  puts "Extra files:"
+  puts extra_files.join(" ")
+end

data/freeze_time.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  # Project
+  s.name         = 'freeze_time'
+  s.summary      = "FreezeTime can freeze time in tests."
+  s.description  = s.summary
+  s.version      = '0.1'
+  s.date         = '2009-09-28'
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Wes Oldenbeuving"]
+  s.email        = "narnach@gmail.com"
+  s.homepage     = "http://www.github.com/Narnach/freeze_time"
+
+  # Files
+  root_files     = %w[MIT-LICENSE readme.rdoc Rakefile freeze_time.gemspec]
+  bin_files      = %w[]
+  lib_files      = %w[freeze_time]
+  test_files     = %w[]
+  spec_files     = %w[freeze_time]
+  other_files    = %w[spec/spec.opts spec/spec_helper.rb]
+  s.bindir       = "bin"
+  s.require_path = "lib"
+  s.executables  = bin_files
+  s.test_files   = test_files.map {|f| 'test/%s_test.rb' % f} + spec_files.map {|f| 'spec/%s_spec.rb' % f}
+  s.files        = root_files + s.test_files + other_files + bin_files.map {|f| 'bin/%s' % f} + lib_files.map {|f| 'lib/%s.rb' % f}
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ readme.rdoc MIT-LICENSE]
+  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'README.rdoc'
+
+  # Requirements
+  s.required_ruby_version = ">= 1.8.0"
+end

data/lib/freeze_time.rb

@@ -0,0 +1,38 @@
+module FreezeTime
+  VERSION = '0.1'
+  module FreezeTime
+    # Within the block, time is frozen.
+    #   t1 = nil
+    #   freeze_time do |time|
+    #     t1 = Time.now
+    #     sleep 1
+    #     t2 = Time.now
+    #     t1 == t2 # => true
+    #   end
+    #   t1 == Time.now # => false
+    #
+    # The value of Time.now is captured before the block is run and then all
+    # subsequent calls to Time.now will yield the same Time object. After the
+    # block, Time.now returns to its previous functionality.
+    def freeze_time(&block) # :yields: time
+      old_time = Time
+      new_time = old_time.clone
+      now = old_time.now
+      class << new_time
+        attr_accessor :now
+      end
+      new_time.now = now
+      Object.send(:remove_const, :Time)
+      Object.send(:const_set, :Time, new_time)
+      block.call(now)
+    ensure
+      Object.send(:remove_const, :Time)
+      Object.send(:const_set, :Time, old_time)
+    end
+  end
+end
+
+class Object
+  extend FreezeTime::FreezeTime
+  include FreezeTime::FreezeTime
+end

data/readme.rdoc

@@ -0,0 +1,30 @@
+= FreezeTime
+
+FreezeTime is a helper for testing code that uses time in some way. It implements Kernel#freeze_time, which freezes time within the block passed to it.
+
+Within the block, time is frozen.
+  t1 = nil
+  freeze_time do |time|
+    t1 = Time.now
+    sleep 1
+    t2 = Time.now
+    t1 == t2 # => true
+  end
+  t1 == Time.now # => false
+
+The value of Time.now is captured before the block is run and then all
+subsequent calls to Time.now will yield the same Time object. After the
+block, Time.now returns to its previous functionality.
+
+== Usage
+
+All you need to do to use it in your tests is:
+  require 'freeze_time'
+  freeze_time do |time|
+    # ...
+  end
+There are no external dependencies.
+
+== Contributors
+
+Wes Oldenbeuving [http://github.com/Narnach]

data/spec/freeze_time_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+require 'freeze_time'
+
+describe FreezeTime do
+  it 'should be included in Object' do
+    Object.ancestors.should include(FreezeTime::FreezeTime)
+    Object.should respond_to(:freeze_time)
+  end
+  
+  it 'should freeze Time.now within the block' do
+    freeze_time do |time|
+      t1 = Time.now
+      t2 = Time.now
+      t1.should == t2
+    end
+  end
+
+  it 'should not freeze Time.now outside of the block' do
+    t1 = nil
+    freeze_time do |time|
+      t1 = Time.now
+    end
+    t1.should_not == Time.now
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--diff unified
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir)

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: freeze_time
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Wes Oldenbeuving
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-28 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: FreezeTime can freeze time in tests.
+email: narnach@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- readme.rdoc
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- readme.rdoc
+- Rakefile
+- freeze_time.gemspec
+- spec/freeze_time_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/freeze_time.rb
+has_rdoc: true
+homepage: http://www.github.com/Narnach/freeze_time
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: FreezeTime can freeze time in tests.
+test_files: 
+- spec/freeze_time_spec.rb