File Coverage

lib/Pod/Weaver/PluginBundle/Author/AJNN/Author.pm

Criterion	Covered	Total	%
statement	25	26	96.1
branch	2	4	50.0
condition			n/a
subroutine	8	8	100.0
pod	0	1	0.0
total	35	39	89.7

use 5.026;
use warnings;

package Pod::Weaver::PluginBundle::Author::AJNN::Author;
# ABSTRACT: Pod section naming the author
$Pod::Weaver::PluginBundle::Author::AJNN::Author::VERSION = '0.05';

use Carp qw(croak);
use Moose;
use namespace::autoclean;
use Pod::Elemental::Element::Nested;
use Pod::Elemental::Element::Pod5::Ordinary;

with 'Pod::Weaver::Role::Section';


our $HEADER = 'AUTHOR';


sub weave_section {
	my ($self, $document, $input) = @_;

	my $author = $input->{authors}->[0];

	croak "Unsupported declaration of multiple authors in dist.ini" if $input->{authors}->@* > 1;

	if ( $author =~ m/<ajnn\@cpan\.org>/ ) {
		$author .= <<~END;
			\n
			If you contact me by email, please make sure you include the word
			"Perl" in your subject header to help beat the spam filters.
			END
	}

	push $document->children->@*, Pod::Elemental::Element::Nested->new({
		command  => 'head1',
		content  => $HEADER,
		children => [ Pod::Elemental::Element::Pod5::Ordinary->new({
			content => $author,
		})],
	});
}


__PACKAGE__->meta->make_immutable;

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Pod::Weaver::PluginBundle::Author::AJNN::Author - Pod section naming the author

=head1 VERSION

version 0.05

=head1 SYNOPSIS

 package Pod::Weaver::PluginBundle::Author::AJNN;

 use Pod::Weaver::PluginBundle::Author::AJNN::Author;

 sub mvp_bundle_config {
   return (
     ...,
     [ '@AJNN/Author', __PACKAGE__ . '::Author', {}, ],
   )
 }

=head1 DESCRIPTION

This package provides AJNN's customised author statement.

In particular, if AJNN is declared as a distribution's only author,
a note is added that may help spam filtering.

=head1 BUGS

Multiple authors are unsupported.

=head1 SEE ALSO

L<Pod::Weaver::PluginBundle::Author::AJNN>

L<Pod::Weaver::Section::Authors>

=head1 AUTHOR

Arne Johannessen <[e-mail]>

If you contact me by email, please make sure you include the word
"Perl" in your subject header to help beat the spam filters.

=head1 COPYRIGHT AND LICENSE

Arne Johannessen has dedicated the work to the Commons by waiving all of his
or her rights to the work worldwide under copyright law and all related or
neighboring legal rights he or she had in the work, to the extent allowable by
law.

Works under CC0 do not require attribution. When citing the work, you should
not imply endorsement by the author.

=cut