debug-bar 1.0.0

data/lib/debug-bar/recipe_book/default.rb

@@ -0,0 +1,34 @@
+require 'pp'
+require 'awesome_print'
+require 'cgi'
+
+module DebugBar
+  module RecipeBook
+    # A default RecipeBook with recipes useful for Rails applications.
+    class Default < Base
+
+      # Displays params in a user readable fashion.
+      #
+      # If the :cutoff option is given, it auto-hides when the params are
+      # more characters in length than the cutoff, otherwise it defaults to
+      # a sane length.
+      def params_recipe(opts={})
+        return Proc.new do |b|
+          params_s = b[:params].awesome_print_html
+          ['Params', params_s, {:id => 'params'}]
+        end
+      end
+
+      # Displays the session in a pretty printed way.
+      def session_recipe
+        return Proc.new {|b| ['Session', b[:session].awesome_print_html, {:id => 'session'}]}
+      end
+
+      # Displays the cookies.
+      def cookies_recipe
+        return Proc.new {|b| ['Cookies', b[:cookies].awesome_print_html, {:id => 'cookies'}]}
+      end
+
+    end
+  end
+end

data/lib/debug-bar/recipe_book.rb

@@ -0,0 +1,2 @@
+require_relative 'recipe_book/base'
+require_relative 'recipe_book/default'

data/lib/debug-bar/version.rb

@@ -0,0 +1,3 @@
+module DebugBar
+  VERSION = '1.0.0'
+end

data/lib/debug-bar.rb

@@ -0,0 +1,6 @@
+require_relative 'debug-bar/ext'
+
+require_relative 'debug-bar/base'
+require_relative 'debug-bar/default'
+
+require_relative 'debug-bar/recipe_book'

data/lib/templates/callback_box.html.erb

@@ -0,0 +1,12 @@
+<div class="callback-box dbar-togglable" style="border:1px solid gray; margin:4px; padding:4px;">
+<% if opts[:id] %>
+  <a href="" id="<%= opts[:id] %>"  class='dbar-toggle persistent'>
+<% else %>
+  <a href="" class='dbar-toggle'>
+<% end %>
+    [x] <span class="title" style="font-weight:bold; color: #000000;"><%= title %></span>
+  </a>
+  <div class="dbar-content <%= 'show' unless opts[:hidden] %>" <%= 'style="display:none"' if opts[:hidden] %> >
+    <%= content %>
+  </div>
+</div>

data/lib/templates/error.html.erb

@@ -0,0 +1,6 @@
+<div class="error">
+  <pre>
+    <%= error.class.to_s.html_escape %>:<%= error.message.to_s.html_escape %>
+  </pre>
+  <%= error.backtrace.awesome_print_html %>
+</div>

data/lib/templates/layout.html.erb

