1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
|
package Config::Model::Role::HelpAsText;
# ABSTRACT: Translate element help from pod to text
use Mouse::Role;
use strict;
use warnings;
use Pod::Text;
use Pod::Simple 3.23;
use v5.20;
use feature qw/postderef signatures/;
no warnings qw/experimental::postderef experimental::signatures/;
requires('get_help');
sub get_help_as_text ($self, @args) {
my $pod = $self->get_help(@args) ;
return unless defined $pod;
my $parser = Pod::Text->new(
indent => 0,
nourls => 1,
);
# require Pod::Simple 3.23
$parser->parse_characters('utf8');
my $output = '';
$parser->output_string(\$output);
$parser->parse_string_document("=pod\n\n" . $pod);
$output =~ s/[\n\s]+$//;
return $output;
}
1;
__END__
=head1 SYNOPSIS
$self->get_help_as_text( ... );
=head1 DESCRIPTION
Role used to transform Config::Model help text or description from pod
to text. The provided method should be used when the help text should
be displayed on STDOUT.
This functionality is provided as a role because the interface to
L<Pod::Text> is not so easy.
=head1 METHODS
=head2 get_help_as_text
Calls C<get_help> and transform the Pod output to text.
=head2 SEE ALSO
L<Pod::Text>, L<Pod::Simple>
=cut
|