t/codingstd/pod_todo.t

   1 #! perl
   2 # Copyright (C) 2001-2010, Parrot Foundation.
   3 # $Id$
   4
   5 use strict;
   6 use warnings;
   7
   8 use Carp;
   9 use Test::More;
  10 use lib qw( lib );
  11 BEGIN {
  12     eval 'use Parrot::Test::Pod';
  13     if ($@) {
  14         plan skip_all => 'Prerequisites for Parrot::Test::Pod not satisfied';
  15         exit;
  16     }
  17 }
  18
  19 plan tests => 2;
  20
  21 my $self = Parrot::Test::Pod->new( {
  22     argv => [ @ARGV ],
  23 } );
  24 ok( defined $self, "Parrot::Test::Pod returned defined value" );
  25
  26 my $need_testing_ref = $self->identify_files_for_POD_testing( {
  27     second_analysis => 'no_pod_todo',
  28 } );
  29
  30 my $bad_files = join( "\n", sort @{ $need_testing_ref } );
  31 my $nbad_files = scalar @{ $need_testing_ref };
  32
  33 # only ok if everything passed
  34 TODO: {
  35     local $TODO = 'some todo remain';
  36
  37 is(
  38     $bad_files,
  39     q{},
  40     'No todo items found'
  41 );
  42
  43 diag("\nFound $nbad_files files with 'todo', 'fixme' or 'XXX' items.\n")
  44     if $nbad_files;
  45 }
  46 =head1 NAME
  47
  48 t/doc/pod_todo.t - find todo items in pod files
  49
  50 =head1 SYNOPSIS
  51
  52     # test all files
  53     % prove t/doc/pod_todo.t
  54
  55     # test specific files
  56     % perl t/doc/pod_todo.t perl_module.pm perl_file.pl
  57
  58 =head1 DESCRIPTION
  59
  60 Tests the all files listed in F<MANIFEST> and F<MANIFEST.generated> that
  61 appear to contain Pod markup for any todo items. If any files contain the
  62 string 'TODO', 'FIXME' or 'XXX', they are reported in the test output.
  63
  64 =head1 AUTHOR
  65
  66 Paul Cochrane <paultcochrane at gmail dot com>; stolen from t/doc/pod.t
  67
  68 =cut
  69
  70 # Local Variables:
  71 #   mode: cperl
  72 #   cperl-indent-level: 4
  73 #   fill-column: 100
  74 # End:
  75 # vim: expandtab shiftwidth=4: