better_errors 0.0.1 → 0.0.3

data/README.md

@@ -2,11 +2,18 @@
 
 Better Errors replaces the standard Rails error page with a much better and more useful error page. It is also usable outside of Rails.
 
-![image](http://i.imgur.com/1GepF.png)
+![image](http://i.imgur.com/quHUZ.png)
+
+## Features
+
+* Full stack trace
+* Source code inspection for all stack frames (with highlighting)
+* Local and instance variable inspection
+* Ruby console on every stack frame
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile (under the **development** group):
 
     gem 'better_errors'
 

data/lib/better_errors/core_ext/exception.rb

@@ -7,10 +7,7 @@ class Exception
     unless Thread.current[:__better_errors_exception_lock]
       Thread.current[:__better_errors_exception_lock] = true
       begin
-        @__better_errors_bindings_stack = []
-        2.upto(caller.size) do |index|
-          @__better_errors_bindings_stack << binding.of_caller(index) rescue break
-        end
+        @__better_errors_bindings_stack = binding.callers.drop(1)
       ensure
         Thread.current[:__better_errors_exception_lock] = false
       end

data/lib/better_errors/error_frame.rb

@@ -3,17 +3,22 @@ module BetterErrors
     def self.from_exception(exception)
       exception.backtrace.each_with_index.map { |frame, idx|
         next unless frame =~ /\A(.*):(\d*):in `(.*)'\z/
-        ErrorFrame.new($1, $2.to_i, $3, exception.__better_errors_bindings_stack[idx])
+        if BetterErrors.binding_of_caller_available?
+          b = exception.__better_errors_bindings_stack[idx]
+        end
+        ErrorFrame.new($1, $2.to_i, $3, b)
       }.compact
     end
     
     attr_reader :filename, :line, :name, :frame_binding
     
-    def initialize(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?
@@ -56,7 +61,14 @@ module BetterErrors
     
     def local_variables
       return {} unless frame_binding
-      Hash[frame_binding.eval("local_variables").map { |x| [x, frame_binding.eval(x.to_s)] }]
+      frame_binding.eval("local_variables").each_with_object({}) do |name, hash|
+        begin
+          hash[name] = frame_binding.eval(name.to_s)
+        rescue NameError => e
+          # local_variables sometimes returns broken variables.
+          # https://bugs.ruby-lang.org/issues/7536
+        end
+      end
     end
     
     def instance_variables
@@ -65,6 +77,17 @@ module BetterErrors
     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

data/lib/better_errors/error_page.rb

@@ -2,12 +2,12 @@ require "json"
 
 module BetterErrors
   class ErrorPage
-    def self.template_path
-      __FILE__.gsub(/\.rb$/, ".erb")
+    def self.template_path(template_name)
+      File.expand_path("../templates/#{template_name}.erb", __FILE__)
     end
     
-    def self.template
-      Erubis::EscapedEruby.new(File.read(template_path))
+    def self.template(template_name)
+      Erubis::EscapedEruby.new(File.read(template_path(template_name)))
     end
     
     attr_reader :exception, :env
@@ -15,20 +15,36 @@ module BetterErrors
     def initialize(exception, env)
       @exception = real_exception(exception)
       @env = env
+      @start_time = Time.now.to_f
     end
     
-    def render
-      self.class.template.result binding
+    def render(template_name = "main")
+      self.class.template(template_name).result binding
+    end
+    
+    def do_variables(opts)
+      index = opts["index"].to_i
+      @frame = backtrace_frames[index]
+      { html: render("variable_info") }
+    end
+    
+    def do_eval(opts)
+      index = opts["index"].to_i
+      response =  begin
+                    result = backtrace_frames[index].frame_binding.eval(opts["source"])
+                    { result: result.inspect }
+                  rescue Exception => e
+                    { error: (e.inspect rescue e.class.name rescue "Exception") }
+                  end
+      response.merge(highlighted_input: CodeRay.scan(opts["source"], :ruby).div(wrap: nil))
     end
     
   private
     def real_exception(exception)
-      loop do
-        case exception
-        when ActionView::Template::Error; exception = exception.original_exception
-        else
-          return exception
-        end
+      if exception.respond_to? :original_exception
+        exception.original_exception
+      else
+        exception
       end
     end
   

data/lib/better_errors/middleware.rb

@@ -1,3 +1,5 @@
+require "json"
+
 module BetterErrors
   class Middleware
     def initialize(app, handler = ErrorPage)
@@ -6,10 +8,28 @@ module BetterErrors
     end
     
     def call(env)
+      if env["REQUEST_PATH"] =~ %r{\A/__better_errors/(?<oid>\d+)/(?<method>\w+)\z}
+        internal_call env, $~
+      else
+        app_call env
+      end
+    end
+    
+  private
+    def app_call(env)
       @app.call env
     rescue Exception => ex
-      error_page = @handler.new ex, env
-      [500, { "Content-Type" => "text/html; charset=utf-8" }, [error_page.render]]
+      @error_page = @handler.new ex, env
+      [500, { "Content-Type" => "text/html; charset=utf-8" }, [@error_page.render]]
+    end
+  
+    def internal_call(env, opts)
+      if opts[:oid].to_i != @error_page.object_id
+        return [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump(error: "Session expired")]]
+      end
+      
+      response = @error_page.send("do_#{opts[:method]}", JSON.parse(env["rack.input"].read))
+      [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump(response)]]
     end
   end
 end

data/lib/better_errors/{error_page.erb → templates/main.erb}

@@ -120,6 +120,7 @@
         font-weight:normal;
         border-top:1px solid #cccccc;
         padding-top:16px;
+        margin-bottom:16px;
     }
     .var_table {
         border-collapse:collapse;
@@ -133,6 +134,33 @@
     .var_table tr {
         border-bottom:1px solid #cccccc;
     }
+    .repl .console {
+        background-color:#ffffff;
+        padding:2px 4px;
+        border:1px solid #d0d0d0;
+        margin-bottom:8px;
+        font-family:monospace;
+    }
+    .repl pre {
+        font-size:12px;
+        white-space:pre-wrap;
+        max-height:400px;
+        overflow:auto;
+    }
+    .repl .prompt {
+        font-size:12px;
+        position:relative;
+    }
+    .repl input {
+        font-size:12px;
+        border:none;
+        font-family:monospace;
+        outline:none;
+        padding:0px;
+        position:absolute;
+        left:20px;
+        right:0px;
+    }
     </style>
 </head>
 <body>
@@ -177,19 +205,15 @@
                 <div class="location"><span class="filename"><%= frame.pretty_path %></span>, line <span class="line"><%= frame.line %></span></div>
                 <%== highlighted_code_block frame %>
                 
-                <h3>Local Variables</h3>
-                <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 class="repl">
+                    <h3>REPL</h3>
+                    <div class="console">
+                        <pre></pre>
+                        <div class="prompt">&gt;&gt; <input/></div>
+                    </div>
+                </div>
                 
-                <h3>Instance Variables</h3>
-                <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 class="variable_info"></div>
             </div>
         <% end %>
         <div style="clear:both"></div>
@@ -197,34 +221,58 @@
 </body>
 <script>
 (function() {
+    var oid = <%== object_id.to_s.inspect %>;
+    
     var previous = null;
     var previousFrameInfo = null;
     var frames = document.querySelectorAll("ul.frames li");
+    var frameInfos = document.querySelectorAll(".frame_info");
     
     var header = document.querySelector("header");
     var headerHeight = header.offsetHeight;
     
+    apiCall = function(method, opts, cb) {
+        var req = new XMLHttpRequest();
+        req.open("POST", "/__better_errors/" + oid + "/" + method, true);
+        req.setRequestHeader("Content-Type", "application/json");
+        req.send(JSON.stringify(opts));
+        req.onreadystatechange = function() {
+            if(req.readyState == 4) {
+                var res = JSON.parse(req.responseText);
+                cb(res);
+            }
+        };
+    }
+    
+    function escapeHTML(html) {
+        return html.replace(/&/, "&amp;").replace(/</g, "&lt;");
+    }
+    
     function selectFrameInfo(index) {
         var el = document.getElementById("frame_info_" + index);
         
+        var varInfo = el.querySelector(".variable_info");
+        if(varInfo.innerHTML == "") {
+            apiCall("variables", { "index": index }, function(response) {
+                if(response.error) {
+                    varInfo.innerHTML = "<span class='error'>" + escapeHTML(response.error) + "</span>";
+                } else {
+                    varInfo.innerHTML = response.html;
+                }
+            });
+        }
+        
         if(previousFrameInfo) {
             previousFrameInfo.style.display = "none";
         }
         previousFrameInfo = el;
         previousFrameInfo.style.display = "block";
+        
+        el.querySelector(".repl input").focus();
     }
     
-    function updateMarginTop() {
-        return;
-        if(previousFrameInfo) {
-            previousFrameInfo.style.marginTop = Math.max(window.scrollY - headerHeight, 0) + "px";
-        }
-    }
-
-    window.onscroll = updateMarginTop;
-    
     for(var i = 0; i < frames.length; i++) {
-        (function(el) {
+        (function(index, el, frameInfo) {
             el.onclick = function() {
                 if(previous) {
                     previous.className = "";
@@ -233,12 +281,29 @@
                 previous = el;
                 
                 selectFrameInfo(el.attributes["data-index"].value);
-                updateMarginTop();
             };
-        })(frames[i]);
+            var replPre = frameInfo.querySelector(".repl pre");
+            var replInput = frameInfo.querySelector(".repl input");
+            replInput.onkeydown = function(ev) {
+                if(ev.keyCode == 13) {
+                    var text = replInput.value;
+                    replInput.value = "";
+                    apiCall("eval", { "index": index, source: text }, function(response) {
+                        replPre.innerHTML += ">> " + response.highlighted_input + "\n";
+                        if(response.error) {
+                            replPre.innerHTML += "!! " + escapeHTML(response.error) + "\n";
+                        } else {
+                            replPre.innerHTML += "=> " + escapeHTML(response.result) + "\n";
+                        }
+                        replPre.scrollTop = replPre.offsetHeight;
+                    });
+                }
+            };
+        })(i, frames[i], frameInfos[i]);
     }
     
     document.querySelector(".frames li:first-child").click();
 })();
 </script>
 </html>
+<!-- generated by Better Errors in <%= Time.now.to_f - @start_time %> seconds -->

data/lib/better_errors/templates/variable_info.erb

@@ -0,0 +1,13 @@
+<h3>Local Variables</h3>
+<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>
+
+<h3>Instance Variables</h3>
+<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>

data/lib/better_errors/version.rb

@@ -1,3 +1,3 @@
 module BetterErrors
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_errors
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   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-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,10 +75,11 @@ files:
 - lib/better_errors.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/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/error_page_spec.rb