better_errors 2.3.0 → 2.9.1

data/lib/better_errors/templates/main.erb

@@ -90,7 +90,7 @@
         nav.sidebar,
         .frame_info {
             position: fixed;
-            top: 95px;
+            top: 102px;
             bottom: 0;
 
             box-sizing: border-box;
@@ -102,7 +102,7 @@
         nav.sidebar {
             width: 40%;
             left: 20px;
-            top: 115px;
+            top: 122px;
             bottom: 20px;
         }
 
@@ -131,7 +131,7 @@
     header.exception {
         padding: 18px 20px;
 
-        height: 59px;
+        height: 66px;
         min-height: 59px;
 
         overflow: hidden;
@@ -146,6 +146,14 @@
     }
 
     /* Heading */
+    header.exception .fix-actions {
+        margin-top: .5em;
+    }
+
+    header.exception .fix-actions input[type=submit] {
+        font-weight: bold;
+    }
+
     header.exception h2 {
         font-weight: 200;
         font-size: 11pt;
@@ -153,7 +161,7 @@
 
     header.exception h2,
     header.exception p {
-        line-height: 1.4em;
+        line-height: 1.5em;
         overflow: hidden;
         white-space: pre;
         text-overflow: ellipsis;
@@ -166,7 +174,7 @@
 
     header.exception p {
         font-weight: 200;
-        font-size: 20pt;
+        font-size: 17pt;
         color: white;
     }
 
@@ -394,7 +402,7 @@
      * Monospace
      * --------------------------------------------------------------------- */
 
-    pre, code, .repl input, .repl .prompt span, textarea, .code_linenums {
+    pre, code, .be-repl input, .be-repl .command-line span, textarea, .code_linenums {
         font-family: menlo, lucida console, monospace;
         font-size: 8pt;
     }
@@ -460,7 +468,7 @@
         font-weight: 200;
     }
 
-    .code, .console, .unavailable {
+    .code, .be-console, .unavailable {
         background: #fff;
         padding: 5px;
 
@@ -532,13 +540,13 @@
     }
 
     /* REPL shell */
-    .console {
+    .be-console {
         padding: 0 1px 10px 1px;
         border-bottom-left-radius: 2px;
         border-bottom-right-radius: 2px;
     }
 
-    .console pre {
+    .be-console pre {
         padding: 10px 10px 0 10px;
         max-height: 400px;
         overflow-x: none;
@@ -548,30 +556,31 @@
         white-space: pre-wrap;
     }
 
-    /* .prompt > span + input */
-    .console .prompt {
+    /* .command-line > span + input */
+    .be-console .command-line {
         display: table;
         width: 100%;
     }
 
-    .console .prompt span,
-    .console .prompt input {
+    .be-console .command-line span,
+    .be-console .command-line input {
         display: table-cell;
     }
 
-    .console .prompt span {
+    .be-console .command-line span {
         width: 1%;
         padding-right: 5px;
         padding-left: 10px;
+        white-space: pre;
     }
 
-    .console .prompt input {
+    .be-console .command-line input {
         width: 99%;
     }
 
     /* Input box */
-    .console input,
-    .console input:focus {
+    .be-console input,
+    .be-console input:focus {
         outline: 0;
         border: 0;
         padding: 0;
@@ -586,6 +595,9 @@
         color: #8080a0;
         padding-left: 20px;
     }
+    .console-has-been-used .live-console-hint {
+        display: none;
+    }
 
     .hint:before {
         content: '\25b2';
@@ -602,17 +614,6 @@
         margin: 10px 0;
     }
 
-    .sub:before {
-        content: '';
-        display: block;
-        width: 100%;
-        height: 4px;
-
-        border-radius: 2px;
-        background: rgba(0, 150, 200, 0.05);
-        box-shadow: 1px 1px 0 rgba(255, 255, 255, 0.7), inset 0 0 0 1px rgba(0, 0, 0, 0.04), inset 2px 2px 2px rgba(0, 0, 0, 0.07);
-    }
-
     .sub h3 {
         color: #39a;
         font-size: 1.1em;
@@ -669,14 +670,14 @@
 
     nav.sidebar::-webkit-scrollbar,
     .inset pre::-webkit-scrollbar,
-    .console pre::-webkit-scrollbar,
+    .be-console pre::-webkit-scrollbar,
     .code::-webkit-scrollbar {
         width: 10px;
         height: 10px;
     }
 
     .inset pre::-webkit-scrollbar-thumb,
-    .console pre::-webkit-scrollbar-thumb,
+    .be-console pre::-webkit-scrollbar-thumb,
     .code::-webkit-scrollbar-thumb {
         background: #ccc;
         border-radius: 5px;
@@ -692,7 +693,7 @@
         background: -webkit-linear-gradient(left, #aaa, #999);
     }
 
-    .console pre:hover::-webkit-scrollbar-thumb,
+    .be-console pre:hover::-webkit-scrollbar-thumb,
     .inset pre:hover::-webkit-scrollbar-thumb,
     .code:hover::-webkit-scrollbar-thumb {
         background: #888;
@@ -720,12 +721,22 @@
               if(document.styleSheets[i].href)
                   document.styleSheets[i].disabled = true;
           }
-          document.addEventListener("page:restore", function restoreCSS(e) {
-              for(var i=0; i < document.styleSheets.length; i++) {
-                  document.styleSheets[i].disabled = false;
-              }
-              document.removeEventListener("page:restore", restoreCSS, false);
-          });
+          if (window.Turbolinks.controller) {
+              // Turbolinks > 5 (see https://github.com/turbolinks/turbolinks/issues/6)
+              document.addEventListener("turbolinks:load", function restoreCSS(e) {
+                  for(var i=0; i < document.styleSheets.length; i++) {
+                      document.styleSheets[i].disabled = false;
+                  }
+                  document.removeEventListener("turbolinks:load", restoreCSS, false);
+              });
+          } else {
+              document.addEventListener("page:restore", function restoreCSS(e) {
+                  for(var i=0; i < document.styleSheets.length; i++) {
+                      document.styleSheets[i].disabled = false;
+                  }
+                  document.removeEventListener("page:restore", restoreCSS, false);
+              });
+          }
       }
     </script>
 
@@ -733,6 +744,21 @@
         <header class="exception">
             <h2><strong><%= exception_type %></strong> <span>at <%= request_path %></span></h2>
             <p><%= exception_message %></p>
+            <% unless active_support_actions.empty? %>
+                <div class='fix-actions'>
+                    <% active_support_actions.each do |action, _| %>
+                        <form class="button_to" method="post" action="<%= action_dispatch_action_endpoint %>">
+                            <input type="submit" value="<%= action %>">
+                            <input type="hidden" name="action" value="<%= action %>">
+                            <input type="hidden" name="error" value="<%= exception_type %>">
+                            <input type="hidden" name="location" value="<%= request_path %>">
+                        </form>
+                    <% end %>
+                </div>
+            <% end %>
+            <% if exception_hint %>
+              <h2>Hint: <%= exception_hint %></h2>
+            <% end %>
         </header>
     </div>
 
@@ -769,6 +795,7 @@
 (function() {
 
     var OID = "<%= id %>";
+    var csrfToken = "<%= csrf_token %>";
 
     var previousFrame = null;
     var previousFrameInfo = null;
@@ -779,6 +806,7 @@
         var req = new XMLHttpRequest();
         req.open("POST", "//" + window.location.host + <%== uri_prefix.gsub("<", "&lt;").inspect %> + "/__better_errors/" + OID + "/" + method, true);
         req.setRequestHeader("Content-Type", "application/json");
+        opts.csrfToken = csrfToken;
         req.send(JSON.stringify(opts));
         req.onreadystatechange = function() {
             if(req.readyState == 4) {
@@ -792,6 +820,28 @@
         return html.replace(/&/, "&amp;").replace(/</g, "&lt;");
     }
 
+    function hasConsoleBeenUsedPreviously() {
+      return !!document.cookie.split('; ').find(function(cookie) {
+          return cookie.startsWith('BetterErrors-has-used-console=');
+      });
+    }
+
+    var consoleHasBeenUsed = hasConsoleBeenUsedPreviously();
+
+    function consoleWasJustUsed() {
+        if (consoleHasBeenUsed) {
+            return;
+        }
+
+        hideConsoleHint();
+        consoleHasBeenUsed = true;
+        document.cookie = "BetterErrors-has-used-console=true;path=/;max-age=31536000;samesite"
+    }
+
+    function hideConsoleHint() {
+        document.querySelector('body').className += " console-has-been-used";
+    }
+
     function REPL(index) {
         this.index = index;
 
@@ -809,19 +859,24 @@
     REPL.prototype.install = function(containerElement) {
         this.container = containerElement;
 
-        this.promptElement  = this.container.querySelector(".prompt span");
+        this.promptElement  = this.container.querySelector(".command-line .prompt");
         this.inputElement   = this.container.querySelector("input");
         this.outputElement  = this.container.querySelector("pre");
 
+        if (consoleHasBeenUsed) {
+            hideConsoleHint();
+        }
+
         var self = this;
         this.inputElement.onkeydown = function(ev) {
             self.onKeyDown(ev);
+            consoleWasJustUsed();
         };
 
         this.setPrompt(">>");
 
         REPL.all[this.index] = this;
-    }
+    };
 
     REPL.prototype.focus = function() {
         this.inputElement.focus();
@@ -924,7 +979,7 @@
 
         el.style.display = "block";
 
-        var replInput = el.querySelector('.console input');
+        var replInput = el.querySelector('.be-console input');
         if (replInput) replInput.focus();
     }
 
@@ -942,11 +997,11 @@
                     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>";
+                    el.innerHTML += "<p><a target='_new' href='https://github.com/BetterErrors/better_errors'>More about Better Errors</a></p>";
                 } else {
                     el.innerHTML = response.html;
 
-                    var repl = el.querySelector(".repl .console");
+                    var repl = el.querySelector(".be-repl .be-console");
                     if(repl) {
                         new REPL(index).install(repl);
                     }

data/lib/better_errors/templates/text.erb

@@ -1,7 +1,10 @@
 <%== text_heading("=", "%s at %s" % [exception_type, request_path]) %>
 
-> <%== exception_message %>
-<% if backtrace_frames.any? %>
+<%== exception_message %>
+
+> To access an interactive console with this error, point your browser to: /__better_errors
+
+<% if backtrace_frames.any? -%>
 
 <%== text_heading("-", "%s, line %i" % [first_frame.pretty_path, first_frame.line]) %>
 

data/lib/better_errors/templates/variable_info.erb

@@ -1,24 +1,31 @@
 <header class="trace_info clearfix">
     <div class="title">
         <h2 class="name"><%= @frame.name %></h2>
-        <div class="location"><span class="filename"><a href="<%= editor_url(@frame) %>"><%= @frame.pretty_path %></a></span></div>
+        <div class="location">
+          <span class="filename">
+            <a
+              href="<%= editor_url(@frame) %>"
+              <%= ENV.key?('BETTER_ERRORS_INSIDE_FRAME') ? "target=_blank" : '' %>
+            ><%= @frame.pretty_path %></a>
+          </span>
+        </div>
     </div>
     <div class="code_block clearfix">
         <%== html_formatted_code_block @frame %>
     </div>
 
     <% if BetterErrors.binding_of_caller_available? && @frame.frame_binding %>
-        <div class="repl">
-            <div class="console">
+        <div class="be-repl">
+            <div class="be-console">
                 <pre></pre>
-                <div class="prompt"><span>&gt;&gt;</span> <input/></div>
+                <div class="command-line"><span class='prompt'>&gt;&gt;</span> <input tabindex="1"/></div>
             </div>
         </div>
     <% end %>
 </header>
 
 <% if BetterErrors.binding_of_caller_available? && @frame.frame_binding %>
-    <div class="hint">
+    <div class="hint live-console-hint">
         This is a live shell. Type in here.
     </div>
 

data/lib/better_errors/version.rb

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

data/lib/better_errors.rb

@@ -3,22 +3,17 @@ 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/middleware"
 require "better_errors/raised_exception"
 require "better_errors/repl"
 require "better_errors/stack_frame"
-require "better_errors/version"
+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
@@ -44,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.
@@ -68,6 +75,7 @@ module BetterErrors
   #   * `:textmate`, `:txmt`, `:tm`
   #   * `:sublime`, `:subl`, `:st`
   #   * `:macvim`
+  #   * `:atom`
   #
   #   @param [Symbol] sym
   #
@@ -97,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
@@ -127,12 +130,8 @@ 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
 
 begin

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: better_errors
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Charlie Somerville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
@@ -61,20 +145,46 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - better_errors.gemspec
+- 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/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
@@ -86,10 +196,13 @@ files:
 - lib/better_errors/templates/text.erb
 - lib/better_errors/templates/variable_info.erb
 - lib/better_errors/version.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:
@@ -105,8 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Better error page for Rails and other Rack apps

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4