/ 
Dancer2-Plugin-DebugDump-0.41
River stage zero No dependents
/ Dancer2::Plugin::DebugDump

NAME

Dancer2::Plugin::DebugDump - Modified debug behavior to create multi-line output that's easier for mere mortals to parse.

VERSION

version 0.41

OVERVIEW

Dancer2::Plugin::DebugDump, is a simple plugin for the Dancer2 web application framework. The target audience for this software is Dancer2 developers that use Dancer2's debug keyword during software development. It's purpose is to make the debug output in the log files or console easier to discern by formatting it across several lines.

SYNOPSIS

By default, Dancer2's debug keyword outputs data structures to a single line. This plugin runs variables through Data::Dumper to produce output that is easier to read.

use Dancer2;
use Dancer2::Plugin::DebugDump;

my $data_stucture = [ { 'key1' => 'value', 'key2' => 'value' }, { 'key1' => 'value' , 'key2' => 'value' } ];
ddump($data_structure);

# Sample output to your log or console
DEBUG DUMP:
$VAR1 = [
          {
            'key1' => 'value',
            'key2' => 'value'
          },
          {
            'key1' => 'value',
            'key2' => 'value',
          },
        ];

# Accepts multiple arguments, each argument should be a scalar or a reference
ddump($data_structure, $scalar_var, \@array_var, \%hash_var, ... );

KEYWORDS

ddump

Accepts list of scalars and references which are processed through Dumper before getting sent to Dancer2's built-in debug keyword. See Synopsis for usaage.

CONFIGURATION

DebugDump requires no configuration files or environment variables.

DEPENDENCIES

Data::Dumper;

INCOMPATIBILITIES

None reported.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

perldoc Dancer2::Plugin::DebugDump

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/sdondley/Dancer2-Plugin-DebugDump

git clone git://github.com/sdondley/Dancer2-Plugin-DebugDump.git

BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the web interface at http://github.com/sdondley/Dancer2-Plugin-DebugDump/issues.

MOTIVATION

I'm new to Dancer2 development and wrote this plugin to scratch a minor itch and to learn how to write a basic Dancer2 module. It's also my first CPAN module.

DEVELOPMENT NOTES

This software is actively maintained. Further releases are expected to help exercise my budding software development skills. Feedback, suggestions, and contributions are greatly appreciated and welcome.

I'm ignorant as to whether there is a better way to solve this problem than with a plugin. If there is a simpler, more elegant solution, I'm happy to hear it and will deprecate this module.

SEE ALSO

Data::Dumper man page. Dancer2 man page. Dancer2::Plugin man page.

AUTHOR

Steve Dondley <s@dondley.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Steve Dondley.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "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 SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

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 SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (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 SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.