rack-bug 0.2.1 → 0.3.0

data/History.txt

@@ -0,0 +1,21 @@
+== 0.3.0 / 2010-05-28
+
+  * New features
+
+    * Log panel includes log level and timestamp (Tim Connor)
+    * Sphinx panel (George Chatzigeorgiou)
+    * Backtraces for Redis panel (Luke Melia & Joey Aghion)
+
+  * Minor fixes
+
+    * Don't "enable" rack bug if you hit cancel on the bookmarklet prompt (Mischa Fierer)
+
+  * Compatibilty
+
+    * backtrace filtering now supports more than just Rails (Alex Chaffee)
+    * compatibility with current rack-test (Luke Melia & Joey Aghion)
+    * update Sinatra sample app (Tim Conner)
+
+== 0.2.1
+
+  * The beginning of recorded history

data/README.md

@@ -0,0 +1,115 @@
+Rack::Bug
+=========
+
+* Repository: [http://github.com/brynary/rack-bug](http://github.com/brynary/rack-bug)
+
+Description
+-----------
+
+Rack::Bug adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
+allowing exploration of logging, database queries, template rendering times, etc.
+
+Features
+--------
+
+* Password-based security
+* IP-based security
+* Rack::Bug instrumentation/reporting is broken up into panels.
+    * Panels in default configuration:
+        * Rails Info
+        * Timer
+        * Request Variables
+        * SQL
+        * Active Record
+        * Cache
+        * Templates
+        * Log
+        * Memory
+    * Other bundled panels:
+        * Redis
+        * Sphinx
+    * The API for adding your own panels is simple and powerful
+
+Rails quick start
+---------------------------
+
+    script/plugin install git://github.com/brynary/rack-bug.git
+
+In config/environments/development.rb, add:
+
+    config.middleware.use "Rack::Bug",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
+
+Add the bookmarklet to your browser:
+
+    open http://RAILS_APP/__rack_bug__/bookmarklet.html
+
+Using with non-Rails Rack apps
+------------------------------
+Nothing should prevent this from being possible. Please contribute docs if you do this. :-)
+
+Configuring custom panels
+-------------------------
+
+Specify the set of panels you want, in the order you want them to appear:
+
+    require "rack/bug"
+
+    ActionController::Dispatcher.middleware.use Rack::Bug,
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :panel_classes => [
+        Rack::Bug::TimerPanel,
+        Rack::Bug::RequestVariablesPanel,
+        Rack::Bug::RedisPanel,
+        Rack::Bug::TemplatesPanel,
+        Rack::Bug::LogPanel,
+        Rack::Bug::MemoryPanel
+      ]
+
+
+Running Rack::Bug in staging or production
+------------------------------------------
+
+We have have found that Rack::Bug is fast enough to run in production for specific troubleshooting efforts.
+
+### Configuration ####
+
+Add the middleware configuration to an initializer or the appropriate environment files, taking the rest of this section into consideration.
+
+### Security ####
+
+Restrict access to particular IP addresses:
+
+    require "ipaddr"
+
+    ActionController::Dispatcher.middleware.use "Rack::Bug"
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :ip_masks   => [IPAddr.new("2.2.2.2/0")]
+
+Restrict access using a password:
+
+    ActionController::Dispatcher.middleware.use "Rack::Bug",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :password   => "yourpassword"
+
+
+Authors
+-------
+
+- Maintained by [Bryan Helmkamp](mailto:bryan@brynary.com)
+- Contributions from Luke Melia, Joey Aghion, and more
+
+Thanks
+------
+Inspiration for Rack::Bug is primarily from the Django debug toolbar. Additional ideas from Rails footnotes, Rack's ShowException middleware, Oink, and Rack::Cache
+
+Thanks to Weplay.com for supporting the development of Rack::Bug
+
+Development
+-----------
+For development, you'll need to install the following gems: rspec, rack-test, webrat, sinatra
+
+License
+-------
+
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -1,24 +1,6 @@
 require "rubygems"
 require "spec/rake/spectask"
 
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
-require "rack/bug"
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name      = "rack-bug"
-    s.author    = "Bryan Helmkamp"
-    s.email     = "bryan" + "@" + "brynary.com"
-    s.homepage  = "http://github.com/brynary/rack-bug"
-    s.summary   = "Debugging toolbar for Rack applications implemented as middleware"
-    # s.description  = "TODO"
-    s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
-
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
 end
