2 use UNIVERSAL::require;
5 use Maypole::Constants;
14 if ( ( caller(0) )[1] eq "-e" ) {
15 $package->handler() == OK and print $buffer;
22 die "Couldn't require $package - $@" if $@;
24 unshift @{ $package . "::ISA" }, "Maypole::CLI";
27 sub get_template_root { $ENV{MAYPOLE_TEMPLATES} || "." }
31 my $url = URI->new( shift @ARGV );
32 (my $uri_base = $self->config->uri_base) =~ s:/$::;
33 my $root = URI->new( $uri_base )->path;
34 $self->{path} = $url->path;
35 $self->{path} =~ s:^$root/?::i if $root;
37 $self->parse_args($url);
41 my ( $self, $url ) = @_;
42 $self->{params} = $url->query_form_hash;
43 $self->{query} = $url->query_form_hash;
46 sub send_output { $buffer = shift->{output} }
51 $package->handler() == OK and return $buffer;
59 Maypole::CLI - Command line interface to Maypole for testing and debugging
63 % setenv MAYPOLE_TEMPLATES /var/www/beerdb/
64 % perl -MMaypole::CLI=BeerDB -e1 http://localhost/beerdb/brewery/frontpage
68 This module is used to test Maypole sites without going through a web
69 server or modifying them to use a CGI frontend. To use it, you should
70 first either be in the template root for your Maypole site or set the
71 environment variable C<MAYPOLE_TEMPLATES> to the right value.
73 Next, you import the C<Maypole::CLI> module specifying your base Maypole
74 subclass. The usual way to do this is with the C<-M> flag:
75 C<perl -MMaypole::CLI=MyApp>. This is equivalent to:
77 use Maypole::CLI qw(MyApp);
79 Now Maypole will automatically call your application's handler with the
80 URL specified as the first command line parameter. This should be the
81 full URL, starting from whatever you have defined as the C<uri_base> in
82 your application's configuration, and may include query parameters.
84 The Maypole HTML output should then end up on standard output.
86 =head1 Support for testing
88 The module can also be used as part of a test script.
90 When used programmatically, rather than from the command line, its
91 behaviour is slightly different.
93 Although the URL is taken from C<@ARGV> as normal, your application's
94 C<handler> method is not called automatically, as it is when used on the
95 command line; you need to call it manually. Additionally, when
96 C<handler> is called, the output is not printed to standard output but
97 stored in C<$Maypole::CLI::buffer>, to allow you to check the contents
100 For instance, a test script could look like this:
102 use Test::More tests => 3;
103 use Maypole::CLI qw(BeerDB);
104 use Maypole::Constants;
105 $ENV{MAYPOLE_TEMPLATES} = "t/templates";
107 # Hack because isa_ok only supports object isa not class isa
108 isa_ok( (bless {},"BeerDB") , "Maypole");
110 like(BeerDB->call_url("http://localhost/beerdb/"), qr/frontpage/, "Got the front page");
112 like(BeerDB->call_url("http://localhost/beerdb/beer/list"), qr/Organic Best/, "Found a beer in the list");
120 for use in scripts. takes an url as argument, and returns the buffer.
125 =head1 Implementation
127 This class overrides a set of methods in the base Maypole class to provide it's
128 functionality. See L<Maypole> for these:
132 =item get_template_root