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-2009 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., 51 Franklin Street, Fifth Floor, Boston, MA
  27 # 02110-1301 or visit their web page on the internet at
  28 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  29 #
  30 #
  31 # CONTRIBUTION SUBMISSION POLICY:
  32 #
  33 # (The following paragraph is not intended to limit the rights granted
  34 # to you to modify and distribute this software under the terms of
  35 # the GNU General Public License and is only of importance to you if
  36 # you choose to contribute your changes and enhancements to the
  37 # community by submitting them to Best Practical Solutions, LLC.)
  38 #
  39 # By intentionally submitting any modifications, corrections or
  40 # derivatives to this work, or any other work intended for use with
  41 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  42 # you are the copyright holder for those contributions and you grant
  43 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  44 # royalty-free, perpetual, license to use, copy, create derivative
  45 # works based on those contributions, and sublicense and distribute
  46 # those contributions and any derivatives thereof.
  47 #
  48 # END BPS TAGGED BLOCK }}}
  49 use strict;
  50 use vars qw($VERSION);
  51 $VERSION = '0.06';
  52
  53 use Pod::Tests;
  54 use Symbol;
  55
  56 =pod
  57
  58 =head1 NAME
  59
  60 extract_pod_tests -  RT-specific variant of pod2tests
  61
  62 =head1 SYNOPSIS
  63
  64   pod2test [-Mmodule] [input [output]]
  65
  66 =head1 DESCRIPTION
  67
  68 B<pod2test> is a front-end for Test::Inline.  It generates the
  69 "Bodies" of MakeMaker style .t testing files from embedded tests and
  70 code examples.
  71
  72 If output is not specified, the resulting .t file will go to STDOUT.
  73 Otherwise, it will go to the given output file.  If input is not
  74 given, it will draw from STDIN.
  75
  76 If the given file contains no tests or code examples, no output will
  77 be given and no output file will be created.
  78
  79 =cut
  80
  81 my($infile, $outfile) = @ARGV;
  82 my($infh,$outfh);
  83
  84
  85 if( defined $infile ) {
  86     $infh = gensym;
  87     open($infh, $infile) or
  88       die "Can't open the POD file $infile: $!";
  89 }
  90 else {
  91     $infh = \*STDIN;
  92 }
  93
  94 unless ($outfile) {
  95      ( my $test = $infile ) =~ s/\.(pm|pod)$//;
  96             $test =~ s/^lib\W//;
  97             $test =~ s/\W/-/;
  98             $test =~ s/\//__/g;
  99
 100         $outfile = "lib/t/autogen/autogen-$test.t";
 101 }
 102
 103
 104 my $p = Pod::Tests->new;
 105 $p->parse_fh($infh);
 106
 107 # XXX Hack to put the filename into the #line directive
 108 $p->{file} = $infile || '';
 109
 110 my @tests    = $p->build_tests($p->tests);
 111 my @examples = $p->build_examples($p->examples);
 112
 113 exit unless @tests or @examples;
 114
 115
 116 if( defined $outfile) {
 117     $outfh = gensym;
 118     open($outfh, ">$outfile") or
 119       die "Can't open the test file $outfile: $!";
 120 }
 121 else {
 122     $outfh = \*STDOUT;
 123 }
 124
 125
 126 print $outfh <<EOF;
 127
 128 use Test::More qw/no_plan/;
 129 use RT;
 130 RT::LoadConfig();
 131 RT::Init();
 132
 133 EOF
 134 foreach my $test (@tests, @examples) {
 135     print $outfh "$test\n";
 136 }
 137
 138 print $outfh "1;\n";
 139
 140 =pod
 141
 142 =head1 BUGS and CAVEATS
 143
 144 This is a very simple rough cut.  It only does very rudimentary tests
 145 on the examples.
 146
 147 =head1 AUTHOR
 148
 149
 150
 151 Based on pod2tests by Michael G Schwern <schwern@pobox.com>
 152
 153 =head1 SEE ALSO
 154
 155 L<Test::Inline>
 156
 157 =cut
 158
 159 1;