roda 3.12.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0839d9d46fb688ab858d224dff6293be6572d9fc2938ea0696cb34bc6cb14949'
-  data.tar.gz: c3cbc4adc620b1f4776d8258e44751f7206837ba12a6a8e4917e5bf6d5a7efec
+  metadata.gz: f5b811d1ec0ddceb3a222c490b2af8e1488c6d454b637c7b6522962c149e6fd6
+  data.tar.gz: 0f3fad8d3d14f799fcc0e92a29bbc9210aadec3bade4bf68379409ce8780b29a
 SHA512:
-  metadata.gz: 7e595d7c11c1486131b3e46b596c6d38a65dac41bb72e686fdbc260f629ce4a639543501e30754412d6252942204d8fa906579bb54a6ff224233dfb333610bfd
-  data.tar.gz: 97f598575e2a13907021cb9024cfa4c6c7c6e1ce68c69639794f89db068a7ee2c27b35bace18b568ae841ae51b6ebf6404c611f3f3f1692b48b95bf1207073a4
+  metadata.gz: 8de657deae4c712c6d18c329c1137e103b979d7c1c4e1f7a36fa9a72f3bd0c202610bc73e78b7ce30c80806adfcd19a67d42da0ce5ab4932e04a8df6aba7a54d
+  data.tar.gz: 66cc1c59eca2bc0fb7a5186fc353332ca630b255de48406429fbb1ecfb7a42253102d2616b98196c8e4bd608a335ea2ce7af973b5b15c6150fddfc124b7b7591

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.13.0 (2018-10-12)
+
+* Make Stream#write in streaming plugin return number of bytes written instead of self, so it works with IO.copy_stream (jeremyevans)
+
+* Add exception_page plugin for showing a page with debugging information for a given exception (jeremyevans)
+
+* Make common_logger plugin handle raised errors (jeremyevans)
+
 = 3.12.0 (2018-09-14)
 
 * Add common_logger plugin for common log support (jeremyevans)

data/doc/release_notes/3.13.0.txt

@@ -0,0 +1,38 @@
+= New Features
+
+* An exception_page plugin has been added for displaying debugging
+  information for a given exception.  It is based on
+  Rack::ShowExceptions, with the following differences:
+
+  * Not a middleware, so it doesn't handle exceptions itself, and
+    has no effect on the callstack unless the exception_page
+    method is called.
+  * Supports external javascript and stylesheets, allowing context
+    toggling to work in applications that use a content security
+    policy to restrict inline javascript and stylesheets (:assets,
+    :css_file, and :js_file options).
+  * Has fewer dependencies (does not require ostruct and erb).
+  * Sets the Content-Type for the response, and returns the body
+    string, but does not modify other headers or the response status.
+  * Supports a configurable amount of context lines in backtraces
+    (:context option).
+  * Supports optional JSON formatted output, if used with the json
+    plugin (:json option).
+
+  Because this plugin just adds a method you can call, you can
+  selectively choose when to display a debugging page and when not
+  to, as well as customize the debugging parameters on a per-call
+  basis (such as returning JSON formatted debugging information
+  for JSON requests, and HTML formatted debugging information for
+  normal requests).
+
+= Other Improvements
+
+* The common_logger plugin now correctly handles cases where an
+  exception is being raised and there is no rack response to
+  introspect.
+
+= Backwards Compatibility
+
+* Stream#write in the streaming plugin now returns the number of
+  bytes written instead of self, so it works with IO.copy_stream.

data/lib/roda/plugins/common_logger.rb

@@ -47,6 +47,8 @@ class Roda
 
         # Log request/response information in common log format to logger.
         def _roda_after_90__common_logger(result)
+          return unless result && result[0] && result[1]
+
           elapsed_time = if timer = @_request_timer
             '%0.4f' % (CommonLogger.start_timer - timer)
           else 

data/lib/roda/plugins/exception_page.rb

