Initial Sinatra-specific ShowException middleware
This commit is contained in:
Simon Rozet
Ryan Tomayko
parent
06161bf714
commit
60bdca965f
|
|
@ -3,6 +3,7 @@ require 'time'
|
|||
require 'uri'
|
||||
require 'rack'
|
||||
require 'rack/builder'
|
||||
require 'sinatra/show_exceptions'
|
||||
|
||||
module Sinatra
|
||||
VERSION = '0.9.1.1'
|
||||
|
|
@ -838,6 +839,11 @@ module Sinatra
|
|||
builder.use Rack::Session::Cookie if sessions? && !test?
|
||||
builder.use Rack::CommonLogger if logging?
|
||||
builder.use Rack::MethodOverride if methodoverride?
|
||||
if show_exceptions?
|
||||
enable :raise_errors
|
||||
builder.use ShowExceptions
|
||||
end
|
||||
|
||||
@middleware.each { |c,a,b| builder.use(c, *a, &b) }
|
||||
builder.run super
|
||||
builder.to_app
|
||||
|
|
@ -916,6 +922,7 @@ module Sinatra
|
|||
set :raise_errors, true
|
||||
set :dump_errors, false
|
||||
set :clean_trace, true
|
||||
set :show_exceptions, Proc.new { development? }
|
||||
set :sessions, false
|
||||
set :logging, false
|
||||
set :methodoverride, false
|
||||
|
|
|
|||
|
|
@ -0,0 +1,274 @@
|
|||
require 'rack/showexceptions'
|
||||
|
||||
module Sinatra
|
||||
class ShowExceptions < Rack::ShowExceptions
|
||||
def initialize(app)
|
||||
@app = app
|
||||
@template = ERB.new(TEMPLATE)
|
||||
end
|
||||
|
||||
TEMPLATE = <<HTML
|
||||
<!DOCTYPE>
|
||||
<html>
|
||||
<head>
|
||||
<title><%=h exception.class %> at <%=h path %></title>
|
||||
<style type="text/css">
|
||||
html * { padding:0; margin:0; }
|
||||
body { font: small Verdana, sans-serif; color: #333; }
|
||||
body * { padding:10px 20px; }
|
||||
body * * { padding:0; }
|
||||
h1 {font-weight:normal; color:#1D6B8D;}
|
||||
h2 { color:#1D6B8D; 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 img { float: left; margin-right: 3em;}
|
||||
#summary h2 { font-weight: normal; color: #666; }
|
||||
#summary h3 { float: left;display: inline;margin:0;padding:0; }
|
||||
#summary ul { list-style-type: none; margin-bottom: 2em; display: inline; padding:0;}
|
||||
#summary ul li { float: left; padding: 0 1em; }
|
||||
#summary ul>li+li { border-left: 1px #666 solid; }
|
||||
#traceback { clear: both; border-top:1px solid #ddd; }
|
||||
#explanation { background:#eee; }
|
||||
#template, #template-not-exist { background:#f6f6f6; }
|
||||
#template-not-exist ul { margin: 0 0 0 20px; }
|
||||
#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; }
|
||||
</style>
|
||||
<script type="text/javascript">
|
||||
//<!--
|
||||
function getElementsByClassName(oElm, strTagName, strClassName){
|
||||
// Written by Jonathan Snook, http://www.snook.ca/jon;
|
||||
// Add-ons by Robert Nyman, http://www.robertnyman.com
|
||||
var arrElements = (strTagName == "*" && document.all)? document.all :
|
||||
oElm.getElementsByTagName(strTagName);
|
||||
var arrReturnElements = new Array();
|
||||
strClassName = strClassName.replace(/\-/g, "\\-");
|
||||
var oRegExp = new RegExp("(^|\\s)" + strClassName + "(\\s|$$)");
|
||||
var oElement;
|
||||
for(var i=0; i<arrElements.length; i++){
|
||||
oElement = arrElements[i];
|
||||
if(oRegExp.test(oElement.className)){
|
||||
arrReturnElements.push(oElement);
|
||||
}
|
||||
}
|
||||
return (arrReturnElements)
|
||||
}
|
||||
function hideAll(elems) {
|
||||
for (var e = 0; e < elems.length; e++) {
|
||||
elems[e].style.display = 'none';
|
||||
}
|
||||
}
|
||||
window.onload = function() {
|
||||
hideAll(getElementsByClassName(document, 'table', 'vars'));
|
||||
hideAll(getElementsByClassName(document, 'ol', 'pre-context'));
|
||||
hideAll(getElementsByClassName(document, 'ol', 'post-context'));
|
||||
}
|
||||
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;
|
||||
}
|
||||
function varToggle(link, id) {
|
||||
toggle('v' + id);
|
||||
var s = link.getElementsByTagName('span')[0];
|
||||
var uarr = String.fromCharCode(0x25b6);
|
||||
var darr = String.fromCharCode(0x25bc);
|
||||
s.innerHTML = s.innerHTML == uarr ? darr : uarr;
|
||||
return false;
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="summary">
|
||||
<img src="/__sinatra__/500.png">
|
||||
<h1><%=h exception.class %> at <%=h path %></h1>
|
||||
<h2><%=h exception.message %></h2>
|
||||
<table><tr>
|
||||
<th>Ruby</th>
|
||||
<td><code><%=h frames.first.filename %></code>: in <code><%=h frames.first.function %></code>, line <%=h frames.first.lineno %></td>
|
||||
</tr><tr>
|
||||
<th>Web</th>
|
||||
<td><code><%=h req.request_method %> <%=h(req.host + path)%></code></td>
|
||||
</tr></table>
|
||||
|
||||
<h3>Jump to:</h3>
|
||||
<ul>
|
||||
<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.each { |frame| %>
|
||||
<li class="frame">
|
||||
<code><%=h frame.filename %></code>: in <code><%=h frame.function %></code>
|
||||
|
||||
<% if frame.context_line %>
|
||||
<div class="context" id="c<%=h frame.object_id %>">
|
||||
<% if frame.pre_context %>
|
||||
<ol start="<%=h frame.pre_context_lineno+1 %>" class="pre-context" id="pre<%=h frame.object_id %>">
|
||||
<% frame.pre_context.each { |line| %>
|
||||
<li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h line %></li>
|
||||
<% } %>
|
||||
</ol>
|
||||
<% end %>
|
||||
|
||||
<ol start="<%=h frame.lineno %>" class="context-line">
|
||||
<li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h frame.context_line %><span>...</span></li></ol>
|
||||
|
||||
<% if frame.post_context %>
|
||||
<ol start='<%=h frame.lineno+1 %>' class="post-context" id="post<%=h frame.object_id %>">
|
||||
<% frame.post_context.each { |line| %>
|
||||
<li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h line %></li>
|
||||
<% } %>
|
||||
</ol>
|
||||
<% end %>
|
||||
</div>
|
||||
<% end %>
|
||||
</li>
|
||||
<% } %>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="requestinfo">
|
||||
<h2>Request information</h2>
|
||||
|
||||
<h3 id="get-info">GET</h3>
|
||||
<% unless req.GET.empty? %>
|
||||
<table class="req">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Variable</th>
|
||||
<th>Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% req.GET.sort_by { |k, v| k.to_s }.each { |key, val| %>
|
||||
<tr>
|
||||
<td><%=h key %></td>
|
||||
<td class="code"><div><%=h val.inspect %></div></td>
|
||||
</tr>
|
||||
<% } %>
|
||||
</tbody>
|
||||
</table>
|
||||
<% else %>
|
||||
<p>No GET data.</p>
|
||||
<% end %>
|
||||
|
||||
<h3 id="post-info">POST</h3>
|
||||
<% unless req.POST.empty? %>
|
||||
<table class="req">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Variable</th>
|
||||
<th>Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% req.POST.sort_by { |k, v| k.to_s }.each { |key, val| %>
|
||||
<tr>
|
||||
<td><%=h key %></td>
|
||||
<td class="code"><div><%=h val.inspect %></div></td>
|
||||
</tr>
|
||||
<% } %>
|
||||
</tbody>
|
||||
</table>
|
||||
<% else %>
|
||||
<p>No POST data.</p>
|
||||
<% end %>
|
||||
|
||||
|
||||
<h3 id="cookie-info">COOKIES</h3>
|
||||
<% unless req.cookies.empty? %>
|
||||
<table class="req">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Variable</th>
|
||||
<th>Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% req.cookies.each { |key, val| %>
|
||||
<tr>
|
||||
<td><%=h key %></td>
|
||||
<td class="code"><div><%=h val.inspect %></div></td>
|
||||
</tr>
|
||||
<% } %>
|
||||
</tbody>
|
||||
</table>
|
||||
<% else %>
|
||||
<p>No cookie data.</p>
|
||||
<% end %>
|
||||
|
||||
<h3 id="env-info">Rack ENV</h3>
|
||||
<table class="req">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Variable</th>
|
||||
<th>Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% env.sort_by { |k, v| k.to_s }.each { |key, val| %>
|
||||
<tr>
|
||||
<td><%=h key %></td>
|
||||
<td class="code"><div><%=h val %></div></td>
|
||||
</tr>
|
||||
<% } %>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="explanation">
|
||||
<p>
|
||||
You're seeing this error because you use you have enabled the <code>show_exceptions</code> option.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
HTML
|
||||
end
|
||||
end
|
||||
|
|
@ -19,6 +19,10 @@ end
|
|||
class Test::Unit::TestCase
|
||||
include Sinatra::Test
|
||||
|
||||
def setup
|
||||
Sinatra::Base.set :environment, :test
|
||||
end
|
||||
|
||||
# Sets up a Sinatra::Base subclass defined with the block
|
||||
# given. Used in setup or individual spec methods to establish
|
||||
# the application.
|
||||
|
|
@ -30,6 +34,7 @@ class Test::Unit::TestCase
|
|||
Sinatra::Default.set(
|
||||
:environment => :development,
|
||||
:raise_errors => Proc.new { test? },
|
||||
:show_exceptions => Proc.new { development? },
|
||||
:dump_errors => true,
|
||||
:sessions => false,
|
||||
:logging => Proc.new { ! test? },
|
||||
|
|
|
|||
|
|
@ -176,6 +176,39 @@ describe_option 'raise_errors' do
|
|||
end
|
||||
end
|
||||
|
||||
describe_option 'show_exceptions' do
|
||||
it 'is enabled on Default only in development' do
|
||||
@base.set(:environment, :development)
|
||||
assert @base.show_exceptions?
|
||||
|
||||
assert @default.development?
|
||||
assert @default.show_exceptions?
|
||||
|
||||
@default.set(:environment, :test)
|
||||
assert ! @default.show_exceptions?
|
||||
|
||||
@base.set(:environment, :production)
|
||||
assert ! @base.show_exceptions?
|
||||
end
|
||||
|
||||
it 'returns a friendly 500' do
|
||||
mock_app {
|
||||
disable :raise_errors
|
||||
enable :show_exceptions
|
||||
|
||||
get '/' do
|
||||
raise StandardError
|
||||
end
|
||||
}
|
||||
|
||||
get '/'
|
||||
assert @app.raise_errors? # it enables raise_errors when enabled
|
||||
assert_equal 500, status
|
||||
assert body.include?("StandardError")
|
||||
assert body.include?("<code>show_exceptions</code> option")
|
||||
end
|
||||
end
|
||||
|
||||
describe_option 'dump_errors' do
|
||||
it 'is disabled on Base' do
|
||||
assert ! @base.dump_errors?
|
||||
|
|
|
|||
Loading…
Reference in New Issue