Poet::Mason -- Mason settings and enhancements for Poet
# 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(...);
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 $m (the Mason request object).
$m
Returns a hash of Mason options by combining default settings and configuration.
Returns the main Mason instance used for web requests, which is created with options from get_options.
Returns a new main Mason object, using options from get_options. Unless you specifically need a new object, you probably want to call instance.
comp_root is set to $env->comps_dir, by default the comps subdirectory under the environment root.
comp_root
comps
data_dir is set to $env->data_dir, by default the data subdirectory under the environment root.
data_dir
data
plugins is set to include Cache, HTMLFilters and RouterSimple.
plugins
cache_root_class (a parameter of the Cache plugin) is set to MyApp::Cache if it exists (replacing MyApp with your app name), otherwise Poet::Cache.
cache_root_class
Cache
MyApp::Cache
MyApp
Poet::Cache
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.
mason: static_source: 1 static_source_touch_file: ${root}/data/purge.dat extra_plugins: - AnotherFavoritePlugin
Poet inserts the following line at the top of of every compiled Mason component:
use Poet qw($conf $env :web);
which means that $conf, $env, and web utilities are available from every component.
Under Poet these additional web-related methods are available in the Mason request object, accessible in components via $m or elsewhere via Mason::Request->current_request.
Mason::Request->current_request
A reference to the Plack::Request object. e.g.
my $user_agent = $m->req->headers->header('User-Agent');
A reference to the Plack::Response object. e.g.
$m->res->content_type('text/plain');
These methods are overriden to set the response status before aborting, if status is provided. e.g. to send back a FORBIDDEN result:
$m->clear_and_abort(403);
This is equivalent to
$m->res->status(403); $m->clear_and_abort();
If a status is not provided, the methods work just as before.
Sets headers and status for redirect, then clears the Mason buffer and aborts the request. e.g.
$m->redirect("http://somesite.com", 302);
is equivalent to
$m->res->redirect("http://somesite.com", 302); $m->clear_and_abort();
Sets the status to 404, then clears the Mason buffer and aborts the request. e.g.
$m->not_found();
$m->clear_and_abort(404);
A shortcut for $m->req->session, the Plack session. e.g.
$m->req->session
$m->session->get($key); $m->session->set($key, $value);
Output the JSON-encoded $data, set the content type to "application/json", and abort. e.g.
method handle { my $data; # compute data somehow $m->send_json($data); }
send_json is a shortcut for
send_json
$m->clear_buffer; $m->print(JSON::XS::encode_json($data)); $m->res->content_type("application/json"); $m->abort();
Poet
Jonathan Swartz <swartz@pobox.com>
This software is copyright (c) 2012 by Jonathan Swartz.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Poet, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Poet
CPAN shell
perl -MCPAN -e shell install Poet
For more information on module installation, please visit the detailed CPAN module installation guide.