better_errors 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d53ee50b3a870061cf9298e5225635771043d6d7
-  data.tar.gz: b4280966bd31d24f4f4cb12ea54c1eea11bccdaa
+  metadata.gz: 4a1dc267fbb1b144d24214815df6e7a31f23411d
+  data.tar.gz: 2415e49dbf1e39761859473d0321d4951694c3cf
 SHA512:
-  metadata.gz: e068142eaef86037e0cc6088672158a0a9d021e49e7fe9a823c888d1f319181e07b18a03852b46da4a6d9a0db49f6d420ac7359ceb6ec4a35549bb56b403bec5
-  data.tar.gz: 9c184752196c2cf65b7dba20f94cf3b47428c6fd067c880ffa452bca8ed2fa6d3e84e5cd64ae6e295199622fe4e1ff2d6d09979d2a35e0b9bf36d38c6ebfdd33
+  metadata.gz: 0b1ca0e01a8bdacbdbf9e99a9fa6ef1f386a75baeeadf06cadb0913ac3819488c51c7374949d0e1fa9dfd61d2820296f4e8c78aadb29abfbdd80b991a5096cfb
+  data.tar.gz: db6bf3012259cb357efaf1fcb7929186a7d0bc0a01141310289b4a29e64ec165f3e960988b78f6645ebbe1fa99fa3a002a8a1a94f2a2dcba2029246c6002e845

data/README.md

@@ -22,76 +22,46 @@ Add this to your Gemfile:
 ```ruby
 group :development do
   gem "better_errors"
+  gem "binding_of_caller"
 end
 ```
 
-If you would like to use Better Errors' **advanced features** (REPL, local/instance variable inspection, pretty stack frame names), you need to add the [`binding_of_caller`](https://github.com/banister/binding_of_caller) gem by [@banisterfiend](https://twitter.com/banisterfiend) to your Gemfile:
-
-```ruby
-gem "binding_of_caller"
-```
-
-This is an optional dependency however, and Better Errors will work without it.
+[`binding_of_caller`](https://github.com/banister/binding_of_caller) is optional, but is necessary to use Better Errors' advanced features (REPL, local/instance variable inspection, pretty stack frame names).
 
 _Note: If you discover that Better Errors isn't working - particularly after upgrading from version 0.5.0 or less - be sure to set `config.consider_all_requests_local = true` in `config/environments/development.rb`._
 
 ## Security
 
-**NOTE:** It is *critical* you put better\_errors in the **development** section. **Do NOT run better_errors in production, or on Internet facing hosts.**
-
-You will notice that the only machine that gets the Better Errors page is localhost, which means you get the default error page if you are developing on a remote host (or a virtually remote host, such as a Vagrant box). Obviously, the REPL is not something you want to expose to the public, but there may also be other pieces of sensitive information available in the backtrace.
-
-To poke selective holes in this security mechanism, you can add a line like this to your startup (for example, on Rails it would be `config/environments/development.rb`)
-
-```ruby
-BetterErrors::Middleware.allow_ip! ENV['TRUSTED_IP'] if ENV['TRUSTED_IP']
-```
-
-Then run Rails like this:
-
-```shell
-TRUSTED_IP=66.68.96.220 rails s
-```
+**NOTE:** It is *critical* you put better\_errors only in the **development** section of your Gemfile.
+**Do NOT run better_errors in production, or on Internet-facing hosts.**
 
-Note that the `allow_ip!` is actually backed by a `Set`, so you can add more than one IP address or subnet.
+You will notice that the only machine that gets the Better Errors page is localhost, which means you get the default error page if you are developing on a remote host (or a virtually remote host, such as a Vagrant box).
+Obviously, the REPL is not something you want to expose to the public, and there may be sensitive information available in the backtrace.
 
-**Tip:** You can find your apparent IP by hitting the old error page's "Show env dump" and looking at "REMOTE_ADDR".
-
-**VirtualBox:** If you are using VirtualBox and are accessing the guest from your host's browser, you will need to use `allow_ip!` to see the error page.
+For more information on how to configure access, see [the wiki](https://github.com/charliesome/better_errors/wiki/Allowing-access-to-the-console).
 
 ## Usage
 
 If you're using Rails, there's nothing else you need to do.
 
-If you're not using Rails, you need to insert `BetterErrors::Middleware` into your middleware stack, and optionally set `BetterErrors.application_root` if you'd like Better Errors to abbreviate filenames within your application.
-
-Here's an example using Sinatra:
+### Using without Rails.
 
-```ruby
-require "sinatra"
-require "better_errors"
-
-configure :development do
-  use BetterErrors::Middleware
-  BetterErrors.application_root = __dir__
-end
+If you're not using Rails, you need to insert `BetterErrors::Middleware` into your middleware stack, and optionally set `BetterErrors.application_root` if you'd like Better Errors to abbreviate filenames within your application.
 
-get "/" do
-  raise "oops"
-end
-```
+For instructions for your specific middleware, [see the wiki](https://github.com/charliesome/better_errors/wiki/Non-Rails-frameworks).
 
-### Plain text
+### Plain text requests
 
 Better Errors will render a plain text error page  when the request is an
 `XMLHttpRequest` or when the `Accept` header does *not* include 'html'.
 
 ### Unicorn, Puma, and other multi-worker servers
 
-Better Errors works by leaving a lot of context in server process memory. If
-you're using a web server that runs multiple "workers" it's likely that a second
+Better Errors works by leaving a lot of context in server process memory.
+If you're using a web server that runs multiple "workers" it's likely that a second
 request (as happens when you click on a stack frame) will hit a different
-worker. That worker won't have the necessary context in memory, and you'll see
+worker.
+That worker won't have the necessary context in memory, and you'll see
 a `Session Expired` message.
 
 If this is the case for you, consider turning the number of workers to one (1)
@@ -99,13 +69,11 @@ in `development`. Another option would be to use Webrick, Mongrel, Thin,
 or another single-process server as your `rails server`, when you are trying
 to troubleshoot an issue in development.
 
-##Specify editor to open files in
+### Changing the link to your editor
 
-```ruby
-# e.g. in config/initializers/better_errors.rb
-# Other preset values are [:mvim, :macvim, :textmate, :txmt, :tm, :sublime, :subl, :st]
-BetterErrors.editor = :mvim
-```
+Better Errors includes a link to your editor for the file and line of code that is being shown.
+By default, it uses your environment to determine which editor should be opened.
+See [the wiki for instructions on configuring the editor](https://github.com/charliesome/better_errors/wiki/Link-to-your-editor).
 
 ## Get in touch!
 

data/better_errors.gemspec

@@ -12,13 +12,15 @@ Gem::Specification.new do |s|
   s.homepage      = "https://github.com/charliesome/better_errors"
   s.license       = "MIT"
 
-  s.files         = `git ls-files`.split($/)
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^((test|spec|features|feature-screenshots)/|Rakefile)})
+  end
+
   s.require_paths = ["lib"]
 
   s.required_ruby_version = ">= 2.0.0"
 
-  s.add_dependency "erubis", ">= 2.6.6"
+  s.add_dependency "erubi", ">= 1.0.0"
   s.add_dependency "coderay", ">= 1.0.0"
   s.add_dependency "rack", ">= 0.9.0"
 

data/lib/better_errors.rb

@@ -1,5 +1,5 @@
 require "pp"
-require "erubis"
+require "erubi"
 require "coderay"
 require "uri"
 

data/lib/better_errors/error_page.rb

@@ -10,7 +10,7 @@ module BetterErrors
     end
 
     def self.template(template_name)
-      Erubis::EscapedEruby.new(File.read(template_path(template_name)))
+      Erubi::Engine.new(File.read(template_path(template_name)), escape: true)
     end
 
     attr_reader :exception, :env, :repls
@@ -27,7 +27,7 @@ module BetterErrors
     end
 
     def render(template_name = "main")
-      self.class.template(template_name).result binding
+      binding.eval(self.class.template(template_name).src)
     end
 
     def do_variables(opts)
@@ -41,17 +41,13 @@ module BetterErrors
       index = opts["index"].to_i
       code = opts["source"]
 
-      unless binding = backtrace_frames[index].frame_binding
+      unless (binding = backtrace_frames[index].frame_binding)
         return { error: "REPL unavailable in this stack frame" }
       end
 
-      result, prompt, prefilled_input =
-        (@repls[index] ||= REPL.provider.new(binding)).send_input(code)
+      @repls[index] ||= REPL.provider.new(binding, exception)
 
-      { result: result,
-        prompt: prompt,
-        prefilled_input: prefilled_input,
-        highlighted_input: CodeRay.scan(code, :ruby).div(wrap: nil) }
+      eval_and_respond(index, code)
     end
 
     def backtrace_frames
@@ -114,5 +110,16 @@ module BetterErrors
     rescue Exception
       "<span class='unsupported'>(exception was raised in inspect)</span>"
     end
+
+    def eval_and_respond(index, code)
+      result, prompt, prefilled_input = @repls[index].send_input(code)
+
+      {
+        highlighted_input: CodeRay.scan(code, :ruby).div(wrap: nil),
+        prefilled_input:   prefilled_input,
+        prompt:            prompt,
+        result:            result
+      }
+    end
   end
 end

data/lib/better_errors/middleware.rb

@@ -124,9 +124,8 @@ module BetterErrors
     end
 
     def internal_call(env, opts)
-      if opts[:id] != @error_page.id
-        return [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump(error: "Session expired")]]
-      end
+      return no_errors_json_response unless @error_page
+      return invalid_error_json_response if opts[:id] != @error_page.id
 
       env["rack.input"].rewind
       response = @error_page.send("do_#{opts[:method]}", JSON.parse(env["rack.input"].read))
@@ -137,5 +136,33 @@ module BetterErrors
       "<h1>No errors</h1><p>No errors have been recorded yet.</p><hr>" +
       "<code>Better Errors v#{BetterErrors::VERSION}</code>"
     end
+
+    def no_errors_json_response
+      explanation = if defined? Middleman
+        "Middleman reloads all dependencies for each request, " +
+          "which breaks Better Errors."
+      elsif defined?(Shotgun) && defined?(Hanami)
+        "Hanami is likely running with code-reloading enabled, which is the default. " +
+          "You can disable this by running hanami with the `--no-code-reloading` option."
+      elsif defined? Shotgun
+        "The shotgun gem causes everything to be reloaded for every request. " +
+          "You can disable shotgun in the Gemfile temporarily to use Better Errors."
+      else
+        "The application has been restarted since this page loaded, " +
+          "or the framework is reloading all gems before each request "
+      end
+      [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump(
+        error: 'No exception information available',
+        explanation: explanation,
+      )]]
+    end
+
+    def invalid_error_json_response
+      [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump(
+        error: "Session expired",
+        explanation: "This page was likely opened from a previous exception, " +
+          "and the exception is no longer available in memory.",
+      )]]
+    end
   end
 end

data/lib/better_errors/repl.rb

@@ -21,7 +21,9 @@ module BetterErrors
     end
 
     def self.test_provider(provider)
-      require provider[:impl]
+      # We must load this file instead of `require`ing it, since during our tests we want the file
+      # to be reloaded. In practice, this will only be called once, so `require` is not necessary.
+      load "#{provider[:impl]}.rb"
       true
     rescue LoadError
       false

data/lib/better_errors/repl/basic.rb

@@ -1,7 +1,7 @@
 module BetterErrors
   module REPL
     class Basic
-      def initialize(binding)
+      def initialize(binding, _exception)
         @binding = binding
       end
 

data/lib/better_errors/repl/pry.rb

@@ -30,9 +30,13 @@ module BetterErrors
         ensure
           @buffer = ""
         end
+
+        def print(*args)
+          @buffer << args.join(' ')
+        end
       end
 
-      def initialize(binding)
+      def initialize(binding, exception)
         @fiber = Fiber.new do
           @pry.repl binding
         end
@@ -40,9 +44,15 @@ module BetterErrors
         @output = BetterErrors::REPL::Pry::Output.new
         @pry = ::Pry.new input: @input, output: @output
         @pry.hooks.clear_all if defined?(@pry.hooks.clear_all)
+        store_last_exception exception
         @fiber.resume
       end
 
+      def store_last_exception(exception)
+        return unless defined? ::Pry::LastException
+        @pry.instance_variable_set(:@last_exception, ::Pry::LastException.new(exception.exception))
+      end
+
       def send_input(str)
         local ::Pry.config, color: false, pager: false do
           @fiber.resume "#{str}\n"

data/lib/better_errors/stack_frame.rb

@@ -68,7 +68,14 @@ module BetterErrors
 
     def local_variables
       return {} unless frame_binding
+
       frame_binding.eval("local_variables").each_with_object({}) do |name, hash|
+        # Ruby 2.2's local_variables will include the hidden #$! variable if
+        # called from within a rescue context. This is not a valid variable name,
+        # so the local_variable_get method complains. This should probably be
+        # considered a bug in Ruby itself, but we need to work around it.
+        next if name == :"\#$!"
+
         if defined?(frame_binding.local_variable_get)
           hash[name] = frame_binding.local_variable_get(name)
         else

data/lib/better_errors/templates/main.erb

@@ -777,7 +777,7 @@
 
     function apiCall(method, opts, cb) {
         var req = new XMLHttpRequest();
-        req.open("POST", <%== uri_prefix.gsub("<", "&lt;").inspect %> + "/__better_errors/" + OID + "/" + method, true);
+        req.open("POST", "//" + window.location.host + <%== uri_prefix.gsub("<", "&lt;").inspect %> + "/__better_errors/" + OID + "/" + method, true);
         req.setRequestHeader("Content-Type", "application/json");
         req.send(JSON.stringify(opts));
         req.onreadystatechange = function() {
@@ -938,7 +938,11 @@
             apiCall("variables", { "index": index }, function(response) {
                 el.loaded = true;
                 if(response.error) {
-                    el.innerHTML = "<span class='error'>" + escapeHTML(response.error) + "</span>";
+                    el.innerHTML = "<h2 class='error'>" + escapeHTML(response.error) + "</h2>";
+                    if(response.explanation) {
+                      el.innerHTML += "<p class='explanation'>" + escapeHTML(response.explanation) + "</p>";
+                    }
+                    el.innerHTML += "<p><a target='_new' href='https://github.com/charliesome/better_errors'>More about Better Errors</a></p>";
                 } else {
                     el.innerHTML = response.html;
 
@@ -946,9 +950,8 @@
                     if(repl) {
                         new REPL(index).install(repl);
                     }
-
-                    switchTo(el);
                 }
+                switchTo(el);
             });
         }
     }

data/lib/better_errors/version.rb

@@ -1,3 +1,3 @@
 module BetterErrors
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: better_errors
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Charlie Somerville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-30 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.6
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.6
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
@@ -68,17 +68,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - better_errors.gemspec
-- feature-screenshots/1-application-error.jpg
-- feature-screenshots/2-other-application-frame.jpg
-- feature-screenshots/3-live-shell.jpg
-- feature-screenshots/4-other-frames.jpg
-- feature-screenshots/5-open-editor.jpg
-- feature-screenshots/6-local-variables.jpg
-- feature-screenshots/7-non-html-requests.jpg
-- feature-screenshots/8-xhr-shows-text-error.jpg
-- feature-screenshots/9-xhr-error-in-manual-console.jpg
 - lib/better_errors.rb
 - lib/better_errors/code_formatter.rb
 - lib/better_errors/code_formatter/html.rb
@@ -96,18 +86,6 @@ files:
 - lib/better_errors/templates/text.erb
 - lib/better_errors/templates/variable_info.erb
 - lib/better_errors/version.rb
-- 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
-- spec/better_errors/stack_frame_spec.rb
-- 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
@@ -132,16 +110,4 @@ rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Better error page for Rails and other Rack apps
-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
-- spec/better_errors/stack_frame_spec.rb
-- spec/better_errors/support/my_source.rb
-- spec/better_errors_spec.rb
-- spec/spec_helper.rb
-- spec/without_binding_of_caller.rb
+test_files: []

data/Rakefile

@@ -1,13 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-namespace :test do
-  RSpec::Core::RakeTask.new(:with_binding_of_caller)
-
-  without_task = RSpec::Core::RakeTask.new(:without_binding_of_caller)
-  without_task.ruby_opts = "-I spec -r without_binding_of_caller"
-
-  task :all => [:with_binding_of_caller, :without_binding_of_caller]
-end
-
-task :default => "test:all"