Dancer-Plugin-FlashMessage-0.314000755000765000765 011655456164 15573 5ustar00damsdams000000000000README100644000765000765 55211655456164 16516 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314 This archive contains the distribution Dancer-Plugin-FlashMessage, version 0.314: Dancer plugin to display temporary messages, so called "flash messages". This software is copyright (c) 2011 by Damien "dams" Krotkine. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Changes100644000765000765 322211655456164 17146 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.3140.314 2011-11-06 11:07:45 Europe/Paris . fixed hooks deprecation 0.313 2011-02-07 10:11:55 Europe/Paris . fixed operators priorities 0.312 2011-02-06 13:09:54 Europe/Paris . depends on Dancer 1.3001 0.311 2011-02-05 21:27:23 Europe/Paris . fix versioning issue . check there is a session engine . update documentation 0.310 2011-02-05 18:50:27 Europe/Paris . fix case where no flash has been defined . thanks to ambs and sawyerX 0.309 2011-02-05 13:24:13 Europe/Paris . documentation fixed 0.308 2011-02-05 13:14:07 Europe/Paris . remove the persistence config . get the module to be as simple as possible . documentation fixed 0.307 2011-01-30 13:15:30 Europe/Paris . add Dancer dependancy . get Makefile.PL properly generated 0.306 2011-01-28 16:15:49 Europe/Paris . Fix RT#65009 again . flash messages are now smart enough to stay alive across multiple requests, until they are used in templates ( thanks to Flavio Poletti for the idea ) 0.305 2011-01-23 19:20:17 Europe/Paris . Fix RT#65009 . 'persistence' configuration key added . tests for (non) persistence added 0.304 2011-01-16 14:25:58 Europe/Paris . Fix tests 0.303 2011-01-15 13:58:20 Europe/Paris . Don't require Dancer::Plugin::TemplateToolkit (hence Template::Toolkit) for tests . Add warning about Dist::Zilla in Makefile.PL 0.302 2011-01-11 17:41:49 Europe/Paris 0.301 2011-01-11 17:40:16 Europe/Paris 0.300 2011-01-11 17:39:00 Europe/Paris . Dist-Zillification 0.2 . more Rails-like : flash is a hash of messages 0.1 . first version LICENSE100644000765000765 4373611655456164 16716 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314This software is copyright (c) 2011 by Damien "dams" Krotkine. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2011 by Damien "dams" Krotkine. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2011 by Damien "dams" Krotkine. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End dist.ini100644000765000765 253311655456164 17323 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314name = Dancer-Plugin-FlashMessage author = Damien "dams" Krotkine license = Perl_5 copyright_holder = Damien "dams" Krotkine copyright_year = 2011 main_module = lib/Dancer/Plugin/FlashMessage.pm ; -- static meta-information [MetaResources] homepage = http://search.cpan.org/dist/Dancer-Plugin-FlashMessage repository = http://github.com/dams/Dancer-Plugin-FlashMessage ; -- fetch & generate files [GatherDir] [PruneFiles] ; don't include the Makefile.PL as it's to be used only by people building from ; the source (github), not cpan filenames = Makefile.PL ; -- tests [Test::Compile] [Test::Perl::Critic] [MetaTests] [PodCoverageTests] [ExtraTests] ; -- remove files [PruneCruft] [ManifestSkip] ; -- get prereqs [AutoPrereqs] [Prereqs] Dancer = 1.3001 ; -- munge files [NextRelease] [PkgVersion] [PodWeaver] [Prepender] copyright = 1 ; -- dynamic meta information ; [InstallDirs] [MetaProvides::Package] ; -- generate meta/build files [License] [MakeMaker] [ModuleBuild] [MetaYAML] [Readme] [Manifest] ; should come last ; -- release [CheckChangeLog] [Git::NextVersion] first_version = 0.800 [Git::Tag] [Git::Check] [Git::Commit] [UploadToCPAN] [Git::Push] [Twitter] hash-tags = #perl #dancer #plugin #cpan #release tweet_url = http://search.cpan.org/search?query={{$DIST}}&mode=all tweet = Just released {{$DIST}}-{{$VERSION}} on CPAN : {{$URL}} META.yml100644000765000765 161111655456164 17124 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314--- abstract: "Dancer plugin to display temporary messages, so called \"flash messages\"." author: - "Damien \"dams\" Krotkine" build_requires: Dancer::Test: 0 English: 0 File::Find: 0 File::Temp: 0 Module::Build: 0.3601 Test::More: 0 configure_requires: ExtUtils::MakeMaker: 6.30 Module::Build: 0.3601 dynamic_config: 0 generated_by: 'Dist::Zilla version 4.300003, CPAN::Meta::Converter version 2.112621' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: Dancer-Plugin-FlashMessage provides: Dancer::Plugin::FlashMessage: file: lib/Dancer/Plugin/FlashMessage.pm version: 0.314 requires: Carp: 0 Dancer: 1.3001 Dancer::Plugin: 0 strict: 0 warnings: 0 resources: homepage: http://search.cpan.org/dist/Dancer-Plugin-FlashMessage repository: http://github.com/dams/Dancer-Plugin-FlashMessage version: 0.314 MANIFEST100644000765000765 37511655456164 16772 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314Build.PL Changes LICENSE MANIFEST META.yml Makefile.PL README README.pod dist.ini lib/Dancer/Plugin/FlashMessage.pm t/00-compile.t t/01_base.t t/02_flash.t t/03_retrieve.t t/author-critic.t t/release-distmeta.t t/release-pod-coverage.t t/views/index.tt Build.PL100644000765000765 170011655456164 17146 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314 use strict; use warnings; use Module::Build 0.3601; my %module_build_args = ( "build_requires" => { "Dancer::Test" => 0, "English" => 0, "File::Find" => 0, "File::Temp" => 0, "Module::Build" => "0.3601", "Test::More" => 0 }, "configure_requires" => { "ExtUtils::MakeMaker" => "6.30", "Module::Build" => "0.3601" }, "dist_abstract" => "Dancer plugin to display temporary messages, so called \"flash messages\".", "dist_author" => [ "Damien \"dams\" Krotkine" ], "dist_name" => "Dancer-Plugin-FlashMessage", "dist_version" => "0.314", "license" => "perl", "module_name" => "Dancer::Plugin::FlashMessage", "recommends" => {}, "recursive_test_files" => 1, "requires" => { "Carp" => 0, "Dancer" => "1.3001", "Dancer::Plugin" => 0, "strict" => 0, "warnings" => 0 }, "script_files" => [] ); my $build = Module::Build->new(%module_build_args); $build->create_build_script; README.pod100644000765000765 671411655456164 17325 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314=pod =head1 NAME Dancer::Plugin::FlashMessage - A plugin to display "flash messages" : short temporary messages =head1 SYNOPSYS Example with Template Toolkit In your configuration, make sure you have session configured. Of course you can use any session engine : session: "simple" In your index.tt view or in your layout : <% IF flash.error %>
<% flash.error %>
<% END %> In your css : .error { background: #CEE5F5; padding: 0.5em; border: 1px solid #AACBE2; } In your Dancer App : package MyWebService; use Dancer; use Dancer::Plugin::FlashMessage; get '/hello' => sub { flash error => 'Error message'; template 'index'; }; =head1 DESCRIPTION This plugin helps you display temporary messages, so called "flash messages". It provides a C method to define the message. The plugin then takes care of attaching the content to the session, propagating it to the templating system, and then removing it from the session. However, it's up to you to have a place in your views or layout where the message will be displayed. But that's not too hard (see L). Basically, the plugin gives you access to the 'flash' hash in your views. It can be used to display flash messages. By default, the plugin works using a decent configuration. However, you can change the behaviour of the plugin. See L =head1 METHODS =head2 flash # sets the flash message for the warning key flash warning => 'some warning message'; # retrieves and removes the flash message for the warning key my $warning_message = flash 'warning'; This method can take 1 or 2 parameters. When called with two parameters, it sets the flash message for the given key. When called with one parameter, it returns the value of the flash message of the given key. The message is deleted from the flash hash in the session. In both cases, C always returns the value; =head1 IN YOUR TEMPLATE After having set a flash message using C in your Dancer route, you can access the flash message from within your template. The plugin provides you with the C hashref, that you can access in your template, for example like this :
<% flash.error %>
When you use it in your template, the flash message is deleted. So next time, C will not exist. =head1 CONFIGURATION With no configuration whatsoever, the plugin will work fine, thus contributing to the I motto of Dancer. =head2 configuration default values These are the default values. See below for a description of the keys plugins: FlashMessage: token_name: flash session_hash_key: _flash =head2 configuration description =over =item token_name The name of the template token that will contain the hash of flash messages. B : C =item session_hash_key You probably don't need that, but this setting allows you to change the name of the session key used to store the hash of flash messages. It may be useful in the unlikely case where you have key name conflicts in your session. B : C<_flash> =back =head1 COPYRIGHT This software is copyright (c) 2011 by Damien "dams" Krotkine . =head1 LICENCE This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 AUTHORS This module has been written by Damien "dams" Krotkine . =head1 SEE ALSO L =cut t000755000765000765 011655456164 15757 5ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.31401_base.t100644000765000765 10311655456164 17470 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/tuse Test::More tests => 1; use_ok 'Dancer::Plugin::FlashMessage'; Makefile.PL100644000765000765 244611655456164 17634 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314 use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "Dancer plugin to display temporary messages, so called \"flash messages\".", "AUTHOR" => "Damien \"dams\" Krotkine", "BUILD_REQUIRES" => { "Dancer::Test" => 0, "English" => 0, "File::Find" => 0, "File::Temp" => 0, "Module::Build" => "0.3601", "Test::More" => 0 }, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30", "Module::Build" => "0.3601" }, "DISTNAME" => "Dancer-Plugin-FlashMessage", "EXE_FILES" => [], "LICENSE" => "perl", "NAME" => "Dancer::Plugin::FlashMessage", "PREREQ_PM" => { "Carp" => 0, "Dancer" => "1.3001", "Dancer::Plugin" => 0, "strict" => 0, "warnings" => 0 }, "VERSION" => "0.314", "test" => { "TESTS" => "t/*.t" } ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) { my $br = delete $WriteMakefileArgs{BUILD_REQUIRES}; my $pp = $WriteMakefileArgs{PREREQ_PM}; for my $mod ( keys %$br ) { if ( exists $pp->{$mod} ) { $pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod}; } else { $pp->{$mod} = $br->{$mod}; } } } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); 02_flash.t100644000765000765 154011655456164 17702 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/tuse Test::More tests => 10, import => ['!pass']; use Dancer ':syntax'; use Dancer::Test; use_ok 'Dancer::Plugin::FlashMessage'; setting views => path('t', 'views'); ok( get '/nothing' => sub { template 'index', { }; }); ok( get '/' => sub { flash(error => 'plop'); template 'index', { foo => 'bar' }; }); ok( get '/different' => sub { template 'index', { foo => 'bar' }; } ); # empty route route_exists [ GET => '/nothing' ]; response_content_like( [ GET => '/nothing' ], qr/foo :\s*, message :\s*$/ ); # first time we get the error message route_exists [ GET => '/' ]; response_content_like( [ GET => '/' ], qr/foo : bar, message : plop$/ ); # second time the error has disappeared route_exists [ GET => '/different' ]; response_content_like( [ GET => '/different' ], qr/foo : bar, message : \s*$/ ); 00-compile.t100644000765000765 353311655456164 20155 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/t#!perl # # This file is part of Dancer-Plugin-FlashMessage # # This software is copyright (c) 2011 by Damien "dams" Krotkine. # # This is free software; you can redistribute it and/or modify it under # the same terms as the Perl 5 programming language system itself. # use strict; use warnings; use Test::More; use File::Find; use File::Temp qw{ tempdir }; my @modules; find( sub { return if $File::Find::name !~ /\.pm\z/; my $found = $File::Find::name; $found =~ s{^lib/}{}; $found =~ s{[/\\]}{::}g; $found =~ s/\.pm$//; # nothing to skip push @modules, $found; }, 'lib', ); sub _find_scripts { my $dir = shift @_; my @found_scripts = (); find( sub { return unless -f; my $found = $File::Find::name; # nothing to skip open my $FH, '<', $_ or do { note( "Unable to open $found in ( $! ), skipping" ); return; }; my $shebang = <$FH>; return unless $shebang =~ /^#!.*?\bperl\b\s*$/; push @found_scripts, $found; }, $dir, ); return @found_scripts; } my @scripts; do { push @scripts, _find_scripts($_) if -d $_ } for qw{ bin script scripts }; my $plan = scalar(@modules) + scalar(@scripts); $plan ? (plan tests => $plan) : (plan skip_all => "no tests to run"); { # fake home for cpan-testers # no fake requested ## local $ENV{HOME} = tempdir( CLEANUP => 1 ); like( qx{ $^X -Ilib -e "require $_; print '$_ ok'" }, qr/^\s*$_ ok/s, "$_ loaded ok" ) for sort @modules; SKIP: { eval "use Test::Script 1.05; 1;"; skip "Test::Script needed to test script compilation", scalar(@scripts) if $@; foreach my $file ( @scripts ) { my $script = $file; $script =~ s!.*/!!; script_compiles( $file, "$script script compiles" ); } } } 03_retrieve.t100644000765000765 32311655456164 20411 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/tuse Test::More tests => 4, import => ['!pass']; use Dancer ':syntax'; use Dancer::Test; use_ok 'Dancer::Plugin::FlashMessage'; is(flash(foo => 'bar'), 'bar'); is(flash('foo'), 'bar'); is(flash('foo'), undef); views000755000765000765 011655456164 17114 5ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/tindex.tt100644000765000765 5411655456164 20673 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/t/viewsfoo : <% foo %>, message : <% flash.error %>author-critic.t100644000765000765 127411655456164 21065 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/t#!perl # # This file is part of Dancer-Plugin-FlashMessage # # This software is copyright (c) 2011 by Damien "dams" Krotkine. # # This is free software; you can redistribute it and/or modify it under # the same terms as the Perl 5 programming language system itself. # BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } use strict; use warnings; use Test::More; use English qw(-no_match_vars); eval "use Test::Perl::Critic"; plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; all_critic_ok(); release-distmeta.t100644000765000765 106311655456164 21534 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/t#!perl # # This file is part of Dancer-Plugin-FlashMessage # # This software is copyright (c) 2011 by Damien "dams" Krotkine. # # This is free software; you can redistribute it and/or modify it under # the same terms as the Perl 5 programming language system itself. # BEGIN { unless ($ENV{RELEASE_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for release candidate testing'); } } use Test::More; eval "use Test::CPAN::Meta"; plan skip_all => "Test::CPAN::Meta required for testing META.yml" if $@; meta_yaml_ok(); release-pod-coverage.t100644000765000765 137311655456164 22301 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/t#!perl # # This file is part of Dancer-Plugin-FlashMessage # # This software is copyright (c) 2011 by Damien "dams" Krotkine. # # This is free software; you can redistribute it and/or modify it under # the same terms as the Perl 5 programming language system itself. # BEGIN { unless ($ENV{RELEASE_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for release candidate testing'); } } use Test::More; eval "use Test::Pod::Coverage 1.08"; plan skip_all => "Test::Pod::Coverage 1.08 required for testing POD coverage" if $@; eval "use Pod::Coverage::TrustPod"; plan skip_all => "Pod::Coverage::TrustPod required for testing POD coverage" if $@; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); Plugin000755000765000765 011655456164 20714 5ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/lib/DancerFlashMessage.pm100644000765000765 1331011655456164 23772 0ustar00damsdams000000000000Dancer-Plugin-FlashMessage-0.314/lib/Dancer/Plugin# # This file is part of Dancer-Plugin-FlashMessage # # This software is copyright (c) 2011 by Damien "dams" Krotkine. # # This is free software; you can redistribute it and/or modify it under # the same terms as the Perl 5 programming language system itself. # use strict; use warnings; package Dancer::Plugin::FlashMessage; { $Dancer::Plugin::FlashMessage::VERSION = '0.314'; } # ABSTRACT: Dancer plugin to display temporary messages, so called "flash messages". use Carp; use Dancer ':syntax'; use Dancer::Plugin; our $AUTHORITY = 'DAMS'; my $conf = plugin_setting; my $token_name = $conf->{token_name} || 'flash'; my $session_hash_key = $conf->{session_hash_key} || '_flash'; my $session_engine; register flash => sub ($;$) { my ($key, $value) = @_; $session_engine ||= engine 'session' or croak __PACKAGE__ . " error2 : there is no session engine configured in the configuration. You need a session engine to be able to use this plugin"; my $flash = session($session_hash_key) || {}; @_ == 2 and $flash->{$key} = $value; @_ == 1 and $value = delete $flash->{$key}; session $session_hash_key, $flash; return $value; }; hook before_template => sub { shift->{$token_name} = { map { my $key = $_; my $value; ( $key, sub { defined $value and return $value; my $flash = session($session_hash_key) || {}; $value = delete $flash->{$key}; session $session_hash_key, $flash; return $value; } ); } ( keys %{session($session_hash_key) || {} }) }; }; register_plugin; 1; =pod =head1 NAME Dancer::Plugin::FlashMessage - Dancer plugin to display temporary messages, so called "flash messages". =head1 VERSION version 0.314 =head1 DESCRIPTION This plugin helps you display temporary messages, so called "flash messages". It provides a C method to define the message. The plugin then takes care of attaching the content to the session, propagating it to the templating system, and then removing it from the session. However, it's up to you to have a place in your views or layout where the message will be displayed. But that's not too hard (see L). Basically, the plugin gives you access to the 'flash' hash in your views. It can be used to display flash messages. By default, the plugin works using a decent configuration. However, you can change the behaviour of the plugin. See L =head1 NAME Dancer::Plugin::FlashMessage - A plugin to display "flash messages" : short temporary messages =head1 SYNOPSYS Example with Template Toolkit In your configuration, make sure you have session configured. Of course you can use any session engine : session: "simple" In your index.tt view or in your layout : <% IF flash.error %>
<% flash.error %>
<% END %> In your css : .error { background: #CEE5F5; padding: 0.5em; border: 1px solid #AACBE2; } In your Dancer App : package MyWebService; use Dancer; use Dancer::Plugin::FlashMessage; get '/hello' => sub { flash error => 'Error message'; template 'index'; }; =head1 METHODS =head2 flash # sets the flash message for the warning key flash warning => 'some warning message'; # retrieves and removes the flash message for the warning key my $warning_message = flash 'warning'; This method can take 1 or 2 parameters. When called with two parameters, it sets the flash message for the given key. When called with one parameter, it returns the value of the flash message of the given key. The message is deleted from the flash hash in the session. In both cases, C always returns the value; =head1 IN YOUR TEMPLATE After having set a flash message using C in your Dancer route, you can access the flash message from within your template. The plugin provides you with the C hashref, that you can access in your template, for example like this :
<% flash.error %>
When you use it in your template, the flash message is deleted. So next time, C will not exist. =head1 CONFIGURATION With no configuration whatsoever, the plugin will work fine, thus contributing to the I motto of Dancer. =head2 configuration default values These are the default values. See below for a description of the keys plugins: FlashMessage: token_name: flash session_hash_key: _flash =head2 configuration description =over =item token_name The name of the template token that will contain the hash of flash messages. B : C =item session_hash_key You probably don't need that, but this setting allows you to change the name of the session key used to store the hash of flash messages. It may be useful in the unlikely case where you have key name conflicts in your session. B : C<_flash> =back =head1 COPYRIGHT This software is copyright (c) 2011 by Damien "dams" Krotkine . =head1 LICENCE This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 AUTHORS This module has been written by Damien "dams" Krotkine . =head1 SEE ALSO L =head1 AUTHOR Damien "dams" Krotkine =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2011 by Damien "dams" Krotkine. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut __END__