rails-caddy 0.0.8

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,69 @@
+= rails-caddy
+
+A developer's QA "caddy" that aids in QA'ing, debugging, and otherwise navigating your application during development and/or QA.
+
+== Rails Compatibility
+
+Tests cover rails 2.1.2, 2.2.2, and 2.3.2 specifically.  Previous releases on each minor version have not been explicitly tested, but I suspect they should all function equally well.
+
+== Usage
+
+RULE #1: DO NOT DEPLOY THIS TO PRODUCTION.  I WILL HAVE NO EMPATHY WHATSOEVER IF YOU DO NOT HEED MY WARNING.  THIS IS A VERY DANGEROUS GEM THAT WILL DEFINITELY SCREW YOU OVER IF YOU DEPLOY IT TO PRODUCTION.
+
+This process is not currently scripted, but following these steps will get you off and running.
+
+* edit application.rb
+
+    if Object.const_defined?(:RailsCaddy)
+      helper RailsCaddyHelper
+      around_filter :handle_sanitize_email
+      around_filter :handle_timecop_offset, :except => [:timecop_update, :timecop_reset]
+    end
+  
+* edit config/environments/development.rb -- DO NOT MAKE THIS AVAILABLE TO PRODUCTION!!!
+
+    config.gem "rails-caddy"
+  
+    config.after_initialize do
+      require 'rails-caddy'
+      require_dependency 'application_controller' # 'application' if pre rails 2.3
+      RailsCaddy.init!
+
+      ActionMailer::Base.sanitized_recipients = "nobody@smartlogicsolutions.com"
+    end
+
+* add just before you close your body tag in your layout (it's actually unimportant where you place it, as long as it's in the body):
+
+    <%= rails_caddy if Object.const_defined?(:RailsCaddy) %>
+  
+* add to the top of config/routes.rb
+
+    RailsCaddy.define_routes!(map) if Object.const_defined?(:RailsCaddy)
+
+== Dependencies
+
+rails-caddy is dependent on the {sanitize_email gem}[http://github.com/jtrupiano/sanitize_email/tree/master].  Unfortunately, for the time being you'll need to build and install that locally.  Why?  Because the dependency is on +sanitize_email+ and NOT <tt>jtrupiano-sanitize_email</tt>, the latter of which can be installed remotely.  Hopefully this will change soon (that's _your_ cue to fork and fix).
+
+== Building/Testing
+
+In order to run the tests, you'll want to build the gem.  Why?  Because <tt>rake test:rails_compatibility</tt> tests all supported versions of rails (see <b>Rails Compatibility</b>, above).  It does this by creating mini-Rails apps for each version and config-gem'ing rails-caddy (<tt>config.gem 'rails-caddy'</tt>).  If you don't build the gem and try to run the tests, you'll get an error telling you to <tt>run `rake gems:install`</tt>.
+
+The easiest way to build the gem is to install {technicalpickle's}[http://technicalpickles.com/] {jeweler gem}[http://github.com/technicalpickles/jeweler/tree/master]: <tt>sudo gem install jeweler</tt>.
+
+After jeweler is installed, you can build and install with some handy rake tasks:
+
+    rake build
+    rake install
+
+<b>n.b.</b> <tt>rake install</tt> uses +sudo+
+
+(Problems?  See *Dependencies*, above.)
+
+Now you can run your tests:
+
+    rake test:all                  # Run all test suites.
+    rake test:rails_compatibility  # Test all supported versions of rails.
+
+== Copyright
+
+Copyright (c) 2009 John Trupiano. See LICENSE for details.

data/VERSION.yml

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

data/lib/rails-caddy.rb

@@ -0,0 +1,43 @@
+require 'timecop'
+require 'actionmailer' # would like to remove this
+require 'sanitize_email'
+require 'rails-caddy/errors'
+require 'rails-caddy/controllers/session_editing_controller'
+require 'rails-caddy/controllers/timecop_controller'
+require 'rails-caddy/controllers/sanitize_email_controller'
+require 'rails-caddy/helpers/rails_caddy_helper'
+
+$rails_caddy_activated = false
+
+class RailsCaddy
+  
+  def self.init!
+    # extend ActionController::Base
+    ActionController::Base.send(:include, TimecopController::ActionControllerExtensions)
+    ActionController::Base.send(:include, SanitizeEmailController::ActionControllerExtensions)
+    
+	  # Pull in the RailsCaddyController
+	  require 'rails-caddy/controllers/rails_caddy_controller'
+	      
+    # Lastly, let's add our views to the load path...
+    ActionController::Base.append_view_path(File.expand_path(File.join(File.dirname(__FILE__), "rails-caddy", "views")))
+    
+    # we will inspect this at a few places in the consuming rails app, most notably config/routes.rb
+    $rails_caddy_activated = true
+  end
+  
+  def self.define_routes!(map)
+    # Session editing routes
+    map.update_session '/rails_caddy/update_session/:id', :controller => 'rails_caddy', :action => 'update_session'
+    map.remove_session '/rails_caddy/remove_session/:id', :controller => 'rails_caddy', :action => 'remove_session'
+
+    # Timecop routes
+    map.timecop_update '/rails_caddy/timecop_update', :controller => 'rails_caddy', :action => 'timecop_update'
+    map.timecop_reset '/rails_caddy/timecop_reset', :controller => 'rails_caddy', :action => 'timecop_reset'
+
+    # Sanitize Email routes
+    map.set_sanitize_email_address '/rails_caddy/set_sanitize_email_address', :controller => 'rails_caddy', :action => 'set_sanitize_email_address'
+    map.unset_sanitize_email_address '/rails_caddy/unset_sanitize_email_address', :controller => 'rails_caddy', :action => 'unset_sanitize_email_address'
+  end
+    
+end

data/lib/rails-caddy/controllers/rails_caddy_controller.rb

@@ -0,0 +1,17 @@
+require 'rails-caddy/session_controller_finder'
+
+# Find the controller responsible for establishing session
+session_controller = SessionControllerFinder.find
+
+# Dynamically define the RailsCaddyController now
+c = Class.new(session_controller) do
+  include SessionEditingController
+  include TimecopController
+  include SanitizeEmailController
+  
+  def verify_authenticity_token
+    # this is lame that I have to override it here...can't figure out why a skip_before_filter fails
+  end
+  
+end
+Object.const_set("RailsCaddyController", c)

data/lib/rails-caddy/controllers/sanitize_email_controller.rb

@@ -0,0 +1,42 @@
+module SanitizeEmailController
+  
+  def self.included(base)
+    base.send(:include, Actions)
+  end
+
+  module Actions
+  
+    def set_sanitize_email_address
+      session[:sanitize_email_address] = params[:value]
+      render :status => 200, :text => params[:value]
+    end
+  
+    def unset_sanitize_email_address
+      session[:sanitize_email_address] = nil
+      render :status => 200, :text => "nil"
+    end
+  end
+  
+  module ActionControllerExtensions
+    # def self.included(base)
+    #   base.class_eval do
+    #     around_filter :handle_sanitize_email
+    #   end
+    # end
+    
+    def handle_sanitize_email
+      if session[:sanitize_email_address].nil?
+        yield
+        return
+      end
+      
+      @original_sanitized_recipients = ActionMailer::Base.sanitized_recipients
+      ActionMailer::Base.sanitized_recipients = session[:sanitize_email_address]
+      yield
+    ensure
+      ActionMailer::Base.sanitized_recipients = @original_sanitized_recipients
+    end
+    
+    private :handle_sanitize_email
+  end
+end

data/lib/rails-caddy/controllers/session_editing_controller.rb

@@ -0,0 +1,21 @@
+module SessionEditingController
+
+  def update_session
+    if params[:id].nil?
+      render :status => 422, :text => "Invalid request.  No session variable provided."
+      return false
+    end      
+    session[params[:id].to_sym] = params[:value]
+    render :status => 200, :text => params[:value]
+  end
+  
+  def remove_session
+    if params[:id].nil?
+      render :status => 422, :text => "Invalid request.  Session variable is either missing or invalid."
+      return false
+    end      
+    session[params[:id].to_sym] = nil
+    render :status => 200, :nothing => true
+  end
+
+end

data/lib/rails-caddy/controllers/timecop_controller.rb

@@ -0,0 +1,56 @@
+module TimecopController
+  
+  def self.included(base)
+    # base.class_eval do
+    #   # Make sure we don't reset our own time!
+    #   skip_filter :handle_timecop_offset
+    # end
+    base.send(:include, Actions)
+  end
+
+  module Actions
+    def timecop_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 timecop_reset
+      session[:timecop_adjusted_time] = nil
+      render :status => 200, :nothing => true
+    end
+  end
+  
+  module ActionControllerExtensions
+    # 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
+  
+end

data/lib/rails-caddy/errors.rb

@@ -0,0 +1,8 @@
+class RailsCaddy
+  
+  class SessionUninitializedError < StandardError
+  end
+
+  class SessionControllerNotFoundError < StandardError
+  end
+end

data/lib/rails-caddy/helpers/rails_caddy_helper.rb

@@ -0,0 +1,33 @@
+module RailsCaddyHelper
+  # actually embeds the magic that is the Rails Caddy
+  def rails_caddy
+    render(:partial => '/rails_caddy')
+  end
+  
+  def translated_remove_session_path
+    url = remove_session_path
+    url << "/" unless url.match(/\/$/)
+  end
+  
+  def rc_in_place_editor(key, field_id, url)
+    function =  "RailsCaddy.editors['" + key + "'] = new Ajax.InPlaceEditor("
+    function << "'#{field_id}', "
+    function << "'#{url}'"
+    function << ');'
+
+    javascript_tag(function)
+  end
+  
+  def rc_in_place_editor_field(key, value)
+    tag = ::ActionView::Helpers::InstanceTag.new("rails_caddy", key, self)
+    tag_options = {:tag => "span", :id => "rails_caddy_#{key}_in_place_editor", :name => "value", :class => "in_place_editor_field"}
+    
+    # rails < 2.3 needs to be treated with kid gloves.
+    url = update_session_path
+    url << "/" unless url.match(/\/$/)
+    url << key
+    
+    tag.content_tag(tag_options.delete(:tag), value, tag_options) + rc_in_place_editor(key, tag_options[:id], url)
+  end
+  
+end

data/lib/rails-caddy/session_controller_finder.rb

@@ -0,0 +1,17 @@
+# Responsible for locating the controller responsible for establishing the session
+class SessionControllerFinder
+  def self.find
+    if !Object.const_defined?(:ApplicationController)
+      raise RailsCaddy::SessionControllerNotFoundError, 
+        "Cannot find ApplicationController.  If you're sure that you have defined it, try adding require_dependency 'application_controller' prior to invoking RailsCaddy.init!"
+    end
+    
+    candidate = ApplicationController
+    # if candidate.session_options[:key].nil?
+    #   raise RailsCaddy::SessionUninitializedError, 
+    #     "session does not appear to be established for #{candidate.class}. session: #{candidate.session_options.inspect}"
+    # end
+    
+    candidate
+  end
+end

data/lib/rails-caddy/views/_rails_caddy.html.erb

@@ -0,0 +1,57 @@
+<%= render(:partial => '/rails_caddy_css') %>
+
+<%= render(:partial => '/rails_caddy_js')%>
+
+<div id="railsCaddy">
+	
+	<a href="#" id="railsCaddyTab">caddy</a>
+	
+	<div id="railsCaddyContents" style="display: none;">
+		<div id="railsCaddyContentsInner">
+		  <div id="railsCaddySession">
+		    <h2>Session</h2>
+		    <div id="sessionObjects">
+		      <script type="text/javascript">
+  		    <% (session.data.keys - ["flash", :timecop_adjusted_time, :sanitize_email_address]).each do |key| -%>
+  		      <% next if session[key].nil? -%>
+  		      document.write(RailsCaddy.sessionVariableEditor("<%= escape_javascript(key.to_s) %>", "<%= escape_javascript(session[key].to_s) %>"));
+          <% end -%>
+          </script>
+        </div>
+        <p><a href="javascript:void(0)" onclick="RailsCaddy.addSessionVariable();">+ New Session Variable</a></p>
+		  </div>
+		  
+		  <div id="railsCaddyTimecop">
+		    <h2>Timecop</h2>
+		    <p>The time is <strong style="color: red;"><%= Time.now.to_s(:db) %></strong></p>
+        <% form_remote_tag :url => timecop_update_path do -%>
+          <% %w(year month day hour min sec).each do |field| -%>
+            <%= text_field_tag field, Time.now.send(field), :size => (field == "year" ? 3 : 1) %>
+          <% end -%>
+          <p>
+            <%= submit_tag "Time Travel" %>
+            <%= link_to_remote "Reset", :url => timecop_reset_path %>
+          </p>
+        <% end -%>
+		  </div>
+		  
+		  <div id="railsCaddyEmail">
+		    <h2>Sanitize Email</h2>
+		    <p>All email sent to: <strong style="color: red;"><%= ActionMailer::Base.sanitized_recipients %></strong></p>
+		    <% form_remote_tag :url => set_sanitize_email_address_path do -%>
+		      <%= text_field_tag "value", "", :size => 15 %>
+		      <p>
+		        <%= submit_tag "Change Email" %>
+		        <%= link_to_remote "Unset", :url => unset_sanitize_email_address_path %>
+		      </p>
+		    <% end -%>
+		  </div>
+		  
+		  <div id="railsCaddyStats">
+		    <h2>Stats</h2>
+		  </div>
+		  
+		</div>
+	</div>
+	
+</div>

data/lib/rails-caddy/views/_rails_caddy_css.html.erb

@@ -0,0 +1,60 @@
+<style type="text/css">
+  #railsCaddy {
+    text-align: left;
+  	position: absolute;
+  	width: auto;
+  	height: auto;
+  	top: 100px;
+  	left: 0px;
+  	z-index: 100;
+  	font-family: Helvetica, Arial, Times;
+  }
+
+  #railsCaddyTab {
+  	float: left;
+  	height: 137px;
+  	width: 28px;
+    text-decoration: none;
+  }
+  
+  #railsCaddyTab img {
+    border: none;
+  }
+
+  #railsCaddyContents {
+  	float: left;
+  	overflow: hidden !important;
+  	width: 200px;
+  }
+
+  #railsCaddyContentsInner {
+  	width: 200px;
+  	margin-top: 30px;
+  	font-size: 12px;
+  }
+
+  #railsCaddyContentsInner > div {
+    border: solid 1px red;
+  }
+
+  #railsCaddyContentsInner h2 {
+  	margin: 0px 0px 3px 0px;
+  	padding: 2px;
+  	background-color: #CC3400;
+  	color: #FFFFFF;
+  	font-size: 14px;
+  }
+  
+  #railsCaddySession p {
+    margin-top: 0px;
+    margin-bottom: 4px;
+  }
+  
+  #railsCaddySession p strong {
+    font-size: 110%;
+  }
+  
+  #railsCaddySession a.x {
+    color: red;
+  }
+</style>