better_errors 0.0.2 → 0.2.0

data/lib/better_errors/templates/variable_info.erb

@@ -0,0 +1,21 @@
+<div class="sub">
+    <h3>Local Variables</h3>
+    <div class='inset variables'>
+        <table class="var_table">
+            <% @frame.local_variables.each do |name, value| %>
+                <tr><td class="name"><%= name %></td><td><pre><%= value.inspect %></pre></td></tr>
+            <% end %>
+        </table>
+    </div>
+</div>
+
+<div class="sub">
+    <h3>Instance Variables</h3>
+    <div class="inset variables">
+        <table class="var_table">
+            <% @frame.instance_variables.each do |name, value| %>
+                <tr><td class="name"><%= name %></td><td><pre><%= value.inspect %></pre></td></tr>
+            <% end %>
+        </table>
+    </div>
+</div>

data/lib/better_errors/version.rb

@@ -1,3 +1,3 @@
 module BetterErrors
-  VERSION = "0.0.2"
+  VERSION = "0.2.0"
 end

data/lib/better_errors.rb

@@ -4,11 +4,13 @@ require "coderay"
 
 require "better_errors/version"
 require "better_errors/error_page"
-require "better_errors/error_frame"
+require "better_errors/stack_frame"
 require "better_errors/middleware"
+require "better_errors/code_formatter"
+require "better_errors/repl"
 
 class << BetterErrors
-  attr_accessor :application_root, :binding_of_caller_available
+  attr_accessor :application_root, :binding_of_caller_available, :logger
   
   alias_method :binding_of_caller_available?, :binding_of_caller_available
 end
@@ -20,12 +22,12 @@ rescue LoadError => e
   BetterErrors.binding_of_caller_available = false
 end
 
-if BetterErrors.binding_of_caller_available?
-  require "better_errors/core_ext/exception"
-else
+unless BetterErrors.binding_of_caller_available?
   warn "BetterErrors: binding_of_caller gem unavailable, cannot display local variables on error pages."
   warn "Add 'binding_of_caller' to your Gemfile to make this warning go away."
   warn ""
 end
 
+require "better_errors/core_ext/exception"
+
 require "better_errors/rails" if defined? Rails::Railtie

data/spec/better_errors/code_formatter_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+module BetterErrors
+  describe CodeFormatter do
+    let(:filename) { File.expand_path("../support/my_source.rb", __FILE__) }
+    
+    let(:formatter) { CodeFormatter.new(filename, 8) }
+    
+    it "should pick an appropriate scanner" do
+      formatter.coderay_scanner.should == :ruby
+    end
+    
+    it "should show 5 lines of context" do
+      formatter.line_range.should == (3..13)
+      
+      formatter.context_lines.should == [
+          "three\n",
+          "four\n",
+          "five\n",
+          "six\n",
+          "seven\n",
+          "eight\n",
+          "nine\n",
+          "ten\n",
+          "eleven\n",
+          "twelve\n",
+          "thirteen\n"
+        ]
+    end
+    
+    it "should highlight the erroring line" do
+      formatter.html.should =~ /highlight.*eight/
+    end
+    
+    it "should work when the line is right on the edge" do
+      formatter = CodeFormatter.new(filename, 20)
+      formatter.line_range.should == (15..20)
+      formatter.html.should_not == formatter.source_unavailable
+    end
+    
+    it "should not barf when the lines don't make any sense" do
+      formatter = CodeFormatter.new(filename, 999)
+      formatter.html.should == formatter.source_unavailable
+    end
+    
+    it "should not barf when the file doesn't exist" do
+      formatter = CodeFormatter.new("fkdguhskd7e l", 1)
+      formatter.html.should == formatter.source_unavailable
+    end
+  end
+end

data/spec/better_errors/error_page_spec.rb

@@ -7,6 +7,16 @@ module BetterErrors
     let(:error_page) { ErrorPage.new exception, { "REQUEST_PATH" => "/some/path" } }
     
     let(:response) { error_page.render }
+    
+    let(:empty_binding) {
+      local_a = :value_for_local_a
+      local_b = :value_for_local_b
+      
+      @inst_c = :value_for_inst_c
+      @inst_d = :value_for_inst_d
+      
+      binding
+    }
   
     it "should include the error message" do
       response.should include("you divided by zero you silly goose!")
@@ -20,26 +30,31 @@ module BetterErrors
       response.should include("ZeroDivisionError")
     end
     
-    context "when showing source code" do
-      before do
-        exception.stub!(:backtrace).and_return([
-          "#{File.expand_path("../support/my_source.rb", __FILE__)}:8:in `some_method'"
-        ])
-      end
+    context "variable inspection" do
+      let(:exception) { empty_binding.eval("raise") rescue $! }
       
