better_errors 1.0.0 → 2.9.1

data/lib/better_errors.rb

@@ -1,23 +1,19 @@
 require "pp"
-require "erubis"
+require "erubi"
 require "coderay"
 require "uri"
 
 require "better_errors/version"
+require "better_errors/code_formatter"
+require "better_errors/inspectable_value"
 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/editor"
 
 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
@@ -43,20 +39,32 @@ module BetterErrors
     # The ignored instance variables.
     # @return [Array]
     attr_accessor :ignored_instance_variables
+
+    # The maximum variable payload size. If variable.inspect exceeds this,
+    # the variable won't be returned.
+    # @return int
+    attr_accessor :maximum_variable_inspect_size
+
+    # List of classes that are excluded from inspection.
+    # @return [Array]
+    attr_accessor :ignored_classes
   end
   @ignored_instance_variables = []
+  @maximum_variable_inspect_size = 100_000
+  @ignored_classes = ['ActionDispatch::Request', 'ActionDispatch::Response']
 
-  # Returns a proc, which when called with a filename and line number argument,
+  # Returns an object which responds to #url, 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]
+  #   BetterErrors.editor.url("/some/file", 123)
   #     # => txmt://open?url=file:///some/file&line=123
   #
   # @return [Proc]
   def self.editor
-    @editor
+    @editor ||= default_editor
   end
 
   # Configures how Better Errors generates open-in-editor URLs.
@@ -67,6 +75,7 @@ module BetterErrors
   #   * `:textmate`, `:txmt`, `:tm`
   #   * `:sublime`, `:subl`, `:st`
   #   * `:macvim`
+  #   * `:atom`
   #
   #   @param [Symbol] sym
   #
@@ -96,27 +105,22 @@ module BetterErrors
   #   @param [Proc] proc
   #
   def self.editor=(editor)
-    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 } }
+    if editor.is_a? Symbol
+      @editor = Editor.editor_from_symbol(editor)
+      raise(ArgumentError, "Symbol #{editor} is not a symbol in the list of supported errors.") unless editor
+    elsif editor.is_a? String
+      @editor = Editor.for_formatting_string(editor)
+    elsif editor.respond_to? :call
+      @editor = Editor.for_proc(editor)
     else
-      if editor.respond_to? :call
-        @editor = editor
-      else
-        raise TypeError, "Expected editor to be a valid editor key, a format string or a callable."
-      end
+      raise ArgumentError, "Expected editor to be a valid editor key, a format string or a callable."
     end
   end
 
   # Enables experimental Pry support in the inline REPL
   #
   # If you encounter problems while using Pry, *please* file a bug report at
-  # https://github.com/charliesome/better_errors/issues
+  # https://github.com/BetterErrors/better_errors/issues
   def self.use_pry!
     REPL::PROVIDERS.unshift const: :Pry, impl: "better_errors/repl/pry"
   end
@@ -126,22 +130,16 @@ module BetterErrors
   #
   # @return [Symbol]
   def self.default_editor
-    POSSIBLE_EDITOR_PRESETS.detect(-> { {} }) { |config|
-      ENV["EDITOR"] =~ config[:sniff]
-    }[:url] || :textmate
+    Editor.default_editor
   end
-
-  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
   BetterErrors.binding_of_caller_available = false
 end
 
-require "better_errors/core_ext/exception"
-
 require "better_errors/rails" if defined? Rails::Railtie

metadata

@@ -1,70 +1,193 @@
 --- !ruby/object:Gem::Specification
 name: better_errors
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Charlie Somerville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.6
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: erubi
+  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: 2.6.6
+        version: 1.0.0
 - !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.
 email:
 - charlie@charliesomerville.com
 executables: []
-extensions:
-- ext/mkrf_conf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".coveralls.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - better_errors.gemspec
-- ext/mkrf_conf.rb
+- gemfiles/pry010.gemfile
+- gemfiles/pry011.gemfile
+- gemfiles/pry09.gemfile
+- gemfiles/rack.gemfile
+- gemfiles/rack_boc.gemfile
+- gemfiles/rails42.gemfile
+- gemfiles/rails42_boc.gemfile
+- gemfiles/rails42_haml.gemfile
+- gemfiles/rails50.gemfile
+- gemfiles/rails50_boc.gemfile
+- gemfiles/rails50_haml.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails51_boc.gemfile
+- gemfiles/rails51_haml.gemfile
+- gemfiles/rails52.gemfile
+- gemfiles/rails52_boc.gemfile
+- gemfiles/rails52_haml.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails60_boc.gemfile
+- gemfiles/rails60_haml.gemfile
 - lib/better_errors.rb
 - 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/editor.rb
 - lib/better_errors/error_page.rb
+- lib/better_errors/exception_extension.rb
+- lib/better_errors/exception_hint.rb
+- lib/better_errors/inspectable_value.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
@@ -73,49 +196,30 @@ 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/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
-homepage: https://github.com/charliesome/better_errors
+homepage: https://github.com/BetterErrors/better_errors
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/BetterErrors/better_errors/releases
+  source_code_uri: https://github.com/BetterErrors/better_errors
+  bug_tracker_uri: https://github.com/BetterErrors/better_errors/issues
 post_install_message: 
 rdoc_options: []
 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: 3.1.4
 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/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
-has_rdoc: 
+test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 1.9.3
-  - 1.9.2
-  - jruby-1.7.4

data/Rakefile

@@ -1,4 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec
-task :test => :spec
-task :spec do sh 'bundle exec rspec' end

data/ext/mkrf_conf.rb

@@ -1,11 +0,0 @@
-require 'rubygems/dependency_installer'
-
-gem = Gem::DependencyInstaller.new
-
-if ["rbx", "ruby"].include?(RUBY_ENGINE)
-  # This MUST match the version specified in lib/better_errors.rb, or else
-  # weird shit will happen.
-  if Gem::Dependency.new("binding_of_caller", "0.7.2").matching_specs.empty?
-    gem.install "binding_of_caller", "0.7.2"
-  end
-end

data/lib/better_errors/core_ext/exception.rb

@@ -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

data/spec/better_errors/code_formatter_spec.rb

@@ -1,92 +0,0 @@
-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",
-          "five\n",
-          "six\n",
-          "seven\n",
-          "eight\n",
-          "nine\n",
-          "ten\n",
-          "eleven\n",
-          "twelve\n",
-          "thirteen\n"
-        ]
-    end
-
-    it "works when the line is right on the edge" do
-      formatter = CodeFormatter.new(filename, 20)
-      formatter.line_range.should == (15..20)
-    end
-
-    describe CodeFormatter::HTML do
-      it "highlights the erroring line" do
-        formatter = CodeFormatter::HTML.new(filename, 8)
-        formatter.output.should =~ /highlight.*eight/
-      end
-
-      it "works when the line is right on the edge" do
-        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
-      end
-    end
-
-    describe CodeFormatter::Text do
-      it "highlights the erroring line" do
-        formatter = CodeFormatter::Text.new(filename, 8)
-        formatter.output.should == <<-TEXT.gsub(/^        /, "")
-            3   three
-            4   four
-            5   five
-            6   six
-            7   seven
-        >   8   eight
-            9   nine
-           10   ten
-           11   eleven
-           12   twelve
-           13   thirteen
-        TEXT
-      end
-
-      it "works when the line is right on the edge" do
-        formatter = CodeFormatter::Text.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::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
-      end
-    end
-  end
-end

data/spec/better_errors/error_page_spec.rb

@@ -1,76 +0,0 @@
-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]
-          html.should include("local_a")
-          html.should include(":value_for_local_a")
-          html.should include("local_b")
-          html.should include(":value_for_local_b")
-        end
-      else
-        it "tells the user to add binding_of_caller to their gemfile to get fancy features" do
-          html = error_page.do_variables("index" => 0)[:html]
-          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")
-        html.should include(":value_for_inst_c")
-        html.should include("inst_d")
-        html.should include(":value_for_inst_d")
-      end
-
-      it "shows filter instance variables" do
-        BetterErrors.stub(:ignored_instance_variables).and_return([ :@inst_d ])
-        html = error_page.do_variables("index" => 0)[:html]
-        html.should include("inst_c")
-        html.should include(":value_for_inst_c")
-        html.should_not include('<td class="name">@inst_d</td>')
-        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'"
-      ])
-      response.should include("Source unavailable")
-    end
-  end
-end