package Markdent::Role::DebugPrinter;
use strict;
use warnings;
use namespace::autoclean;
our $VERSION = '0.30';
use Markdent::Types;
use Moose::Role;
has debug => (
is => 'rw',
isa => t('Bool'),
default => $ENV{MARKDENT_DEBUG} || 0,
);
my $HR1 = q{=} x 70;
my $HR2 = q{-} x 70;
## no critic (Subroutines::ProhibitUnusedPrivateSubroutines)
sub _debug_parse_result {
my $self = shift;
my $text = shift;
my $type = shift;
my $extra = shift || [];
my $msg = '[' . $text . "]\n" . $HR2 . "\n" . ' - ' . $type . "\n";
while ( @{$extra} ) {
my ( $key, $value ) = splice @{$extra}, 0, 2;
$msg .= sprintf( ' - %-10s : %s', $key, $value );
$msg .= "\n";
}
$self->_print_debug($msg);
}
## use critic
sub _print_debug {
warn $HR1 . "\n" . ( ref $_[0] ) . "\n" . $_[1] . "\n";
}
1;
# ABSTRACT: A role for classes which output debugging information
__END__
=pod
=encoding UTF-8
=head1 NAME
Markdent::Role::DebugPrinter - A role for classes which output debugging information
=head1 VERSION
version 0.30
=head1 DESCRIPTION
This role implements behavior shared by all classes which output debugging information.
=head1 ATTRIBUTES
This roles provides the following attributes:
=head2 debug
This is a read-write boolean attribute.
It defaults to the value of C<$ENV{MARKDENT_DEBUG}>, if set, or 0.
=head1 METHODS
This roles provides the following methods:
=head2 $object->_debug_parse_result( $text, $type, $extra )
This method takes a text string, a parse result string (like "preformatted" or
"code_start"), and an optional array reference of extra key/value pairs.
All of this will be concatenated together in a pretty(-ish) way and passed to
C<< $object->_print_debug() >>.
=head2 $object->_print_debug($text)
This warns out the provided text along with a delimiter above the message.
=head1 BUGS
See L<Markdent> for bug reporting details.
Bugs may be submitted at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Markdent> or via email to L<bug-markdent@rt.cpan.org|mailto:bug-markdent@rt.cpan.org>.
I am also usually active on IRC as 'autarch' on C<irc://irc.perl.org>.
=head1 SOURCE
The source code repository for Markdent can be found at L<https://github.com/houseabsolute/Markdent>.
=head1 AUTHOR
Dave Rolsky <autarch@urth.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Dave Rolsky.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
The full text of the license can be found in the
F<LICENSE> file included with this distribution.
=cut