-      it "should show the line where the exception was raised" do
-        response.should include("8 eight")
+      it "should show local variables" do
+        html = error_page.do_variables("index" => 0)[:html]
+        html.should include("local_a")
+        html.should include(":value_for_local_a")
+        html.should include("local_b")
+        html.should include(":value_for_local_b")
       end
       
-      it "should show five lines of context" do
-        response.should include("3 three")
-        response.should include("13 thirteen")
-      end
-      
-      it "should not show more than five lines of context" do
-        response.should_not include("2 two")
-        response.should_not include("14 fourteen")
+      it "should show instance variables" do
+        html = error_page.do_variables("index" => 0)[:html]
+        html.should include("inst_c")
+        html.should include(":value_for_inst_c")
+        html.should include("inst_d")
+        html.should include(":value_for_inst_d")
       end
     end
+    
+    it "should not die if the source file is not a real filename" do
+      exception.stub!(:backtrace).and_return([
+        "<internal:prelude>:10:in `spawn_rack_application'"
+      ])
+      response.should include("Source unavailable")
+    end
   end
 end

data/spec/better_errors/middleware_spec.rb

@@ -21,6 +21,14 @@ module BetterErrors
         
         headers["Content-Type"].should == "text/html; charset=utf-8"
       end
+      
+      it "should log the exception" do
+        logger = Object.new
+        logger.should_receive :fatal
+        BetterErrors.stub!(:logger).and_return(logger)
+        
+        app.call({})
+      end
     end
   end
 end

data/spec/better_errors/repl/basic_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+require "better_errors/repl/basic"
+
+module BetterErrors
+  module REPL
+    describe Basic do
+      let(:fresh_binding) {
+        local_a = 123
+        binding
+      }
+      
+      let(:repl) { Basic.new fresh_binding }
+      
+      it "should evaluate ruby code in a given context" do
+        repl.send_input("local_a = 456")
+        fresh_binding.eval("local_a").should == 456
+      end
+      
+      it "should return a tuple of output and the new prompt" do
+        output, prompt = repl.send_input("1 + 2")
+        output.should == "=> 3\n"
+        prompt.should == ">>"
+      end
+      
+      it "should not barf if the code throws an exception" do
+        output, prompt = repl.send_input("raise Exception")
+        output.should == "!! #<Exception: Exception>\n"
+        prompt.should == ">>"
+      end
+    end
+  end
+end

data/spec/better_errors/{error_frame_spec.rb → stack_frame_spec.rb}

@@ -1,24 +1,24 @@
 require "spec_helper"
 
 module BetterErrors
-  describe ErrorFrame do
+  describe StackFrame do
     context "#application?" do
       it "should be true for application filenames" do
         BetterErrors.stub!(:application_root).and_return("/abc/xyz")
-        frame = ErrorFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
+        frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         
         frame.application?.should be_true
       end
       
       it "should be false for everything else" do
         BetterErrors.stub!(:application_root).and_return("/abc/xyz")
-        frame = ErrorFrame.new("/abc/nope", 123, "foo")
+        frame = StackFrame.new("/abc/nope", 123, "foo")
         
         frame.application?.should be_false
       end
       
       it "should not care if no application_root is set" do
-        frame = ErrorFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
+        frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         
         frame.application?.should be_false
       end
@@ -27,14 +27,14 @@ module BetterErrors
     context "#gem?" do
       it "should be true for gem filenames" do
         Gem.stub!(:path).and_return(["/abc/xyz"])
-        frame = ErrorFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
+        frame = StackFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
         
         frame.gem?.should be_true
       end
       
       it "should be false for everything else" do
         Gem.stub!(:path).and_return(["/abc/xyz"])
-        frame = ErrorFrame.new("/abc/nope", 123, "foo")
+        frame = StackFrame.new("/abc/nope", 123, "foo")
         
         frame.gem?.should be_false
       end
@@ -43,7 +43,7 @@ module BetterErrors
     context "#application_path" do
       it "should chop off the application root" do
         BetterErrors.stub!(:application_root).and_return("/abc/xyz")
-        frame = ErrorFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
+        frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         
         frame.application_path.should == "app/controllers/crap_controller.rb"
       end
@@ -52,10 +52,33 @@ module BetterErrors
     context "#gem_path" do
       it "should chop of the gem path and stick (gem) there" do
         Gem.stub!(:path).and_return(["/abc/xyz"])
-        frame = ErrorFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
+        frame = StackFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
         
         frame.gem_path.should == "(gem) whatever-1.2.3/lib/whatever.rb"
       end
     end