@@ -0,0 +1,405 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The exception_page plugin provides an exception_page method that is designed
+    # to be called inside the error handler to provide a page to the developer
+    # with debugging information. It should only be used in developer environments
+    # with trusted clients, as it can leak source code and other information that
+    # may be useful for attackers if used in other environments.
+    #
+    # Example:
+    #
+    #   plugin :exception_page
+    #   plugin :error_handler do |e|
+    #     next exception_page(e) if ENV['RACK_ENV'] == 'development'
+    #     # ...
+    #   end
+    #
+    # The exception_page plugin is based on Rack::ShowExceptions, with the following
+    # differences:
+    #
+    # * Not a middleware, so it doesn't handle exceptions itself, and has no effect
+    #   on the callstack unless the exception_page method is called.
+    # * Supports external javascript and stylesheets, allowing context toggling to
+    #   work in applications that use a content security policy to restrict inline
+    #   javascript and stylesheets (:assets, :css_file, and :js_file options).
+    # * Has fewer dependencies (does not require ostruct and erb).
+    # * Sets the Content-Type for the response, and returns the body string, but does
+    #   not modify other headers or the response status.
+    # * Supports a configurable amount of context lines in backtraces (:context option).
+    # * Supports optional JSON formatted output, if used with the json plugin (:json option).
+    #
+    # To use the external javascript and stylesheets, you can call +r.exception_page_assets+
+    # in your routing tree:
+    #
+    #   route do |r|
+    #     # ...
+    #
+    #     # serve GET /exception_page.{css,js} requests
+    #     # Use with assets: true +exception_page+ option
+    #     r.exception_page_assets
+    #     
+    #     r.on "static" do
+    #       # serve GET /static/exception_page.{css,js} requests
+    #       # Use with assets: '/static' +exception_page+ option
+    #       r.exception_page_assets
+    #     end
+    #   end
+    #
+    # It's also possible to store the asset information in static files and serve those,
+    # you can get the current assets by calling:
+    #
+    #   Roda::RodaPlugins::ExceptionPage.css
+    #   Roda::RodaPlugins::ExceptionPage.js
+    #
+    # As the exception_page plugin is based on Rack::ShowExceptions, it is also under
+    # rack's license:
+    #
+    # Copyright (C) 2007-2018 Christian Neukirchen <http://chneukirchen.org/infopage.html>
+    #
+    # Permission is hereby granted, free of charge, to any person obtaining a copy
+    # of this software and associated documentation files (the "Software"), to
+    # deal in the Software without restriction, including without limitation the
+    # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+    # sell copies of the Software, and to permit persons to whom the Software is
+    # furnished to do so, subject to the following conditions:
+    #
+    # The above copyright notice and this permission notice shall be included in
+    # all copies or substantial portions of the Software.
+    #
+    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+    # THE AUTHORS 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.
+    #
+    # The HTML template used in Rack::ShowExceptions was based on Django's
+    # template and is under the following license:
+    #
+    # adapted from Django <www.djangoproject.com>
+    # Copyright (c) Django Software Foundation and individual contributors.
+    # Used under the modified BSD license:
+    # http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5
+    module ExceptionPage
+      def self.load_dependencies(app)
+        app.plugin :h
+      end
+
+      # Stylesheet used by the HTML exception page
+      def self.css
+        <<END
+html * { padding:0; margin:0; }
+body * { padding:10px 20px; }
+body * * { padding:0; }
+body { font:small sans-serif; }
+body>div { border-bottom:1px solid #ddd; }
+h1 { font-weight:normal; }
+h2 { margin-bottom:.8em; }
+h2 span { font-size:80%; color:#666; font-weight:normal; }
+h3 { margin:1em 0 .5em 0; }
+h4 { margin:0 0 .5em 0; font-weight: normal; }
+table {
+    border:1px solid #ccc; border-collapse: collapse; background:white; }
+tbody td, tbody th { vertical-align:top; padding:2px 3px; }
+thead th {
+    padding:1px 6px 1px 3px; background:#fefefe; text-align:left;
+    font-weight:normal; font-size:11px; border:1px solid #ddd; }
+tbody th { text-align:right; color:#666; padding-right:.5em; }
+table.vars { margin:5px 0 2px 40px; }
+table.vars td, table.req td { font-family:monospace; }
+table td.code { width:100%;}
+table td.code div { overflow:hidden; }
+table.source th { color:#666; }
+table.source td {
+    font-family:monospace; white-space:pre; border-bottom:1px solid #eee; }
+ul.traceback { list-style-type:none; }
+ul.traceback li.frame { margin-bottom:1em; }
+div.context { margin: 10px 0; }
+div.context ol {
+    padding-left:30px; margin:0 10px; list-style-position: inside; }
+div.context ol li {
+    font-family:monospace; white-space:pre; color:#666; cursor:pointer; }
+div.context ol.context-line li { color:black; background-color:#ccc; }
+div.context ol.context-line li span { float: right; }
+div.commands { margin-left: 40px; }
+div.commands a { color:black; text-decoration:none; }
+#summary { background: #ffc; }
+#summary h2 { font-weight: normal; color: #666; }
+#summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
+#summary ul#quicklinks li { float: left; padding: 0 1em; }
+#summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
+#explanation { background:#eee; }
+#traceback { background:#eee; }
+#requestinfo { background:#f6f6f6; padding-left:120px; }
+#summary table { border:none; background:transparent; }
+#requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
+#requestinfo h3 { margin-bottom:-1em; }
+.error { background: #ffc; }
+.specific { color:#cc3300; font-weight:bold; }
+END
+      end
+
+      # Javascript used by the HTML exception page for context toggling
+      def self.js
+        <<END
+var contexts = document.getElementsByClassName('context');
+var num_contexts = contexts.length;
+function toggle() {
+  for (var i = 0; i < arguments.length; i++) {
+    var e = document.getElementById(arguments[i]);
+    if (e) {
+      e.style.display = e.style.display == 'none' ? 'block' : 'none';
+    }
+  }
+  return false;
+}
+for (var j = 0; j < num_contexts; j++) {
+  contexts[j].onclick = function(){toggle('b'+this.id, 'a'+this.id);}
+  contexts[j].onclick();
+}
+END
+      end
+
+      module InstanceMethods
+        # Return a HTML page showing the exception, allowing a developer
+        # more information for debugging.  Designed to be called inside
+        # an exception handler, passing in the received exception.
+        # Sets the Content-Type header in the response, and returns the
+        # string used for the body.  If the Accept request header is present
+        # and text/html is accepted, return an HTML page with the backtrace
+        # with the ability to see the context for each backtrace line, as
+        # well as the GET, POST, cookie, and rack environment data.  If text/html
+        # is not accepted, then just show a plain text page with the exception
+        # class, message, and backtrace.
+        #
+        # Options:
+        # 
+        # :assets :: If +true+, sets :css_file to +/exception_page.css+ and :js_file to
+        #            +/exception_page.js+, assuming that +r.exception_page_assets+ is called
+        #            in the route block to serve the exception page assets.  If a String,
+        #            uses the string as a prefix, assuming that +r.exception_page_assets+
+        #            is called in a nested block inside the route block. If false, doesn't
+        #            use any CSS or JS.
+        # :context :: The number of context lines before and after each line in
+        #             the backtrace (default: 7).
+        # :css_file :: A path to the external CSS file for the HTML exception page. If false,
+        #              doesn't use any CSS.
+        # :js_file :: A path to the external javascript file for the HTML exception page. If
+        #             false, doesn't use any JS.
+        # :json :: Return a hash of exception information.  The hash will have
+        #          a single key, "exception", with a value being a hash with
+        #          three keys, "class", "message", and "backtrace", which
+        #          contain information derived from the given exception.
+        #          Designed to be used with the +json+ exception, which will
+        #          automatically convert the hash to JSON format.
+        def exception_page(exception, opts=OPTS)
+          if opts[:json]
+            @_response['Content-Type'] = "application/json"
+            {
+              "exception"=>{
+                "class"=>exception.class.to_s,
+                "message"=>exception.message.to_s,
+                "backtrace"=>exception.backtrace.map(&:to_s)
+              }
+            }
+          elsif env['HTTP_ACCEPT'] =~ /text\/html/
+            @_response['Content-Type'] = "text/html"
+
+            context = opts[:context] || 7
+            css_file = opts[:css_file]
+            js_file = opts[:js_file]
+
+            case prefix = opts[:assets]
+            when false
+              css_file = false if css_file.nil?
+              js_file = false if js_file.nil?
+            when nil
+              # nothing
+            else
+              prefix = '' if prefix == true
+              css_file ||= "#{prefix}/exception_page.css"
+              js_file ||= "#{prefix}/exception_page.js"
+            end
+
+            css = case css_file
+            when nil
+              "<style type=\"text/css\">#{ExceptionPage.css}</style>"
+            when false
+              # :nothing
+            else
+              "<link rel=\"stylesheet\" href=\"#{h css_file}\" />"
+            end
+
+            js = case js_file
+            when nil
+              "<script type=\"text/javascript\">\n//<!--\n#{ExceptionPage.js}\n//-->\n</script>"
+            when false
+              # :nothing
+            else
+              "<script type=\"text/javascript\" src=\"#{h js_file}\"></script>"
+            end
+
+            frames = exception.backtrace.map.with_index do |line, i|
+              frame = {:id=>i}
+              if line =~ /(.*?):(\d+)(:in `(.*)')?/
+                filename = frame[:filename] = $1
+                lineno = frame[:lineno] = $2.to_i
+                frame[:function] = $4
+
+                begin
+                  lineno -= 1
+                  lines = ::File.readlines(filename)
+                  pre_lineno = frame[:pre_context_lineno] = [lineno-context, 0].max
+                  frame[:pre_context] = lines[pre_lineno...lineno]
+                  frame[:context_line] = lines[lineno].chomp
+                  post_lineno = frame[:post_context_lineno] = [lineno+context, lines.size].min
+                  frame[:post_context] = lines[lineno+1..post_lineno]
+                rescue
+                end
+
+                frame
+              else
+                nil
+              end
+            end.compact
+
+            r = @_request
+            info = lambda do |title, id, var, none|
+              <<END
+  <h3 id="#{id}">#{title}</h3>
+  #{(var && !var.empty?) ? (<<END1) : "<p>#{none}</p>"
+    <table class="req">
+      <thead>
+        <tr>
+          <th>Variable</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+          #{var.sort_by{|k, _| k.to_s}.map{|key, val| (<<END2)}.join
+          <tr>
+            <td>#{h key}</td>
+            <td class="code"><div>#{h val.inspect}</div></td>
+          </tr>
+END2
+}
+      </tbody>
+    </table>
+END1
+}
+END
+            end
+
+            <<END
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>#{h exception.class} at #{h r.path}</title>
+  #{css}
+</head>
+<body>
+
+<div id="summary">
+  <h1>#{h exception.class} at #{h r.path}</h1>
+  <h2>#{h exception.message}</h2>
+  <table><tr>
+    <th>Ruby</th>
+    <td>
+#{(first = frames.first) ? "<code>#{h first[:filename]}</code>: in <code>#{h first[:function]}</code>, line #{first[:lineno]}" : "unknown location"}
+    </td>
+  </tr><tr>
+    <th>Web</th>
+    <td><code>#{r.request_method} #{h r.host}#{h r.path}</code></td>
+  </tr></table>
+
+  <h3>Jump to:</h3>
+  <ul id="quicklinks">
+    <li><a href="#get-info">GET</a></li>
+    <li><a href="#post-info">POST</a></li>
+    <li><a href="#cookie-info">Cookies</a></li>
+    <li><a href="#env-info">ENV</a></li>
+  </ul>
+</div>
+
+<div id="traceback">
+  <h2>Traceback <span>(innermost first)</span></h2>
+  <ul class="traceback">
+#{frames.map{|frame| id = frame[:id]; (<<END1)}.join
+      <li class="frame">
+        <code>#{h frame[:filename]}</code>: in <code>#{h frame[:function]}</code>
+
+          #{frame[:context_line] ? (<<END2) : '</li>'
+          <div class="context" id="c#{id}">
+            #{frame[:pre_context] ? (<<END3) : ''
+            <ol start="#{frame[:pre_context_lineno]+1}" id="bc#{id}">
+              #{frame[:pre_context].map{|line| "<li>#{h line}</li>"}.join}
+            </ol>
+END3
+}
+
+            <ol start="#{frame[:lineno]}" class="context-line">
+              <li>#{h frame[:context_line]}<span>...</span></li>
+            </ol>
+
+            #{frame[:post_context] ? (<<END4) : ''
+            <ol start='#{frame[:lineno]+1}' id="ac#{id}">
+              #{frame[:post_context].map{|line| "<li>#{h line}</li>"}.join}
+            </ol>
+END4
+}
+          </div>
+END2
+}
+END1
+}
+  </ul>
+</div>
+
+<div id="requestinfo">
+  <h2>Request information</h2>
+
+  #{info.call('GET', 'get-info', r.GET, 'No GET data')}
+  #{info.call('POST', 'post-info', r.POST, 'No POST data')}
+  #{info.call('Cookies', 'cookie-info', r.cookies, 'No cookie data')}
+  #{info.call('Rack ENV', 'env-info', r.env, 'No Rack env?')}
+</div>
+
+<div id="explanation">
+  <p>
+    You're seeing this error because you use the Roda exception_page plugin.
+  </p>
+</div>
+
+#{js}
+</body>
+</html>
+END
+          else
+            @_response['Content-Type'] = "text/plain"
+            "#{exception.class}: #{exception.message}\n#{exception.backtrace.map{|l| "\t#{l}"}.join("\n")}"
+          end
+        end
+      end
+
+      module RequestMethods
+        # Serve exception page assets
+        def exception_page_assets
+          get 'exception_page.css' do
+            response['Content-Type'] = "text/css"
+            ExceptionPage.css
+          end
+          get 'exception_page.js' do
+            response['Content-Type'] = "application/javascript"
+            ExceptionPage.js
+          end
+        end
+      end
+    end
+
+    register_plugin(:exception_page, ExceptionPage)
+  end
+end

data/lib/roda/plugins/streaming.rb

@@ -53,12 +53,18 @@ class Roda
           @closed = false
         end
 
-        # Add output to the streaming response body.
+        # Add output to the streaming response body. Returns number of bytes written.
         def write(data)
-          @out.call(data.to_s)
+          data = data.to_s
+          @out.call(data)
+          data.bytesize
+        end
+
+        # Add output to the streaming response body. Returns self.
+        def <<(data)
+          write(data)
           self
         end
-        alias << write
 
         # If not already closed, close the connection, and call
         # any callbacks.

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 12
+  RodaMinorVersion = 13
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/common_logger_spec.rb

@@ -56,4 +56,30 @@ describe "common_logger plugin" do
     @logger.rewind
     @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 - 0.\d\d\d\d\n\z/
   end
+
+  it 'does not log if an error is raised' do
+    cl_app do |r|
+      raise "foo"
+    end
+
+    begin
+      body
+    rescue => e
+    end
+    e.must_be_instance_of(RuntimeError)
+    e.message.must_equal 'foo'
+  end
+
+  it 'logs errors if used with error_handler' do
+    cl_app do |r|
+      raise "foo"
+    end
+    @app.plugin :error_handler do |_|
+      "bad"
+    end
+
+    body.must_equal 'bad'
+    @logger.rewind
+    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 3 0.\d\d\d\d\n\z/
+  end
 end

data/spec/plugin/exception_page_spec.rb

@@ -0,0 +1,157 @@
+require_relative "../spec_helper"
+
+describe "exception_page plugin" do 
+  def ep_app(&block)
+    app(:exception_page) do |r|
+      raise "foo" rescue block ? instance_exec($!, &block) : exception_page($!)
+    end
+  end
+
+  def req(path = '/', headers={})
+    if path.is_a?(Hash)
+      super(path.merge('rack.input'=>StringIO.new))
+    else
+      super(path, headers.merge('rack.input'=>StringIO.new))
+    end
+  end
+
+  it "returns HTML page with exception information if text/html is accepted" do
+    ep_app
+    s, h, body = req('HTTP_ACCEPT'=>'text/html')
+
+    s.must_equal 200
+    h['Content-Type'].must_equal 'text/html'
+    body = body.join
+    body.must_include "<title>RuntimeError at /"
+    body.must_include "<h1>RuntimeError at /</h1>"
+    body.must_include "<h2>foo</h2>"
+    body.must_include __FILE__
+    body.must_include "No GET data"
+    body.must_include "No POST data"
+    body.must_include "No cookie data"
+    body.must_include "Rack ENV"
+    body.must_include "HTTP_ACCEPT"
+    body.must_include "text/html"
+    body.must_include "table td.code"
+    body.must_include "function toggle()"
+    body.wont_include "\"/exception_page.css\""
+    body.wont_include "\"/exception_page.js\""
+
+    size = body.size
+    ep_app{|e| exception_page(e, :context=>10)}
+    body('HTTP_ACCEPT'=>'text/html').size.must_be :>, size
+
+    ep_app{|e| exception_page(e, :assets=>true, :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.wont_include "function toggle()"
+    body.must_include "\"/exception_page.css\""
+    body.must_include "\"/exception_page.js\""
+
+    ep_app{|e| exception_page(e, :assets=>"/static", :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.wont_include "function toggle()"
+    body.must_include "\"/static/exception_page.css\""
+    body.must_include "\"/static/exception_page.js\""
+
+    ep_app{|e| exception_page(e, :css_file=>"/foo.css", :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.must_include "function toggle()"
+    body.must_include "\"/foo.css\""
+
+    ep_app{|e| exception_page(e, :js_file=>"/foo.js", :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.must_include "table td.code"
+    body.wont_include "function toggle()"
+    body.must_include "\"/foo.js\""
+
+    ep_app{|e| exception_page(e, :assets=>false, :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.wont_include "function toggle()"
+    body.wont_include "\"/exception_page.css\""
+    body.wont_include "\"/exception_page.js\""
+
+    ep_app{|e| exception_page(e, :assets=>false, :css_file=>"/foo.css", :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.wont_include "function toggle()"
+    body.must_include "\"/foo.css\""
+
+    ep_app{|e| exception_page(e, :assets=>false, :js_file=>"/foo.js", :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.wont_include "function toggle()"
+    body.must_include "\"/foo.js\""
+
+    ep_app{|e| exception_page(e, :css_file=>false, :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.wont_include "table td.code"
+    body.must_include "function toggle()"
+    body.wont_include "\"/exception_page.css\""
+    body.wont_include "\"/exception_page.js\""
+
+    ep_app{|e| exception_page(e, :js_file=>false, :context=>0)}
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.must_include "table td.code"
+    body.wont_include "function toggle()"
+    body.wont_include "\"/exception_page.css\""
+    body.wont_include "\"/exception_page.js\""
+  end
+
+  it "returns plain text page with exception information if text/html is not accepted" do
+    ep_app
+    s, h, body = req
+
+    s.must_equal 200
+    h['Content-Type'].must_equal 'text/plain'
+    body = body.join
+    first, *bt = body.split("\n")
+    first.must_equal "RuntimeError: foo"
+    bt.first.must_include __FILE__
+  end
+
+  it "returns JSON with exception information if :json information is used" do
+    ep_app{|e| exception_page(e, :json=>true)}
+    @app.plugin :json
+    s, h, body = req
+
+    s.must_equal 200
+    h['Content-Type'].must_equal 'application/json'
+    hash = JSON.parse(body.join)
+    bt = hash["exception"].delete("backtrace")
+    hash.must_equal("exception"=>{"class"=>"RuntimeError", "message"=>"foo"})
+    bt.must_be_kind_of Array
+    bt.each{|line| line.must_be_kind_of String}
+  end
+
+  it "should handle backtrace lines in unexpected forms" do
+    ep_app do |e|
+      e.backtrace.first.upcase!
+      e.backtrace[-1] = ''
+      exception_page(e)
+    end
+    body = body('HTTP_ACCEPT'=>'text/html')
+    body.must_include "RuntimeError: foo"
+    body.must_include __FILE__
+    body.wont_include 'id="c0"'
+  end
+
+  it "should serve exception page assets" do
+    app(:exception_page) do |r|
+      r.exception_page_assets
+    end
+
+    s, h, b = req('/exception_page.css')
+    s.must_equal 200
+    h['Content-Type'].must_equal 'text/css'
+    b.join.must_equal Roda::RodaPlugins::ExceptionPage.css
+
+    s, h, b = req('/exception_page.js')
+    s.must_equal 200
+    h['Content-Type'].must_equal 'application/javascript'
+    b.join.must_equal Roda::RodaPlugins::ExceptionPage.js
+  end
+end

data/spec/plugin/streaming_spec.rb

@@ -4,7 +4,10 @@ describe "streaming plugin" do
   it "adds stream method for streaming responses" do
     app(:streaming) do |r|
       stream do |out|
-        %w'a b c'.each{|v| out << v; out.write(v) }
+        %w'a b c'.each do |v|
+          (out << v).must_equal out
+          out.write(v).must_equal 1
+        end
       end
     end
 
@@ -14,6 +17,20 @@ describe "streaming plugin" do
     b.to_a.must_equal %w'a a b b c c'
   end
 
+  it "works with IO.copy_stream" do
+    app(:streaming) do |r|
+      stream do |out|
+        %w'a b c'.each{|v| IO.copy_stream(StringIO.new(v), out) }
+      end
+    end
+
+    s, h, b = req
+    s.must_equal 200
+    h.must_equal('Content-Type'=>'text/html')
+    # dup as copy_stream reuses the buffer
+    b.map(&:dup).must_equal %w'a b c'
+  end
+
   it "should handle errors when streaming, and run callbacks" do
     a = []
     app(:streaming) do |r|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.13.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -208,6 +208,7 @@ extra_rdoc_files:
 - doc/release_notes/3.10.0.txt
 - doc/release_notes/3.11.0.txt
 - doc/release_notes/3.12.0.txt
+- doc/release_notes/3.13.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -254,6 +255,7 @@ files:
 - doc/release_notes/3.10.0.txt
 - doc/release_notes/3.11.0.txt
 - doc/release_notes/3.12.0.txt
+- doc/release_notes/3.13.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
@@ -293,6 +295,7 @@ files:
 - lib/roda/plugins/error_email.rb
 - lib/roda/plugins/error_handler.rb
 - lib/roda/plugins/error_mail.rb
+- lib/roda/plugins/exception_page.rb
 - lib/roda/plugins/flash.rb
 - lib/roda/plugins/h.rb
 - lib/roda/plugins/halt.rb
@@ -394,6 +397,7 @@ files:
 - spec/plugin/error_email_spec.rb
 - spec/plugin/error_handler_spec.rb
 - spec/plugin/error_mail_spec.rb
+- spec/plugin/exception_page_spec.rb
 - spec/plugin/flash_spec.rb
 - spec/plugin/h_spec.rb
 - spec/plugin/halt_spec.rb