@@ -33,4 +15,9 @@ Spec::Rake::SpecTask.new(:rcov) do |t|
 end
 
 desc "Run the specs"
-task :default => :spec
+task :default => :spec
+
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/Thorfile

@@ -0,0 +1,109 @@
+module GemHelpers
+
+  def generate_gemspec
+    $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
+    require "rack/bug"
+
+    Gem::Specification.new do |s|
+      s.name      = "rack-bug"
+      s.version   = Rack::Bug::VERSION
+      s.author    = "Bryan Helmkamp"
+      s.email     = "bryan@brynary.com"
+      s.homepage  = "http://github.com/brynary/rack-bug"
+      s.summary   = "Debugging toolbar for Rack applications implemented as middleware"
+      # s.description  = "TODO"
+      s.rubyforge_project = "rack-bug"
+
+      require "git"
+      repo = Git.open(".")
+
+      s.files      = normalize_files(repo.ls_files.keys - repo.lib.ignored_files)
+      s.test_files = normalize_files(Dir['spec/**/*.rb'] - repo.lib.ignored_files)
+
+      s.has_rdoc = true
+      s.extra_rdoc_files = %w[README.md MIT-LICENSE.txt]
+
+      s.add_dependency "rack", ">= 1.0"
+    end
+  end
+
+  def normalize_files(array)
+    # only keep files, no directories, and sort
+    array.select do |path|
+      File.file?(path)
+    end.sort
+  end
+
+  # Adds extra space when outputting an array. This helps create better version
+  # control diffs, because otherwise it is all on the same line.
+  def prettyify_array(gemspec_ruby, array_name)
+    gemspec_ruby.gsub(/s\.#{array_name.to_s} = \[.+?\]/) do |match|
+      leadin, files = match[0..-2].split("[")
+      leadin + "[\n    #{files.split(",").join(",\n   ")}\n  ]"
+    end
+  end
+
+  def read_gemspec
+    @read_gemspec ||= eval(File.read("rack-bug.gemspec"))
+  end
+
+  def sh(command)
+    puts command
+    system command
+  end
+end
+
+class Default < Thor
+  include GemHelpers
+
+  desc "gemspec", "Regenerate rack-bug.gemspec"
+  def gemspec
+    File.open("rack-bug.gemspec", "w") do |file|
+      gemspec_ruby = generate_gemspec.to_ruby
+      gemspec_ruby = prettyify_array(gemspec_ruby, :files)
+      gemspec_ruby = prettyify_array(gemspec_ruby, :test_files)
+      gemspec_ruby = prettyify_array(gemspec_ruby, :extra_rdoc_files)
+
+      file.write gemspec_ruby
+    end
+
+    puts "Wrote gemspec to rack-bug.gemspec"
+    read_gemspec.validate
+  end
+
+  desc "build", "Build a rack-bug gem"
+  def build
+    sh "gem build rack-bug.gemspec"
+    FileUtils.mkdir_p "pkg"
+    FileUtils.mv read_gemspec.file_name, "pkg"
+  end
+
+  desc "install", "Install the latest built gem"
+  def install
+    sh "gem install --local pkg/#{read_gemspec.file_name}"
+  end
+
+  desc "release", "Release the current branch to GitHub and Gemcutter"
+  def release
+    gemspec
+    build
+    Release.new.tag
+    Release.new.gem
+  end
+end
+
+class Release < Thor
+  include GemHelpers
+
+  desc "tag", "Tag the gem on the origin server"
+  def tag
+    release_tag = "v#{read_gemspec.version}"
+    sh "git tag -a #{release_tag} -m 'Tagging #{release_tag}'"
+    sh "git push origin #{release_tag}"
+  end
+
+  desc "gem", "Push the gem to Gemcutter"
+  def gem
+    sh "gem push pkg/#{read_gemspec.file_name}"
+  end
+end

data/lib/rack/bug.rb

@@ -1,6 +1,7 @@
 require "rack"
 
 module Rack::Bug
+  autoload :FilteredBacktrace,      "rack/bug/filtered_backtrace"
   autoload :Options,                "rack/bug/options"
   autoload :Panel,                  "rack/bug/panel"
   autoload :PanelApp,               "rack/bug/panel_app"
@@ -19,8 +20,9 @@ module Rack::Bug
   autoload :SQLPanel,               "rack/bug/panels/sql_panel"
   autoload :TemplatesPanel,         "rack/bug/panels/templates_panel"
   autoload :TimerPanel,             "rack/bug/panels/timer_panel"
+  autoload :SphinxPanel,            "rack/bug/panels/sphinx_panel"
 
-  VERSION = File.read(File.join(File.dirname(__FILE__), "..", "..", "VERSION")).strip
+  VERSION = "0.3.0"
 
   class SecurityError < StandardError
   end
@@ -40,4 +42,4 @@ module Rack::Bug
   def self.new(*args, &block)
     Toolbar.new(*args, &block)
   end
-end
+end

data/lib/rack/bug/filtered_backtrace.rb

@@ -0,0 +1,38 @@
+module Rack
+  module Bug
+    module FilteredBacktrace
+
+      def backtrace
+        @backtrace
+      end
+
+      def has_backtrace?
+        filtered_backtrace.any?
+      end
+
+      def filtered_backtrace
+        @filtered_backtrace ||= @backtrace.map{|l| l.to_s.strip }.select do |line|
+          root_for_backtrace_filtering.nil? ||
+          (line.index(root_for_backtrace_filtering) == 0) && !(line.index(root_for_backtrace_filtering("vendor")) == 0)
+        end
+      end
+
+      def root_for_backtrace_filtering(sub_path = nil)
+        if defined?(Rails) && Rails.respond_to?(:root)
+          sub_path ? Rails.root.join(sub_path) : Rails.root
+        else
+          root = if defined?(RAILS_ROOT)
+            RAILS_ROOT
+          elsif defined?(ROOT)
+            ROOT
+          elsif defined?(Sinatra::Application)
+            Sinatra::Application.root
+          else
+            nil
+          end
+          sub_path ? ::File.join(root, sub_path) : root
+        end
+      end
+    end
+  end
+end

data/lib/rack/bug/options.rb

@@ -9,7 +9,7 @@ module Rack::Bug
         define_method("#{key}?") { || !! read_option(key) }
       end
     end
-    
+
     option_accessor :secret_key
     option_accessor :ip_masks
     option_accessor :password
@@ -45,7 +45,7 @@ module Rack::Bug
     end
 
   private
-  
+
     def read_option(key)
       options[option_name(key)]
     end
@@ -61,7 +61,7 @@ module Rack::Bug
       else raise ArgumentError
       end
     end
-    
+
     def initialize_options(options={})
       @default_options = {
         'rack-bug.ip_masks' => [IPAddr.new("127.0.0.1")],
@@ -84,6 +84,6 @@ module Rack::Bug
       }
       self.options = options
     end
-    
+
   end
 end

data/lib/rack/bug/panel.rb

@@ -2,14 +2,14 @@ require "erb"
 
 module Rack
   module Bug
-    
+
     # Panels are also Rack middleware
     class Panel
       include Render
       include ERB::Util
-      
+
       attr_reader :request
-      
+
       def initialize(app)
         if panel_app
           @app = Rack::Cascade.new([panel_app, app])
@@ -17,7 +17,7 @@ module Rack
           @app = app
         end
       end
-      
+
       def call(env)
         before(env)
         status, headers, body = @app.call(env)
@@ -26,25 +26,25 @@ module Rack
         env["rack-bug.panels"] << self
         return [status, headers, body]
       end
-      
+
       def panel_app
         nil
       end
-      
+
       def has_content?
         true
       end
-      
+
       def before(env)
       end
-      
+
       def after(env, status, headers, body)
       end
-      
+
       def render(template)
       end
-      
+
     end
-    
+
   end
-end
+end

data/lib/rack/bug/panel_app.rb

@@ -1,20 +1,20 @@
 module Rack
   module Bug
-    
+
     class PanelApp
       include Rack::Bug::Render
-      
+
       attr_reader :request
-      
+
       def call(env)
         @request = Rack::Request.new(env)
         dispatch
       end
-      
+
       def render_template(*args)
         Rack::Response.new([super]).to_a
       end
-      
+
       def params
         @request.GET
       end
@@ -26,8 +26,8 @@ module Rack
       def validate_params
         ParamsSignature.new(request).validate!
       end
-      
+
     end
-    
+
   end
-end
+end