better_errors 0.9.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 785a0ad660868a52fd48ab6d3b7c2f0271a9c32d
-  data.tar.gz: 40d2e1dab31d7aeca46c9d6761ab907e5c944b87
-SHA512:
-  metadata.gz: 715085c73baaa36af3b73294f1de9d61b8dd44011e310f1d2145fe9156d624c8fe1f089c1558ad5156c37b7f9386c43eb4573e5e8e485a7e0cda6ef1c70fc82e
-  data.tar.gz: 56cf655e78b89ecdbd960008e7f77973ed91c2d2583ad6c3d6c0fa9cf1b88aa098c37525b7072f801b4e2ae62fdf371d2a8cbd2e947397063104900c6594c5d2
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjYyNmFjYTQ1MjJmN2M4ZTIyODQ0MGY2YzNjOTE5ODU5ODU2NzQyZQ==
+  data.tar.gz: !binary |-
+    OWRjYzA4NTI5YzI1YWViZDAyMjlhN2RmOWQ4NDA3MWYwMTlkMzUyNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTBhZDMwMTI5MzFiZTYwNzNlNzk2YWI2NTE2OTYzODc2ODZjZjFkYjQ4MGIw
+    MGI5ZGM5NzVkMzQzZmUzYzBjOTJlYmYzMWZjMDZlMjZjYmQzNjQ2NDM5OTY5
+    NTdlNDMwMjFhNTlhY2VhYWU1YzVlMTA2ZGZmYmI0OGYwYzYxNmQ=
+  data.tar.gz: !binary |-
+    ZTZmNjc4ZTRmZjlhZTZhOTJhMjc1MDM0NDAwMDMyYjdkNzY4MDdkOTNlN2Nk
+    YjBhMjhlNjE3YTZhZmFkODU1OTk1MGFkMjk4MWRhMzljNzc4ZTczMzdhMTBk
+    MTRjNWJhMGU4NDllYWFiMDFiOWNiMmNhZTQ4OGU2MzE3MGQyMzQ=

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
   - 2.0.0
+  - jruby-1.7.4

data/Gemfile

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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Charlie Somerville
+Copyright (c) 2013 Charlie Somerville
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,4 +1,4 @@
-# Better Errors
+# 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 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.
 
@@ -67,7 +67,7 @@ require "better_errors"
 
 configure :development do
   use BetterErrors::Middleware
-  BetterErrors.application_root = File.expand_path("..", __FILE__)
+  BetterErrors.application_root = __dir__
 end
 
 get "/" do