@@ -0,0 +1,142 @@
+<style>
+  .dbar-content pre {
+    background: #a9a9a9;
+    margin: 0;
+    padding: 0;
+    font-size: 10px;
+    font-family: "Lucida Console", Monaco, monospace;
+  }
+
+  .dbar-content pre pre {
+    background: #a9a9a9;
+    margin: 0;
+    padding: 0;
+    border: 0;
+    font-size: 10px;
+    font-family: "Lucida Console", Monaco, monospace;
+    display: inline;
+  }
+
+</style>
+
+<div id="debug-bar" style="text-align:left; border:1px solid yellow; background:#ffffaa; width:24px; position:fixed; top:0; left:0; z-index:999">
+  <a href="" id="debug-toggle">[x]</a>
+  <div id="debug-data" style="font-size:9pt; display:none; overflow:auto;">
+    <%= content %>
+  </div>
+</div>
+
+<script>
+  /*!
+   * jQuery Cookie Plugin
+   * https://github.com/carhartl/jquery-cookie
+   *
+   * Copyright 2011, Klaus Hartl
+   * Dual licensed under the MIT or GPL Version 2 licenses.
+   * http://www.opensource.org/licenses/mit-license.php
+   * http://www.opensource.org/licenses/GPL-2.0
+   */
+  (function($) {
+      $.cookie = function(key, value, options) {
+
+          // key and at least value given, set cookie...
+          if (arguments.length > 1 && (!/Object/.test(Object.prototype.toString.call(value)) || value === null || value === undefined)) {
+              options = $.extend({}, options);
+
+              if (value === null || value === undefined) {
+                  options.expires = -1;
+              }
+
+              if (typeof options.expires === 'number') {
+                  var days = options.expires, t = options.expires = new Date();
+                  t.setDate(t.getDate() + days);
+              }
+
+              value = String(value);
+
+              return (document.cookie = [
+                  encodeURIComponent(key), '=', options.raw ? value : encodeURIComponent(value),
+                  options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
+                  options.path    ? '; path=' + options.path : '',
+                  options.domain  ? '; domain=' + options.domain : '',
+                  options.secure  ? '; secure' : ''
+              ].join(''));
+          }
+
+          // key and possibly options given, get cookie...
+          options = value || {};
+          var decode = options.raw ? function(s) { return s; } : decodeURIComponent;
+
+          var pairs = document.cookie.split('; ');
+          for (var i = 0, pair; pair = pairs[i] && pairs[i].split('='); i++) {
+              if (decode(pair[0]) === key) return decode(pair[1] || ''); // IE saves cookies with empty string as "c; ", e.g. without "=" as opposed to EOMB, thus pair[1] may be undefined
+          }
+          return null;
+      };
+  })(jQuery);
+</script>
+<script>
+  jQuery('document').ready(function(){
+    var toggleDebugBar = function(){
+      var data = jQuery('#debug-data').toggle();
+      jQuery('#debug-bar').css('width',  data.is(':visible') ? 'auto' : '24px');
+      jQuery('#debug-bar').css('max-height', data.is(':visible') ? '100%' : '24px');
+      jQuery('#debug-bar').css('overflow-y', data.is(':visible') ? 'auto' : 'hidden');
+    };
+
+    jQuery('#debug-toggle').on('click', function(e){
+      toggleDebugBar();
+      return false;
+    });
+
+    jQuery('body').bind('keydown', function(e){
+      if(e.keyCode == 192 && e.ctrlKey == true)
+        toggleDebugBar();
+    });
+    
+    // Debug-bar section specific toggle (may differ from generic toggle.
+    // This is meant to be consumable by callback makers.
+    jQuery('.dbar-toggle').bind('click', function(){
+      var toggle = jQuery(this); 
+      var content = toggle.closest('.dbar-togglable').find('.dbar-content');
+      content.first().toggle(); 
+      return false;
+    });
+
+    // Generic togglable inside of debug bar callback content area.
+    jQuery('.dbar-content').find('.toggle-switch').click(function(){
+      var toggle_content = jQuery(this).siblings('.toggle-content');
+      toggle_content.toggle();
+      return false;
+    });
+    
+    jQuery('.callback-box .dbar-toggle.persistent').bind('click', function() {
+      // caching
+      var toggle = jQuery(this);
+      var id = toggle.attr('id');
+      
+      // Deal with an empty cookie and split the commas
+      var debug_bar_array = jQuery.cookie('debug_bar') ? jQuery.cookie('debug_bar').split(',') : [];
+      
+      // Just a double check it has an id
+      if (id)
+      {
+        // Decide which way to toggle this key
+        var id_index = debug_bar_array.indexOf(id);
+        if (id_index > -1)
+        {
+          // Remove id from cookie 
+          debug_bar_array.splice(id_index, 1);
+        }
+        else
+        {
+          // Add the id into the list to keep open
+          debug_bar_array.push(id);
+        }
+        
+        // Rejoin the cookie keys and store
+        jQuery.cookie('debug_bar', debug_bar_array.join(','), { path: '/', expires: 7 });
+      } 
+    });
+  });
+</script>

data/spec/base_spec.rb

