timecop 0.2.0 → 0.2.1

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.2.1 / 2009-03-06
+* API Changes
+  
+  * Introduced a 5th style of arguments to be passed into #travel and #freeze.  Now, if you pass in a single integer value,
+    it will be interpreted as a relative offset in seconds from the current Time.now.  Previously this was interpreted as
+    only the year, similar to calling Time.local(2008) --> Jan. 1, 2008.  This is no longer the case.
+
 === 0.2.0 / 2008-12-23
 
 * API Changes

data/{README.txt → README.textile}

@@ -1,23 +1,28 @@
-= timecop
+h1. timecop
 
 * http://github.com/jtrupiano/timecop
 
-== DESCRIPTION:
+h2. DESCRIPTION
 
-A gem providing simple ways to mock Time.now, Date.today, and DateTime.now.  It provides "time travel" and "time freezing" capabilities, making it dead simple to write test time-dependent code.
+A gem providing simple ways to mock Time.now, Date.today, and DateTime.now.  It provides "time travel" and "time freezing" capabilities, making it dead simple to test time-dependent code.
 
-== FEATURES:
+h2. FEATURES
 
 * Temporarily (or permanently if you prefer) change the concept of Time.now, DateTime.now, and Date.today
-* Timecop api allows an arguments to be passed into #freeze and #travel as one of: 1) Time instance, 2) DateTime instance, 3) Date instance,
-  4) individual arguments (year, month, day, hour, minute, second)
+* Timecop api allows arguments to be passed into #freeze and #travel as one of the following:
+  # Time instance
+  # DateTime instance
+  # Date instance
+  # individual arguments (year, month, day, hour, minute, second)
+  # a single integer argument that is interpreted as an offset in seconds from Time.now
+  
 * Nested calls to Timecop#travel and Timecop#freeze are supported -- each block will maintain it's interpretation of now.
 
-== SHORTCOMINGS:
+h2. SHORTCOMINGS
 
 * Only fully tested on the 1.8.6 Ruby implementations.  1.8.7 and 1.9.1 should be tested, as well as other flavors (jruby, etc.)
 
-== SYNOPSIS:
+h2. SYNOPSIS
 
 * Run a time-sensitive test:
 <code>
@@ -44,16 +49,21 @@ config.after_initialize do
 end
 </code>
 
-== REQUIREMENTS:
+h2. REQUIREMENTS
 
 * None
 
-== INSTALL:
+h2. INSTALL
 
 * sudo gem install timecop (latest stable version from rubyforge)
 * sudo gem install jtrupiano-timecop (HEAD of the repo from github)
 
-== LICENSE:
+h2. REFERENCES
+
+* http://blog.smartlogicsolutions.com/2008/11/19/timecop-freeze-time-in-ruby-for-better-testing/
+* http://blog.smartlogicsolutions.com/2008/12/24/timecop-2-released-freeze-and-rebase-time-ruby/
+
+h2. LICENSE
 
 (The MIT License)
 

data/Rakefile

@@ -1,36 +1,24 @@
-# -*- ruby -*-
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
 
-require 'rubygems'
-require 'hoe'
-require './lib/timecop/version.rb'
-
-PKG_NAME      = "timecop"
-PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-version = Timecop::Version::STRING.dup
-if ENV['SNAPSHOT'].to_i == 1
-  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
-end
-PKG_VERSION   = version
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-Hoe.new(PKG_NAME, PKG_VERSION) do |p|
-  p.rubyforge_name = 'johntrupiano' # if different than lowercase project name
-  p.developer('John Trupiano', 'jtrupiano@gmail.com')
-  p.name = PKG_NAME
-  p.version = PKG_VERSION
-  #p.platform = Gem::Platform::RUBY
-  p.author = "John Trupiano"
-  p.email = "jtrupiano@gmail.com"
-  p.description = %q(A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.)
-  p.summary = p.description # More details later??
-  p.remote_rdoc_dir = PKG_NAME # Release to /PKG_NAME
-  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.need_zip = true
-  p.need_tar = false
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "timecop"
+    s.rubyforge_project = 'johntrupiano' # if different than lowercase project name
+    s.description = %q(A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to test time-dependent code.)
+    s.summary = s.description # More details later??
+    s.email = "jtrupiano@gmail.com"
+    s.homepage = "http://github.com/jtrupiano/timecop"
+    s.authors = ["John Trupiano"]
+    s.files =  FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    #s.add_dependency 'schacon-git'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-# vim: syntax=Ruby
-
 # Override the test task and instruct them how to actually run the tests.
 Rake.application.send(:eval, "@tasks.delete('test')")
 desc "Does not execute tests.  Manually run shell script ./run_tests.sh to execute tests."

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 1

data/lib/timecop/timecop.rb

@@ -160,6 +160,9 @@ class Timecop
       elsif Object.const_defined?(:Date) && arg.is_a?(Date)
         year, month, day, hour, minute, second = arg.year, arg.month, arg.day, 0, 0, 0
         #puts "#{year}-#{month}-#{day} #{hour}:#{minute}:#{second}"
