<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
This file was generated by Devel::Cover Version 1.26
Devel::Cover is copyright 2001-2012, Paul Johnson (paul@pjcj.net)
Devel::Cover is free. It is licensed under the same terms as Perl itself.
The latest version of Devel::Cover should be available from my homepage:
http://www.pjcj.net
-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
<meta http-equiv="Content-Language" content="en-us"></meta>
<link rel="stylesheet" type="text/css" href="cover.css"></link>
<link rel="stylesheet" type="text/css" href="cover.css"></link>
<title>File Coverage: lib/Yukki/Error.pm</title>
</head>
<body>
<h1>File Coverage</h1>
<table>
<tr><td class="h" align="right">File:</td><td align="left">lib/Yukki/Error.pm</td></tr>
<tr><td class="h" align="right">Coverage:</td><td align="left" class="c2">91.3%</td></tr>
</table>
<div><br/></div>
<table>
<tr><th>line</th><th>stmt</th><th>bran</th><th>cond</th><th>sub</th><th>pod</th><th>time</th><th>code</th></tr>
<tr><td class="h">1</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">package Yukki::Error;</td></tr>
<tr><td class="h">2</td><td colspan="7"></td></tr><tr><td class="h">3</td><td><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L3">7</a></div></td><td></td><td><div>55</div><div>18</div></td><td class="s">use v5.24;</td></tr>
<tr><td class="h">4</td><td><div class="c3">7</div><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L4">7</a></div></td><td></td><td><div>21</div><div>7</div><div>38</div></td><td class="s">use utf8;</td></tr>
<tr><td class="h">5</td><td><div class="c3">7</div><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L5">7</a></div></td><td></td><td><div>328</div><div>5186</div><div>27</div></td><td class="s">use Moo;</td></tr>
<tr><td class="h">6</td><td colspan="7"></td></tr><tr><td class="h">7</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">extends qw( HTTP::Throwable::Factory );</td></tr>
<tr><td class="h">8</td><td colspan="7"></td></tr><tr><td class="h">9</td><td><div class="c3">7</div><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L9">7</a></div></td><td></td><td><div>3803</div><div>31</div><div>145</div></td><td class="s">use Yukki::Web::View;</td></tr>
<tr><td class="h">10</td><td colspan="7"></td></tr><tr><td class="h">11</td><td><div class="c3">7</div><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L11">7</a></div></td><td></td><td><div>30</div><div>9</div><div>33</div></td><td class="s">use namespace::clean;</td></tr>
<tr><td class="h">12</td><td colspan="7"></td></tr><tr><td class="h">13</td><td><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L13">7</a></div></td><td></td><td><div>2212</div></td><td class="s">use Sub::Exporter -setup => {</td></tr>
<tr><td class="h">14</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> exports => [ qw< http_throw http_exception > ],</td></tr>
<tr><td class="h">15</td><td><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td></td><td></td><td><div>14057</div><div>68</div></td><td class="s">};</td></tr>
<tr><td class="h">16</td><td colspan="7"></td></tr><tr><td class="h">17</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"># ABSTRACT: Yukki's exception class</td></tr>
<tr><td class="h">18</td><td colspan="7"></td></tr><tr><td class="h">19 - 59</td><td colspan="6"></td><td class="s"><pre>=head1 SYNOPSIS
Yukki::Error->throw("Something really bad.", { ... });
=head1 DESCRIPTION
If you are familiar with L<HTTP::Throwable::Factory>, this is similar to that (and is based on that).
However, there are two differences. First, the error message is given primacy rather than exception type, so you can just use this to throw an exception:
use Yukki::Error qw( http_throw );
http_throw('something went wrong');
Since you almost always want your exception to be an internal server error of some kind, this makes more sense to me than having to write:
use HTTP::Throwable::Factory qw( http_throw );
http_throw(InternalServerError => {
message => 'something went wrong',
});
To specify the type of exception, us C<status>:
use Yukki::Error qw( http_throw );
http_throw('something was not found', {
status => 'NotFound',
});
The second difference is that all exceptions thrown by this factory inherit from L<Yukki::Error>, so this works:
use Scalar::Util qw( blessed );
use Try::Tiny;
try { ... }
catch {
if (blassed $_ && $_->isa("Yukki::Error") {
# we now this is an application error from Yukki
}
};
This makes it easy to know whether Yukki generated the exception or something else did.
=cut</pre></td></tr>
<tr><td class="h">60</td><td colspan="7"></td></tr><tr><td class="h">61</td><td><div class="c3">2</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L61">2</a></div></td><td><div class="c3">1</div></td><td><div>21241</div></td><td class="s">sub base_class { 'Yukki::Error' }</td></tr>
<tr><td class="h">62</td><td><div class="c3">2</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L62">2</a></div></td><td><div class="c3">1</div></td><td><div>18</div></td><td class="s">sub extra_roles { 'Yukki::Error::Body' }</td></tr>
<tr><td class="h">63</td><td colspan="7"></td></tr><tr><td class="h">64 - 75</td><td colspan="6"></td><td class="s"><pre>=head1 EXPORTS
=head2 http_exception
my $error = http_exception('message', {
status => 'InternalServerError',
show_stask_trace => 0,
});
Creates a new exception object. Calls the constructor for L<Yukki:Error> and applied the L<HTTP::Throwable> status role needed (prior to construction actually).
=cut</pre></td></tr>
<tr><td class="h">76</td><td colspan="7"></td></tr><tr><td class="h">77</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">sub http_exception {</td></tr>
<tr><td class="h">78</td><td><div class="c3">2</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L78">2</a></div></td><td><div class="c3">1</div></td><td><div>5</div></td><td class="s"> my ($name, $args) = @_;</td></tr>
<tr><td class="h">79</td><td colspan="7"></td></tr><tr><td class="h">80</td><td><div class="c3">2</div><div class="c3">2</div></td><td></td><td><div class="c0"><a href="lib-Yukki-Error-pm--condition.html#L80">50</a></div></td><td></td><td></td><td><div>3</div><div>17</div></td><td class="s"> my %args = %{ $args // {} };</td></tr>
<tr><td class="h">81</td><td><div class="c3">2</div></td><td></td><td><div class="c0"><a href="lib-Yukki-Error-pm--condition.html#L81">50</a></div></td><td></td><td></td><td><div>6</div></td><td class="s"> my $status = delete $args{status} // 'InternalServerError';</td></tr>
<tr><td class="h">82</td><td colspan="7"></td></tr><tr><td class="h">83</td><td><div class="c3">2</div></td><td></td><td></td><td></td><td></td><td><div>23</div></td><td class="s"> Yukki::Error->new_exception($status => {</td></tr>
<tr><td class="h">84</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> %args,</td></tr>
<tr><td class="h">85</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> message => "$name",</td></tr>
<tr><td class="h">86</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> });</td></tr>
<tr><td class="h">87</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
<tr><td class="h">88</td><td colspan="7"></td></tr><tr><td class="h">89 - 98</td><td colspan="6"></td><td class="s"><pre>=head2 http_throw
http_throw('message', {
status => 'InternalServerError',
show_stask_trace => 0,
});
Constructs the exception (via L</http_exception>) and throws it.
=cut</pre></td></tr>
<tr><td class="h">99</td><td colspan="7"></td></tr><tr><td class="h">100</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">sub http_throw {</td></tr>
<tr><td class="h">101</td><td><div class="c3">2</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L101">2</a></div></td><td><div class="c3">1</div></td><td><div>4</div></td><td class="s"> my ($name, $args) = @_;</td></tr>
<tr><td class="h">102</td><td colspan="7"></td></tr><tr><td class="h">103</td><td><div class="c3">2</div></td><td></td><td></td><td></td><td></td><td><div>6</div></td><td class="s"> http_exception($name, $args)->throw;</td></tr>
<tr><td class="h">104</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
<tr><td class="h">105</td><td colspan="7"></td></tr><tr><td class="h">106</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">sub BUILDARGS {</td></tr>
<tr><td class="h">107</td><td><div class="c3">2</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L107">2</a></div></td><td><div class="c0">0</div></td><td><div>21852</div></td><td class="s"> my ($class, $args) = @_;</td></tr>
<tr><td class="h">108</td><td><div class="c3">2</div></td><td></td><td></td><td></td><td></td><td><div>26</div></td><td class="s"> $args;</td></tr>
<tr><td class="h">109</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
<tr><td class="h">110</td><td colspan="7"></td></tr><tr><td class="h">111 - 119</td><td colspan="6"></td><td class="s"><pre>=begin Pod::Coverage
BUILDARGS
base_class
extra_roles
=end Pod::Coverage
=cut</pre></td></tr>
<tr><td class="h">120</td><td colspan="7"></td></tr><tr><td class="h">121</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">{</td></tr>
<tr><td class="h">122</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> package Yukki::Error::Body;</td></tr>
<tr><td class="h">123</td><td colspan="7"></td></tr><tr><td class="h">124</td><td><div class="c3">7</div><div class="c3">7</div><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L124">7</a></div></td><td></td><td><div>3344</div><div>9</div><div>25</div></td><td class="s"> use Moo::Role;</td></tr>
<tr><td class="h">125</td><td colspan="7"></td></tr><tr><td class="h">126 - 132</td><td colspan="6"></td><td class="s"><pre>=head1 METHODS
=head2 body
Renders the HTML body for the error.
=cut</pre></td></tr>
<tr><td class="h">133</td><td colspan="7"></td></tr><tr><td class="h">134</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> sub body {</td></tr>
<tr><td class="h">135</td><td><div class="c3">1</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L135">1</a></div></td><td><div class="c0">0</div></td><td><div>2</div></td><td class="s"> my ($self, $env) = @_;</td></tr>
<tr><td class="h">136</td><td colspan="7"></td></tr><tr><td class="h">137</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>3</div></td><td class="s"> my $app = $env->{'yukki.app'};</td></tr>
<tr><td class="h">138</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>7</div></td><td class="s"> my $view = Yukki::Web::View->new(app => $app);</td></tr>
<tr><td class="h">139</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>141</div></td><td class="s"> my $ctx = Yukki::Web::Context->new(env => $env);</td></tr>
<tr><td class="h">140</td><td colspan="7"></td></tr><tr><td class="h">141</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>25</div></td><td class="s"> my $template = $view->prepare_template(</td></tr>
<tr><td class="h">142</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> template => 'error.html',</td></tr>
<tr><td class="h">143</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> directives => [</td></tr>
<tr><td class="h">144</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> '#error-page' => 'error_message',</td></tr>
<tr><td class="h">145</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> ],</td></tr>
<tr><td class="h">146</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> );</td></tr>
<tr><td class="h">147</td><td colspan="7"></td></tr><tr><td class="h">148</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>603</div></td><td class="s"> $ctx->response->page_title($self->reason);</td></tr>
<tr><td class="h">149</td><td colspan="7"></td></tr><tr><td class="h">150</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>100</div></td><td class="s"> return $view->render_page(</td></tr>
<tr><td class="h">151</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> template => $template,</td></tr>
<tr><td class="h">152</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> context => $ctx,</td></tr>
<tr><td class="h">153</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> vars => {</td></tr>
<tr><td class="h">154</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> 'error_message' => $self->message,</td></tr>
<tr><td class="h">155</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> },</td></tr>
<tr><td class="h">156</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> );</td></tr>
<tr><td class="h">157</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
<tr><td class="h">158</td><td colspan="7"></td></tr><tr><td class="h">159 - 163</td><td colspan="6"></td><td class="s"><pre>=head2 body_headers
Setup the HTTP headers.
=cut</pre></td></tr>
<tr><td class="h">164</td><td colspan="7"></td></tr><tr><td class="h">165</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> sub body_headers {</td></tr>
<tr><td class="h">166</td><td><div class="c3">1</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L166">1</a></div></td><td><div class="c0">0</div></td><td><div>30</div></td><td class="s"> my ($self, $body) = @_;</td></tr>
<tr><td class="h">167</td><td colspan="7"></td></tr><tr><td class="h">168</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> return [</td></tr>
<tr><td class="h">169</td><td><div class="c3">1</div></td><td></td><td></td><td></td><td></td><td><div>4</div></td><td class="s"> 'Content-type' => 'text/html',</td></tr>
<tr><td class="h">170</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> 'Content-length' => length $body,</td></tr>
<tr><td class="h">171</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> ];</td></tr>
<tr><td class="h">172</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
<tr><td class="h">173</td><td colspan="7"></td></tr><tr><td class="h">174 - 178</td><td colspan="6"></td><td class="s"><pre>=head2 as_string
Returns the message.
=cut</pre></td></tr>
<tr><td class="h">179</td><td colspan="7"></td></tr><tr><td class="h">180</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> sub as_string {</td></tr>
<tr><td class="h">181</td><td><div class="c3">7</div></td><td></td><td></td><td><div class="c3"><a href="lib-Yukki-Error-pm--subroutine.html#L181">7</a></div></td><td><div class="c0">0</div></td><td><div>396</div></td><td class="s"> my $self = shift;</td></tr>
<tr><td class="h">182</td><td><div class="c3">7</div></td><td></td><td></td><td></td><td></td><td><div>15</div></td><td class="s"> return $self->message;</td></tr>
<tr><td class="h">183</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> }</td></tr>
<tr><td class="h">184</td><td colspan="7"></td></tr><tr><td class="h">185</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> around as_psgi => sub {</td></tr>
<tr><td class="h">186</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> shift; # original method is ignored</td></tr>
<tr><td class="h">187</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> my ($self, $env) = @_;</td></tr>
<tr><td class="h">188</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> my $body = $self->body( $env );</td></tr>
<tr><td class="h">189</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> my $headers = $self->build_headers( $body );</td></tr>
<tr><td class="h">190</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> [ $self->status_code, $headers, [ defined $body ? $body : () ] ];</td></tr>
<tr><td class="h">191</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s"> };</td></tr>
<tr><td class="h">192</td><td colspan="7"></td></tr><tr><td class="h">193</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">}</td></tr>
<tr><td class="h">194</td><td colspan="7"></td></tr><tr><td class="h">195</td><td></td><td></td><td></td><td></td><td></td><td></td><td class="s">1;</td></tr>
</table>
</body>
</html>