quantum_leap 0.7.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6573232468bb00173ef5a5a8fe561cf3c6ae83ea
+  data.tar.gz: 0b018140dab2a5467d6bd9e568b5ae3983a3db7b
+SHA512:
+  metadata.gz: c119021b8581adceffa56fcf3fa0e4189d04311225afe6994d0d8d943133bf09b3081451bbc165cab99bead20af020c2eaebae7187d1abac15d1cd3e500c7da7
+  data.tar.gz: e178a8a69e594a46fa5c8883cc363543211b50f098c9bd1460c0df43d4d92ac543e66d314d9bf8306202b5d0a9e1eff63b15b897bc0ab0bedb2f9551254feb88

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Matthew Conway
+Copyright (c) 2014 Matthew Conway
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,7 +1,7 @@
 # QuantumLeap
 
-[![Build Status](https://secure.travis-ci.org/mattonrails/quantum_leap.png?branch=master)](http://travis-ci.org/mattonrails/quantum_leap)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mattonrails/quantum_leap)
+[![Build Status](https://travis-ci.org/mattreduce/quantum_leap.svg?branch=master)](https://travis-ci.org/mattreduce/quantum_leap)
+[![Code Climate](https://codeclimate.com/github/mattreduce/quantum_leap/badges/gpa.svg)](https://codeclimate.com/github/mattreduce/quantum_leap)
 
 Righting wrongs in your test suite with time travel!
 

data/lib/quantum.rb

@@ -1,9 +1,36 @@
 require 'quantum_leap'
 
+# Public: Quantum is the public-facing interface to the library.
+#
+# Examples
+#
+#   Quantum.leap(Time.new(1956, 9, 13))
+#   # => 1956-09-13 00:00:00 -0700
+#
+#   Quantum.leap_back
+#   # => 2013-05-20 21:55:54 -0700
+#
+#   Quantum.leap(Time.new(1974, 10, 24)) do
+#     puts Time.now
+#   end
 class Quantum
-  INITIAL_LEAP = Time.new(1956, 9, 13, 15, 00)
-
-  def self.leap(time = INITIAL_LEAP)
+  # Public: Change the current time to a specific point in the past or future.
+  # You can change the time temporarily by specifying a block; time is
+  # unchanged outside the context of the block.
+  #
+  # time - The Time to leap to (default: 1956-09-13 00:00:00).
+  #
+  # Examples
+  #
+  #   Quantum.leap(Time.new(1956, 9, 13))
+  #   # => 1956-09-13 00:00:00 -0700
+  #
+  #   Quantum.leap(Time.new(1974, 10, 24)) do
+  #     puts Time.now
+  #   end
+  #
+  # Returns the current time.
+  def self.leap(time = QuantumLeap::INITIAL_LEAP)
     QuantumLeap::Accelerator.mock_current_time(time)
     if block_given?
       begin
@@ -15,6 +42,9 @@ class Quantum
     return Time.now
   end
 
+  # Public: Return to the present time.
+  #
+  # Returns the current time.
   def self.leap_back
     QuantumLeap::Accelerator.reset
     Time.now

data/lib/quantum_leap/accelerator.rb

@@ -1,25 +1,87 @@
 require 'quantum_leap'
 
 module QuantumLeap
+  # Internal: The main module for methods that manipulate time, and provide
+  # interfaces to the custom time.
+  #
+  # All methods are module methods and should be called on the
+  # QuantumLeap::Accelerator module.
+  #
+  # Examples
+  #
+  #   QuantumLeap::Accelerator.mock_current_time(Time.new(1956, 9, 13))
+  #   # => [1788820900.589824]
+  #
+  #   QuantumLeap::Accelerator.time_travel_offsets
+  #   # => [1788820900.589824]
+  #
+  #   QuantumLeap::Accelerator.now
+  #   # => 1956-09-13 00:00:01 -0700
+  #
+  #   QuantumLeap::Accelerator.date
+  #   # => #<Date: 1956-09-13 ((2435730j,0s,0n),+0s,2299161j)>
+  #
+  #   QuantumLeap::Accelerator.reset
+  #   # => []
   module Accelerator
     extend self
 
+    # Internal: Return or initialize the stack of time offsets as Floats.
+    #
+    # Examples
+    #
+    #   QuantumLeap::Accelerator.time_travel_offsets
+    #   # => [1788820900.589824]
+    #
+    # Returns an empty Array or an Array of Floats.
     def time_travel_offsets
       @time_travel_offsets ||= []
     end
 
+    # Internal: Empties the stack of time offsets, effectively resetting the
+    # current time to the actual time.
+    #
+    # Returns an empty Array.
     def reset
       @time_travel_offsets = []
     end
 
+    # Internal: Add to the stack of time offsets the difference between the
+    # actual current time, and the desired new time.
+    #
+    # new_time - The past or future Time to leap to.
+    #
+    # Examples
+    #
+    #   QuantumLeap::Accelerator.mock_current_time(Time.new(1956, 9, 13))
+    #   # => [1788820900.589824]
+    #
+    # Returns the stack of time offsets, an Array of Floats.
     def mock_current_time(new_time)
       time_travel_offsets.push(Time.now - new_time)
     end
 
+    # Internal: Provide the mocked time by applying all offsets to the actual
+    # current time.
+    #
+    # Examples
+    #
+    #   QuantumLeap::Accelerator.now
+    #   # => 1956-09-13 00:00:01 -0700
+    #
+    # Returns the mocked current Time.
     def now
       Time.really_now - time_travel_offsets.inject(0, :+)
     end
 
+    # Internal: Converts the current mocked Time to a Date object.
+    #
+    # Examples
+    #
+    #   QuantumLeap::Accelerator.date
+    #   # => #<Date: 1956-09-13 ((2435730j,0s,0n),+0s,2299161j)>
+    #
+    # Returns the mocked current Date.
     def date
       now.to_date
     end

data/lib/quantum_leap/version.rb

@@ -1,3 +1,3 @@
 module QuantumLeap
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/lib/quantum_leap.rb

@@ -3,5 +3,10 @@ require 'quantum_leap/version'
 require 'quantum_leap/core_ext/date'
 require 'quantum_leap/core_ext/time'
 
+module QuantumLeap
+  # Internal: Default time to replace the real current time with.
+  INITIAL_LEAP = Time.new(1956, 9, 13, 15, 00)
+end
+
 require 'quantum_leap/accelerator'
 require 'quantum'

data/quantum_leap.gemspec

@@ -2,16 +2,18 @@
 require File.expand_path('../lib/quantum_leap/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Matthew Conway"]
-  gem.email         = ["mattonrails@shortmail.com"]
+  gem.name          = "quantum_leap"
   gem.description   = %q{Righting wrongs in your test suite with time travel!}
   gem.summary       = %q{Lets you change the current time in your tests}
-  gem.homepage      = "http://mattonrails.github.com/quantum_leap/"
+
+  gem.authors       = ["Matthew Conway"]
+  gem.license = 'MIT'
+  gem.email         = ["himself@mattonrails.com"]
+  gem.homepage      = "https://mattreduce.github.io/quantum_leap/"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "quantum_leap"
   gem.require_paths = ["lib"]
   gem.version       = QuantumLeap::VERSION
 

metadata

@@ -1,41 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: quantum_leap
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 0.7.1
 platform: ruby
 authors:
 - Matthew Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Righting wrongs in your test suite with time travel!
 email:
-- mattonrails@shortmail.com
+- himself@mattonrails.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -50,35 +47,29 @@ files:
 - quantum_leap.gemspec
 - spec/quantum_spec.rb
 - spec/spec_helper.rb
-homepage: http://mattonrails.github.com/quantum_leap/
-licenses: []
+homepage: https://mattreduce.github.io/quantum_leap/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 781284437395688069
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 781284437395688069
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lets you change the current time in your tests
 test_files:
 - spec/quantum_spec.rb