RubyGems - better_errors - Versions diffs - 1.0.0 → 2.0.0 - Mend

better_errors 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

checksums.yaml +4 -4
data/.gitignore +7 -5
data/.travis.yml +1 -3
data/CHANGELOG.md +3 -0
data/Gemfile +1 -1
data/LICENSE.txt +1 -1
data/README.md +12 -2
data/Rakefile +12 -3
data/better_errors.gemspec +3 -4
data/lib/better_errors/error_page.rb +22 -33
data/lib/better_errors/exception_extension.rb +17 -0
data/lib/better_errors/middleware.rb +7 -7
data/lib/better_errors/raised_exception.rb +66 -0
data/lib/better_errors/repl/pry.rb +2 -2
data/lib/better_errors/stack_frame.rb +19 -67
data/lib/better_errors/templates/main.erb +63 -49
data/lib/better_errors/templates/text.erb +2 -2
data/lib/better_errors/version.rb +1 -1
data/lib/better_errors.rb +7 -8
data/spec/better_errors/middleware_spec.rb +42 -0
data/spec/better_errors/raised_exception_spec.rb +52 -0
data/spec/better_errors/repl/pry_spec.rb +5 -1
data/spec/better_errors/stack_frame_spec.rb +26 -30
data/spec/spec_helper.rb +2 -4
data/spec/without_binding_of_caller.rb +9 -0
metadata +35 -18
data/ext/mkrf_conf.rb +0 -11
data/lib/better_errors/core_ext/exception.rb +0 -21

data/lib/better_errors/templates/main.erb CHANGED Viewed

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-    <title><%= exception.class %> at <%= request_path %></title>
+    <title><%= exception.type %> at <%= request_path %></title>
 </head>
 <body>
     <%# Stylesheets are placed in the <body> for Turbolinks compatibility. %>
@@ -180,6 +180,7 @@
         padding-right: 20px;
         overflow-y: auto;
         word-wrap: break-word;
+        white-space: pre-wrap;
         height: auto;
         max-height: 7em;
     }
@@ -443,13 +444,13 @@
         font-weight: bold;
         font-size: 10pt;
     }
     .trace_info .title .location a {
         color:inherit;
         text-decoration:none;
         border-bottom:1px solid #aaaaaa;
     }
     .trace_info .title .location a:hover {
         border-color:#666666;
     }
