rt/sbin/extract_pod_tests

   1 #!/usr/bin/perl
   2 # {{{ BEGIN BPS TAGGED BLOCK
   3 #
   4 # COPYRIGHT:
   5 #
   6 # This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC
   7 #                                          <jesse@bestpractical.com>
   8 #
   9 # (Except where explicitly superseded by other copyright notices)
  10 #
  11 #
  12 # LICENSE:
  13 #
  14 # This work is made available to you under the terms of Version 2 of
  15 # the GNU General Public License. A copy of that license should have
  16 # been provided with this software, but in any event can be snarfed
  17 # from www.gnu.org.
  18 #
  19 # This work is distributed in the hope that it will be useful, but
  20 # WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22 # General Public License for more details.
  23 #
  24 # You should have received a copy of the GNU General Public License
  25 # along with this program; if not, write to the Free Software
  26 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  27 #
  28 #
  29 # CONTRIBUTION SUBMISSION POLICY:
  30 #
  31 # (The following paragraph is not intended to limit the rights granted
  32 # to you to modify and distribute this software under the terms of
  33 # the GNU General Public License and is only of importance to you if
  34 # you choose to contribute your changes and enhancements to the
  35 # community by submitting them to Best Practical Solutions, LLC.)
  36 #
  37 # By intentionally submitting any modifications, corrections or
  38 # derivatives to this work, or any other work intended for use with
  39 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  40 # you are the copyright holder for those contributions and you grant
  41 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  42 # royalty-free, perpetual, license to use, copy, create derivative
  43 # works based on those contributions, and sublicense and distribute
  44 # those contributions and any derivatives thereof.
  45 #
  46 # }}} END BPS TAGGED BLOCK
  47 use strict;
  48 use vars qw($VERSION);
  49 $VERSION = '0.06';
  50
  51 use Pod::Tests;
  52 use Symbol;
  53
  54 =pod
  55
  56 =head1 NAME
  57
  58 extract_pod_tests -  RT-specific variant of pod2tests
  59
  60 =head1 SYNOPSIS
  61
  62   pod2test [-Mmodule] [input [output]]
  63
  64 =head1 DESCRIPTION
  65
  66 B<pod2test> is a front-end for Test::Inline.  It generates the
  67 "Bodies" of MakeMaker style .t testing files from embedded tests and
  68 code examples.
  69
  70 If output is not specified, the resulting .t file will go to STDOUT.
  71 Otherwise, it will go to the given output file.  If input is not
  72 given, it will draw from STDIN.
  73
  74 If the given file contains no tests or code examples, no output will
  75 be given and no output file will be created.
  76
  77 =cut
  78
  79 my($infile, $outfile) = @ARGV;
  80 my($infh,$outfh);
  81
  82
  83 if( defined $infile ) {
  84     $infh = gensym;
  85     open($infh, $infile) or
  86       die "Can't open the POD file $infile: $!";
  87 }
  88 else {
  89     $infh = \*STDIN;
  90 }
  91
  92 unless ($outfile) {
  93      ( my $test = $infile ) =~ s/\.(pm|pod)$//;
  94             $test =~ s/^lib\W//;
  95             $test =~ s/\W/-/;
  96             $test =~ s/\//__/g;
  97
  98         $outfile = "lib/t/autogen/autogen-$test.t";
  99 }
 100
 101
 102 my $p = Pod::Tests->new;
 103 $p->parse_fh($infh);
 104
 105 # XXX Hack to put the filename into the #line directive
 106 $p->{file} = $infile || '';
 107
 108 my @tests    = $p->build_tests($p->tests);
 109 my @examples = $p->build_examples($p->examples);
 110
 111 exit unless @tests or @examples;
 112
 113
 114 if( defined $outfile) {
 115     $outfh = gensym;
 116     open($outfh, ">$outfile") or
 117       die "Can't open the test file $outfile: $!";
 118 }
 119 else {
 120     $outfh = \*STDOUT;
 121 }
 122
 123
 124
 125 foreach my $test (@tests, @examples) {
 126     print $outfh "$test\n";
 127 }
 128
 129 print $outfh "1;\n";
 130
 131 =pod
 132
 133 =head1 BUGS and CAVEATS
 134
 135 This is a very simple rough cut.  It only does very rudimentary tests
 136 on the examples.
 137
 138 =head1 AUTHOR
 139
 140
 141
 142 Based on pod2tests by Michael G Schwern <schwern@pobox.com>
 143
 144 =head1 SEE ALSO
 145
 146 L<Test::Inline>
 147
 148 =cut
 149
 150 1;