RubyGems - better_errors - Versions diffs - 1.1.0 → 2.1.1 - Mend

better_errors 1.1.0 → 2.1.1

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 (33) hide show

checksums.yaml +4 -4
data/.gitignore +7 -5
data/.travis.yml +3 -3
data/Gemfile +1 -1
data/LICENSE.txt +1 -1
data/README.md +10 -3
data/Rakefile +12 -3
data/better_errors.gemspec +3 -3
data/lib/better_errors/code_formatter/html.rb +1 -1
data/lib/better_errors/code_formatter.rb +7 -7
data/lib/better_errors/error_page.rb +23 -34
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/basic.rb +2 -2
data/lib/better_errors/repl/pry.rb +9 -9
data/lib/better_errors/repl.rb +3 -3
data/lib/better_errors/stack_frame.rb +7 -56
data/lib/better_errors/templates/main.erb +6 -5
data/lib/better_errors/templates/text.erb +2 -2
data/lib/better_errors/version.rb +1 -1
data/lib/better_errors.rb +6 -6
data/spec/better_errors/code_formatter_spec.rb +7 -7
data/spec/better_errors/error_page_spec.rb +12 -12
data/spec/better_errors/middleware_spec.rb +8 -0
data/spec/better_errors/raised_exception_spec.rb +72 -0
data/spec/better_errors/repl/basic_spec.rb +1 -1
data/spec/better_errors/repl/shared_examples.rb +2 -2
data/spec/better_errors/stack_frame_spec.rb +31 -35
data/spec/spec_helper.rb +2 -4
data/spec/without_binding_of_caller.rb +9 -0
metadata +33 -15
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. %>
@@ -182,7 +182,7 @@
         word-wrap: break-word;
         white-space: pre-wrap;
         height: auto;
