File Coverage

blib/lib/Dist/Zilla/Plugin/Test/CheckDeps.pm

Criterion	Covered	Total	%
statement	8	8	100.0
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod	0	1	0.0
total	11	12	91.6

package Dist::Zilla::Plugin::Test::CheckDeps; # git description: v0.013-8-g41c9a1a
# vim: set ts=8 sts=4 sw=4 tw=115 et :

our $VERSION = '0.014';

use Moose;
extends qw/Dist::Zilla::Plugin::InlineFiles/;
with qw/Dist::Zilla::Role::TextTemplate Dist::Zilla::Role::PrereqSource/;
use namespace::autoclean;

has todo_when => (
    is => 'ro',
    isa => 'Str',
    default => '0',     # special value for 'insert no special code at all'
);

has fatal => (
    is => 'ro',
    isa => 'Bool',
    default => 0,
);

has level => (
    is => 'ro',
    isa => 'Str',
    lazy => 1,
    default => 'classic',
);

has filename => (
    is => 'ro',
    isa => 'Str',
    default => 't/00-check-deps.t',
);

around dump_config => sub {
    my $orig = shift;
    my $self = shift;

    my $config = $self->$orig;

    $config->{+__PACKAGE__} = {
        (map { $_ => $self->$_ } qw(todo_when level filename)),
        fatal => $self->fatal ? 1 : 0,
        blessed($self) ne __PACKAGE__ ? ( version => $VERSION ) : (),
    };

    return $config;
};

around add_file => sub {
    my ($orig, $self, $file) = @_;

    return $self->$orig(
        Dist::Zilla::File::InMemory->new(
            name    => $self->filename,
            content => $self->fill_in_string($file->content,
            {
                dist => \($self->zilla),
                plugin => \$self,
                todo_when => $self->todo_when,
                fatal => $self->fatal,
                level => $self->level,
            })
        )
    );
};

sub register_prereqs {
    my $self = shift;
    $self->zilla->register_prereqs(
        { phase => 'test', type => 'requires' },
        'Test::More' => '0.94',
        'Test::CheckDeps' => '0.010',
    );
}

__PACKAGE__->meta->make_immutable;

# ABSTRACT: Check for presence of dependencies

#pod =pod
#pod
#pod =head1 SYNOPSIS
#pod
#pod  [Test::CheckDeps]
#pod  fatal = 0          ; default
#pod  level = classic
#pod
#pod =head1 DESCRIPTION
#pod
#pod This module adds a test that assures all dependencies have been installed properly. If requested, it can bail out all testing on error.
#pod
#pod This plugin accepts the following options:
#pod
#pod =for stopwords TODO
#pod
#pod =over 4
#pod
#pod =item * C<todo_when>: a code string snippet (evaluated when the test is run)
#pod to indicate when failing tests should be considered L<TODO|Test::More/Conditional tests>,
#pod rather than genuine fails -- default is '0' (tests are never C<TODO>).
#pod
#pod Other suggested values are:
#pod
#pod     todo_when = !$ENV{AUTHOR_TESTING} && !$ENV{AUTOMATED_TESTING}
#pod     todo_when = $^V < '5.012'   ; CPAN.pm didn't reliably read META.* before this
#pod
#pod =item * C<fatal>: if true, C<BAIL_OUT> is called if the tests fail. Defaults
#pod to false.
#pod
#pod =item * C<level>: passed to C<check_dependencies> in L<Test::CheckDeps>.
#pod (Defaults to C<classic>.)
#pod
#pod =item * C<filename>: the name of the generated file. Defaults to
#pod F<t/00-check-deps.t>.
#pod
#pod =back
#pod
#pod =for Pod::Coverage register_prereqs
#pod
#pod =cut

=pod

=encoding UTF-8

=head1 NAME

Dist::Zilla::Plugin::Test::CheckDeps - Check for presence of dependencies

=head1 VERSION

version 0.014

=head1 SYNOPSIS

 [Test::CheckDeps]
 fatal = 0          ; default
 level = classic

=head1 DESCRIPTION

This module adds a test that assures all dependencies have been installed properly. If requested, it can bail out all testing on error.

This plugin accepts the following options:

=for stopwords TODO

=over 4

=item * C<todo_when>: a code string snippet (evaluated when the test is run)
to indicate when failing tests should be considered L<TODO|Test::More/Conditional tests>,
rather than genuine fails -- default is '0' (tests are never C<TODO>).

Other suggested values are:

    todo_when = !$ENV{AUTHOR_TESTING} && !$ENV{AUTOMATED_TESTING}
    todo_when = $^V < '5.012'   ; CPAN.pm didn't reliably read META.* before this

=item * C<fatal>: if true, C<BAIL_OUT> is called if the tests fail. Defaults
to false.

=item * C<level>: passed to C<check_dependencies> in L<Test::CheckDeps>.
(Defaults to C<classic>.)

=item * C<filename>: the name of the generated file. Defaults to
F<t/00-check-deps.t>.

=back

=for Pod::Coverage register_prereqs

=head1 SUPPORT

Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Test-CheckDeps>
(or L<[e-mail]|mailto:[e-mail]>).

There is also a mailing list available for users of this distribution, at
L<http://dzil.org/#mailing-list>.

There is also an irc channel available for users of this distribution, at
L<C<#distzilla> on C<irc.perl.org>|irc://irc.perl.org/#distzilla>.

=head1 AUTHOR

Leon Timmermans <[e-mail]>

=head1 CONTRIBUTORS

=for stopwords Karen Etheridge Leon Timmermans Brendan Byrd

=over 4

=item *

Karen Etheridge <[e-mail]>

=item *

Leon Timmermans <[e-mail]>

=item *

Brendan Byrd <[e-mail]>

=back

=head1 COPYRIGHT AND LICENCE

This software is copyright (c) 2011 by Leon Timmermans.

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

=cut

__DATA__
___[ test-checkdeps ]___
use strict;
use warnings;

# this test was generated with {{ ref $plugin }} {{ $plugin->VERSION }}

use Test::More 0.94;
{{
    my $use = 'use Test::CheckDeps 0.010;';

    # todo_when = 0 is treated as a special default, backwards-compatible case
    $use = "BEGIN {\n    ($todo_when) && eval \"" . $use
        . " 1\"\n        or plan skip_all => '!!! Test::CheckDeps required for checking dependencies -- failure to satisfy specified prerequisites!';\n}\n"
        . $use
            if $todo_when ne '0';
    $use
}}

{{
    $todo_when eq '0'
        ? ''
        : "local \$TODO = 'these tests are not fatal when $todo_when' if (${todo_when});\n"
            . 'my $builder = Test::Builder->new;' . "\n"
            . 'my $todo_output_orig = $builder->todo_output;' . "\n"
            . '$builder->todo_output($builder->failure_output);' . "\n";
}}
check_dependencies('{{ $level }}');
{{
    $todo_when ne '0' ? "\$builder->todo_output(\$todo_output_orig);\n" : '';
}}

if ({{ $fatal }}) {
    BAIL_OUT("Missing dependencies") if !Test::More->builder->is_passing;
}

done_testing;