+
+    it "should special case SyntaxErrors" do
+      syntax_error = SyntaxError.new "my_file.rb:123: you wrote bad ruby!"
+      syntax_error.stub!(:backtrace).and_return([])
+      frames = StackFrame.from_exception(syntax_error)
+      frames.count.should == 1
+      frames.first.filename.should == "my_file.rb"
+      frames.first.line.should == 123
+    end
+    
+    it "should not blow up if no method name is given" do
+      error = StandardError.new
+      
+      error.stub!(:backtrace).and_return(["foo.rb:123"])
+      frames = StackFrame.from_exception(error)
+      frames.first.filename.should == "foo.rb"
+      frames.first.line.should == 123
+      
+      error.stub!(:backtrace).and_return(["foo.rb:123: this is an error message"])
+      frames = StackFrame.from_exception(error)
+      frames.first.filename.should == "foo.rb"
+      frames.first.line.should == 123
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_errors
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-08 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,8 +58,10 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-description: Better Errors gives Rails a better error page.
+        version: 1.0.0
+description: Provides a better error page for Rails and other Rack apps. Includes
+  source code inspection, a live REPL and local/instance variable inspection for all
+  stack frames.
 email:
 - charlie@charliesomerville.com
 executables: []
@@ -73,16 +75,23 @@ files:
 - Rakefile
 - better_errors.gemspec
 - lib/better_errors.rb
+- lib/better_errors/code_formatter.rb
 - lib/better_errors/core_ext/exception.rb
-- lib/better_errors/error_frame.rb
-- lib/better_errors/error_page.erb
 - lib/better_errors/error_page.rb
 - lib/better_errors/middleware.rb
 - lib/better_errors/rails.rb
+- lib/better_errors/repl.rb
+- lib/better_errors/repl/basic.rb
+- lib/better_errors/repl/pry.rb
+- lib/better_errors/stack_frame.rb
+- lib/better_errors/templates/main.erb
+- lib/better_errors/templates/variable_info.erb
 - lib/better_errors/version.rb
-- spec/better_errors/error_frame_spec.rb
+- spec/better_errors/code_formatter_spec.rb
 - spec/better_errors/error_page_spec.rb
 - spec/better_errors/middleware_spec.rb
+- spec/better_errors/repl/basic_spec.rb
+- spec/better_errors/stack_frame_spec.rb
 - spec/better_errors/support/my_source.rb
 - spec/spec_helper.rb
 homepage: https://github.com/charliesome/better_errors
@@ -109,11 +118,13 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Better Errors gives Rails a better error page
+summary: Better error page for Rails and other Rack apps
 test_files:
-- spec/better_errors/error_frame_spec.rb
+- spec/better_errors/code_formatter_spec.rb
 - spec/better_errors/error_page_spec.rb
 - spec/better_errors/middleware_spec.rb
+- spec/better_errors/repl/basic_spec.rb
+- spec/better_errors/stack_frame_spec.rb
 - spec/better_errors/support/my_source.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/better_errors/error_frame.rb

@@ -1,86 +0,0 @@
-module BetterErrors
-  class ErrorFrame
-    def self.from_exception(exception)
-      exception.backtrace.each_with_index.map { |frame, idx|
-        next unless frame =~ /\A(.*):(\d*):in `(.*)'\z/
-        b = exception.__better_errors_bindings_stack[idx]
-        ErrorFrame.new($1, $2.to_i, $3, b)
-      }.compact
-    end
-    
-    attr_reader :filename, :line, :name, :frame_binding
-    
-    def initialize(filename, line, name, frame_binding = nil)
-      @filename       = filename
-      @line           = line
-      @name           = name
-      @frame_binding  = frame_binding
-      
-      set_pretty_method_name if frame_binding
-    end
-    
-    def application?
-      starts_with? filename, BetterErrors.application_root if BetterErrors.application_root
-    end
-    
-    def application_path
-      filename[(BetterErrors.application_root.length+1)..-1]
-    end
-
-    def gem?
-      Gem.path.any? { |path| starts_with? filename, path }
-    end
-    
-    def gem_path
-      Gem.path.each do |path|
-        if starts_with? filename, path
-          return filename.gsub("#{path}/gems/", "(gem) ")
-        end
-      end
-    end
-    
-    def context
-      if application?
-        :application
-      elsif gem?
-        :gem
-      else
-        :dunno
-      end
-    end
-    
-    def pretty_path
-      case context
-      when :application;  application_path
-      when :gem;          gem_path
-      else                filename
-      end
-    end
-    
-    def local_variables
-      return {} unless frame_binding
-      Hash[frame_binding.eval("local_variables").map { |x| [x, frame_binding.eval(x.to_s)] }]
-    end
-    
-    def instance_variables
-      return {} unless frame_binding
-      Hash[frame_binding.eval("instance_variables").map { |x| [x, frame_binding.eval(x.to_s)] }]
-    end
-    
-  private
-    def set_pretty_method_name
-      name =~ /\A(block (\([^)]+\) )?in )?/
-      recv = frame_binding.eval("self")
-      method = frame_binding.eval("__method__")
-      @name = if recv.is_a? Module
-                "#{$1}#{recv}.#{method}"
-              else
-                "#{$1}#{recv.class}##{method}"
-              end
-    end
-  
-    def starts_with?(haystack, needle)
-      haystack[0, needle.length] == needle
-    end
-  end
-end