@@ -75,27 +75,18 @@ get "/" do
 end
 ```
 
-## Compatibility
-
-* **Supported**
-  * MRI 1.9.2, 1.9.3, 2.0.0
-  * JRuby (1.9 mode) - *advanced features unsupported*
-  * Rubinius (1.9 mode) - *advanced features unsupported*
-
-[![Build Status](https://travis-ci.org/charliesome/better_errors.png)](https://travis-ci.org/charliesome/better_errors)
-
 ### 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 muliple "workers" it's likely that a second
+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
 a `Session Expired` message.
 
-If this is the case for you, consider turing the number of workers to one (1)
-in `development`. Another option would be to use `rails server`, or another
-single-process web server, when you are trying to troubleshoot an issue in
-development.
+If this is the case for you, consider turning the number of workers to one (1)
+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.
 
 ## Get in touch!
 

data/better_errors.gemspec

@@ -18,14 +18,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.required_ruby_version = ">= 1.9.2"
-
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.12.0"
-  s.add_development_dependency "binding_of_caller"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "simplecov"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "redcarpet"
   
   s.add_dependency "erubis", ">= 2.6.6"
   s.add_dependency "coderay", ">= 1.0.0"

data/lib/better_errors.rb

@@ -11,25 +11,32 @@ require "better_errors/code_formatter"
 require "better_errors/repl"
 
 module BetterErrors
+  POSSIBLE_EDITOR_PRESETS = [
+    { symbols: [:emacs, :emacsclient],  sniff: /emacs/i, url: "emacs://open?url=file://%{file}&line=%{line}" },
+    { symbols: [:macvim, :mvim],        sniff: /vim/i,   url: proc { |file, line| "mvim://open?url=file://#{file}&line=#{line}" } },
+    { symbols: [:sublime, :subl, :st],  sniff: /subl/i,  url: "subl://open?url=file://%{file}&line=%{line}" },
+    { symbols: [:textmate, :txmt, :tm], sniff: /mate/i,  url: "txmt://open?url=file://%{file}&line=%{line}" },
+  ]
+
   class << self
     # The path to the root of the application. Better Errors uses this property
     # to determine if a file in a backtrace should be considered an application
     # frame. If you are using Better Errors with Rails, you do not need to set
     # this attribute manually.
-    # 
+    #
     # @return [String]
     attr_accessor :application_root
-    
+
     # The logger to use when logging exception details and backtraces. If you
     # are using Better Errors with Rails, you do not need to set this attribute
     # manually. If this attribute is `nil`, nothing will be logged.
-    # 
+    #
     # @return [Logger, nil]
     attr_accessor :logger
 
     # @private
     attr_accessor :binding_of_caller_available
-    
+
     # @private
     alias_method :binding_of_caller_available?, :binding_of_caller_available
 
@@ -41,64 +48,61 @@ module BetterErrors
 
   # Returns a proc, which when called with a filename and line number argument,
   # returns a URL to open the filename and line in the selected editor.
-  # 
+  #
   # Generates TextMate URLs by default.
-  # 
+  #
   #   BetterErrors.editor["/some/file", 123]
   #     # => txmt://open?url=file:///some/file&line=123
-  # 
+  #
   # @return [Proc]
   def self.editor
     @editor
   end
-  
+
   # Configures how Better Errors generates open-in-editor URLs.
-  # 
+  #
   # @overload BetterErrors.editor=(sym)
   #   Uses one of the preset editor configurations. Valid symbols are:
   #
   #   * `:textmate`, `:txmt`, `:tm`
   #   * `:sublime`, `:subl`, `:st`
   #   * `:macvim`
-  # 
+  #
   #   @param [Symbol] sym
-  # 
+  #
   # @overload BetterErrors.editor=(str)
   #   Uses `str` as the format string for generating open-in-editor URLs.
-  # 
+  #
   #   Use `%{file}` and `%{line}` as placeholders for the actual values.
-  # 
+  #
   #   @example
   #     BetterErrors.editor = "my-editor://open?url=%{file}&line=%{line}"
-  # 
+  #
   #   @param [String] str
-  # 
+  #
   # @overload BetterErrors.editor=(proc)
   #   Uses `proc` to generate open-in-editor URLs. The proc will be called
   #   with `file` and `line` parameters when a URL needs to be generated.
-  # 
+  #
   #   Your proc should take care to escape `file` appropriately with
   #   `URI.encode_www_form_component` (please note that `URI.escape` is **not**
   #   a suitable substitute.)
-  # 
+  #
   #   @example
   #     BetterErrors.editor = proc { |file, line|
   #       "my-editor://open?url=#{URI.encode_www_form_component file}&line=#{line}"
   #     }
-  #   
+  #
   #   @param [Proc] proc
-  # 
+  #
   def self.editor=(editor)
-    case editor
-    when :textmate, :txmt, :tm
-      self.editor = "txmt://open?url=file://%{file}&line=%{line}"
-    when :sublime, :subl, :st
-      self.editor = "subl://open?url=file://%{file}&line=%{line}"
-    when :macvim, :mvim
-      self.editor = proc { |file, line| "mvim://open?url=file://#{file}&line=#{line}" }
-    when :emacs
-      self.editor = "emacs://open?url=file://%{file}&line=%{line}"
-    when String
+    POSSIBLE_EDITOR_PRESETS.each do |config|
+      if config[:symbols].include?(editor)
+        return self.editor = config[:url]
+      end
+    end
+
+    if editor.is_a? String
       self.editor = proc { |file, line| editor % { file: URI.encode_www_form_component(file), line: line } }
     else
       if editor.respond_to? :call
@@ -116,8 +120,18 @@ module BetterErrors
   def self.use_pry!
     REPL::PROVIDERS.unshift const: :Pry, impl: "better_errors/repl/pry"
   end
-  
-  BetterErrors.editor = :textmate
+
+  # Automatically sniffs a default editor preset based on the EDITOR
+  # environment variable.
+  #
+  # @return [Symbol]
+  def self.default_editor
+    POSSIBLE_EDITOR_PRESETS.detect(-> { {} }) { |config|
+      ENV["EDITOR"] =~ config[:sniff]
+    }[:url] || :textmate
+  end
+
+  BetterErrors.editor = default_editor
 end
 
 begin

data/lib/better_errors/code_formatter.rb

@@ -36,9 +36,9 @@ module BetterErrors
     end
 
     def each_line_of(lines, &blk)
-      line_range.zip(lines).map do |current_line, str|
+      line_range.zip(lines).map { |current_line, str|
         yield (current_line == line), current_line, str
-      end
+      }
     end
     
     def highlighted_lines

data/lib/better_errors/code_formatter/html.rb

@@ -6,14 +6,21 @@ module BetterErrors
     end
 
     def formatted_lines
-      each_line_of highlighted_lines do |highlight, current_line, str|
+      each_line_of(highlighted_lines) { |highlight, current_line, str|
         class_name = highlight ? "highlight" : ""
-        sprintf '<pre class="%s">%5d %s</pre>', class_name, current_line, str
-      end
+        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" : ""
+        sprintf '<span class="%s">%5d</span>', class_name, current_line
+      }
     end
 
     def formatted_code
-      %{<div class="code">#{super}</div>}
+      %{<div class="code_linenums">#{formatted_nums.join}</div><div class="code">#{super}</div>}
     end
   end
 end

data/lib/better_errors/code_formatter/text.rb

@@ -6,9 +6,9 @@ module BetterErrors
     end
 
     def formatted_lines
-      each_line_of context_lines do |highlight, current_line, str|
+      each_line_of(context_lines) { |highlight, current_line, str|
         sprintf '%s %3d   %s', (highlight ? '>' : ' '), current_line, str
-      end
+      }
     end
   end
 end

data/lib/better_errors/error_page.rb

@@ -40,11 +40,12 @@ module BetterErrors
         return { error: "REPL unavailable in this stack frame" }
       end
       
-      result, prompt =
+      result, prompt, prefilled_input =
         (@repls[index] ||= REPL.provider.new(binding)).send_input(code)
       
       { result: result,
         prompt: prompt,
+        prefilled_input: prefilled_input,
         highlighted_input: CodeRay.scan(code, :ruby).div(wrap: nil) }
     end
 

data/lib/better_errors/middleware.rb

@@ -64,8 +64,8 @@ module BetterErrors
     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"]
-      ip = IPAddr.new env["REMOTE_ADDR"]
+      return true unless env["REMOTE_ADDR"] and !env["REMOTE_ADDR"].strip.empty?
+      ip = IPAddr.new env["REMOTE_ADDR"].split("%").first
       ALLOWED_IPS.any? { |subnet| subnet.include? ip }
     end
 
@@ -85,10 +85,10 @@ module BetterErrors
     rescue Exception => ex
       @error_page = @handler.new ex, env
       log_exception
-      show_error_page(env)
+      show_error_page(env, ex)
     end
 
-    def show_error_page(env)
+    def show_error_page(env, exception=nil)
       type, content = if @error_page
         if text?(env)
           [ 'plain', @error_page.render('text') ]
@@ -99,7 +99,12 @@ module BetterErrors
         [ 'html', no_errors_page ]
       end
 
-      [500, { "Content-Type" => "text/#{type}; charset=utf-8" }, [content]]
+      status_code = 500
+      if defined? ActionDispatch::ExceptionWrapper
+        status_code = ActionDispatch::ExceptionWrapper.new(env, exception).status_code
+      end
+
+      [status_code, { "Content-Type" => "text/#{type}; charset=utf-8" }, [content]]
     end
 
     def text?(env)

data/lib/better_errors/repl.rb

@@ -15,9 +15,9 @@ module BetterErrors
     end
     
     def self.detect
-      PROVIDERS.find do |prov|
+      PROVIDERS.find { |prov|
         test_provider prov
-      end
+      }
     end
     
     def self.test_provider(provider)

data/lib/better_errors/repl/basic.rb

@@ -6,7 +6,7 @@ module BetterErrors
       end
     
       def send_input(str)
-        [execute(str), ">>"]
+        [execute(str), ">>", ""]
       end
     
     private

data/lib/better_errors/repl/pry.rb

@@ -40,19 +40,24 @@ module BetterErrors
         @output = Output.new
         @pry = ::Pry.new input: @input, output: @output
         @pry.hooks.clear_all
-        @continued_expression = false
-        @pry.hooks.add_hook :after_read, "better_errors hacky hook" do
-          @continued_expression = false
-        end
         @fiber.resume
       end
     
       def send_input(str)
         local ::Pry.config, color: false, pager: false do
-          @continued_expression = true
           @fiber.resume "#{str}\n"
-          [@output.read_buffer, @continued_expression ? ".." : ">>"]
+          [@output.read_buffer, *prompt]
+        end
+      end
+
+      def prompt
+        if indent = @pry.instance_variable_get(:@indent) and !indent.indent_level.empty?
+          ["..", indent.indent_level]
+        else
+          [">>", ""]
         end
+      rescue
+        [">>", ""]
       end
       
     private

data/lib/better_errors/stack_frame.rb

@@ -1,8 +1,10 @@
+require "set"
+
 module BetterErrors
   # @private
   class StackFrame
     def self.from_exception(exception)
-      if exception.__better_errors_bindings_stack.any?
+      if has_binding_stack?(exception)
         list = exception.__better_errors_bindings_stack.map { |binding|
           file = binding.eval "__FILE__"
           line = binding.eval "__LINE__"
@@ -16,12 +18,36 @@ module BetterErrors
         }.compact
       end
 
-      if exception.is_a?(SyntaxError) && exception.to_s =~ /\A(.*):(\d*):/
-        list.unshift StackFrame.new($1, $2.to_i, "")
+      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?
+    end
     
     attr_reader :filename, :line, :name, :frame_binding
     
@@ -85,7 +111,11 @@ module BetterErrors
       return {} unless frame_binding
       frame_binding.eval("local_variables").each_with_object({}) do |name, hash|
         begin
-          hash[name] = frame_binding.eval(name.to_s)
+          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
@@ -110,14 +140,18 @@ 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("__method__")
-      if recv.is_a? Module
+
+      return unless method_name = frame_binding.eval("::Kernel.__method__")
+
+      if Kernel.instance_method(:is_a?).bind(recv).call Module
         @class_name = "#{$1}#{recv}"
         @method_name = ".#{method_name}"
       else
-        @class_name = "#{$1}#{recv.class}"
+        @class_name = "#{$1}#{Kernel.instance_method(:class).bind(recv).call}"
         @method_name = "##{method_name}"
       end
     end