diff --git a/.gitignore b/.gitignore index 5b39d6c..b00b891 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,10 @@ blib .* !.gitignore !.shipit +/Plack-Middleware-Debug-* +/.build +/_build_params +/Build +!Build/ +!META.json +!LICENSE diff --git a/.shipit b/.shipit deleted file mode 100644 index defcbcd..0000000 --- a/.shipit +++ /dev/null @@ -1,2 +0,0 @@ -steps = FindVersion, ChangeAllVersions, CheckChangeLog, DistTest, Commit, Tag, MakeDist, UploadCPAN -git.push_to = origin diff --git a/Build.PL b/Build.PL new file mode 100644 index 0000000..9c32d0c --- /dev/null +++ b/Build.PL @@ -0,0 +1,3 @@ +use 5.008001; +use Module::Build::Tiny 0.026; +Build_PL(); diff --git a/Changes b/Changes index 42e37a3..7df85ed 100644 --- a/Changes +++ b/Changes @@ -1,5 +1,7 @@ Revision history for Perl extension Plack-Middleware-Debug +{{$NEXT}} + 0.14 Sun Sep 18 12:51:49 PDT 2011 - Fixed warnings (chiselwright) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..caa35a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2009 by Marcel Grunauer, C<< >>. + +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) 2009 by Marcel Grunauer, C<< >>. + +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, Suite 500, Boston, MA 02110-1335 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) 2009 by Marcel Grunauer, C<< >>. + +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 + diff --git a/MANIFEST b/MANIFEST deleted file mode 100644 index b40842f..0000000 --- a/MANIFEST +++ /dev/null @@ -1,69 +0,0 @@ -Changes -examples/dbi/app.psgi -examples/dbi/dump.sql -examples/dbi/foo.db -examples/hello-world/app.psgi -inc/Module/AutoInstall.pm -inc/Module/Install.pm -inc/Module/Install/AutoInstall.pm -inc/Module/Install/Base.pm -inc/Module/Install/Can.pm -inc/Module/Install/Fetch.pm -inc/Module/Install/Include.pm -inc/Module/Install/Makefile.pm -inc/Module/Install/Metadata.pm -inc/Module/Install/ReadmeFromPod.pm -inc/Module/Install/Repository.pm -inc/Module/Install/Share.pm -inc/Module/Install/Win32.pm -inc/Module/Install/WriteAll.pm -INSTALL -lib/Plack/Middleware/Debug.pm -lib/Plack/Middleware/Debug/Base.pm -lib/Plack/Middleware/Debug/CatalystLog.pm -lib/Plack/Middleware/Debug/DBITrace.pm -lib/Plack/Middleware/Debug/Environment.pm -lib/Plack/Middleware/Debug/Memory.pm -lib/Plack/Middleware/Debug/ModuleVersions.pm -lib/Plack/Middleware/Debug/Panel.pm -lib/Plack/Middleware/Debug/Parameters.pm -lib/Plack/Middleware/Debug/PerlConfig.pm -lib/Plack/Middleware/Debug/Response.pm -lib/Plack/Middleware/Debug/Session.pm -lib/Plack/Middleware/Debug/Timer.pm -lib/Plack/Middleware/Debug/TrackObjects.pm -Makefile.PL -MANIFEST This list of files -META.yml -README -README.mkdn -share/debug_toolbar/back.png -share/debug_toolbar/back_hover.png -share/debug_toolbar/close.png -share/debug_toolbar/close_hover.png -share/debug_toolbar/indicator.png -share/debug_toolbar/information.gif -share/debug_toolbar/jquery.cookie.js -share/debug_toolbar/jquery.js -share/debug_toolbar/panel_bg.png -share/debug_toolbar/toolbar.css -share/debug_toolbar/toolbar.js -share/debug_toolbar/toolbar.min.css -share/debug_toolbar/toolbar.min.js -t/01_basic.t -t/parameters-leak.t -t/utf8.t -xt/author/00_compile.t -xt/author/01_perl_critic.t -xt/author/02_pod.t -xt/author/03_podspell.t -xt/author/04_pod_coverage.t -xt/author/05_kwalitee.t -xt/author/06_yaml_meta.t -xt/author/07_portability_files.t -xt/author/08_synopsis.t -xt/author/09_minimum_version.t -xt/author/10_has_version.t -xt/author/11_check_changes.t -xt/author/12_manifest.t -xt/author/perlcriticrc diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP deleted file mode 100644 index 7430be2..0000000 --- a/MANIFEST.SKIP +++ /dev/null @@ -1,41 +0,0 @@ -# Version control files and dirs. -\bRCS\b -\bCVS\b -\.svn -\.git -,v$ - -# Makemaker/Build.PL generated files and dirs. -^MANIFEST\. -^Makefile$ -^Build$ -^blib -^pm_to_blib$ -^_build -^MakeMaker-\d -embedded -cover_db -smoke.html -smoke.yaml -smoketee.txt -sqlnet.log -BUILD.SKIP -COVER.SKIP -CPAN.SKIP -t/000_standard__* -Debian_CPANTS.txt - -# Temp, old, emacs, vim, backup files. -~$ -\.old$ -\.swp$ -\.tar$ -\.tar\.gz$ -^#.*#$ -^\.# -.shipit - -# Local files, not to be included -^scratch$ -^core$ -^var$ diff --git a/META.json b/META.json new file mode 100644 index 0000000..c716419 --- /dev/null +++ b/META.json @@ -0,0 +1,78 @@ +{ + "abstract" : "display information about the current request/response", + "author" : [ + "Marcel Grunauer, C<< >>" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Milla version v1.0.4, Dist::Zilla version 4.300037, CPAN::Meta::Converter version 2.132140", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Plack-Middleware-Debug", + "no_index" : { + "directory" : [ + "t", + "xt", + "inc", + "share", + "eg", + "examples" + ] + }, + "prereqs" : { + "configure" : { + "requires" : { + "Module::Build::Tiny" : "0.026" + } + }, + "develop" : { + "requires" : { + "Test::Pod" : "1.41" + } + }, + "runtime" : { + "requires" : { + "Class::Method::Modifiers" : "1.05", + "Data::Dump" : "0", + "Encode" : "2.23", + "File::ShareDir" : "1.00", + "Plack" : "0", + "Text::MicroTemplate" : "0.15", + "parent" : "0", + "perl" : "5.008001" + } + }, + "test" : { + "requires" : { + "Test::More" : "0.70" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/miyagawa/Plack-Middleware-Debug/issues" + }, + "homepage" : "https://github.com/miyagawa/Plack-Middleware-Debug", + "repository" : { + "type" : "git", + "url" : "https://github.com/miyagawa/Plack-Middleware-Debug.git", + "web" : "https://github.com/miyagawa/Plack-Middleware-Debug" + } + }, + "version" : "0.14", + "x_contributors" : [ + "Chisel ", + "Graham Knop ", + "John Napiorkowski ", + "Jonathan Swartz ", + "Marcel Gruenauer ", + "Tatsuhiko Miyagawa ", + "franck cuny " + ] +} + diff --git a/Makefile.PL b/Makefile.PL deleted file mode 100644 index 86d4d17..0000000 --- a/Makefile.PL +++ /dev/null @@ -1,30 +0,0 @@ -use inc::Module::Install; -name 'Plack-Middleware-Debug'; -all_from 'lib/Plack/Middleware/Debug.pm'; -readme_from 'lib/Plack/Middleware/Debug.pm'; -auto_set_repository; -requires 'parent'; -requires 'Plack'; -requires 'Text::MicroTemplate', 0.15; -requires 'Data::Dump'; -requires 'File::ShareDir', '1.00'; -requires 'Class::Method::Modifiers', '1.05'; -requires 'Encode', 2.23; -feature 'Module versions panel', - default => 0, - 'Module::Versions' => '0.01'; -test_requires 'Test::More' => '0.70'; -test_requires 'Test::Requires'; -install_share 'share'; -auto_install; - -Makefile->postamble(< \$(MEDIADIR)/toolbar.min.js -\tjava -jar \$(YUICOMPRESS) \$(MEDIADIR)/jquery.cookie.js >> \$(MEDIADIR)/toolbar.min.js -\tjava -jar \$(YUICOMPRESS) --type css \$(MEDIADIR)/toolbar.css > \$(MEDIADIR)/toolbar.min.css -EOMAKE - -WriteAll; diff --git a/README b/README deleted file mode 100644 index e6a583d..0000000 --- a/README +++ /dev/null @@ -1,181 +0,0 @@ -NAME - Plack::Middleware::Debug - display information about the current - request/response - -SYNOPSIS - enable "Debug"; - -DESCRIPTION - The debug middleware offers a configurable set of panels that displays - information about the current request and response. The information is - generated only for responses with a status of 200 ("OK") and a - "Content-Type" that contains "text/html" or "application/xhtml+xml" and - is embedded in the HTML that is sent back to the browser. Also the code - is injected directly before the "" tag so if there is no such - tag, the information will not be injected. - - To enable the middleware, just use Plack::Builder as usual in your - ".psgi" file: - - use Plack::Builder; - - builder { - enable 'Debug', panels => [ qw(DBITrace Memory Timer) ]; - $app; - }; - - The "Debug" middleware takes an optional "panels" argument whose value - is expected to be a reference to an array of panel specifications. If - given, only those panels will be enabled. If you don't pass a "panels" - argument, the default list of panels - "Environment", "Response", - "Timer", "Memory", "Session" and "DBITrace" - will be enabled, each with - their default settings, and automatically disabled if their targer - modules or middleware components are not loaded. - - Each panel specification can take one of three forms: - - A string - This is interpreted as the base name of a panel in the - "Plack::Middeware::Debug::" namespace. The panel class is loaded and - a panel object is created with its default settings. - - An array reference - If you need to pass arguments to the panel object as it is created, - you may use this form (But see below). - - The first element of the array reference has to be the panel base - name. The remaining elements are key/value pairs to be passed to the - panel. - - For example: - - builder { - enable 'Debug', panels => - [ qw(Environment Response Timer Memory), - [ 'DBITrace', level => 2 ] - ]; - $app; - }; - - Because each panel is a middleware component, you can write this way - as well: - - builder { - enable 'Debug'; # load defaults - enable 'Debug::DBITrace', level => 2; - $app; - }; - - Note that the " line should come before other Debug - panels because of the order middleware components are executed. - - Custom middleware - You can also pass a Panel middleware component. This might be useful - if you have custom debug panels in your framework or web - application. - -HOW TO WRITE YOUR OWN DEBUG PANEL - The "Debug" middleware is designed to be easily extensible. You might - want to write a custom debug panel for your framework or for your web - application. Each debug panel is also a Plack middleware copmonent and - is easy to write one. - - Let's look at the anatomy of the "Timer" debug panel. Here is the code - from that panel: - - package Plack::Middleware::Debug::Timer; - use Time::HiRes; - - use parent qw(Plack::Middleware::Debug::Base); - - sub run { - my($self, $env, $panel) = @_; - - my $start = [ Time::HiRes::gettimeofday ]; - - return sub { - my $res = shift; - - my $end = [ Time::HiRes::gettimeofday ]; - my $elapsed = sprintf '%.6f s', Time::HiRes::tv_interval $start, $end; - - $panel->nav_subtitle($elapsed); - $panel->content( - $self->render_list_pairs( - [ Start => $self->format_time($start), - End => $self->format_time($end), - Elapsed => $elapsed ], - ), - ); - }; - } - - sub format_time { ... } - - To write a new debug panel, place it in the "Plack::Middleware::Debug::" - namespace. In our example, the "Timer" panel lives in the - "Plack::Middleware::Debug::Timer" package. - - The only thing your panel should do is to subclass - Plack::Middleware::Debug::Base. This does most of the things a - middleware component should do as a Plack middleware, so you only need - to override "run" method to profile and create the panel content. - - sub run { - my($self, $env, $panel) = @_; - - # Do something before the application runs - - return sub { - my $res = shift; - - # Do something after the application returns - - }; - } - - You can create as many lexical variables as you need and reference that - in the returned callback as a closure, and update the content of of the - $panel which is Plack::Middleware::Debug::Panel object. - - In our "Timer" example we want to list three key/value pairs: the start - time, the end time and the elapsed time. We use the - "render_list_pairs()" method to place the pairs in the order we want. - There is also a "render_hash()" and "render_lines()" method, to render a - hash keys and values, as well as just text lines (e.g. log messages). - -BUGS AND LIMITATIONS - Please report any bugs or feature requests through the web interface at - . - -INSTALLATION - See perlmodinstall for information and options on installing Perl - modules. - -AVAILABILITY - The latest version of this module is available from the Comprehensive - Perl Archive Network (CPAN). Visit to find a - CPAN site near you. Or see - . - - The development version lives at - . Instead of sending - patches, please fork this project using the standard git and github - infrastructure. - -AUTHORS - Marcel Grünauer, "" - - Tatsuhiko Miyagawa, "" - -COPYRIGHT AND LICENSE - Copyright 2009 by Marcel Grünauer - - This library is free software; you can redistribute it and/or modify it - under the same terms as Perl itself. - -SEE ALSO - The debug middleware is heavily influenced (that is, adapted from) the - Django Debug Toolbar - see - . - diff --git a/README.md b/README.md new file mode 100644 index 0000000..708f1a6 --- /dev/null +++ b/README.md @@ -0,0 +1,189 @@ +# NAME + +Plack::Middleware::Debug - display information about the current request/response + +# SYNOPSIS + + enable "Debug"; + +# DESCRIPTION + +The debug middleware offers a configurable set of panels that displays +information about the current request and response. The information is +generated only for responses with a status of 200 (`OK`) and a +`Content-Type` that contains `text/html` or `application/xhtml+xml` +and is embedded in the HTML that is sent back to the browser. Also the +code is injected directly before the `` tag so if there is +no such tag, the information will not be injected. + +To enable the middleware, just use [Plack::Builder](http://search.cpan.org/perldoc?Plack::Builder) as usual in your `.psgi` +file: + + use Plack::Builder; + + builder { + enable 'Debug', panels => [ qw(DBITrace Memory Timer) ]; + $app; + }; + +The `Debug` middleware takes an optional `panels` argument whose value is +expected to be a reference to an array of panel specifications. If given, +only those panels will be enabled. If you don't pass a `panels` +argument, the default list of panels - `Environment`, `Response`, +`Timer`, `Memory`, `Session` and `DBITrace` - will be enabled, each with +their default settings, and automatically disabled if their targer modules or +middleware components are not loaded. + +Each panel specification can take one of three forms: + +- A string + + This is interpreted as the base name of a panel in the + `Plack::Middeware::Debug::` namespace. The panel class is loaded and a panel + object is created with its default settings. + +- An array reference + + If you need to pass arguments to the panel object as it is created, + you may use this form (But see below). + + The first element of the array reference has to be the panel base + name. The remaining elements are key/value pairs to be passed to the + panel. + + For example: + + builder { + enable 'Debug', panels => + [ qw(Environment Response Timer Memory), + [ 'DBITrace', level => 2 ] + ]; + $app; + }; + + Because each panel is a middleware component, you can write this way + as well: + + builder { + enable 'Debug'; # load defaults + enable 'Debug::DBITrace', level => 2; + $app; + }; + + Note that the ` line should come before other Debug + panels because of the order middleware components are executed. + +- Custom middleware + + You can also pass a Panel middleware component. This might be useful + if you have custom debug panels in your framework or web application. + +# HOW TO WRITE YOUR OWN DEBUG PANEL + +The `Debug` middleware is designed to be easily extensible. You might +want to write a custom debug panel for your framework or for your web +application. Each debug panel is also a Plack middleware copmonent and +is easy to write one. + +Let's look at the anatomy of the `Timer` debug panel. Here is the code from +that panel: + + package Plack::Middleware::Debug::Timer; + use Time::HiRes; + + use parent qw(Plack::Middleware::Debug::Base); + + sub run { + my($self, $env, $panel) = @_; + + my $start = [ Time::HiRes::gettimeofday ]; + + return sub { + my $res = shift; + + my $end = [ Time::HiRes::gettimeofday ]; + my $elapsed = sprintf '%.6f s', Time::HiRes::tv_interval $start, $end; + + $panel->nav_subtitle($elapsed); + $panel->content( + $self->render_list_pairs( + [ Start => $self->format_time($start), + End => $self->format_time($end), + Elapsed => $elapsed ], + ), + ); + }; + } + + sub format_time { ... } + +To write a new debug panel, place it in the `Plack::Middleware::Debug::` +namespace. In our example, the `Timer` panel lives in the +`Plack::Middleware::Debug::Timer` package. + +The only thing your panel should do is to subclass +[Plack::Middleware::Debug::Base](http://search.cpan.org/perldoc?Plack::Middleware::Debug::Base). This does most of the things a +middleware component should do as a Plack middleware, so you only need +to override `run` method to profile and create the panel content. + + sub run { + my($self, $env, $panel) = @_; + + # Do something before the application runs + + return sub { + my $res = shift; + + # Do something after the application returns + + }; + } + +You can create as many lexical variables as you need and reference +that in the returned callback as a closure, and update the content of +of the `$panel` which is Plack::Middleware::Debug::Panel object. + +In our `Timer` example we want to list three key/value pairs: the +start time, the end time and the elapsed time. We use the +`render_list_pairs()` method to place the pairs in the order we +want. There is also a `render_hash()` and `render_lines()` method, +to render a hash keys and values, as well as just text lines (e.g. log +messages). + +# BUGS AND LIMITATIONS + +Please report any bugs or feature requests through the web interface at +[http://rt.cpan.org](http://rt.cpan.org). + +# INSTALLATION + +See perlmodinstall for information and options on installing Perl modules. + +# AVAILABILITY + +The latest version of this module is available from the Comprehensive Perl +Archive Network (CPAN). Visit [http://www.perl.com/CPAN/](http://www.perl.com/CPAN/) to find a CPAN site +near you. Or see [http://search.cpan.org/dist/Plack-Middleware-Debug/](http://search.cpan.org/dist/Plack-Middleware-Debug/). + +The development version lives at +[http://github.com/miyagawa/plack-middleware-debug/](http://github.com/miyagawa/plack-middleware-debug/). Instead of sending +patches, please fork this project using the standard git and github +infrastructure. + +# AUTHORS + +Marcel Grunauer, `` + +Tatsuhiko Miyagawa, `` + +# COPYRIGHT AND LICENSE + +Copyright 2009 by Marcel Grünauer + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +# SEE ALSO + +The debug middleware is heavily influenced (that is, adapted from) the Django +Debug Toolbar - see [http://github.com/robhudson/django-debug-toolbar](http://github.com/robhudson/django-debug-toolbar). diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..6275db4 --- /dev/null +++ b/cpanfile @@ -0,0 +1,12 @@ +requires 'Class::Method::Modifiers', '1.05'; +requires 'Data::Dump'; +requires 'Encode', '2.23'; +requires 'File::ShareDir', '1.00'; +requires 'Plack'; +requires 'Text::MicroTemplate', '0.15'; +requires 'parent'; +requires 'perl', '5.008001'; + +on test => sub { + requires 'Test::More', '0.70'; +}; diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..a4dbffa --- /dev/null +++ b/dist.ini @@ -0,0 +1 @@ +[@Milla] diff --git a/lib/Plack/Middleware/Debug.pm b/lib/Plack/Middleware/Debug.pm index 28a6e24..ddbffec 100644 --- a/lib/Plack/Middleware/Debug.pm +++ b/lib/Plack/Middleware/Debug.pm @@ -340,7 +340,7 @@ infrastructure. =head1 AUTHORS -Marcel GrEnauer, C<< >> +Marcel Grunauer, C<< >> Tatsuhiko Miyagawa, C<< >>