rails_debugging_toolbar 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rails_debugging_toolbar.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    rails_debugging_toolbar (0.0.1)
+      actionpack (>= 2.3.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 2.3.5)
+  rails_debugging_toolbar!

data/History.txt

@@ -0,0 +1,5 @@
+
+== 0.0.2 (2011-01-31)
+
+Initial gem release.
+

data/README.markdown

@@ -0,0 +1,87 @@
+# Render Debugging Toolbar for Rails
+
+If you are looking at the front end of a Rails app and see something you want to
+work on, there are several ways you might answer the question:
+
+## Which template is rendering that particular chunk of HTML?
+
+If you have simple views, logical markup and your URLs map very quickly to
+views, then you can probably just open your editor and guess pretty much
+exactly where you need to edit. You're in the Rails happy place, and you
+probably don't need a tool to help you.
+
+If you're working on a less-happy Rails application, however, you might have
+some of the following impediments:
+
+ * hundreds of similarly-named views
+ * complex views with partials within partials
+ * URLs that don't map so easily quickly and obviously to view filenames
+ * markup without obviously unique patterns to search for
+
+I was in this situation recently; I found myself wishing for something
+to just tell me where the HTML was coming from.
+
+# The Render Debugging Toolbar helps you find your view
+
+There are tools that let you interactively point at the different parts of
+your page and tell you a bunch of back-end information.
+
+Drupal has the [Drupal Theme Developer][1], Django has the
+[Django Debug Toolbar][2], but I couldn't find anything to
+help me out when I asked Rails the same question of this Rails app:
+"What is generating that HTML right there?"
+
+The Render Debugging Toolbar aims to be that tool for Rails.
+
+# Installation
+
+  Add the following to the "development" group in your Gemfile:
+    gem "rails-render-debugging-toolbar"
+  Bundler will take care of the rest when you run
+    bundle install
+  
+  If you're not using Bundler, you won't have a Gemfile, so you'll need
+  to install the gem manually.
+
+# Usage
+
+The toolbar needs a lot of extra markup to do its work, so you probably won't
+want to leave it enabled all the time. You can turn it on for a single request
+by adding the query parameter "?debug=render" to a request.
+
+For example, if you are interested in the page:
+
+    http://localhost:3000/examples/new
+
+You can try the toolbar by visiting the following:
+
+    http://localhost:3000/examples/new?template_debug
+
+When the toolbar is enabled, you should see a little debugging checkbox overlaid
+on top of the normal page. Switch it on, and then everything you point at should
+show a panel of debugging information about what rendered it.
+
+Simply point at the element you're interested in, and the panel will tell you
+where the view is.
+
+
+
+[1]: http://drupal.org/project/devel_themer
+[2]: https://github.com/robhudson/django-debug-toolbar
+
+
+# License
+
+Copyright 2011 Rob Hunter and ThoughtWorks, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/ext/action_controller.rb

@@ -0,0 +1,10 @@
+
+class ActionController::Base
+  private
+  def assign_shortcuts_with_debugging_toolbar_support(request, response)
+    assign_shortcuts_without_debugging_toolbar_support(request, response)
+    response.template.extend(RailsDebuggingToolbar::Extensions::ActionView) if request.parameters.has_key?(:template_debug)
+  end
+  alias_method_chain :assign_shortcuts, :debugging_toolbar_support
+end
+

data/lib/rails_debugging_toolbar/version.rb

@@ -0,0 +1,3 @@
+module RailsDebuggingToolbar
+  VERSION = "0.0.2"
+end

data/lib/rails_debugging_toolbar.rb

