-
-
08 Jan 2015 06:48:58 UTC
- Distribution: Poet
- Module version: 0.16
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues (7)
- Testers (797 / 15 / 0)
- Kwalitee
Bus factor: 1- 85.71% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (74.45KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- CHI
- Capture::Tiny
- Class::Load
- Data::Rmap
- File::ShareDir
- File::ShareDir::Install
- File::Slurp
- File::Spec::Functions
- Guard
- JSON::XS
- Log::Any::Adapter
- Mason
- Mason::Plugin::Cache
- Mason::Plugin::HTMLFilters
- Mason::Plugin::RouterSimple
- MasonX::ProcessDir
- Method::Signatures::Simple
- Moose
- MooseX::App::Cmd
- MooseX::HasDefaults::RO
- MooseX::StrictConstructor
- Plack
- Plack::Middleware::Debug
- Plack::Middleware::Session
- Plack::Session::Store::Cache
- Try::Tiny
- URI
- URI::Escape
- YAML::XS
- Reverse dependencies
- CPAN Testers List
- Dependency graph
- NAME
- SYNOPSIS
- DESCRIPTION
- CLASS METHODS
- DEFAULT SETTINGS
- CONFIGURATION
- QUICK VARS AND UTILITIES
- NEW REQUEST METHODS
- SEE ALSO
- AUTHOR
- COPYRIGHT AND LICENSE
NAME
Poet::Mason -- Mason settings and enhancements for Poet
SYNOPSIS
# 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(...);
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
$m
(the Mason request object).CLASS METHODS
- get_options
-
Returns a hash of Mason options by combining default settings and configuration.
- instance
-
Returns the main Mason instance used for web requests, which is created with options from get_options.
- 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.
DEFAULT SETTINGS
comp_root
is set to $poet->comps_dir, by default thecomps
subdirectory under the environment root.data_dir
is set to $poet->data_dir, by default thedata
subdirectory under the environment root.plugins
is set to include Cache, HTMLFilters and RouterSimple.cache_root_class
(a parameter of theCache
plugin) is set toMyApp::Cache
if it exists (replacingMyApp
with your app name), otherwisePoet::Cache
.
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.
mason: static_source: 1 static_source_touch_file: ${root}/data/purge.dat extra_plugins: - AnotherFavoritePlugin
QUICK VARS AND UTILITIES
Poet inserts the following line at the top of of every compiled Mason component:
use Poet qw($conf $poet :web);
which means that $conf, $poet, and web utilities are available from every component.
NEW REQUEST METHODS
Under Poet these additional web-related methods are available in the Mason request object, accessible in components via
$m
or elsewhere viaMason::Request->current_request
.- req ()
-
A reference to the Plack::Request object. e.g.
my $user_agent = $m->req->headers->header('User-Agent');
- res ()
-
A reference to the Plack::Response object. e.g.
$m->res->content_type('text/plain');
- abort (status)
- clear_and_abort (status)
-
These methods are overridden 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.
- redirect (url[, status])
-
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();
- not_found ()
-
Sets the status to 404, then clears the Mason buffer and aborts the request. e.g.
$m->not_found();
is equivalent to
$m->clear_and_abort(404);
- session
-
A shortcut for
$m->req->session
, 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).my $value = $m->session->{key}; $m->session->{key} = { some_complex => ['value'] };
- send_json ($data)
-
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$m->clear_buffer; $m->print(JSON::XS::encode_json($data)); $m->res->content_type("application/json"); $m->abort();
SEE ALSO
AUTHOR
Jonathan Swartz <swartz@pobox.com>
COPYRIGHT AND LICENSE
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.
Module Install Instructions
To install Poet, copy and paste the appropriate command in to your terminal.
cpanm Poet
perl -MCPAN -e shell install Poet
For more information on module installation, please visit the detailed CPAN module installation guide.