@@ -0,0 +1,363 @@
+require 'spec_helper'
+
+
+class TestDefaultRecipeBook < DebugBar::RecipeBook::Base
+
+      def params_recipe(opts={})
+        return Proc.new do |b|
+          params_s = b[:params].awesome_print_html
+          hidden = params_s.length > opts.fetch(:cutoff, 512)
+          puts [params_s.length, hidden, opts].inspect
+          ['Params', params_s, {:hidden => hidden, :id => 'params'}]
+        end
+      end
+
+      def block_test_recipe(arg=nil)
+        return Proc.new do |b|
+          ['Block Test', "|arg|#{arg}|arg| |block|#{yield(b) if block_given?}|block|", {}]
+        end
+      end
+
+end
+
+describe DebugBar::Base do
+
+  describe 'callbacks' do
+
+    before(:each) do
+      @debug_bar = DebugBar::Base.new
+    end
+
+    it 'should register recipes in initializer after the block is called' do
+      debug_bar = DebugBar::Base.new(:params) do |bar|
+        bar.add_recipe_book(TestDefaultRecipeBook)
+        bar.callbacks.length.should == 0
+      end
+
+      debug_bar.callbacks.length.should == 1
+    end
+
+
+    it 'should register blocks' do
+      @debug_bar.add {|b| ["Test Block", "Test Content", {}]}
+
+      @debug_bar.callbacks.length.should == 1
+      @debug_bar.callbacks.first.should be_kind_of(Proc)
+    end
+
+    it 'should register recipes' do
+      @debug_bar.add_recipe_book(TestDefaultRecipeBook)
+      @debug_bar.add(:params)
+
+      @debug_bar.callbacks.length.should == 1
+      @debug_bar.callbacks.first.should be_kind_of(Proc)
+    end
+
+    it 'should error on nil' do
+      lambda {@debug_bar.add(nil)}.should raise_error(ArgumentError)
+    end
+
+  end
+
+  describe 'render' do
+
+    before(:each) do
+      @debug_bar = DebugBar::Base.new
+    end
+
+    it 'should render blocks' do
+      title = "Testing The Block"
+      content = "<pre>Alpha Beta</pre>"
+      @debug_bar.add {|b| [title, content, {}]}
+
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+      html.should_not be_empty
+
+      html.index(title).should_not be_nil
+      html.index(content).should_not be_nil
+    end
+
+    it 'should render as html_safe string' do
+      @debug_bar.add {|b| ["foo", "bar", {}]}
+      html = @debug_bar.render(binding)
+      html.should be_kind_of(ActiveSupport::SafeBuffer)
+    end
+
+    it 'should render with a given binding' do
+      @debug_bar.add {|b| ["Title", "||#{b.eval('foobar')}||", {}]}
+
+      foobar = "Spoilers!"
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+
+      html.index(foobar).should_not be_nil
+    end
+
+    it 'should render with a custom decorated binding' do
+      @debug_bar.add {|b| ["Binding", "||get is #{b.respond_to?(:[])}||", {}]}
+
+      binding.should_not respond_to(:[])
+      html = @debug_bar.render(binding)
+
+      html.index("||get is true||").should_not be_nil
+    end
+
+    it 'should render recipes' do
+      @debug_bar.add_recipe_book(TestDefaultRecipeBook)
+      @debug_bar.add(:params)
+      params = {:given_name => 'Amelia', :family_name => 'Pond'} 
+
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+      html.should_not be_empty
+
+      html.index('Amelia').should_not be_nil
+      html.index(':given_name').should_not be_nil
+      html.index('dbar-content show').should_not be_nil # See if params was expanded.
+    end
+
+    it 'should render recipes with args' do
+      @debug_bar.add_recipe_book(TestDefaultRecipeBook)
+      @debug_bar.add(:params, :cutoff => 12)
+
+      params = {:given_name => 'Amelia', :family_name => 'Pond'}
+
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+      html.should_not be_empty
+
+      html.index('Amelia').should_not be_nil
+      html.index(':given_name').should_not be_nil
+      html.index('dbar-content show').should be_nil # See if params was collapsed due to cutoff.
+    end
+
+    it 'should render recipes with block args' do
+      @debug_bar.add_recipe_book(TestDefaultRecipeBook)
+      @debug_bar.add(:block_test) {|b| b.class.name}
+
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+      html.should_not be_empty
+
+      html.index('|block|Binding|block|').should_not be_nil
+    end
+
+    it 'should render the callback_box' do
+      @debug_bar.add {|b| ["foo", "bar", {}]}
+      html = @debug_bar.render(binding)
+
+      html.index('callback-box').should_not be_nil # Picked the CSS class as a good indicator of presence.
+    end
+
+    it 'should render the layout' do
+      @debug_bar.add {|b| ["foo", "bar", {}]}
+      html = @debug_bar.render(binding)
+
+      html.index('debug-bar').should_not be_nil # Picked the presence of CSS class as a good inidcator of presence.
+    end
+
+    it 'should render on crash in callback' do
+      @debug_bar.add {|b| raise RuntimeError, "Uh-oh, you didn't handle the exception!"}
+      html = ''
+      lambda {html = @debug_bar.render(binding)}.should_not raise_error
+      html.index('ERROR').should_not be_nil
+    end
+
+  end
+
+  describe 'options' do
+
+    before(:each) do
+      @debug_bar = DebugBar::Base.new
+    end
+
+    it 'should interpret missing opts from callback as {}' do
+      @debug_bar.add {|b| ['foo', 'bar']}
+
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+      html.should_not be_empty
+
+      html.index('foo').should_not be_nil
+      html.index('bar').should_not be_nil
+    end
+
+    it 'should interpret nil opts from callback as {}' do
+      @debug_bar.add {|b| ['foo', 'bar', nil]}
+
+      html = @debug_bar.render(binding)
+
+      html.should be_kind_of(String)
+      html.should_not be_empty
+
+      html.index('foo').should_not be_nil
+      html.index('bar').should_not be_nil
+    end
+
+    it 'should default :hidden option to true if not explicitly given and session remembers it as open based on id' do
+      # Emulate saving of open callback box ids in cookies.
+      cookies = {:debug_bar => 'rory_williams,amelia_pond'}
+      # Put into binding.
+      b = binding
+
+      html_rory = DebugBar::Base.new.add {|b| ['foo', 'bar', :id => 'rory_williams']}.render(b)
+      html_rose = DebugBar::Base.new.add {|b| ['foo', 'bar', :id => 'rose_tyler']}.render(b)
+
+      # Extract the classes from the first div that has a dbar-content class in it.
+      extract_classes = lambda do |html|
+        m = /<div[^>]+class=['"]([^>'"]*dbar-content[^>'"]*)[^>]+>/.match(html)
+        return m.to_a[1].to_s.split(/\s+/)
+      end
+
+      html_rory.should include('show')
+      html_rose.should_not include('show')
+    end
+
+    it 'should recognize :hidden options' do
+      html_hidden = DebugBar::Base.new.add {|b| ['foo', 'bar', :hidden => true]}.render(binding)
+      html_nohide = DebugBar::Base.new.add {|b| ['foo', 'bar', :hidden => false]}.render(binding)
+
+      # Extract the classes from the first div that has a dbar-content class in it.
+      extract_classes = lambda do |html|
+        m = /<div[^>]+class=['"]([^>'"]*dbar-content[^>'"]*)[^>]+>/.match(html)
+        return m.to_a[1].to_s.split(/\s+/)
+      end
+
+      extract_classes.call(html_hidden).should_not include('show')
+      extract_classes.call(html_nohide).should include('show')
+    end
+
+  end
+
+  describe 'recipe books' do
+
+    class TestBook < DebugBar::RecipeBook::Base
+      def duplicated_recipe
+        Proc.new {|b| :test_book_duplicated_recipe}
+      end
+
+      def beta_recipe
+        Proc.new {|b| :test_book_beta_recipe}
+      end
+
+      def some_helper
+      end
+    end
+
+    class AnotherTestBook < DebugBar::RecipeBook::Base
+      def duplicated_recipe
+        Proc.new {|b| :another_test_book_duplicated_recipe}
+      end
+
+      def gamma_recipe
+        Proc.new {|b| :another_test_book_gamma_recipe}
+      end
+    end
+
+    before(:each) do
+      @book_class = TestBook # TODO: This is a poor choice, we should create one just for testing.
+      @book = @book_class.new
+
+      @base_debug_bar = DebugBar::Base.new
+      @debug_bar = DebugBar::Base.new {|bar| bar.add_recipe_book(TestBook); bar.add_recipe_book(AnotherTestBook)}
+    end
+
+    it 'should add recipe books by class' do
+      @base_debug_bar.add_recipe_book(@book_class)
+
+      @base_debug_bar.recipe_books.length.should == 1
+      @base_debug_bar.recipe_books.first.should be_kind_of(@book_class)
+    end
+
+    it 'should add recipe books by instance' do
+      @base_debug_bar.add_recipe_book(@book)
+
+      @base_debug_bar.recipe_books.length.should == 1
+      @base_debug_bar.recipe_books.first.should be_kind_of(@book_class)
+    end
+
+    it 'should return the list of known recipes' do
+      @debug_bar.recipes.sort.should == [:beta, :duplicated, :gamma].sort
+    end
+
+    it 'should return a recipe callback if one is found' do
+      callback = @debug_bar.recipe_callback(:beta)
+      callback.should be_kind_of(Proc)
+      callback.call.should == :test_book_beta_recipe
+    end
+
+    it 'should raise an Argument Error if a recipe is not found' do
+      lambda {@debug_bar.recipe_callback(:zeta)}.should raise_error(ArgumentError)
+    end
+
+    it 'should use the last found instance of a recipe when it is duplicated' do
+      callback = @debug_bar.recipe_callback(:duplicated)
+      callback.should be_kind_of(Proc)
+      callback.call.should == :another_test_book_duplicated_recipe
+    end
+
+  end
+
+  describe 'subclass overrides' do
+
+    class SubclassTestBook < DebugBar::RecipeBook::Base
+
+      def beta_recipe
+        Proc.new {|b| :test_book_beta_recipe}
+      end
+
+    end
+
+    class SubclassInstanceTestBook < DebugBar::RecipeBook::Base
+
+      def foo_recipe
+        Proc.new {|b| :instance_test_book_foo_recipe}
+      end
+
+    end
+
+    class SubclassTestBar < DebugBar::Base
+
+      private
+
+      def default_recipe_books
+        return [SubclassTestBook, SubclassInstanceTestBook.new]
+      end
+
+      def default_recipes
+        return [:beta]
+      end
+
+      def template_search_paths
+        return :standin_for_an_array_of_pathnames
+      end
+
+    end
+
+    before(:each) do
+      @debug_bar = SubclassTestBar.new
+    end
+
+    it 'should add recipe books from the default recipe books method' do
+      @debug_bar.recipe_books.length.should == 2
+      @debug_bar.recipe_books.each {|book| book.should be_kind_of(DebugBar::RecipeBook::Base)}
+    end
+
+    it 'should add recipes from the default recipe method' do
+      @debug_bar.recipes.sort.should == [:beta, :foo].sort
+    end
+
+    it 'should allow overriding of the template path' do
+      @debug_bar.send(:template_search_paths).should == :standin_for_an_array_of_pathnames
+    end
+
+  end
+
+end