@@ -0,0 +1,211 @@
+require 'ext/action_controller'
+module RailsDebuggingToolbar
+  module Extensions
+    module ActionView
+      def render(options = {}, local_assigns = {}, &block)
+        actual_output = super(options, local_assigns, &block)
+        id = next_available_render_id
+
+        on_entering_render
+        record_render_details(id, options, local_assigns)
+        on_leaving_render
+
+        return debug_log_after_body(actual_output) if at_outer_level_render?
+
+        wrapped_output(actual_output, id)
+      end
+
+      private
+      attr_writer :my_render_depth
+      def render_partial(options = {})
+        actual_output = super(options)
+        id = next_available_render_id
+
+        on_entering_render
+        record_render_details(id, options, {})
+        on_leaving_render
+
+        wrapped_output(actual_output, id)
+      end
+
+      def on_entering_render
+        self.my_render_depth = my_render_depth.succ
+      end
+      def on_leaving_render
+        self.my_render_depth = my_render_depth.pred
+      end
+
+      def wrapped_output(actual_output, id)
+        ERB.new(<<-HTML).result(binding)
+          <span class='render-debug partial' id='render-debug-wrapper-<%= h id %>'>
+            <%= actual_output %>
+          </span>
+        HTML
+      end
+
+      def debug_log_after_body(actual_output)
+        debug_log = ERB.new(<<-HTML).result(binding)
+          <div class='render-debug' id='debug-log'>
+            <% recorded_render_details.each_pair do |id, stuff| %>
+              <%
+              recorded_options = stuff[:options]
+              locals = recorded_options[:locals] || {}
+              partial = recorded_options[:partial] || "unknown"
+              unrecognized_options = recorded_options.reject do |option_name, option_value|
+                [:locals, :partial].include? option_name
+              end
+              %>
+              <div class="render-debug render-detail" id="render-debug-detail-<%= h id %>">
+                <h3><label for="render-debug-wrapper-<%= h id %>"><code><%= h partial %></code></label></h3>
+                <% if locals.any? %>
+                  <h4><label for="render-debug-locals-<%= h id %>">Locals</label></h4>
+                  <dl>
+                    <% locals.each_pair do |local_name, local_value| %>
+                      <dt><%= h local_name %></dt>
+                      <dd><code><%= h local_value.inspect %></code></dd>
+                    <% end %>
+                  </dl>
+                <% end %>
+
+                <% if unrecognized_options.any? %>
+                  <h4><label for="render-debug-options-<%= h id %>">Other options</label></h4>
+                  <dl>
+                    <% unrecognized_options.each_pair do |option_name, option_value| %>
+                      <dt><%= h option_name %></dt>
+                      <dd><%= h option_value.inspect %></dd>
+                    <% end %>
+                  </dl>
+                <% end %>
+              </div>
+            <% end %>
+          </div>
+          <form action="#" class="render-debug debug-show">
+            <input type="checkbox" id="enable-debug-detail-checkbox" name="render" value="debug" />
+            <label for="enable-debug-detail-checkbox">Show rendering details</label>
+            <input type="checkbox" id="debug-follows-cursor-checkbox" name="follow_cursor" value="yes" />
+            <label for="debug-follows-cursor-checkbox">Show rendering details</label>
+          </form>
+          <style type="text/css">
+            #debug-log {
+              display: block; position: absolute; top: 0px; right: 0px; top: 0px; width: 300px; z-index: -1000;
+              background: transparent;
+              font-family: sans-serif;
+              text-align: left;
+              color: #ccc;
+              border: none;
+            }
+            #debug-log.active {
+              display: block; position: fixed; top: 0px; right: 0px; top: 0px; width: 300px; z-index: 1000;
+              background: black; opacity: 0.8;
+              border: thin solid white;
+            }
+            #debug-log .render-detail {
+              display: none;
+            }
+            #debug-log .render-detail.active {
+              display: block;
+              border-top: thin dashed #777;
+              padding-bottom: 1ex;
+              padding-top: 1ex;
+            }
+            #debug-log h1,
+            #debug-log h2,
+            #debug-log h3,
+            #debug-log h4,
+            #debug-log h5,
+            #debug-log h6
+            {
+              font-weight: bold;
+              display: block;
+              padding-top: 1ex;
+              font-size: 20px;
+              color: white;
+            }
+            #debug-log h3
+            {
+              color: #f13;
+              text-align: center;
+              height: auto;
+              width: 80%;
+              padding-left: 1em;
+              padding-right: 1em;
+            }
+            #debug-log code {
+              white-space: pre;
+            }
+            #debug-log dl {
+              display: block;
+            }
+            #debug-log dt {
+              display: block;
+              margin-left: 0px;
+              font-weight: bold;
+              float: left;
+              width: 8em;
+              word-break: break-all;
+              overflow: hidden;
+            }
+            #debug-log dd {
+              display: block;
+              margin-left: 2px;
+              max-height: 4ex;
+              overflow: hidden;
+            }
+            form.debug-show {
+              display: block; position: fixed; bottom: 0px; left: 0px; width: 100px; z-index: 1000;
+              background: black; opacity: 1.0;
+              border: thin solid white;
+            }
+          </style>
+          
+          <script type="text/javascript">
+          (function ($) {
+            $(function() {
+              var checkbox = $("input#enable-debug-detail-checkbox");
+              
+              checkbox.change(function() {
+                if ($(this).is(':checked')) {
+                  $("#debug-log").addClass("active");
+                  $(".render-debug.partial").hover(function() {
+                    var detail_div = $("label[for=" + this.id + "]").parents("#debug-log .render-detail");
+                    detail_div.addClass("active");
+                  }, function() {
+                    var detail_div = $("label[for=" + this.id + "]").parents("#debug-log .render-detail");
+                    detail_div.removeClass("active");
+                  });
+                } else {
+                  $("#debug-log").removeClass("active");
+                  $(".render-debug.partial").unbind();
+                }
+              });
+            });
+          })(jQuery);
+          </script>
+        HTML
+        actual_output.sub("</body>", debug_log + "</body>".html_safe!)
+      end
+
+      def my_render_depth
+        @some_render_depth ||= 0
+      end
+
+      def at_outer_level_render?
+        (my_render_depth == 0)
+      end
+
+      def next_available_render_id
+        @render_id_counter ||= 0
+        @render_id_counter += 1 # XXX: totally not thread safe
+        @render_id_counter
+      end
+
+      def record_render_details(id, options, local_assigns)
+        recorded_render_details[id] = {:options => options, :local_assigns => local_assigns}
+      end
+
+      def recorded_render_details
+        @recorded_render_details ||= {}
+      end
+    end
+  end
+end

data/rails_debugging_toolbar.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_debugging_toolbar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_debugging_toolbar"
+  s.version     = RailsDebuggingToolbar::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rob Hunter"]
+  s.email       = ["rhunter@thoughtworks.com"]
+  s.homepage    = ""
+  s.summary     = %q{Use your browser to find which template rendered some HTML}
+  s.description = %q{This tool helps you dig deeper through the Rails rendering stack using just your browser.}
+
+  s.rubyforge_project = "rails_debugging_toolbar"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "actionpack", ">= 2.3.5"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: rails_debugging_toolbar
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Rob Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+description: This tool helps you dig deeper through the Rails rendering stack using just your browser.
+email: 
+- rhunter@thoughtworks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- History.txt
+- README.markdown
+- Rakefile
+- lib/ext/action_controller.rb
+- lib/rails_debugging_toolbar.rb
+- lib/rails_debugging_toolbar/version.rb
+- rails_debugging_toolbar.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rails_debugging_toolbar
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Use your browser to find which template rendered some HTML
+test_files: []
+