[catagits/Catalyst-Runtime.git] / lib / Catalyst / Helper.pm

package Catalyst::Helper;

use strict;
use base 'Class::Accessor::Fast';
use File::Spec;
use File::Path;
use IO::File;
use FindBin;

=head1 NAME

Catalyst::Helper - Bootstrap a Catalyst application

=head1 SYNOPSIS

See L<Catalyst::Manual::Intro>

=head1 DESCRIPTION

Bootstrap a Catalyst application.

=head2 METHODS

=head3 mk_app

=cut

sub mk_app {
    my ( $self, $name ) = @_;
    return 0 if $name =~ /[^\w\:]/;
    $self->{name} = $name;
    $self->{dir}  = $name;
    $self->{dir} =~ s/\:\:/-/g;
    $self->_mk_dirs;
    $self->_mk_appclass;
    $self->_mk_makefile;
    $self->_mk_readme;
    $self->_mk_changes;
    $self->_mk_apptest;
    $self->_mk_server;
    $self->_mk_test;
    $self->_mk_create;
    return 1;
}

=head3 mk_component

=cut

sub mk_component {
    my ( $self, $app, $type, $name, $helper, @args ) = @_;
    return 0
      if ( $name =~ /[^\w\:]/ || !\$type =~ /^model|m|view|v|controller|c\$/i );
    return 0 if $name =~ /[^\w\:]/;
    $type = 'M' if $type =~ /model|m/i;
    $type = 'V' if $type =~ /view|v/i;
    $type = 'C' if $type =~ /controller|c/i;
    $self->{type}  = $type;
    $self->{name}  = $name;
    $self->{class} = "$app\::$type\::$name";
    $self->{app}   = $app;

    # Class
    my $appdir = File::Spec->catdir( split /\:\:/, $app );
    my $path = File::Spec->catdir( $FindBin::Bin, '..', 'lib', $appdir, $type );
    my $file = $name;
    if ( $name =~ /\:/ ) {
        my @path = split /\:\:/, $name;
        $file = pop @path;
        $path = File::Spec->catdir( $path, @path );
        mkpath $path;
    }
    $file = File::Spec->catfile( $path, "$file.pm" );
    $self->{file} = $file;

    # Test
    $self->{test_dir} = File::Spec->catdir( $FindBin::Bin, '..', 't' );
    $self->{test}     = $self->next_test;

    # Helper
    if ($helper) {
        my $comp = 'Model';
        $comp = 'View'       if $type eq 'V';
        $comp = 'Controller' if $type eq 'C';
        my $class = "Catalyst::Helper::$comp\::$helper";
        eval "require $class";
        die qq/Couldn't load helper "$class", "$@"/ if $@;
        if ( $class->can('mk_compclass') ) {
            return 1 unless $class->mk_compclass( $self, @args );
        }
        else { return 1 unless $self->_mk_compclass }

        if ( $class->can('mk_comptest') ) {
            $class->mk_comptest( $self, @args );
        }
        else { $self->_mk_comptest }
    }

    # Fallback
    else {
        return 1 unless $self->_mk_compclass;
        $self->_mk_comptest;
    }
    return 1;
}

=head3 mk_dir

=cut

sub mk_dir {
    my ( $self, $dir ) = @_;
    if ( -d $dir ) {
        print qq/ exists "$dir"\n/;
        return 0;
    }
    if ( mkpath $dir) {
        print qq/created "$dir"\n/;
        return 1;
    }
    die qq/Couldn't create "$dir", "$!"/;
}

=head3 mk_file

=cut

sub mk_file {
    my ( $self, $file, $content ) = @_;
    if ( -e $file ) {
        print qq/ exists "$file"\n/;
        return 0;
    }
    if ( my $f = IO::File->new("> $file") ) {
        print $f $content;
        print qq/created "$file"\n/;
        return 1;
    }
    die qq/Couldn't create "$file", "$!"/;
}

=head3 next_test

=cut