-        max-height: 7em;
+        max-height: 7.5em;
     }
     @media screen and (max-width: 1100px) {
@@ -731,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>
@@ -768,7 +768,7 @@
 <script>
 (function() {
-    var OID = <%== object_id.to_s.inspect %>;
+    var OID = "<%= id %>";
     var previousFrame = null;
     var previousFrameInfo = null;
@@ -875,6 +875,7 @@
             this.previousCommandOffset = previousCommands.push(text);
             if(previousCommands.length > 100) {
               previousCommands.splice(0, 1);
+              this.previousCommandOffset -= 1;
             }
             localStorage.setItem("better_errors_previous_commands", JSON.stringify(previousCommands));
         }

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.1.0"
+  VERSION = "2.1.1"
 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 = [
@@ -136,11 +137,10 @@ end
 begin
   require "binding_of_caller"
+  require "better_errors/exception_extension"
   BetterErrors.binding_of_caller_available = true
-rescue LoadError => e
+rescue LoadError
   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/code_formatter_spec.rb CHANGED Viewed

@@ -3,16 +3,16 @@ 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 "picks an appropriate scanner" do
       formatter.coderay_scanner.should == :ruby
     end
     it "shows 5 lines of context" do
       formatter.line_range.should == (3..13)
       formatter.context_lines.should == [
           "three\n",
           "four\n",
@@ -43,12 +43,12 @@ module BetterErrors
         formatter = CodeFormatter::HTML.new(filename, 20)
         formatter.output.should_not == formatter.source_unavailable
       end
       it "doesn't barf when the lines don't make any sense" do
         formatter = CodeFormatter::HTML.new(filename, 999)
         formatter.output.should == formatter.source_unavailable
       end
       it "doesn't barf when the file doesn't exist" do
         formatter = CodeFormatter::HTML.new("fkdguhskd7e l", 1)
         formatter.output.should == formatter.source_unavailable
@@ -82,7 +82,7 @@ module BetterErrors
         formatter = CodeFormatter::Text.new(filename, 999)
         formatter.output.should == formatter.source_unavailable
       end
       it "doesn't barf when the file doesn't exist" do
         formatter = CodeFormatter::Text.new("fkdguhskd7e l", 1)
         formatter.output.should == formatter.source_unavailable

data/spec/better_errors/error_page_spec.rb CHANGED Viewed

@@ -3,36 +3,36 @@ require "spec_helper"
 module BetterErrors
   describe ErrorPage do
     let!(:exception) { raise ZeroDivisionError, "you divided by zero you silly goose!" rescue $! }
     let(:error_page) { ErrorPage.new exception, { "PATH_INFO" => "/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 "includes the error message" do
       response.should include("you divided by zero you silly goose!")
     end
     it "includes the request path" do
       response.should include("/some/path")
     end
     it "includes the exception class" do
       response.should include("ZeroDivisionError")
     end
     context "variable inspection" do
       let(:exception) { empty_binding.eval("raise") rescue $! }
       if BetterErrors.binding_of_caller_available?
         it "shows local variables" do
           html = error_page.do_variables("index" => 0)[:html]
@@ -47,7 +47,7 @@ module BetterErrors
           html.should include(%{gem "binding_of_caller"})
         end
       end
       it "shows instance variables" do
         html = error_page.do_variables("index" => 0)[:html]
         html.should include("inst_c")
@@ -65,7 +65,7 @@ module BetterErrors
         html.should_not include("<pre>:value_for_inst_d</pre>")
       end
     end
     it "doesn't die if the source file is not a real filename" do
       exception.stub(:backtrace).and_return([
         "<internal:prelude>:10:in `spawn_rack_application'"

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

data/spec/better_errors/raised_exception_spec.rb ADDED Viewed

@@ -0,0 +1,72 @@
+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
+    context "when the exception is a Coffeelint syntax error" do
+      before do
+        stub_const("Sprockets::Coffeelint::Error", Class.new(SyntaxError))
+      end
+      let(:exception) {
+        Sprockets::Coffeelint::Error.new("[stdin]:11:88: error: unexpected=").tap do |ex|
+          ex.set_backtrace(["app/assets/javascripts/files/index.coffee:11", "sprockets/coffeelint.rb:3"])
+        end
+      }
+      its(:message) { should == "[stdin]:11:88: error: unexpected=" }
+      its(:type)    { should == Sprockets::Coffeelint::Error }
+      it "has the right filename and line number in the backtrace" do
+        subject.backtrace.first.filename.should == "app/assets/javascripts/files/index.coffee"
+        subject.backtrace.first.line.should == 11
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module BetterErrors
         local_a = 123
         binding
       }
       let(:repl) { Basic.new fresh_binding }
       it_behaves_like "a REPL provider"

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

@@ -3,13 +3,13 @@ shared_examples_for "a REPL provider" do
     repl.send_input("local_a = 456")
     fresh_binding.eval("local_a").should == 456
   end
   it "returns a tuple of output and the new prompt" do
     output, prompt = repl.send_input("1 + 2")
     output.should == "=> 3\n"
     prompt.should == ">>"
   end
   it "doesn't barf if the code throws an exception" do
     output, prompt = repl.send_input("raise Exception")
     output.should include "Exception: Exception"

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
+        frame.should be_application
       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
+        frame.should_not be_application
       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
+        frame.should_not be_application
       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
+        frame.should be_gem
       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
+        frame.should_not be_gem
       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

metadata CHANGED Viewed

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: better_errors
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Charlie Somerville
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.6
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.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.
@@ -47,9 +61,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -60,10 +74,11 @@ files:
 - lib/better_errors/code_formatter.rb
 - lib/better_errors/code_formatter/html.rb
 - lib/better_errors/code_formatter/text.rb
-- lib/better_errors/core_ext/exception.rb
 - lib/better_errors/error_page.rb
+- lib/better_errors/exception_extension.rb
 - lib/better_errors/middleware.rb
 - lib/better_errors/rails.rb
+- lib/better_errors/raised_exception.rb
 - lib/better_errors/repl.rb
 - lib/better_errors/repl/basic.rb
 - lib/better_errors/repl/pry.rb
@@ -75,6 +90,7 @@ files:
 - spec/better_errors/code_formatter_spec.rb
 - spec/better_errors/error_page_spec.rb
 - spec/better_errors/middleware_spec.rb
+- spec/better_errors/raised_exception_spec.rb
 - spec/better_errors/repl/basic_spec.rb
 - spec/better_errors/repl/pry_spec.rb
 - spec/better_errors/repl/shared_examples.rb
@@ -82,6 +98,7 @@ files:
 - spec/better_errors/support/my_source.rb
 - spec/better_errors_spec.rb
 - spec/spec_helper.rb
+- spec/without_binding_of_caller.rb
 homepage: https://github.com/charliesome/better_errors
 licenses:
 - MIT
@@ -92,17 +109,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key:
 specification_version: 4
 summary: Better error page for Rails and other Rack apps
@@ -110,6 +127,7 @@ test_files:
 - spec/better_errors/code_formatter_spec.rb
 - spec/better_errors/error_page_spec.rb
 - spec/better_errors/middleware_spec.rb
+- spec/better_errors/raised_exception_spec.rb
 - spec/better_errors/repl/basic_spec.rb
 - spec/better_errors/repl/pry_spec.rb
 - spec/better_errors/repl/shared_examples.rb
@@ -117,4 +135,4 @@ test_files:
 - spec/better_errors/support/my_source.rb
 - spec/better_errors_spec.rb
 - spec/spec_helper.rb
-has_rdoc:
+- spec/without_binding_of_caller.rb

data/lib/better_errors/core_ext/exception.rb DELETED Viewed

@@ -1,21 +0,0 @@
-class Exception
-  original_set_backtrace = instance_method(:set_backtrace)
-  if BetterErrors.binding_of_caller_available?
-    define_method :set_backtrace do |*args|
-      unless Thread.current[:__better_errors_exception_lock]
-        Thread.current[:__better_errors_exception_lock] = true
-        begin
-          @__better_errors_bindings_stack = binding.callers.drop(1)
-        ensure
-          Thread.current[:__better_errors_exception_lock] = false
-        end
-      end
-      original_set_backtrace.bind(self).call(*args)
-    end
-  end
-  def __better_errors_bindings_stack
-    @__better_errors_bindings_stack || []
-  end
-end