timecop-console 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Trupiano
+
+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,53 @@
+= timecop-console
+
+* http://github.com/jtrupiano/timecop-console
+
+== Description
+
+timecop-console exposes controllers/routes for manipulating Time.now (using the Timecop gem) from your app.  This is especially useful
+during development and QA, as you can very easily simulate the movement of time.  Just as timecop gives you this ability within your tests,
+you can now easily make this available to your dev and QA team through a debug console.
+
+I have plans to build out rails-caddy, a debug console that will pull in timecop-console (and a few others that I'm thinking about) to
+truly give you a powerful QA tool.
+
+== Install
+  sudo gem install timecop-console            (latest stable release)
+  sudo gem install jtrupiano-timecop-console  (head of repository)
+  
+== Requirements
+  * Timecop ~> 0.2.1
+
+== How to Use
+
+You'll want to hook in the functionality in the specific environments that you want this to load in (probably only development, staging, and qa).  In the specific environment file (e.g. config/environments/staging.rb), include the following snippet:
+
+  config.after_initialize do
+    require 'timecop_console'
+  end
+
+By requiring this file, you will open up ActionController::Base and inject an around_filter that will manage Time.now and friends for you.  Additionally, it will add lib/timecop-console/controllers/timecop_controller.rb to the load path along with its routes.  The two routes are:
+
+  map.update_time '/timecop/update', :controller => 'timecop', :action => 'update'
+  map.reset_time '/timecop/reset', :controller => 'timecop', :action => 'reset'
+
+Then, to take advantage of this, you'll want to add a snippet of code to the bottom of your application's layout file, e.g.:
+
+  <% if ["development", "staging", "qa"].include?(RAILS_ENV) -%>
+    <div id="debug_console">
+      The time is <%= Time.now.to_s(:db) %> |
+      <% form_remote_tag :url => update_time_path do -%>
+        <%= submit_tag "Time Travel" %>
+        <% %w(year month day hour min sec).each do |field| -%>
+          <%= text_field_tag field, Time.now.send(field), :size => 4 %>
+        <% end -%>
+      <% end -%>
+      <%= link_to_remote "Reset", :url => reset_time_path %>
+    </div>
+  <% end -%>
+
+This snippet exposes textfields to allow you to alter each component of time (year, month, day, hour, minute, second).  It's raw, and there is no validation whatsoever.  A default (and customizable) snippet like this will be added to this library shortly.  In the meantime, you can hand-write it.
+  
+== Copyright
+
+Copyright (c) 2009 John Trupiano. See LICENSE for details.

data/VERSION.yml

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

data/lib/timecop-console/controllers/timecop_controller.rb

@@ -0,0 +1,21 @@
+
+# Because we want to use the session, we need to inherit from ApplicationController
+# This is currently very brittle....need to think this one through further.
+require_dependency 'application' if Object.const_defined?(:RAILS_ENV)
+class TimecopController < ApplicationController
+  
+  # verify :method => 'post'
+  skip_filter :handle_timecop_offset
+  
+  def update
+    year, month, day, hour, min, sec = params[:year], params[:month], params[:day], params[:hour], params[:min], params[:sec]
+    session[:timecop_adjusted_time] = Time.local(year, month, day, hour, min, sec)
+    render :status => 200, :nothing => true
+  end
+  
+  def reset
+    session[:timecop_adjusted_time] = nil
+    render :status => 200, :nothing => true
+  end
+  
+end

data/lib/timecop-console/routes.rb

@@ -0,0 +1,16 @@
+module ActionController
+  module Routing #:nodoc:
+    class RouteSet #:nodoc:
+      alias_method :draw_without_timecop_routes, :draw
+      def draw
+        draw_without_timecop_routes do |map|
+
+          map.update_time '/timecop/update', :controller => 'timecop', :action => 'update'
+          map.reset_time '/timecop/reset', :controller => 'timecop', :action => 'reset'
+
+          yield map if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/timecop-console/timecop_controller_methods.rb

@@ -0,0 +1,33 @@
+# Defines extensions applied to ActionController::Base to support our time travel
+module TimecopControllerMethods
+  
+  def self.included(base)
+    base.class_eval do
+      around_filter :handle_timecop_offset
+    end
+  end
+  
+  # to be used as an around_filter
+  def handle_timecop_offset
+    # Establish now
+    if !session[:timecop_adjusted_time].nil?
+      puts "***** Time traveling to #{session[:timecop_adjusted_time].to_s}"
+      Timecop.travel(session[:timecop_adjusted_time])
+    else
+      Timecop.return
+    end
+    
+    # Run the intended action
+    yield
+    
+    # we want to continue to slide time forward, even if it's only 3 seconds at a time.
+    # this ensures that subsequent calls during the same "time travel" actually pass time
+    if !session[:timecop_adjusted_time].nil?
+      puts "====== Resetting session to: #{Time.now + 3}"
+      session[:timecop_adjusted_time] = Time.now + 3 # slide it forward a couple of seconds
+    end
+  end
+  
+  private :handle_timecop_offset
+  
+end

data/lib/timecop_console.rb

@@ -0,0 +1,7 @@
+
+require 'timecop'
+require 'timecop-console/timecop_controller_methods'
+ActionController::Base.send(:include, TimecopControllerMethods)
+
+require File.join(File.dirname(__FILE__), "timecop-console", "controllers", "timecop_controller")
+require File.join(File.dirname(__FILE__), "timecop-console", "routes")

data/test/geminstaller.yml

@@ -0,0 +1,6 @@
+
+gems:
+- name: Shoulda
+  version: '~> 1.2.0'
+- name: timecop
+  version: '~> 0.2.1'

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+class Test::Unit::TestCase
+end

data/test/timecop_console_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'actionpack'
+require 'action_controller'
+# require 'action_controller/assertions/routing_assertions'
+
+require "timecop-console/timecop_controller_methods"
+
+# We need this defined for the session key
+class ApplicationController < ActionController::Base
+  
+end
+
+require 'timecop_console'
+class SampleController < ActionController::Base
+  
+end
+
+class TimecopConsoleTest < Test::Unit::TestCase
+  
+  should "add around_filter to SampleController" do
+    assert SampleController.around_filter.any?{|filter| filter.around? && filter.method == :handle_timecop_offset}, "before_filter should have been applied"
+  end
+  
+  # should "recognize the new routes" do
+  #   assert_recognizes({:controller => 'timecop', :action => 'update'})
+  #   assert_recognizes({:controller => 'timecop', :action => 'reset'})
+  # end
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: timecop-console
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Trupiano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+description: 
+email: jtrupiano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/timecop-console
+- lib/timecop-console/controllers
+- lib/timecop-console/controllers/timecop_controller.rb
+- lib/timecop-console/routes.rb
+- lib/timecop-console/timecop_controller_methods.rb
+- lib/timecop_console.rb
+- test/geminstaller.yml
+- test/test_helper.rb
+- test/timecop_console_test.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/jtrupiano/timecop-console
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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: johntrupiano
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Expose Timecop's capabilities to the UI in your rails app, allowing QA to take advantage of it.
+test_files: []
+