sub next_test {
    my ( $self, $tname ) = @_;
    my $dir = $self->{test_dir};
    my $num = '01';
    for my $i (<$dir/*.t>) {
        $i =~ /(\d+)[^\/]*.t$/;
        my $j = $1 || $num;
        $num = $j if $j > $num;
    }
    $num++;
    $num = sprintf '%02d', $num;
    if ($tname) { $tname = "$num$tname.t" }
    else {
        my $name   = $self->{name};
        my $type   = $self->{type};
        my $prefix = $name;
        $prefix =~ s/::/_/g;
        $prefix         = lc $prefix;
        $tname          = lc( $num . $type . '_' . $prefix . '.t' );
        $self->{prefix} = $prefix;
    }
    return "$dir/$tname";
}

sub _mk_dirs {
    my $self = shift;
    $self->mk_dir( $self->{dir} );
    $self->{script} = File::Spec->catdir( $self->{dir}, 'script' );
    $self->mk_dir( $self->{script} );
    $self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' );
    $self->mk_dir( $self->{lib} );
    $self->{root} = File::Spec->catdir( $self->{dir}, 'root' );
    $self->mk_dir( $self->{root} );
    $self->{t} = File::Spec->catdir( $self->{dir}, 't' );
    $self->mk_dir( $self->{t} );
    $self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) );
    $self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} );
    $self->mk_dir( $self->{mod} );
    $self->{m} = File::Spec->catdir( $self->{mod}, 'M' );
    $self->mk_dir( $self->{m} );
    $self->{v} = File::Spec->catdir( $self->{mod}, 'V' );
    $self->mk_dir( $self->{v} );
    $self->{c} = File::Spec->catdir( $self->{mod}, 'C' );
    $self->mk_dir( $self->{c} );
    $self->{base} = File::Spec->rel2abs( $self->{dir} );
}

sub _mk_appclass {
    my $self = shift;
    my $mod  = $self->{mod};
    my $name = $self->{name};
    my $base = $self->{base};
    $self->mk_file( "$mod.pm", <<"EOF");
package $name;

use strict;
use Catalyst qw/-Debug/;

our \$VERSION = '0.01';

$name->config(
    name => '$name',
    root => '$base/root',
);

$name->action(

    '!default' => sub {
        my ( \$self, \$c ) = \@_;
        \$c->res->output('Congratulations, $name is on Catalyst!');
    },

);

=head1 NAME

$name - A very nice application

=head1 SYNOPSIS

    Very simple to use

=head1 DESCRIPTION

Very nice application.

=head1 AUTHOR

Clever guy

=head1 LICENSE

This library is free software . You can redistribute it and/or modify it under
the same terms as perl itself.

=cut

1;
EOF
}

sub _mk_makefile {
    my $self  = shift;
    my $name  = $self->{name};
    my $dir   = $self->{dir};
    my $class = $self->{class};
    $self->mk_file( "$dir\/Makefile.PL", <<"EOF");
use ExtUtils::MakeMaker;

WriteMakefile(
    NAME         => '$name',
    VERSION_FROM => 'lib/$class.pm',
    PREREQ_PM    => { Catalyst => 0 }
);
EOF
}

sub _mk_readme {
    my $self = shift;
    my $dir  = $self->{dir};
    $self->mk_file( "$dir\/README", <<"EOF");
Run script/server.pl to test the application.
EOF
}

sub _mk_changes {
    my $self = shift;
    my $name = $self->{name};
    my $dir  = $self->{dir};
    my $time = localtime time;
    $self->mk_file( "$dir\/Changes", <<"EOF");
This file documents the revision history for Perl extension $name.

0.01  $time
        - initial revision, generated by Catalyst
EOF
}

sub _mk_apptest {
    my $self = shift;
    my $t    = $self->{t};
    my $name = $self->{name};
    $self->mk_file( "$t\/01app.t", <<"EOF");
use Test::More tests => 2;
use_ok( Catalyst::Test, '$name' );

ok( request('/')->is_success );
EOF
    $self->mk_file( "$t\/02podcoverage.t", <<"EOF");
use Test::More;

eval "use Test::Pod::Coverage 1.04";
plan skip_all => 'Test::Pod::Coverage 1.04 required' if \$@;
plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};

all_pod_coverage_ok();
EOF
}

sub _mk_server {
    my $self   = shift;
    my $name   = $self->{name};
    my $script = $self->{script};
    $self->mk_file( "$script\/server.pl", <<"EOF");
#!/usr/bin/perl -w

use strict;
use Getopt::Long;
use Pod::Usage;
use FindBin;
use lib "\$FindBin::Bin/../lib";
use Catalyst::Test '$name';

my \$help = 0;
my \$port = 3000;

GetOptions( 'help|?' => \\\$help, 'port=s' => \\\$port );

pod2usage(1) if \$help;

Catalyst::Test::server(\$port);

1;
__END__

=head1 NAME

server - Catalyst Testserver

=head1 SYNOPSIS

server.pl [options]

 Options:
   -? -help    display this help and exits
   -p -port    port (defaults to 3000)

 See also:
   perldoc Catalyst::Manual
   perldoc Catalyst::Manual::Intro

=head1 DESCRIPTION

Run a Catalyst Testserver for this application.

=head1 AUTHOR

Sebastian Riedel, C<sri\@oook.de>

=head1 COPYRIGHT

Copyright 2004 Sebastian Riedel. All rights reserved.

This library is free software. You can redistribute it and/or modify it under
the same terms as perl itself.

=cut
EOF
    chmod 0700, "$script/server.pl";
}

sub _mk_test {
    my $self   = shift;
    my $name   = $self->{name};
    my $script = $self->{script};
    $self->mk_file( "$script/test.pl", <<"EOF");
#!/usr/bin/perl -w

use strict;
use Getopt::Long;
use Pod::Usage;
use FindBin;
use lib "\$FindBin::Bin/../lib";

my \$help = 0;

GetOptions( 'help|?' => \\\$help );

pod2usage(1) if ( \$help || !\$ARGV[0] );

require Catalyst::Test;
import Catalyst::Test '$name';

print get(\$ARGV[0]) . "\n";

1;
__END__

=head1 NAME

test - Catalyst Test

=head1 SYNOPSIS

test.pl [options] uri

 Options:
   -help    display this help and exits

 Examples:
   test.pl http://localhost/some_action
   test.pl /some_action

 See also:
   perldoc Catalyst::Manual
   perldoc Catalyst::Manual::Intro

=head1 DESCRIPTION

Run a Catalyst action from the comand line.

=head1 AUTHOR

Sebastian Riedel, C<sri\@oook.de>

=head1 COPYRIGHT

Copyright 2004 Sebastian Riedel. All rights reserved.

This library is free software. You can redistribute it and/or modify it under
the same terms as perl itself.

=cut
EOF
    chmod 0700, "$script/test.pl";
}

sub _mk_create {
    my $self   = shift;
    my $name   = $self->{name};
    my $script = $self->{script};
    $self->mk_file( "$script\/create.pl", <<"EOF");
#!/usr/bin/perl -w

use strict;
use Getopt::Long;
use Pod::Usage;
use Catalyst::Helper;

my \$help = 0;

GetOptions( 'help|?' => \$help );

pod2usage(1) if ( \$help || !\$ARGV[1] );

my \$helper = Catalyst::Helper->new;
pod2usage(1) unless \$helper->mk_component( '$name', \@ARGV );

1;
__END__

=head1 NAME

create - Create a new Catalyst Component

=head1 SYNOPSIS

create.pl [options] model|view|controller name [helper] [options]

 Options:
   -help    display this help and exits

 Examples:
   create.pl controller My::Controller
   create.pl view My::View
   create.pl view MyView TT
   create.pl view TT TT
   create.pl model My::Model
   create.pl model SomeDB CDBI dbi:SQLite:/tmp/my.db
   create.pl model AnotherDB CDBI dbi:Pg:dbname=foo root 4321

 See also:
   perldoc Catalyst::Manual
   perldoc Catalyst::Manual::Intro

=head1 DESCRIPTION

Create a new Catalyst Component.

=head1 AUTHOR

Sebastian Riedel, C<sri\@oook.de>

=head1 COPYRIGHT

Copyright 2004 Sebastian Riedel. All rights reserved.

This library is free software. You can redistribute it and/or modify it under
the same terms as perl itself.

=cut
EOF
    chmod 0700, "$script/create.pl";
}

sub _mk_compclass {
    my $self   = shift;
    my $app    = $self->{app};
    my $class  = $self->{class};
    my $type   = $self->{type};
    my $action = '';
    $action = <<"EOF" if $type eq 'C';

$app->action(

    '!?default' => sub {
        my ( \$self, \$c ) = \@_;
        \$c->res->output('Congratulations, $class is on Catalyst!');
    },

);
EOF
    my $file = $self->{file};
    return $self->mk_file( "$file", <<"EOF");
package $class;

use strict;
use base 'Catalyst::Base';
$action
=head1 NAME

$class - A Component

=head1 SYNOPSIS

    Very simple to use

=head1 DESCRIPTION

Very nice component.

=head1 AUTHOR

Clever guy

=head1 LICENSE

This library is free software . You can redistribute it and/or modify it under
the same terms as perl itself.

=cut

1;
EOF
}

sub _mk_comptest {
    my $self   = shift;
    my $prefix = $self->{prefix};
    my $type   = $self->{type};
    my $class  = $self->{class};
    my $app    = $self->{app};
    my $test   = $self->{test};
    if ( $self->{type} eq 'C' ) {
        $self->mk_file( "$test", <<"EOF");
use Test::More tests => 3;
use_ok( Catalyst::Test, '$app' );
use_ok('$class');

ok( request('$prefix')->is_success );
EOF
    }
    else {
        $self->mk_file( "$test", <<"EOF");
use Test::More tests => 1;
use_ok('$class');
EOF
    }
}

=head1 HELPERS

Helpers are classes that provide two methods.

    * mk_compclass - creates the Component class
    * mk_comptest  - creates the Component test

So when you call C<bin/create view MyView TT>, create would try to execute
Catalyst::Helper::View::TT->mk_compclass and
Catalyst::Helper::View::TT->mk_comptest.

See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::CDBI> for
examples.

All helper classes should be under one of the following namespaces.

    Catalyst::Helper::Model::
    Catalyst::Helper::View::
    Catalyst::Helper::Controller::

=head1 SEE ALSO

L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
L<Catalyst::Response>, L<Catalyst>

=head1 AUTHOR

Sebastian Riedel, C<sri@oook.de>

=head1 LICENSE

This library is free software . You can redistribute it and/or modify it under
the same terms as perl itself.

=cut

1;
Commit	Line	Data
fc7ec1d9	1	package Catalyst::Helper;
	2
	3	use strict;
	4	use base 'Class::Accessor::Fast';
	5	use File::Spec;
	6	use File::Path;
	7	use IO::File;
	8	use FindBin;
	9
	10	=head1 NAME
	11
	12	Catalyst::Helper - Bootstrap a Catalyst application
	13
	14	=head1 SYNOPSIS
	15
	16	See L<Catalyst::Manual::Intro>
	17
	18	=head1 DESCRIPTION
	19
	20	Bootstrap a Catalyst application.
	21
	22	=head2 METHODS
	23
	24	=head3 mk_app
	25
	26	=cut
	27
	28	sub mk_app {
	29	my ( $self, $name ) = @_;
	30	return 0 if $name =~ /[^\w\:]/;
	31	$self->{name} = $name;
	32	$self->{dir} = $name;
	33	$self->{dir} =~ s/\:\:/-/g;
	34	$self->_mk_dirs;
	35	$self->_mk_appclass;
	36	$self->_mk_makefile;
91864987	37	$self->_mk_readme;
91864987	38	$self->_mk_changes;
fc7ec1d9	39	$self->_mk_apptest;
	40	$self->_mk_server;
	41	$self->_mk_test;
	42	$self->_mk_create;
	43	return 1;
	44	}
	45
ad41e777	46	=head3 mk_component
	47
	48	=cut
	49
	50	sub mk_component {
	51	my ( $self, $app, $type, $name, $helper, @args ) = @_;
	52	return 0
	53	if ( $name =~ /[^\w\:]/ \|\| !\$type =~ /^model\|m\|view\|v\|controller\|c\$/i );
	54	return 0 if $name =~ /[^\w\:]/;
	55	$type = 'M' if $type =~ /model\|m/i;
	56	$type = 'V' if $type =~ /view\|v/i;
	57	$type = 'C' if $type =~ /controller\|c/i;
	58	$self->{type} = $type;
	59	$self->{name} = $name;
	60	$self->{class} = "$app\::$type\::$name";
	61	$self->{app} = $app;
	62
	63	# Class
	64	my $appdir = File::Spec->catdir( split /\:\:/, $app );
	65	my $path = File::Spec->catdir( $FindBin::Bin, '..', 'lib', $appdir, $type );
	66	my $file = $name;
	67	if ( $name =~ /\:/ ) {
	68	my @path = split /\:\:/, $name;
	69	$file = pop @path;
	70	$path = File::Spec->catdir( $path, @path );
	71	mkpath $path;
	72	}
	73	$file = File::Spec->catfile( $path, "$file.pm" );
	74	$self->{file} = $file;
	75
	76	# Test
	77	$self->{test_dir} = File::Spec->catdir( $FindBin::Bin, '..', 't' );
	78	$self->{test} = $self->next_test;
	79
	80	# Helper
	81	if ($helper) {
	82	my $comp = 'Model';
	83	$comp = 'View' if $type eq 'V';
	84	$comp = 'Controller' if $type eq 'C';
	85	my $class = "Catalyst::Helper::$comp\::$helper";
	86	eval "require $class";
	87	die qq/Couldn't load helper "$class", "$@"/ if $@;
	88	if ( $class->can('mk_compclass') ) {
	89	return 1 unless $class->mk_compclass( $self, @args );
	90	}
	91	else { return 1 unless $self->_mk_compclass }
	92
	93	if ( $class->can('mk_comptest') ) {
	94	$class->mk_comptest( $self, @args );
	95	}
	96	else { $self->_mk_comptest }
	97	}
	98
	99	# Fallback
	100	else {
	101	return 1 unless $self->_mk_compclass;
	102	$self->_mk_comptest;
	103	}
	104	return 1;
	105	}
	106
	107	=head3 mk_dir
	108
	109	=cut
110
111	sub mk_dir {
112	my ( $self, $dir ) = @_;
113	if ( -d $dir ) {
114	print qq/ exists "$dir"\n/;
115	return 0;
116	}
117	if ( mkpath $dir) {
118	print qq/created "$dir"\n/;
119	return 1;
120	}
121	die qq/Couldn't create "$dir", "$!"/;
122	}
123
124	=head3 mk_file
125
126	=cut
127
128	sub mk_file {
129	my ( $self, $file, $content ) = @_;
130	if ( -e $file ) {
131	print qq/ exists "$file"\n/;
132	return 0;
133	}
134	if ( my $f = IO::File->new("> $file") ) {
135	print $f $content;
136	print qq/created "$file"\n/;
137	return 1;
138	}
139	die qq/Couldn't create "$file", "$!"/;
140	}
141
142	=head3 next_test
143
144	=cut
145
146	sub next_test {
147	my ( $self, $tname ) = @_;
148	my $dir = $self->{test_dir};
149	my $num = '01';
150	for my $i (<$dir/*.t>) {
151	$i =~ /(\d+)[^\/]*.t$/;
152	my $j = $1 \|\| $num;
153	$num = $j if $j > $num;
154	}
155	$num++;
156	$num = sprintf '%02d', $num;
157	if ($tname) { $tname = "$num$tname.t" }
158	else {
159	my $name = $self->{name};
160	my $type = $self->{type};
161	my $prefix = $name;
162	$prefix =~ s/::/_/g;
163	$prefix = lc $prefix;
164	$tname = lc( $num . $type . '_' . $prefix . '.t' );
165	$self->{prefix} = $prefix;
166	}
167	return "$dir/$tname";
168	}
169
fc7ec1d9	170	sub _mk_dirs {
fc7ec1d9	171	my $self = shift;
ad41e777	172	$self->mk_dir( $self->{dir} );
91864987	173	$self->{script} = File::Spec->catdir( $self->{dir}, 'script' );
91864987	174	$self->mk_dir( $self->{script} );
fc7ec1d9	175	$self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' );
ad41e777	176	$self->mk_dir( $self->{lib} );
fc7ec1d9	177	$self->{root} = File::Spec->catdir( $self->{dir}, 'root' );
ad41e777	178	$self->mk_dir( $self->{root} );
fc7ec1d9	179	$self->{t} = File::Spec->catdir( $self->{dir}, 't' );
ad41e777	180	$self->mk_dir( $self->{t} );
fc7ec1d9	181	$self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) );
fc7ec1d9	182	$self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} );
ad41e777	183	$self->mk_dir( $self->{mod} );
fc7ec1d9	184	$self->{m} = File::Spec->catdir( $self->{mod}, 'M' );
ad41e777	185	$self->mk_dir( $self->{m} );
fc7ec1d9	186	$self->{v} = File::Spec->catdir( $self->{mod}, 'V' );
ad41e777	187	$self->mk_dir( $self->{v} );
fc7ec1d9	188	$self->{c} = File::Spec->catdir( $self->{mod}, 'C' );
ad41e777	189	$self->mk_dir( $self->{c} );
fc7ec1d9	190	$self->{base} = File::Spec->rel2abs( $self->{dir} );
	191	}
	192
	193	sub _mk_appclass {
ad41e777	194	my $self = shift;
	195	my $mod = $self->{mod};
	196	my $name = $self->{name};
	197	my $base = $self->{base};
	198	$self->mk_file( "$mod.pm", <<"EOF");
fc7ec1d9	199	package $name;
	200
	201	use strict;
	202	use Catalyst qw/-Debug/;
	203
	204	our \$VERSION = '0.01';
	205
	206	$name->config(
	207	name => '$name',
	208	root => '$base/root',
	209	);
	210
	211	$name->action(
	212
	213	'!default' => sub {
	214	my ( \$self, \$c ) = \@_;
	215	\$c->res->output('Congratulations, $name is on Catalyst!');
	216	},
	217
	218	);
	219
	220	=head1 NAME
	221
	222	$name - A very nice application
	223
	224	=head1 SYNOPSIS
	225
	226	Very simple to use
	227
	228	=head1 DESCRIPTION
	229
	230	Very nice application.
	231
	232	=head1 AUTHOR
	233
	234	Clever guy
	235
	236	=head1 LICENSE
	237
	238	This library is free software . You can redistribute it and/or modify it under
	239	the same terms as perl itself.
	240
	241	=cut
	242
	243	1;
	244	EOF
	245	}
	246
	247	sub _mk_makefile {
ad41e777	248	my $self = shift;
	249	my $name = $self->{name};
	250	my $dir = $self->{dir};
	251	my $class = $self->{class};
	252	$self->mk_file( "$dir\/Makefile.PL", <<"EOF");
fc7ec1d9	253	use ExtUtils::MakeMaker;
	254
	255	WriteMakefile(
	256	NAME => '$name',
	257	VERSION_FROM => 'lib/$class.pm',
	258	PREREQ_PM => { Catalyst => 0 }
	259	);
	260	EOF
	261	}
	262
91864987	263	sub _mk_readme {
	264	my $self = shift;
	265	my $dir = $self->{dir};
	266	$self->mk_file( "$dir\/README", <<"EOF");
	267	Run script/server.pl to test the application.
	268	EOF
	269	}
	270
	271	sub _mk_changes {
	272	my $self = shift;
	273	my $name = $self->{name};
	274	my $dir = $self->{dir};
	275	my $time = localtime time;
	276	$self->mk_file( "$dir\/Changes", <<"EOF");
	277	This file documents the revision history for Perl extension $name.
	278
	279	0.01 $time
	280	- initial revision, generated by Catalyst
	281	EOF
	282	}
	283
fc7ec1d9	284	sub _mk_apptest {
	285	my $self = shift;
	286	my $t = $self->{t};
	287	my $name = $self->{name};
ad41e777	288	$self->mk_file( "$t\/01app.t", <<"EOF");
fc7ec1d9	289	use Test::More tests => 2;
	290	use_ok( Catalyst::Test, '$name' );
	291
	292	ok( request('/')->is_success );
	293	EOF
ad41e777	294	$self->mk_file( "$t\/02podcoverage.t", <<"EOF");
1df125c9	295	use Test::More;
	296
	297	eval "use Test::Pod::Coverage 1.04";
	298	plan skip_all => 'Test::Pod::Coverage 1.04 required' if \$@;
	299	plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};
	300
	301	all_pod_coverage_ok();
	302	EOF
fc7ec1d9	303	}
	304
	305	sub _mk_server {
91864987	306	my $self = shift;
	307	my $name = $self->{name};
	308	my $script = $self->{script};
	309	$self->mk_file( "$script\/server.pl", <<"EOF");
fc7ec1d9	310	#!/usr/bin/perl -w
	311
	312	use strict;
	313	use Getopt::Long;
	314	use Pod::Usage;
	315	use FindBin;
	316	use lib "\$FindBin::Bin/../lib";
	317	use Catalyst::Test '$name';
	318
	319	my \$help = 0;
	320	my \$port = 3000;
	321
	322	GetOptions( 'help\|?' => \\\$help, 'port=s' => \\\$port );
	323
	324	pod2usage(1) if \$help;
	325
	326	Catalyst::Test::server(\$port);
	327
	328	1;
	329	__END__
	330
	331	=head1 NAME
	332
	333	server - Catalyst Testserver
	334
	335	=head1 SYNOPSIS
	336
91864987	337	server.pl [options]
fc7ec1d9	338
fc7ec1d9	339	Options:
ad41e777	340	-? -help display this help and exits
ad41e777	341	-p -port port (defaults to 3000)
fc7ec1d9	342
03a53815	343	See also:
	344	perldoc Catalyst::Manual
	345	perldoc Catalyst::Manual::Intro
	346
fc7ec1d9	347	=head1 DESCRIPTION
	348
	349	Run a Catalyst Testserver for this application.
	350
	351	=head1 AUTHOR
	352
	353	Sebastian Riedel, C<sri\@oook.de>
	354
	355	=head1 COPYRIGHT
	356
	357	Copyright 2004 Sebastian Riedel. All rights reserved.
	358
	359	This library is free software. You can redistribute it and/or modify it under
	360	the same terms as perl itself.
	361
	362	=cut
	363	EOF
91864987	364	chmod 0700, "$script/server.pl";
fc7ec1d9	365	}
	366
	367	sub _mk_test {
91864987	368	my $self = shift;
	369	my $name = $self->{name};
	370	my $script = $self->{script};
	371	$self->mk_file( "$script/test.pl", <<"EOF");
fc7ec1d9	372	#!/usr/bin/perl -w
	373
	374	use strict;
	375	use Getopt::Long;
	376	use Pod::Usage;
	377	use FindBin;
	378	use lib "\$FindBin::Bin/../lib";
	379
	380	my \$help = 0;
	381
	382	GetOptions( 'help\|?' => \\\$help );
	383
	384	pod2usage(1) if ( \$help \|\| !\$ARGV[0] );
	385
	386	require Catalyst::Test;
	387	import Catalyst::Test '$name';
	388
	389	print get(\$ARGV[0]) . "\n";
	390
	391	1;
	392	__END__
	393
	394	=head1 NAME
	395
	396	test - Catalyst Test
	397
	398	=head1 SYNOPSIS
	399
91864987	400	test.pl [options] uri
fc7ec1d9	401
	402	Options:
	403	-help display this help and exits
	404
	405	Examples:
91864987	406	test.pl http://localhost/some_action
91864987	407	test.pl /some_action
fc7ec1d9	408
03a53815	409	See also:
	410	perldoc Catalyst::Manual
	411	perldoc Catalyst::Manual::Intro
	412
fc7ec1d9	413	=head1 DESCRIPTION
	414
	415	Run a Catalyst action from the comand line.
	416
	417	=head1 AUTHOR
	418
	419	Sebastian Riedel, C<sri\@oook.de>
	420
	421	=head1 COPYRIGHT
	422
	423	Copyright 2004 Sebastian Riedel. All rights reserved.
	424
	425	This library is free software. You can redistribute it and/or modify it under
	426	the same terms as perl itself.
	427
	428	=cut
	429	EOF
91864987	430	chmod 0700, "$script/test.pl";
fc7ec1d9	431	}
	432
	433	sub _mk_create {
91864987	434	my $self = shift;
	435	my $name = $self->{name};
	436	my $script = $self->{script};
	437	$self->mk_file( "$script\/create.pl", <<"EOF");
fc7ec1d9	438	#!/usr/bin/perl -w
	439
	440	use strict;
	441	use Getopt::Long;
	442	use Pod::Usage;
	443	use Catalyst::Helper;
	444
	445	my \$help = 0;
	446
	447	GetOptions( 'help\|?' => \$help );
	448
	449	pod2usage(1) if ( \$help \|\| !\$ARGV[1] );
	450
	451	my \$helper = Catalyst::Helper->new;
	452	pod2usage(1) unless \$helper->mk_component( '$name', \@ARGV );
	453
	454	1;
	455	__END__
	456
	457	=head1 NAME
	458
	459	create - Create a new Catalyst Component
	460
	461	=head1 SYNOPSIS
	462
91864987	463	create.pl [options] model\|view\|controller name [helper] [options]
fc7ec1d9	464
	465	Options:
	466	-help display this help and exits
	467
	468	Examples:
91864987	469	create.pl controller My::Controller
	470	create.pl view My::View
	471	create.pl view MyView TT
	472	create.pl view TT TT
	473	create.pl model My::Model
	474	create.pl model SomeDB CDBI dbi:SQLite:/tmp/my.db
	475	create.pl model AnotherDB CDBI dbi:Pg:dbname=foo root 4321
03a53815	476
	477	See also:
	478	perldoc Catalyst::Manual
	479	perldoc Catalyst::Manual::Intro
fc7ec1d9	480
	481	=head1 DESCRIPTION
	482
	483	Create a new Catalyst Component.
	484
	485	=head1 AUTHOR
	486
	487	Sebastian Riedel, C<sri\@oook.de>
	488
	489	=head1 COPYRIGHT
	490
	491	Copyright 2004 Sebastian Riedel. All rights reserved.
	492
	493	This library is free software. You can redistribute it and/or modify it under
	494	the same terms as perl itself.
	495
	496	=cut
	497	EOF
91864987	498	chmod 0700, "$script/create.pl";
fc7ec1d9	499	}
fc7ec1d9	500
fc7ec1d9	501	sub _mk_compclass {
	502	my $self = shift;
	503	my $app = $self->{app};
	504	my $class = $self->{class};
	505	my $type = $self->{type};
	506	my $action = '';
	507	$action = <<"EOF" if $type eq 'C';
	508
	509	$app->action(
	510
	511	'!?default' => sub {
	512	my ( \$self, \$c ) = \@_;
	513	\$c->res->output('Congratulations, $class is on Catalyst!');
	514	},
	515
	516	);
	517	EOF
	518	my $file = $self->{file};
ad41e777	519	return $self->mk_file( "$file", <<"EOF");
fc7ec1d9	520	package $class;
	521
	522	use strict;
	523	use base 'Catalyst::Base';
	524	$action
	525	=head1 NAME
	526
	527	$class - A Component
	528
	529	=head1 SYNOPSIS
	530
	531	Very simple to use
	532
	533	=head1 DESCRIPTION
	534
	535	Very nice component.
	536
	537	=head1 AUTHOR
	538
	539	Clever guy
	540
	541	=head1 LICENSE
	542
	543	This library is free software . You can redistribute it and/or modify it under
	544	the same terms as perl itself.
	545
	546	=cut
	547
	548	1;
	549	EOF
	550	}
	551
	552	sub _mk_comptest {
	553	my $self = shift;
	554	my $prefix = $self->{prefix};
	555	my $type = $self->{type};
	556	my $class = $self->{class};
	557	my $app = $self->{app};
	558	my $test = $self->{test};
fc7ec1d9	559	if ( $self->{type} eq 'C' ) {
ad41e777	560	$self->mk_file( "$test", <<"EOF");
fc7ec1d9	561	use Test::More tests => 3;
	562	use_ok( Catalyst::Test, '$app' );
	563	use_ok('$class');
	564
	565	ok( request('$prefix')->is_success );
	566	EOF
	567	}
	568	else {
ad41e777	569	$self->mk_file( "$test", <<"EOF");
fc7ec1d9	570	use Test::More tests => 1;
	571	use_ok('$class');
	572	EOF
	573	}
	574	}
	575
7833fdfc	576	=head1 HELPERS
	577
	578	Helpers are classes that provide two methods.
	579
	580	* mk_compclass - creates the Component class
	581	* mk_comptest - creates the Component test
	582
	583	So when you call C<bin/create view MyView TT>, create would try to execute
	584	Catalyst::Helper::View::TT->mk_compclass and
	585	Catalyst::Helper::View::TT->mk_comptest.
	586
	587	See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::CDBI> for
	588	examples.
	589
	590	All helper classes should be under one of the following namespaces.
	591
	592	Catalyst::Helper::Model::
	593	Catalyst::Helper::View::
	594	Catalyst::Helper::Controller::
	595
fc7ec1d9	596	=head1 SEE ALSO
	597
	598	L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
	599	L<Catalyst::Response>, L<Catalyst>
	600
	601	=head1 AUTHOR
	602
	603	Sebastian Riedel, C<sri@oook.de>
	604
	605	=head1 LICENSE
	606
	607	This library is free software . You can redistribute it and/or modify it under
	608	the same terms as perl itself.
	609
	610	=cut
	611
	612	1;