timecop-console 0.1.0 → 0.2.0

data/Gemfile

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

data/README.rdoc

@@ -11,43 +11,46 @@ you can now easily make this available to your dev and QA team through a debug c
 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:
+Add to your `Gemfile`:
+
+  gem 'timecop-console', :github => 'jtrupiano/timecop-console', :require => 'timecop_console'
+
+By requiring this dependency, it will open up ActionController::Base and inject an around_filter that will manage Time.now and friends for you.
 
-  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:
+You'll want to hook in the mountable engine for handling time changes in the specific environments that you want this to load in (probably only development, staging). Modify your `config/routes.rb`, adding:
+
+  if Rails.env.development? || Rails.env.staging?
+    mount TimecopConsole::Engine => '/timecop_console'
+  end
 
-  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 %>
+  <% if Rails.env.development? || Rails.env.staging? %>
+
+    <div id="debug-console">
+      <p>
+        The time is <%= Time.now.to_s(:db) %> |
+      </p>
+      <%= form_tag timecop_console.update_path do %>
+        <p>
+          <%= datetime_select("timecop", "current_time") %>
+        </p>
+
+        <p>
+          <%= submit_tag "Time Travel", :class => 'btn' %>
+        </p>
+      <% end %>
+      <%= link_to "Reset", timecop_console.reset_path %>
     </div>
-  <% end -%>
+
+  <% 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/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+namespace :spec do
+  task :coverage do
+    # TODO - setup simplecov
+    #ENV['INVOKE_SIMPLECOV'] = 'true'
+    Rake::Task[:spec].invoke
+  end
+end

data/app/controllers/timecop_console/main_controller.rb

@@ -0,0 +1,39 @@
+module TimecopConsole
+  class MainController < ::ApplicationController
+    skip_filter :handle_timecop_offset
+
+    def update
+      if date_select_format?
+        year   = params['timecop']['current_time(1i)']
+        month  = params['timecop']['current_time(2i)']
+        day    = params['timecop']['current_time(3i)']
+        hour   = params['timecop']['current_time(4i)']
+        minute = params['timecop']['current_time(5i)']
+        second = Time.now.sec
+      else
+        # backward compatible format
+        year   = params[:year]
+        month  = params[:month]
+        day    = params[:day]
+        hour   = params[:hour]
+        minute = params[:min]
+        second = params[:sec]
+      end
+
+      session[SESSION_KEY_NAME] = Time.local(year, month, day, hour, minute, second)
+      redirect_to :back
+    end
+
+    def reset
+      session[SESSION_KEY_NAME] = nil
+      redirect_to :back
+    end
+
+    private
+
+      # http://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-date_select
+      def date_select_format?
+        params['timecop']['current_time(1i)'].present?
+      end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+TimecopConsole::Engine.routes.draw do
+  match '/update' => 'main#update', :as => :update, :via => [:post, :put]
+  match '/reset' => 'main#reset', :as => :reset, :via => [:get]
+end

data/lib/timecop_console/controller_methods.rb

@@ -0,0 +1,34 @@
+# Defines extensions applied to ActionController::Base to support our time travel
+module TimecopConsole
+  module ControllerMethods
+    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[TimecopConsole::SESSION_KEY_NAME].present?
+        Rails.logger.debug "[timecop-console] Time traveling to #{session[TimecopConsole::SESSION_KEY_NAME].to_s}"
+        Timecop.travel(session[TimecopConsole::SESSION_KEY_NAME])
+      else
+        Timecop.return
+      end
+
+      # Run the intended action
+      yield
+
+      if session[TimecopConsole::SESSION_KEY_NAME].present?
+        # 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
+        adjusted_time = Time.now + 3
+        Rails.logger.debug "[timecop-console] Resetting session to: #{adjusted_time}"
+        session[TimecopConsole::SESSION_KEY_NAME] = adjusted_time
+      end
+    end
+
+    private :handle_timecop_offset
+  end
+end

data/lib/timecop_console/engine.rb

@@ -0,0 +1,9 @@
+require 'rails'
+require 'timecop'
+require 'timecop_console'
+
+module TimecopConsole
+  class Engine < Rails::Engine
+    isolate_namespace TimecopConsole
+  end
+end

data/lib/timecop_console/version.rb

@@ -0,0 +1,17 @@
+module TimecopConsole
+  class Version
+    MAJOR = 0 unless defined? MAJOR
+    MINOR = 2 unless defined? MINOR
+    PATCH = 0 unless defined? PATCH
+
+    class << self
+
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH].compact.join('.')
+      end
+
+    end
+
+  end
+end

data/lib/timecop_console.rb

@@ -1,7 +1,8 @@
+require 'timecop_console/engine'
+require 'timecop_console/controller_methods'
 
-require 'timecop'
-require 'timecop-console/timecop_controller_methods'
-ActionController::Base.send(:include, TimecopControllerMethods)
+module TimecopConsole
+  SESSION_KEY_NAME = :timecop_adjusted_time unless defined?(SESSION_KEY_NAME)
+end
 
-require File.join(File.dirname(__FILE__), "timecop-console", "controllers", "timecop_controller")
-require File.join(File.dirname(__FILE__), "timecop-console", "routes")
+ActionController::Base.send(:include, TimecopConsole::ControllerMethods)

data/spec/controllers/main_controller_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe TimecopConsole::MainController do
+  before(:each) do
+    request.env["HTTP_REFERER"] = "where_i_came_from"
+  end
+
+  describe "POST to :update" do
+    let(:timecop_param) do
+      {
+        'current_time(1i)' => 2012,
+        'current_time(2i)' => 11,
+        'current_time(3i)' => 30,
+        'current_time(4i)' => 22,
+        'current_time(5i)' => 01
+      }
+    end
+
+    it 'redirects back' do
+      post :update, :timecop => timecop_param, :use_route => :timecop_console
+
+      response.should redirect_to("where_i_came_from")
+    end 
+  end
+
+  describe "GET to :reset" do
+    it 'redirects back' do
+      get :reset, :use_route => :timecop_console
+
+      response.should redirect_to "where_i_came_from"
+    end
+  end
+end

data/spec/controllers/sample_controller_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe SampleController do
+  describe "GET to :index" do
+    controller do
+      def index
+        render :nothing => true
+      end
+    end
+
+    it 'calls around filter method' do
+      controller.should_receive(:handle_timecop_offset)
+
+      get :index
+    end
+  end
+
+  describe "#handle_timecop_offset" do
+    controller do
+      def index
+        raise Time.zone.now.to_s
+      end
+    end
+
+    it 'sets proper time inside action method' do
+      frozen_time = 1.year.from_now
+
+      session[TimecopConsole::SESSION_KEY_NAME] = frozen_time
+
+      expect { get :index }.to raise_error(frozen_time.to_s)
+    end 
+  end
+end

data/spec/dummy_app/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2'
+
+gem 'timecop-console', :path => '../../', :require => 'timecop_console'

data/spec/dummy_app/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: ../../
+  specs:
+    timecop-console (0.1.0)
+      timecop (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    timecop (0.5.2)
+    treetop (1.4.11)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (~> 3.2)
+  timecop-console!

data/spec/dummy_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy_app/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+DummyApp::Application.load_tasks

data/spec/dummy_app/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .