better_errors 1.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe0694430a61558b1ad22a156922e9a162b02352
-  data.tar.gz: 6804d151297037d1eb778143d3eb807fe7573e9d
+  metadata.gz: 5ae01bfc76b45f6af1df26c7268229088f8de251
+  data.tar.gz: f95f617f84e01f1641bf193d735d45d85360b768
 SHA512:
-  metadata.gz: 3d0c58b00e4b6965e8dfd3ae3ded8a9efbfde40f8878854cf3ed86b46a5b344e647a73e24f541de858ea1f9f1b6b6c5b29145896b73870ac3eb34219edafb9db
-  data.tar.gz: 5fc01d0bd170e712c28d0efde81fa177eff86b6b36862bef1217749e1b39778c6e97e1899bed429f66dfaecfee45de843328935fe746402508892657232cf7aa
+  metadata.gz: 4881b5a147d85c9c7ed116a8838e45745bd95958df71dea8934e0b5601fd32cde2a016bbc419a855f9e29dd8e6bab322fcae8d676a78ede120d134809dac29b7
+  data.tar.gz: 6fb75468216fc264250e8f6726d47689025352441701cb83b2c125b541ac389c491da6ba8b3eeded2759b99be47f5c0cd103b54315122d7a33905261d02d4cca

data/.gitignore

@@ -1,6 +1,8 @@
 *.gem
-tmp
-Gemfile.lock
-coverage
-.yardoc
-doc
+/tmp
+/Gemfile.lock
+/coverage
+/.yardoc
+/doc
+/.bundle
+/vendor/gems

data/.travis.yml

@@ -1,6 +1,6 @@
+sudo: false
 language: ruby
+cache: bundler
 rvm:
+  - 2.1.0
   - 2.0.0
-  - 1.9.3
-  - 1.9.2
-  - jruby-1.7.4

data/Gemfile

@@ -3,9 +3,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rake"
+gem "rack"
 gem "rspec", "2.14.1"
 gem "binding_of_caller", platforms: :ruby
 gem "pry", "0.9.12"
-gem "simplecov"
 gem "yard"
 gem "kramdown"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Charlie Somerville
+Copyright (c) 2012-2015 Charlie Somerville
 
 MIT License
 

data/README.md

@@ -1,8 +1,8 @@
-# Better Errors [![Build Status](https://travis-ci.org/charliesome/better_errors.png)](https://travis-ci.org/charliesome/better_errors) [![Code Climate](https://codeclimate.com/github/charliesome/better_errors.png)](https://codeclimate.com/github/charliesome/better_errors)
+# Better Errors [![Gem Version](https://img.shields.io/gem/v/better_errors.svg)](https://rubygems.org/gems/better_errors) [![Build Status](https://travis-ci.org/charliesome/better_errors.svg)](https://travis-ci.org/charliesome/better_errors) [![Code Climate](https://img.shields.io/codeclimate/github/charliesome/better_errors.svg)](https://codeclimate.com/github/charliesome/better_errors)
 
 Better Errors replaces the standard Rails error page with a much better and more useful error page. It is also usable outside of Rails in any Rack app as Rack middleware.
 
-![image](http://i.imgur.com/6zBGAAb.png)
+![image](https://i.imgur.com/6zBGAAb.png)
 
 ## Features
 
@@ -21,7 +21,7 @@ group :development do
 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](http://twitter.com/banisterfiend) to your Gemfile:
+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"
@@ -29,6 +29,8 @@ gem "binding_of_caller"
 
 This is an optional dependency however, and Better Errors will work without it.
 
+_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.**
@@ -75,6 +77,11 @@ get "/" do
 end
 ```
 
+### Plain text
+
+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

data/Rakefile

@@ -1,4 +1,13 @@
 require "bundler/gem_tasks"
-task :default => :spec
-task :test => :spec
-task :spec do sh 'bundle exec rspec' end
+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"

data/better_errors.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'better_errors/version'
@@ -17,10 +16,11 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 1.9.2"
-  
+  s.required_ruby_version = ">= 2.0.0"
+
   s.add_dependency "erubis", ">= 2.6.6"
   s.add_dependency "coderay", ">= 1.0.0"
+  s.add_dependency "rack", ">= 0.9.0"
 
   # optional dependencies:
   # s.add_dependency "binding_of_caller"

data/lib/better_errors/code_formatter/html.rb

@@ -11,7 +11,7 @@ module BetterErrors
         sprintf '<pre class="%s">%s</pre>', class_name, str
       }
     end
-    
+
     def formatted_nums
       each_line_of(highlighted_lines) { |highlight, current_line, str|
         class_name = highlight ? "highlight" : ""

data/lib/better_errors/code_formatter.rb

@@ -11,9 +11,9 @@ module BetterErrors
       ".erb"  => :erb,
       ".haml" => :haml
     }
-    
+
     attr_reader :filename, :line, :context
-    
+
     def initialize(filename, line, context = 5)
       @filename = filename
       @line     = line
@@ -29,7 +29,7 @@ module BetterErrors
     def formatted_code
       formatted_lines.join
     end
-    
+
     def coderay_scanner
       ext = File.extname(filename)
       FILE_TYPES[ext] || :text
@@ -40,20 +40,20 @@ module BetterErrors
         yield (current_line == line), current_line, str
       }
     end
-    
+
     def highlighted_lines
       CodeRay.scan(context_lines.join, coderay_scanner).div(wrap: nil).lines
     end
-    
+
     def context_lines
       range = line_range
       source_lines[(range.begin - 1)..(range.end - 1)] or raise Errno::EINVAL
     end
-    
+
     def source_lines
       @source_lines ||= File.readlines(filename)
     end
-    
+
     def line_range
       min = [line - context, 1].max
       max = [line + context, source_lines.count].min

data/lib/better_errors/error_page.rb

@@ -1,5 +1,6 @@
 require "cgi"
 require "json"
+require "securerandom"
 
 module BetterErrors
   # @private
@@ -7,42 +8,46 @@ module BetterErrors
     def self.template_path(template_name)
       File.expand_path("../templates/#{template_name}.erb", __FILE__)
     end
-    
+
     def self.template(template_name)
       Erubis::EscapedEruby.new(File.read(template_path(template_name)))
     end
-    
+
     attr_reader :exception, :env, :repls
-    
+
     def initialize(exception, env)
-      @exception = real_exception(exception)
+      @exception = RaisedException.new(exception)
       @env = env
       @start_time = Time.now.to_f
       @repls = []
     end
-    
+
+    def id
+      @id ||= SecureRandom.hex(8)
+    end
+
     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]
       @var_start_time = Time.now.to_f
       { html: render("variable_info") }
     end
-    
+
     def do_eval(opts)
       index = opts["index"].to_i
       code = opts["source"]
-      
+
       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)
-      
+
       { result: result,
         prompt: prompt,
         prefilled_input: prefilled_input,
@@ -50,22 +55,22 @@ module BetterErrors
     end
 
     def backtrace_frames
-      @backtrace_frames ||= StackFrame.from_exception(exception)
+      exception.backtrace
     end
 
     def application_frames
-      backtrace_frames.select { |frame| frame.context == :application }
+      backtrace_frames.select(&:application?)
     end
 
     def first_frame
-      backtrace_frames.detect { |frame| frame.context == :application } || backtrace_frames.first
+      application_frames.first || backtrace_frames.first
     end
-    
+
   private
     def editor_url(frame)
       BetterErrors.editor[frame.filename, frame.line]
     end
-    
+
     def rack_session
       env['rack.session']
     end
@@ -77,31 +82,15 @@ module BetterErrors
     def uri_prefix
       env["SCRIPT_NAME"] || ""
     end
-  
-    def exception_message
-      if exception.is_a?(SyntaxError) && exception.message =~ /\A.*:\d*: (.*)$/
-        $1
-      else
-        exception.message
-      end
-    end
 
-    def real_exception(exception)
-      if exception.respond_to?(:original_exception) && exception.original_exception.is_a?(Exception)
-        exception.original_exception
-      else
-        exception
-      end
-    end
-  
     def request_path
       env["PATH_INFO"]
     end
-    
+
     def html_formatted_code_block(frame)
       CodeFormatter::HTML.new(frame.filename, frame.line).output
     end
-    
+
     def text_formatted_code_block(frame)
       CodeFormatter::Text.new(frame.filename, frame.line).output
     end
@@ -114,7 +103,7 @@ module BetterErrors
       CGI.escapeHTML(obj.inspect)
     rescue NoMethodError
       "<span class='unsupported'>(object doesn't support inspect)</span>"
-    rescue Exception => e
+    rescue Exception
       "<span class='unsupported'>(exception was raised in inspect)</span>"
     end
   end

data/lib/better_errors/exception_extension.rb

@@ -0,0 +1,17 @@
+module BetterErrors
+  module ExceptionExtension
+    prepend_features Exception
+
+    def set_backtrace(*)
+      if caller_locations.none? { |loc| loc.path == __FILE__ }
+        @__better_errors_bindings_stack = ::Kernel.binding.callers.drop(1)
+      end
+
+      super
+    end
+
+    def __better_errors_bindings_stack
+      @__better_errors_bindings_stack || []
+    end
+  end
+end

data/lib/better_errors/middleware.rb

@@ -1,6 +1,7 @@
 require "json"
 require "ipaddr"
 require "set"
+require "rack"
 
 module BetterErrors
   # Better Errors' error handling middleware. Including this in your middleware
@@ -62,16 +63,15 @@ module BetterErrors
   private
 
     def allow_ip?(env)
-      # REMOTE_ADDR is not in the rack spec, so some application servers do
-      # not provide it.
-      return true unless env["REMOTE_ADDR"] and !env["REMOTE_ADDR"].strip.empty?
-      ip = IPAddr.new env["REMOTE_ADDR"].split("%").first
+      request = Rack::Request.new(env)
+      return true unless request.ip and !request.ip.strip.empty?
+      ip = IPAddr.new request.ip.split("%").first
       ALLOWED_IPS.any? { |subnet| subnet.include? ip }
     end
 
     def better_errors_call(env)
       case env["PATH_INFO"]
-      when %r{/__better_errors/(?<oid>-?\d+)/(?<method>\w+)\z}
+      when %r{/__better_errors/(?<id>.+?)/(?<method>\w+)\z}
         internal_call env, $~
       when %r{/__better_errors/?\z}
         show_error_page env
@@ -115,7 +115,7 @@ module BetterErrors
     def log_exception
       return unless BetterErrors.logger
 
-      message = "\n#{@error_page.exception.class} - #{@error_page.exception.message}:\n"
+      message = "\n#{@error_page.exception.type} - #{@error_page.exception.message}:\n"
       @error_page.backtrace_frames.each do |frame|
         message << "  #{frame}\n"
       end
@@ -124,7 +124,7 @@ module BetterErrors
     end
 
     def internal_call(env, opts)
-      if opts[:oid].to_i != @error_page.object_id
+      if opts[:id] != @error_page.id
         return [200, { "Content-Type" => "text/plain; charset=utf-8" }, [JSON.dump(error: "Session expired")]]
       end
 

data/lib/better_errors/raised_exception.rb

@@ -0,0 +1,66 @@
+# @private
+module BetterErrors
+  class RaisedException
+    attr_reader :exception, :message, :backtrace
+
+    def initialize(exception)
+      if exception.respond_to?(:original_exception) && exception.original_exception
+        exception = exception.original_exception
+      end
+
+      @exception = exception
+      @message = exception.message
+
+      setup_backtrace
+      massage_syntax_error
+    end
+
+    def type
+      exception.class
+    end
+
+  private
+    def has_bindings?
+      exception.respond_to?(:__better_errors_bindings_stack) && exception.__better_errors_bindings_stack.any?
+    end
+
+    def setup_backtrace
+      if has_bindings?
+        setup_backtrace_from_bindings
+      else
+        setup_backtrace_from_backtrace
+      end
+    end
+
+    def setup_backtrace_from_bindings
+      @backtrace = exception.__better_errors_bindings_stack.map { |binding|
+        file = binding.eval "__FILE__"
+        line = binding.eval "__LINE__"
+        name = binding.frame_description
+        StackFrame.new(file, line, name, binding)
+      }
+    end
+
+    def setup_backtrace_from_backtrace
+      @backtrace = (exception.backtrace || []).map { |frame|
+        if /\A(?<file>.*?):(?<line>\d+)(:in `(?<name>.*)')?/ =~ frame
+          StackFrame.new(file, line.to_i, name)
+        end
+      }.compact
+    end
+
+    def massage_syntax_error
+      case exception.class.to_s
+      when "Haml::SyntaxError", "Sprockets::Coffeelint::Error"
+        if /\A(.+?):(\d+)/ =~ exception.backtrace.first
+          backtrace.unshift(StackFrame.new($1, $2.to_i, ""))
+        end
+      when "SyntaxError"
+        if /\A(.+?):(\d+): (.*)/m =~ exception.message
+          backtrace.unshift(StackFrame.new($1, $2.to_i, ""))
+          @message = $3
+        end
+      end
+    end
+  end
+end

data/lib/better_errors/repl/basic.rb

@@ -4,11 +4,11 @@ module BetterErrors
       def initialize(binding)
         @binding = binding
       end
-    
+
       def send_input(str)
         [execute(str), ">>", ""]
       end
-    
+
     private
       def execute(str)
         "=> #{@binding.eval(str).inspect}\n"

data/lib/better_errors/repl/pry.rb

@@ -9,40 +9,40 @@ module BetterErrors
           Fiber.yield
         end
       end
-      
+
       class Output
         def initialize
           @buffer = ""
         end
-        
+
         def puts(*args)
           args.each do |arg|
             @buffer << "#{arg.chomp}\n"
           end
         end
-        
+
         def tty?
           false
         end
-        
+
         def read_buffer
           @buffer
         ensure
           @buffer = ""
         end
       end
-      
+
       def initialize(binding)
         @fiber = Fiber.new do
           @pry.repl binding
         end
-        @input = Input.new
-        @output = Output.new
+        @input = BetterErrors::REPL::Pry::Input.new
+        @output = BetterErrors::REPL::Pry::Output.new
         @pry = ::Pry.new input: @input, output: @output
         @pry.hooks.clear_all if defined?(@pry.hooks.clear_all)
         @fiber.resume
       end
-    
+
       def send_input(str)
         local ::Pry.config, color: false, pager: false do
           @fiber.resume "#{str}\n"
@@ -59,7 +59,7 @@ module BetterErrors
       rescue
         [">>", ""]
       end
-      
+
     private
       def local(obj, attrs)
         old_attrs = {}

data/lib/better_errors/repl.rb

@@ -9,17 +9,17 @@ module BetterErrors
     def self.provider
       @provider ||= const_get detect[:const]
     end
-    
+
     def self.provider=(prov)
       @provider = prov
     end
-    
+
     def self.detect
       PROVIDERS.find { |prov|
         test_provider prov
       }
     end
-    
+
     def self.test_provider(provider)
       require provider[:impl]
       true

data/lib/better_errors/stack_frame.rb

@@ -4,49 +4,7 @@ module BetterErrors
   # @private
   class StackFrame
     def self.from_exception(exception)
-      if has_binding_stack?(exception)
-        list = exception.__better_errors_bindings_stack.map { |binding|
-          file = binding.eval "__FILE__"
-          line = binding.eval "__LINE__"
-          name = binding.frame_description
-          StackFrame.new(file, line, name, binding)
-        }
-      else
-        list = (exception.backtrace || []).map { |frame|
-          next unless md = /\A(?<file>.*?):(?<line>\d+)(:in `(?<name>.*)')?/.match(frame)
-          StackFrame.new(md[:file], md[:line].to_i, md[:name])
-        }.compact
-      end
-
-      if syntax_error?(exception)
-        if trace = exception.backtrace and trace.first =~ /\A(.*):(\d+)/
-          list.unshift StackFrame.new($1, $2.to_i, "")
-        end
-      end
-
-      list
-    end
-
-    def self.syntax_error_classes
-      # Better Errors may be loaded before some of the gems that provide these
-      # classes, so we lazily set up the set of syntax error classes at runtime
-      # after everything has hopefully had a chance to load.
-      #
-      @syntax_error_classes ||= begin
-        class_names = %w[
-          Haml::SyntaxError
-        ]
-
-        Set.new(class_names.map { |klass| eval(klass) rescue nil }.compact)
-      end
-    end
-
-    def self.syntax_error?(exception)
-      exception.is_a?(SyntaxError) || syntax_error_classes.include?(exception.class)
-    end
-
-    def self.has_binding_stack?(exception)
-      exception.respond_to?(:__better_errors_bindings_stack) && exception.__better_errors_bindings_stack.any?
+      RaisedException.new(exception).backtrace
     end
 
     attr_reader :filename, :line, :name, :frame_binding
@@ -75,7 +33,7 @@ module BetterErrors
     end
 
     def gem_path
-      if path = Gem.path.detect { |path| filename.index(path) == 0 }
+      if path = Gem.path.detect { |p| filename.index(p) == 0 }
         gem_name_and_version, path = filename.sub("#{path}/gems/", "").split("/", 2)
         /(?<gem_name>.+)-(?<gem_version>[\w.]+)/ =~ gem_name_and_version
         "#{gem_name} (#{gem_version}) #{path}"
@@ -111,15 +69,10 @@ module BetterErrors
     def local_variables
       return {} unless frame_binding
       frame_binding.eval("local_variables").each_with_object({}) do |name, hash|
-        begin
-          if defined?(frame_binding.local_variable_get)
-            hash[name] = frame_binding.local_variable_get(name)
-          else
-            hash[name] = frame_binding.eval(name.to_s)
-          end
-        rescue NameError => e
-          # local_variables sometimes returns broken variables.
-          # https://bugs.ruby-lang.org/issues/7536
+        if defined?(frame_binding.local_variable_get)
+          hash[name] = frame_binding.local_variable_get(name)
+        else
+          hash[name] = frame_binding.eval(name.to_s)
         end
       end
     end
@@ -141,14 +94,12 @@ module BetterErrors
 
   private
     def set_pretty_method_name
-      return if RUBY_VERSION < "2.0.0"
-
       name =~ /\A(block (\([^)]+\) )?in )?/
       recv = frame_binding.eval("self")
 
       return unless method_name = frame_binding.eval("::Kernel.__method__")
 
-      if Kernel.instance_method(:is_a?).bind(recv).call Module
+      if Module === recv
         @class_name = "#{$1}#{recv}"
         @method_name = ".#{method_name}"
       else