.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Poet::Mason 3pm"
.TH Poet::Mason 3pm "2014-02-26" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Poet::Mason \-\- Mason settings and enhancements for Poet
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&    # In a conf file...
\&    mason:
\&      plugins:
\&        \- Cache
\&        \- TidyObjectFiles
\&        \- +My::Mason::Plugin
\&      static_source: 1
\&      static_source_touch_file: ${root}/data/purge.dat
\&
\&    # Get the main Mason instance
\&    my $mason = Poet::Mason\->instance();
\&
\&    # Create a new Mason object
\&    my $mason = Poet::Mason\->new(...);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Poet-specific Mason subclass. It sets up sane default
settings, maintains a main Mason instance for handling web requests, and adds
Poet-specific methods to \f(CW$m\fR (the Mason request object).
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.IP "get_options" 4
.IX Item "get_options"
Returns a hash of Mason options by combining default settings and configuration.
.IP "instance" 4
.IX Item "instance"
Returns the main Mason instance used for web requests, which is created with
options from get_options.
.IP "new" 4
.IX Item "new"
Returns a new main Mason object, using options from
get_options. Unless you specifically need a new object, you
probably want to call instance.
.SH "DEFAULT SETTINGS"
.IX Header "DEFAULT SETTINGS"
.IP "\(bu" 4
\&\f(CW\*(C`comp_root\*(C'\fR is set to \f(CW$poet\fR\->comps_dir, by
default the \f(CW\*(C`comps\*(C'\fR subdirectory under the environment root.
.IP "\(bu" 4
\&\f(CW\*(C`data_dir\*(C'\fR is set to \f(CW$poet\fR\->data_dir, by
default the \f(CW\*(C`data\*(C'\fR subdirectory under the environment root.
.IP "\(bu" 4
\&\f(CW\*(C`plugins\*(C'\fR is set to include Cache,
HTMLFilters and
RouterSimple.
.IP "\(bu" 4
\&\f(CW\*(C`cache_root_class\*(C'\fR (a parameter of the \f(CW\*(C`Cache\*(C'\fR plugin) is set to
\&\f(CW\*(C`MyApp::Cache\*(C'\fR if it exists (replacing \f(CW\*(C`MyApp\*(C'\fR with your app
name), otherwise \f(CW\*(C`Poet::Cache\*(C'\fR.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The Poet configuration entry 'mason', if any, will be treated as a hash of
options that supplements and/or overrides the defaults above. If the hash
contains 'extra_plugins', these will be added to the default plugins. e.g.
.PP
.Vb 5
\&    mason:
\&      static_source: 1
\&      static_source_touch_file: ${root}/data/purge.dat
\&      extra_plugins:
\&         \- AnotherFavoritePlugin
.Ve
.SH "QUICK VARS AND UTILITIES"
.IX Header "QUICK VARS AND UTILITIES"
Poet inserts the following line at the top of of every compiled Mason
component:
.PP
.Vb 1
\&    use Poet qw($conf $poet :web);
.Ve
.PP
which means that \f(CW$conf\fR, \f(CW$poet\fR, and web
utilities are available from every component.
.SH "NEW REQUEST METHODS"
.IX Header "NEW REQUEST METHODS"
Under Poet these additional web-related methods are available in the Mason
request object, accessible in components via \f(CW$m\fR or elsewhere
via \f(CW\*(C`Mason::Request\->current_request\*(C'\fR.
.IP "req ()" 4
.IX Item "req ()"
A reference to the Plack::Request object. e.g.
.Sp
.Vb 1
\&    my $user_agent = $m\->req\->headers\->header(\*(AqUser\-Agent\*(Aq);
.Ve
.IP "res ()" 4
.IX Item "res ()"
A reference to the Plack::Response object. e.g.
.Sp
.Vb 1
\&    $m\->res\->content_type(\*(Aqtext/plain\*(Aq);
.Ve
.IP "abort (status)" 4
.IX Item "abort (status)"
.PD 0
.IP "clear_and_abort (status)" 4
.IX Item "clear_and_abort (status)"
.PD
These methods are overridden to set the response status before aborting, if
\&\fIstatus\fR is provided. e.g. to send back a \s-1FORBIDDEN\s0 result:
.Sp
.Vb 1
\&    $m\->clear_and_abort(403);
.Ve
.Sp
This is equivalent to
.Sp
.Vb 2
\&    $m\->res\->status(403);
\&    $m\->clear_and_abort();
.Ve
.Sp
If a status is not provided, the methods work just as before.
.IP "redirect (url[, status])" 4
.IX Item "redirect (url[, status])"
Sets headers and status for redirect, then clears the Mason buffer and aborts
the request. e.g.
.Sp
.Vb 1
\&    $m\->redirect("http://somesite.com", 302);
.Ve
.Sp
is equivalent to
.Sp
.Vb 2
\&    $m\->res\->redirect("http://somesite.com", 302);
\&    $m\->clear_and_abort();
.Ve
.IP "not_found ()" 4
.IX Item "not_found ()"
Sets the status to 404, then clears the Mason buffer and aborts the request.
e.g.
.Sp
.Vb 1
\&    $m\->not_found();
.Ve
.Sp
is equivalent to
.Sp
.Vb 1
\&    $m\->clear_and_abort(404);
.Ve
.IP "session" 4
.IX Item "session"
A shortcut for \f(CW\*(C`$m\->req\->session\*(C'\fR, the Plack
session.  This is simply a persistent hash that you can read
from and write to. It is tied to the user's browser session via cookies and
stored in a file cache in the data directory (by default).
.Sp
.Vb 2
\&    my $value = $m\->session\->{key};
\&    $m\->session\->{key} = { some_complex => [\*(Aqvalue\*(Aq] };
.Ve
.IP "send_json ($data)" 4
.IX Item "send_json ($data)"
Output the JSON-encoded \fI\f(CI$data\fI\fR, set the content type to \*(L"application/json\*(R",
and abort. e.g.
.Sp
.Vb 5
\&    method handle {
\&        my $data;
\&        # compute data somehow
\&        $m\->send_json($data);
\&    }
.Ve
.Sp
\&\f(CW\*(C`send_json\*(C'\fR is a shortcut for
.Sp
.Vb 4
\&    $m\->clear_buffer;
\&    $m\->print(JSON::XS::encode_json($data));
\&    $m\->res\->content_type("application/json");
\&    $m\->abort();
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Poet
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.