=head1 NAME
Mojolicious::Plugin::Humane - Mojolicious integration for humane.js
=head1 SYNOPSIS
# Mojolicious
$app->plugin('Humane');
# then elsewhere
$c->humane_flash('Not authorized');
# Mojolicious::Lite
plugin 'Humane';
get '/' => sub {
my $c = shift;
$c->humane_stash('Welcome back!');
...
# Without 'auto' feature
plugin 'Humane', auto => 0;
...
__DATA__
...
%= humane_include
=head1 DESCRIPTION
L is a L plugin allowing easy use of humane.js, a browser notification handler (L).
By default the template needed to render the messages is injected only if needed. For infrequent use, this is less costly overall and less to think about. If messages are to be used frequently or perhaps humane.js is to also be used without reloading the page (via websockets perhaps) then turn the C feature off and add the template to your layout manually.
Internally this plugin uses the (non-localized) stash keys C and C. Other stash keys starting with C are reserved for future use should be avoided.
=head1 ATTRIBUTES
=head2 humane_version
Version of humane.js (to be) loaded. Defaults to the highest bundled version. Currently version 3.0.6 is bundled.
In future, non-breaking releases will be silently upgraded, while breaking versions will be kept and left at the highest version that had been bundled.
=head2 static_path
The path to the folder containing the bundled version of humane to be used. This path is added to the static rendering path.
The default is C<< $plugin->path('humane-' . $self->humane_version); >>.
=head2 template
The name of the template to be used. This allows the user to supply their own template name if desired.
=head2 theme
Selects the humane.js theme. This should be chosen from the available themes (see L). The default is C.
=head1 METHODS
L inherits all methods from
L and implements the following new ones.
=head2 C
$plugin->all_themes();
Get a list of all the available themes for humane.js.
=head2 C
$plugin->path($directory);
Find the path to a directory relative to the shared data directory. This isn't likely to be needed.
=head2 C
$plugin->register($app);
Register plugin in L application. Optionally key-value pairs or a hashreference of the same may be passed. Those options are:
=over
=item auto
Set to a true value, the template necessary for humane.js will be automatically added to the C<< >> tag of the rendered document if needed. Note that this will be skipped if no C<< >> tag is found or if no messages are waiting to be added. Default is true.
=back
=head1 HELPERS
This plugin provides several helpers which are available as methods to the application and controllers and as functions to the templates (and lite apps).
=head2 C
$app->humane->theme($newtheme);
Holds the instance of the plugin.
=head2 C/C
$app->humane_stash('Welcome back');
$app->humane_flash('Not authorized');
Take a message or list of messages and adds them to the stack of messages to be rendered during the current or next rendering respectively. Returns an array reference of all the buffered messages in that stack. May be called without argument to get the stack while not adding messages.
Note that each stack is rendered first-in first-out, however all flashed messages are shown before stashed messages.
=head2 C
Behaves like C inserting the template needed to render the messages. You need to use this when setting C<< auto => 0 >>.
=head2 C
Returns a list of all the messages to be rendered in this rendering, in order; flashed messages first, then stashed.
=head1 SEE ALSO
L, L
=head1 SOURCE REPOSITORY
L
=head1 AUTHOR
Joel Berger, Ejoel.a.berger@gmail.comE
=head1 COPYRIGHT AND LICENSE
Mojolicious::Plugin::Humane is
Copyright (C) 2013 by Joel Berger
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
humane.js bears the license
(The MIT License)
Copyright (c) 2011 Marc Harter
See L for terms of use.