data/spec/binding_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+class TestContext
+  TARDIS = :tardis
+  @@gallifrey = :gallifrey
+  $the_doctor = :the_doctor
+
+  def get_binding
+    amelia_pond = :amelia_pond
+    @river_song = :river_song
+
+    return binding
+  end
+end
+
+describe DebugBar::Ext::Binding do
+
+  describe '[] method' do
+
+    before(:all) do
+      @binding = TestContext.new.get_binding
+      @binding.extend(DebugBar::Ext::Binding)
+    end
+
+    it 'should exist on binding' do
+      @binding.should respond_to(:[])
+    end
+
+    it 'should get local variables' do
+      @binding[:amelia_pond].should == :amelia_pond
+      @binding['amelia_pond'].should == :amelia_pond
+    end
+
+    it 'should get instance varaibles' do
+      @binding[:@river_song].should == :river_song
+      @binding['@river_song'].should == :river_song
+    end
+
+    it 'should get global variables' do
+      @binding[:$the_doctor].should == :the_doctor
+      @binding['$the_doctor'].should == :the_doctor
+    end
+
+    it 'should get constants' do
+      @binding[:TARDIS].should == :tardis
+      @binding['TARDIS'].should == :tardis
+    end
+
+    it 'should get class variables' do
+      @binding[:@@gallifrey].should == :gallifrey
+      @binding['@@gallifrey'].should == :gallifrey
+    end
+
+    it 'should not perform arbirary code' do
+      lambda {@binding['1+1']}.should raise_error(NameError)
+      lambda {@binding['amelia_pond.class']}.should raise_error(NameError)
+      lambda {@binding['def foo']}.should raise_error(NameError)
+    end
+
+  end
+
+end