@@ -472,7 +473,7 @@
         padding-bottom:9px;
         float:left;
     }
     .code_linenums span{
         display:block;
         padding:0 12px;
@@ -730,8 +731,8 @@
     <div class='top'>
         <header class="exception">
-            <h2><strong><%= exception.class %></strong> <span>at <%= request_path %></span></h2>
-            <p><%= exception_message %></p>
+            <h2><strong><%= exception.type %></strong> <span>at <%= request_path %></span></h2>
+            <p><%= exception.message %></p>
         </header>
     </div>
@@ -767,8 +768,8 @@
 <script>
 (function() {
-    var OID = <%== object_id.to_s.inspect %>;
+    var OID = "<%= id %>";
     var previousFrame = null;
     var previousFrameInfo = null;
     var allFrames = document.querySelectorAll("ul.frames li");
@@ -786,68 +787,73 @@
             }
         };
     }
     function escapeHTML(html) {
         return html.replace(/&/, "&amp;").replace(/</g, "&lt;");
     }
     function REPL(index) {
         this.index = index;
-        this.previousCommands = [];
-        this.previousCommandOffset = 0;
+        var previousCommands = JSON.parse(localStorage.getItem("better_errors_previous_commands"));
+        if(previousCommands === null) {
+          localStorage.setItem("better_errors_previous_commands", JSON.stringify([]));
+          previousCommands = [];
+        }
+        this.previousCommandOffset = previousCommands.length;
     }
     REPL.all = [];
     REPL.prototype.install = function(containerElement) {
         this.container = containerElement;
         this.promptElement  = this.container.querySelector(".prompt span");
         this.inputElement   = this.container.querySelector("input");
         this.outputElement  = this.container.querySelector("pre");
         var self = this;
         this.inputElement.onkeydown = function(ev) {
             self.onKeyDown(ev);
         };
         this.setPrompt(">>");
         REPL.all[this.index] = this;
     }
     REPL.prototype.focus = function() {
         this.inputElement.focus();
     };
     REPL.prototype.setPrompt = function(prompt) {
         this._prompt = prompt;
         this.promptElement.innerHTML = escapeHTML(prompt);
     };
     REPL.prototype.getInput = function() {
         return this.inputElement.value;
     };
     REPL.prototype.setInput = function(text) {
         this.inputElement.value = text;
         if(this.inputElement.setSelectionRange) {
             // set cursor to end of input
             this.inputElement.setSelectionRange(text.length, text.length);
         }
     };
     REPL.prototype.writeRawOutput = function(output) {
         this.outputElement.innerHTML += output;
         this.outputElement.scrollTop = this.outputElement.scrollHeight;
     };
     REPL.prototype.writeOutput = function(output) {
         this.writeRawOutput(escapeHTML(output));
     };
     REPL.prototype.sendInput = function(line) {
         var self = this;
         apiCall("eval", { "index": this.index, source: line }, function(response) {
@@ -861,48 +867,56 @@
             self.setInput(response.prefilled_input);
         });
     };
     REPL.prototype.onEnterKey = function() {
         var text = this.getInput();
         if(text != "" && text !== undefined) {
-            this.previousCommandOffset = this.previousCommands.push(text);
+            var previousCommands = JSON.parse(localStorage.getItem("better_errors_previous_commands"));
+            this.previousCommandOffset = previousCommands.push(text);
+            if(previousCommands.length > 100) {
+              previousCommands.splice(0, 1);
+            }
+            localStorage.setItem("better_errors_previous_commands", JSON.stringify(previousCommands));
         }
         this.setInput("");
         this.sendInput(text);
     };
     REPL.prototype.onNavigateHistory = function(direction) {
         this.previousCommandOffset += direction;
+        var previousCommands = JSON.parse(localStorage.getItem("better_errors_previous_commands"));
         if(this.previousCommandOffset < 0) {
             this.previousCommandOffset = -1;
             this.setInput("");
             return;
         }
-        if(this.previousCommandOffset >= this.previousCommands.length) {
-            this.previousCommandOffset = this.previousCommands.length;
+        if(this.previousCommandOffset >= previousCommands.length) {
+            this.previousCommandOffset = previousCommands.length;
             this.setInput("");
             return;
         }
-        this.setInput(this.previousCommands[this.previousCommandOffset]);
+        this.setInput(previousCommands[this.previousCommandOffset]);
     };
     REPL.prototype.onKeyDown = function(ev) {
         if(ev.keyCode == 13) {
             this.onEnterKey();
-        } else if(ev.keyCode == 38) {
-            // the user pressed the up arrow.
+        } else if(ev.keyCode == 38 || (ev.ctrlKey && ev.keyCode == 80)) {
+            // the user pressed the up arrow or Ctrl-P
             this.onNavigateHistory(-1);
+            ev.preventDefault();
             return false;
-        } else if(ev.keyCode == 40) {
-            // the user pressed the down arrow.
+        } else if(ev.keyCode == 40 || (ev.ctrlKey && ev.keyCode == 78)) {
+            // the user pressed the down arrow or Ctrl-N
             this.onNavigateHistory(1);
+            ev.preventDefault();
             return false;
         }
     };
     function switchTo(el) {
         if(previousFrameInfo) previousFrameInfo.style.display = "none";
         previousFrameInfo = el;
@@ -937,7 +951,7 @@
             });
         }
     }
     for(var i = 0; i < allFrames.length; i++) {
         (function(i, el) {
             var el = allFrames[i];
@@ -947,12 +961,12 @@
                 }
                 el.className = "selected";
                 previousFrame = el;
                 selectFrameInfo(el.attributes["data-index"].value);
             };
         })(i);
     }
     // Click the first application frame
     (
       document.querySelector(".frames li.application") ||
@@ -968,7 +982,7 @@
     var applicationFramesButtonIsInstalled = false;
     var applicationFramesButton = document.getElementById("application_frames");
     var allFramesButton = document.getElementById("all_frames");
     // The application frames button only needs to be bound if
     // there are actually any application frames to look at.
     var installApplicationFramesButton = function() {
@@ -984,10 +998,10 @@
             }
             return false;
         };
         applicationFramesButtonIsInstalled = true;
     }
     allFramesButton.onclick = function() {
         if(applicationFramesButtonIsInstalled) {
             applicationFramesButton.className = "";
@@ -999,7 +1013,7 @@
         }
         return false;
     };
     // If there are no application frames, select the 'All Frames'
     // tab by default.
     if(applicationFramesCount > 0) {

data/lib/better_errors/templates/text.erb CHANGED Viewed

@@ -1,6 +1,6 @@
-<%== text_heading("=", "%s at %s" % [exception.class, request_path]) %>
+<%== text_heading("=", "%s at %s" % [exception.type, request_path]) %>
-> <%== exception_message %>
+> <%== exception.message %>
 <% if backtrace_frames.any? %>
 <%== text_heading("-", "%s, line %i" % [first_frame.pretty_path, first_frame.line]) %>

data/lib/better_errors/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module BetterErrors
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/better_errors.rb CHANGED Viewed

@@ -3,12 +3,13 @@ require "erubis"
 require "coderay"
 require "uri"
-require "better_errors/version"
+require "better_errors/code_formatter"
 require "better_errors/error_page"
-require "better_errors/stack_frame"
 require "better_errors/middleware"
-require "better_errors/code_formatter"
+require "better_errors/raised_exception"
 require "better_errors/repl"
+require "better_errors/stack_frame"
+require "better_errors/version"
 module BetterErrors
   POSSIBLE_EDITOR_PRESETS = [
@@ -134,14 +135,12 @@ module BetterErrors
   BetterErrors.editor = default_editor
 end
-if Gem::Dependency.new("binding_of_caller", "0.7.2").matching_specs.any?
-  gem "binding_of_caller", "0.7.2"
+begin
   require "binding_of_caller"
+  require "better_errors/exception_extension"
   BetterErrors.binding_of_caller_available = true
-else
+rescue LoadError => e
   BetterErrors.binding_of_caller_available = false
 end
-require "better_errors/core_ext/exception"
 require "better_errors/rails" if defined? Rails::Railtie

data/spec/better_errors/middleware_spec.rb CHANGED Viewed

@@ -40,6 +40,14 @@ module BetterErrors
       app.call("REMOTE_ADDR" => "77.55.33.11")
     end
+    it "respects the X-Forwarded-For header" do
+      app.should_not_receive :better_errors_call
+      app.call(
+        "REMOTE_ADDR"          => "127.0.0.1",
+        "HTTP_X_FORWARDED_FOR" => "1.2.3.4",
+      )
+    end
     it "doesn't blow up when given a blank REMOTE_ADDR" do
       expect { app.call("REMOTE_ADDR" => " ") }.to_not raise_error
     end
@@ -71,6 +79,40 @@ module BetterErrors
         status.should == 500
       end
+      context "original_exception" do
+        class OriginalExceptionException < Exception
+          attr_reader :original_exception
+          def initialize(message, original_exception = nil)
+            super(message)
+            @original_exception = original_exception
+          end
+        end
+        it "shows Original Exception if it responds_to and has an original_exception" do
+          app = Middleware.new(->env {
+            raise OriginalExceptionException.new("Other Exception", Exception.new("Original Exception"))
+          })
+          status, _, body = app.call({})
+          status.should == 500
+          body.join.should_not match(/Other Exception/)
+          body.join.should match(/Original Exception/)
+        end
+        it "won't crash if the exception responds_to but doesn't have an original_exception" do
+          app = Middleware.new(->env {
+            raise OriginalExceptionException.new("Other Exception")
+          })
+          status, _, body = app.call({})
+          status.should == 500
+          body.join.should match(/Other Exception/)
+        end
+      end
       it "returns ExceptionWrapper's status_code" do
         ad_ew = double("ActionDispatch::ExceptionWrapper")
         ad_ew.stub('new').with({}, exception ){ double("ExceptionWrapper", status_code: 404) }

data/spec/better_errors/raised_exception_spec.rb ADDED Viewed

@@ -0,0 +1,52 @@
+require "spec_helper"
+module BetterErrors
+  describe RaisedException do
+    let(:exception) { RuntimeError.new("whoops") }
+    subject { RaisedException.new(exception) }
+    its(:exception) { should == exception }
+    its(:message)   { should == "whoops" }
+    its(:type)      { should == RuntimeError }
+    context "when the exception wraps another exception" do
+      let(:original_exception) { RuntimeError.new("something went wrong!") }
+      let(:exception) { double(:original_exception => original_exception) }
+      its(:exception) { should == original_exception }
+      its(:message)   { should == "something went wrong!" }
+    end
+    context "when the exception is a syntax error" do
+      let(:exception) { SyntaxError.new("foo.rb:123: you made a typo!") }
+      its(:message) { should == "you made a typo!" }
+      its(:type)    { should == SyntaxError }
+      it "has the right filename and line number in the backtrace" do
+        subject.backtrace.first.filename.should == "foo.rb"
+        subject.backtrace.first.line.should == 123
+      end
+    end
+    context "when the exception is a HAML syntax error" do
+      before do
+        stub_const("Haml::SyntaxError", Class.new(SyntaxError))
+      end
+      let(:exception) {
+        Haml::SyntaxError.new("you made a typo!").tap do |ex|
+          ex.set_backtrace(["foo.rb:123", "haml/internals/blah.rb:123456"])
+        end
+      }
+      its(:message) { should == "you made a typo!" }
+      its(:type)    { should == Haml::SyntaxError }
+      it "has the right filename and line number in the backtrace" do
+        subject.backtrace.first.filename.should == "foo.rb"
+        subject.backtrace.first.line.should == 123
+      end
+    end
+  end
+end

data/spec/better_errors/repl/pry_spec.rb CHANGED Viewed

@@ -25,7 +25,11 @@ module BetterErrors
         filled.should == "  "
         output, prompt, filled = repl.send_input "end"
-        output.should == "=> nil\n"
+        if RUBY_VERSION >= "2.1.0"
+          output.should == "=> :f\n"
+        else
+          output.should == "=> nil\n"
+        end
         prompt.should == ">>"
         filled.should == ""
       end

data/spec/better_errors/stack_frame_spec.rb CHANGED Viewed

@@ -6,77 +6,77 @@ module BetterErrors
       it "is true for application filenames" do
         BetterErrors.stub(:application_root).and_return("/abc/xyz")
         frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         frame.application?.should be_true
       end
       it "is false for everything else" do
         BetterErrors.stub(:application_root).and_return("/abc/xyz")
         frame = StackFrame.new("/abc/nope", 123, "foo")
         frame.application?.should be_false
       end
       it "doesn't care if no application_root is set" do
         frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         frame.application?.should be_false
       end
     end
     context "#gem?" do
       it "is true for gem filenames" do
         Gem.stub(:path).and_return(["/abc/xyz"])
         frame = StackFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
         frame.gem?.should be_true
       end
       it "is false for everything else" do
         Gem.stub(:path).and_return(["/abc/xyz"])
         frame = StackFrame.new("/abc/nope", 123, "foo")
         frame.gem?.should be_false
       end
     end
     context "#application_path" do
       it "chops off the application root" do
         BetterErrors.stub(:application_root).and_return("/abc/xyz")
         frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         frame.application_path.should == "app/controllers/crap_controller.rb"
       end
     end
     context "#gem_path" do
       it "chops of the gem path and stick (gem) there" do
         Gem.stub(:path).and_return(["/abc/xyz"])
         frame = StackFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
         frame.gem_path.should == "whatever (1.2.3) lib/whatever.rb"
       end
       it "prioritizes gem path over application path" do
         BetterErrors.stub(:application_root).and_return("/abc/xyz")
         Gem.stub(:path).and_return(["/abc/xyz/vendor"])
         frame = StackFrame.new("/abc/xyz/vendor/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
         frame.gem_path.should == "whatever (1.2.3) lib/whatever.rb"
       end
     end
     context "#pretty_path" do
       it "returns #application_path for application paths" do
         BetterErrors.stub(:application_root).and_return("/abc/xyz")
         frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index")
         frame.pretty_path.should == frame.application_path
       end
       it "returns #gem_path for gem paths" do
         Gem.stub(:path).and_return(["/abc/xyz"])
         frame = StackFrame.new("/abc/xyz/gems/whatever-1.2.3/lib/whatever.rb", 123, "foo")
         frame.pretty_path.should == frame.gem_path
       end
     end
@@ -90,28 +90,28 @@ module BetterErrors
       frames.first.filename.should == "my_file.rb"
       frames.first.line.should == 123
     end
     it "doesn't blow up if no method name is given" do
       error = StandardError.allocate
       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
     it "ignores a backtrace line if its format doesn't make any sense at all" do
       error = StandardError.allocate
       error.stub(:backtrace).and_return(["foo.rb:123:in `foo'", "C:in `find'", "bar.rb:123:in `bar'"])
       frames = StackFrame.from_exception(error)
       frames.count.should == 2
     end
     it "doesn't blow up if a filename contains a colon" do
       error = StandardError.allocate
       error.stub(:backtrace).and_return(["crap:filename.rb:123"])
@@ -125,11 +125,7 @@ module BetterErrors
         ::Kernel.binding
       end
       frame = StackFrame.new("/abc/xyz/app/controllers/crap_controller.rb", 123, "index", obj.my_binding)
-      if RUBY_VERSION >= "2.0.0"
-        frame.class_name.should == 'BasicObject'
-      else
-        frame.class_name.should be_nil
-      end
+      frame.class_name.should == 'BasicObject'
     end
     it "sets method names properly" do
@@ -143,12 +139,12 @@ module BetterErrors
       end
       frame = StackFrame.from_exception(obj.my_method).first
-      if RUBY_VERSION >= "2.0.0"
+      if BetterErrors.binding_of_caller_available?
         frame.method_name.should == "#my_method"
         frame.class_name.should == "String"
       else
         frame.method_name.should == "my_method"
-        frame.class_name.should be_nil
+        frame.class_name.should == nil
       end
     end

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,7 +1,5 @@
-require "simplecov"
-SimpleCov.start
 $: << File.expand_path("../../lib", __FILE__)
 ENV["EDITOR"] = nil
 require "better_errors"
-require "ostruct"

data/spec/without_binding_of_caller.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Kernel
+  alias_method :require_with_binding_of_caller, :require
+  def require(feature)
+    raise LoadError if feature == "binding_of_caller"
+    require_with_binding_of_caller(feature)
+  end
+end