+      elsif args.empty? && arg.kind_of?(Integer)
+        t = Time.now + arg
+        year, month, day, hour, minute, second = t.year, t.month, t.day, t.hour, t.min, t.sec
       else # we'll just assume it's a list of y/m/h/d/m/s
         year   = arg        || 0
         month  = args.shift || 1

data/test/test_timecop.rb

@@ -75,6 +75,23 @@ class TestTimecop < Test::Unit::TestCase
     assert_not_equal DateTime.new(2008, 10, 10, 0, 0, 0), DateTime.now    
   end
   
+  def test_freeze_with_integer_instance_works_as_expected
+    t = Time.local(2008, 10, 10, 10, 10, 10)
+    Timecop.freeze(t) do
+      assert_equal t, Time.now
+      assert_equal DateTime.new(2008, 10, 10, 10, 10, 10), DateTime.now
+      assert_equal Date.new(2008, 10, 10), Date.today
+      Timecop.freeze(10) do
+        assert_equal t + 10, Time.now
+        assert_equal Time.local(2008, 10, 10, 10, 10, 20), Time.now
+        assert_equal Date.new(2008, 10, 10), Date.today
+      end
+    end
+    assert_not_equal t, Time.now
+    assert_not_equal DateTime.new(2008, 10, 10, 10, 10, 10), DateTime.now
+    assert_not_equal Date.new(2008, 10, 10), Date.today
+  end
+
   def test_exception_thrown_in_freeze_block_properly_resets_time
     t = Time.local(2008, 10, 10, 10, 10, 10)
     begin

data/test/test_timecop_internals.rb

@@ -41,6 +41,21 @@ class TestTimecopInternals < Test::Unit::TestCase
     assert_equal s, ts
   end
 
+  # Due to the nature of this test (calling Time.now once in this test and
+  # once in #parse_travel_args), this test may fail when two subsequent calls
+  # to Time.now return a different second.
+  def test_parse_travel_args_with_integer
+    t = Time.now
+    y, m, d, h, min, s = t.year, t.month, t.day, t.hour, t.min, t.sec
+    ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, 0)
+    assert_equal y, ty
+    assert_equal m, tm
+    assert_equal d, td
+    assert_equal h, th
+    assert_equal min, tmin
+    assert_equal s, ts
+  end
+
   def test_parse_travel_args_with_individual_arguments
     y, m, d, h, min, s = 2008, 10, 10, 10, 10, 10
     ty, tm, td, th, tmin, ts = Timecop.instance().send(:parse_travel_args, y, m, d, h, min, s)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: timecop
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - John Trupiano
@@ -9,50 +9,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-24 00:00:00 -05:00
+date: 2009-03-06 00:00:00 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
-    version: 
-description: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.
+dependencies: []
+
+description: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to test time-dependent code.
 email: jtrupiano@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+extra_rdoc_files: []
+
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
 - Rakefile
-- lib/timecop.rb
+- README.textile
+- VERSION.yml
+- lib/timecop
 - lib/timecop/stack_item.rb
 - lib/timecop/time_extensions.rb
 - lib/timecop/timecop.rb
 - lib/timecop/version.rb
+- lib/timecop.rb
 - test/run_tests.sh
 - test/test_timecop.rb
 - test/test_timecop_internals.rb
 - test/test_timecop_without_date.rb
-- timecop.gemspec
 has_rdoc: true
 homepage: http://github.com/jtrupiano/timecop
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -73,8 +63,6 @@ rubyforge_project: johntrupiano
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.
-test_files: 
-- test/test_timecop.rb
-- test/test_timecop_internals.rb
-- test/test_timecop_without_date.rb
+summary: A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to test time-dependent code.
+test_files: []
+

data/timecop.gemspec

@@ -1,35 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{timecop}
-  s.version = "0.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Trupiano"]
-  s.date = %q{2008-12-23}
-  s.description = %q{A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.}
-  s.email = %q{jtrupiano@gmail.com}
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/timecop.rb", "lib/timecop/stack_item.rb", "lib/timecop/time_extensions.rb", "lib/timecop/timecop.rb", "lib/timecop/version.rb", "test/run_tests.sh", "test/test_timecop.rb", "test/test_timecop_internals.rb", "test/test_timecop_without_date.rb", "timecop.gemspec"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/jtrupiano/timecop}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{johntrupiano}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{A gem providing simple ways to temporarily override Time.now, Date.today, and DateTime.now.  It provides "time travel" capabilities, making it dead simple to write test time-dependent code.}
-  s.test_files = ["test/test_timecop.rb", "test/test_timecop_internals.rb", "test/test_timecop_without_date.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
-    else
-      s.add_dependency(%q<hoe>, [">= 1.8.2"])
-    end
-  else
-    s.add_dependency(%q<hoe>, [">= 1.8.2"])
-  end
-end