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

package Catalyst::Helper;

use strict;
use base 'Class::Accessor::Fast';
use Config;
use File::Spec;
use File::Path;
use IO::File;
use FindBin;
use Template;
our $CATALYST_SCRIPT_GEN = 2;

my %cache;

=head1 NAME

Catalyst::Helper - Bootstrap a Catalyst application

=head1 SYNOPSIS

See L<Catalyst::Manual::Intro>

=head1 DESCRIPTION

Bootstrap a Catalyst application.

=head2 METHODS

=head3 get_file

Slurp file from DATA.

=cut

sub get_file {
    my ( $self, $class, $file ) = @_;
    unless ( $cache{$class} ) {
        local $/;
        $cache{$class} = eval "package $class; <DATA>";
    }
    my $data = $cache{$class};
    my @files = split /^__(.+)__\n/m, $data;
    shift @files;
    while (@files) {
        my ( $name, $content ) = splice @files, 0, 2;
        return $content if $name eq $file;
    }
    return 0;
}

=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->{startperl} = $Config{startperl};
    $self->{scriptgen}=$CATALYST_SCRIPT_GEN;
    $self->_mk_dirs;
    $self->_mk_appclass;
    $self->_mk_makefile;
    $self->_mk_readme;
    $self->_mk_changes;
    $self->_mk_apptest;
    $self->_mk_cgi;
    $self->_mk_fcgi;
    $self->_mk_server;
    $self->_mk_test;
    $self->_mk_create;
    return 1;
}

=head3 mk_component

=cut

sub mk_component {
    my $self = shift;
    my $app  = shift;
    $self->{app} = $app;
    $self->{base} = File::Spec->catdir( $FindBin::Bin, '..' );
    unless ( $_[0] =~ /^model|m|view|v|controller|c\$/i ) {
        my $helper = shift;
        my @args   = @_;
        my $class  = "Catalyst::Helper::$helper";
        eval "require $class";
        die qq/Couldn't load helper "$class", "$@"/ if $@;
        if ( $class->can('mk_stuff') ) {
            return 1 unless $class->mk_stuff( $self, @args );
        }
    }
    else {
        my $type   = shift;
        my $name   = shift;
        my $helper = shift;
        my @args   = @_;
        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";

        # 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 ) = @_;
    if ($tname) { $tname = "$tname.t" }
    else {
        my $name   = $self->{name};
        my $prefix = $name;
        $prefix =~ s/::/_/g;
        $prefix         = lc $prefix;
        $tname          = $prefix . '.t';
        $self->{prefix} = $prefix;
    }
    my $dir  = $self->{test_dir};
    my $type = lc $self->{type};
    return File::Spec->catfile( $dir, $type, $tname );
}

=head3 render_file

Render and create a file from a template in DATA.

=cut

sub render_file {
    my ( $self, $file, $path, $vars ) = @_;
    $vars ||= {};
    my $t = Template->new;
    my $template = $self->get_file( ( caller(0) )[0], $file );
    return 0 unless $template;
    my $output;
    $t->process( \$template, { %{$self}, %$vars }, \$output );
    $self->mk_file( $path, $output );
}

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->mk_dir( File::Spec->catdir( $self->{t}, 'm' ) );
    $self->mk_dir( File::Spec->catdir( $self->{t}, 'v' ) );
    $self->mk_dir( File::Spec->catdir( $self->{t}, 'c' ) );
    $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};
    $self->render_file( 'appclass', "$mod.pm" );
}

sub _mk_makefile {
    my $self = shift;
    my $dir  = $self->{dir};
    $self->render_file( 'makefile', "$dir\/Makefile.PL" );
}

sub _mk_readme {
    my $self = shift;
    my $dir  = $self->{dir};
    $self->render_file( 'readme', "$dir\/README" );
}

sub _mk_changes {
    my $self = shift;
    my $dir  = $self->{dir};
    my $time = localtime time;
    $self->render_file( 'changes', "$dir\/Changes", { time => $time } );
}

sub _mk_apptest {
    my $self = shift;
    my $t    = $self->{t};
    $self->render_file( 'apptest',         "$t\/01app.t" );
    $self->render_file( 'podtest',         "$t\/02pod.t" );
    $self->render_file( 'podcoveragetest', "$t\/03podcoverage.t" );
}

sub _mk_cgi {
    my $self   = shift;
    my $script = $self->{script};
    $self->render_file( 'cgi', "$script\/cgi.pl" );
    chmod 0700, "$script/cgi.pl";
}

sub _mk_fcgi {
    my $self   = shift;
    my $script = $self->{script};
    $self->render_file( 'fcgi', "$script\/fcgi.pl" );
    chmod 0700, "$script/fcgi.pl";
}

sub _mk_server {
    my $self   = shift;
    my $script = $self->{script};
    $self->render_file( 'server', "$script\/server.pl" );
    chmod 0700, "$script/server.pl";
}

sub _mk_test {
    my $self   = shift;
    my $script = $self->{script};
    $self->render_file( 'test', "$script/test.pl" );
    chmod 0700, "$script/test.pl";
}

sub _mk_create {
    my $self   = shift;
    my $script = $self->{script};
    $self->render_file( 'create', "$script\/create.pl" );
    chmod 0700, "$script/create.pl";
}

sub _mk_compclass {
    my $self = shift;
    my $file = $self->{file};
    return $self->render_file( 'compclass', "$file" );
}

sub _mk_comptest {
    my $self = shift;
    my $test = $self->{test};
    $self->render_file( 'comptest', "$test" );
}

=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;
__DATA__

__appclass__
package [% name %];

use strict;
use Catalyst qw/-Debug/;

our $VERSION = '0.01';

[% name %]->config(
    name => '[% name %]',
    root => '[% base %]/root',
);

[% name %]->setup;

sub default : Private {
    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;

__makefile__
use ExtUtils::MakeMaker;

WriteMakefile(
    NAME         => '[% name %]',
    VERSION_FROM => 'lib/[% class %].pm',
    PREREQ_PM    => { Catalyst => 5 },
    test         => { TESTS => join ' ', ( glob('t/*.t'), glob('t/*/*.t') ) }
);

__readme__
Run script/server.pl to test the application.

__changes__
This file documents the revision history for Perl extension $name.

0.01  [% time %]
        - initial revision, generated by Catalyst

__apptest__
use Test::More tests => 2;
use_ok( Catalyst::Test, '[% name %]' );

ok( request('/')->is_success );

__podtest__
use Test::More;

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

all_pod_files_ok();

__podcoveragetest__
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();

__cgi__
[% startperl %] -w
BEGIN { $ENV{CATALYST_ENGINE} = 'CGI' }

use strict;
use FindBin;
use lib "$FindBin::Bin/../lib";
use [% name %];

[% name %]->run;

1;

=head1 NAME

cgi - Catalyst CGI

=head1 SYNOPSIS

See L<Catalyst::Manual>

=head1 DESCRIPTION

Run a Catalyst application as cgi.

=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

__fcgi__
[% startperl %] -w

BEGIN { $ENV{CATALYST_ENGINE} = 'FCGI' }

use strict;
use FindBin;
use lib "$FindBin::Bin/../lib";
use [% name %];

[% name %]->run;

1;

=head1 NAME

fcgi - Catalyst FCGI

=head1 SYNOPSIS

See L<Catalyst::Manual>

=head1 DESCRIPTION

Run a Catalyst application as fcgi.

=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

__server__
[% startperl %] -w

BEGIN { 
    $ENV{CATALYST_ENGINE} = 'HTTP';
    $ENV{CATALYST_SCRIPT_GEN} = [% scriptgen %];
}  

use strict;
use Getopt::Long;
use Pod::Usage;
use FindBin;
use lib "$FindBin::Bin/../lib";
use [% name %];

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

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

pod2usage(1) if $help;

[% name %]->run($port);

1;

=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

__test__
[% startperl %] -w

BEGIN { $ENV{CATALYST_ENGINE} = 'Test' }

use strict;
use Getopt::Long;
use Pod::Usage;
use FindBin;
use lib "$FindBin::Bin/../lib";
use [% name %];

my $help = 0;

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

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

print [% name %]->run($ARGV[0])->content . "\n";

1;

=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

__create__
[% startperl %] -w

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

my $help = 0;

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

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

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

1;

=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
   create.pl Ajax

 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

__compclass__
package [% class %];

use strict;
use base 'Catalyst::Base';

[% IF type == 'C' %]
sub default : Private {
    my ( $self, $c ) = @_;
    $c->res->output('Congratulations, [% class %] is on Catalyst!');
}

[% END %]
=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;

__comptest__
[% IF type == 'C' %]
use Test::More tests => 3;
use_ok( Catalyst::Test, '[% app %]' );
use_ok('[% class %]');

ok( request('[% prefix %]')->is_success );
[% ELSE %]
use Test::More tests => 1;
use_ok('[% class %]');
[% END %]
Commit	Line	Data
fc7ec1d9	1	package Catalyst::Helper;
	2
	3	use strict;
	4	use base 'Class::Accessor::Fast';
f1d0b7ea	5	use Config;
fc7ec1d9	6	use File::Spec;
	7	use File::Path;
	8	use IO::File;
	9	use FindBin;
61cfdd57	10	use Template;
42a57832	11	our $CATALYST_SCRIPT_GEN = 2;
61cfdd57	12
61cfdd57	13	my %cache;
fc7ec1d9	14
	15	=head1 NAME
	16
	17	Catalyst::Helper - Bootstrap a Catalyst application
	18
	19	=head1 SYNOPSIS
	20
	21	See L<Catalyst::Manual::Intro>
	22
	23	=head1 DESCRIPTION
	24
	25	Bootstrap a Catalyst application.
	26
	27	=head2 METHODS
	28
61cfdd57	29	=head3 get_file
	30
	31	Slurp file from DATA.
	32
	33	=cut
	34
	35	sub get_file {
	36	my ( $self, $class, $file ) = @_;
	37	unless ( $cache{$class} ) {
	38	local $/;
	39	$cache{$class} = eval "package $class; <DATA>";
	40	}
	41	my $data = $cache{$class};
	42	my @files = split /^__(.+)__\n/m, $data;
	43	shift @files;
	44	while (@files) {
	45	my ( $name, $content ) = splice @files, 0, 2;
	46	return $content if $name eq $file;
	47	}
	48	return 0;
	49	}
	50
fc7ec1d9	51	=head3 mk_app
	52
	53	=cut
	54
	55	sub mk_app {
	56	my ( $self, $name ) = @_;
	57	return 0 if $name =~ /[^\w\:]/;
	58	$self->{name} = $name;
	59	$self->{dir} = $name;
	60	$self->{dir} =~ s/\:\:/-/g;
61cfdd57	61	$self->{startperl} = $Config{startperl};
42a57832	62	$self->{scriptgen}=$CATALYST_SCRIPT_GEN;
fc7ec1d9	63	$self->_mk_dirs;
	64	$self->_mk_appclass;
	65	$self->_mk_makefile;
91864987	66	$self->_mk_readme;
91864987	67	$self->_mk_changes;
fc7ec1d9	68	$self->_mk_apptest;
bc024080	69	$self->_mk_cgi;
cb8d90e5	70	$self->_mk_fcgi;
fc7ec1d9	71	$self->_mk_server;
	72	$self->_mk_test;
	73	$self->_mk_create;
	74	return 1;
	75	}
	76
ad41e777	77	=head3 mk_component
	78
	79	=cut
	80
	81	sub mk_component {
b5524568	82	my $self = shift;
	83	my $app = shift;
	84	$self->{app} = $app;
	85	$self->{base} = File::Spec->catdir( $FindBin::Bin, '..' );
	86	unless ( $_[0] =~ /^model\|m\|view\|v\|controller\|c\$/i ) {
	87	my $helper = shift;
	88	my @args = @_;
	89	my $class = "Catalyst::Helper::$helper";
ad41e777	90	eval "require $class";
ad41e777	91	die qq/Couldn't load helper "$class", "$@"/ if $@;
b5524568	92	if ( $class->can('mk_stuff') ) {
b5524568	93	return 1 unless $class->mk_stuff( $self, @args );
ad41e777	94	}
ad41e777	95	}
ad41e777	96	else {
b5524568	97	my $type = shift;
	98	my $name = shift;
	99	my $helper = shift;
	100	my @args = @_;
	101	return 0 if $name =~ /[^\w\:]/;
	102	$type = 'M' if $type =~ /model\|m/i;
	103	$type = 'V' if $type =~ /view\|v/i;
	104	$type = 'C' if $type =~ /controller\|c/i;
	105	$self->{type} = $type;
	106	$self->{name} = $name;
	107	$self->{class} = "$app\::$type\::$name";
	108
	109	# Class
	110	my $appdir = File::Spec->catdir( split /\:\:/, $app );
	111	my $path =
	112	File::Spec->catdir( $FindBin::Bin, '..', 'lib', $appdir, $type );
	113	my $file = $name;
	114	if ( $name =~ /\:/ ) {
	115	my @path = split /\:\:/, $name;
	116	$file = pop @path;
	117	$path = File::Spec->catdir( $path, @path );
	118	mkpath $path;
	119	}
	120	$file = File::Spec->catfile( $path, "$file.pm" );
	121	$self->{file} = $file;
	122
	123	# Test
	124	$self->{test_dir} = File::Spec->catdir( $FindBin::Bin, '..', 't' );
	125	$self->{test} = $self->next_test;
	126
	127	# Helper
	128	if ($helper) {
	129	my $comp = 'Model';
	130	$comp = 'View' if $type eq 'V';
	131	$comp = 'Controller' if $type eq 'C';
	132	my $class = "Catalyst::Helper::$comp\::$helper";
	133	eval "require $class";
	134	die qq/Couldn't load helper "$class", "$@"/ if $@;
	135	if ( $class->can('mk_compclass') ) {
	136	return 1 unless $class->mk_compclass( $self, @args );
	137	}
	138	else { return 1 unless $self->_mk_compclass }
	139
	140	if ( $class->can('mk_comptest') ) {
	141	$class->mk_comptest( $self, @args );
	142	}
	143	else { $self->_mk_comptest }
	144	}
	145
	146	# Fallback
	147	else {
	148	return 1 unless $self->_mk_compclass;
	149	$self->_mk_comptest;
	150	}
ad41e777	151	}
	152	return 1;
	153	}
	154
	155	=head3 mk_dir
	156
	157	=cut
	158
	159	sub mk_dir {
	160	my ( $self, $dir ) = @_;
	161	if ( -d $dir ) {
	162	print qq/ exists "$dir"\n/;
	163	return 0;
	164	}
	165	if ( mkpath $dir) {
	166	print qq/created "$dir"\n/;
	167	return 1;
	168	}
	169	die qq/Couldn't create "$dir", "$!"/;
	170	}
	171
	172	=head3 mk_file
	173
	174	=cut
	175
	176	sub mk_file {
	177	my ( $self, $file, $content ) = @_;
	178	if ( -e $file ) {
	179	print qq/ exists "$file"\n/;
	180	return 0;
	181	}
	182	if ( my $f = IO::File->new("> $file") ) {
	183	print $f $content;
	184	print qq/created "$file"\n/;
	185	return 1;
	186	}
	187	die qq/Couldn't create "$file", "$!"/;
	188	}
	189
	190	=head3 next_test
	191
	192	=cut
	193
	194	sub next_test {
	195	my ( $self, $tname ) = @_;
3cb1db8c	196	if ($tname) { $tname = "$tname.t" }
ad41e777	197	else {
ad41e777	198	my $name = $self->{name};
ad41e777	199	my $prefix = $name;
	200	$prefix =~ s/::/_/g;
	201	$prefix = lc $prefix;
3cb1db8c	202	$tname = $prefix . '.t';
ad41e777	203	$self->{prefix} = $prefix;
ad41e777	204	}
3cb1db8c	205	my $dir = $self->{test_dir};
	206	my $type = lc $self->{type};
	207	return File::Spec->catfile( $dir, $type, $tname );
ad41e777	208	}
ad41e777	209
61cfdd57	210	=head3 render_file
	211
	212	Render and create a file from a template in DATA.
	213
	214	=cut
	215
	216	sub render_file {
	217	my ( $self, $file, $path, $vars ) = @_;
	218	$vars \|\|= {};
	219	my $t = Template->new;
	220	my $template = $self->get_file( ( caller(0) )[0], $file );
	221	return 0 unless $template;
	222	my $output;
	223	$t->process( \$template, { %{$self}, %$vars }, \$output );
	224	$self->mk_file( $path, $output );
	225	}
	226
fc7ec1d9	227	sub _mk_dirs {
fc7ec1d9	228	my $self = shift;
ad41e777	229	$self->mk_dir( $self->{dir} );
91864987	230	$self->{script} = File::Spec->catdir( $self->{dir}, 'script' );
91864987	231	$self->mk_dir( $self->{script} );
fc7ec1d9	232	$self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' );
ad41e777	233	$self->mk_dir( $self->{lib} );
fc7ec1d9	234	$self->{root} = File::Spec->catdir( $self->{dir}, 'root' );
ad41e777	235	$self->mk_dir( $self->{root} );
fc7ec1d9	236	$self->{t} = File::Spec->catdir( $self->{dir}, 't' );
ad41e777	237	$self->mk_dir( $self->{t} );
3cb1db8c	238	$self->mk_dir( File::Spec->catdir( $self->{t}, 'm' ) );
	239	$self->mk_dir( File::Spec->catdir( $self->{t}, 'v' ) );
	240	$self->mk_dir( File::Spec->catdir( $self->{t}, 'c' ) );
fc7ec1d9	241	$self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) );
fc7ec1d9	242	$self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} );
ad41e777	243	$self->mk_dir( $self->{mod} );
fc7ec1d9	244	$self->{m} = File::Spec->catdir( $self->{mod}, 'M' );
ad41e777	245	$self->mk_dir( $self->{m} );
fc7ec1d9	246	$self->{v} = File::Spec->catdir( $self->{mod}, 'V' );
ad41e777	247	$self->mk_dir( $self->{v} );
fc7ec1d9	248	$self->{c} = File::Spec->catdir( $self->{mod}, 'C' );
ad41e777	249	$self->mk_dir( $self->{c} );
fc7ec1d9	250	$self->{base} = File::Spec->rel2abs( $self->{dir} );
	251	}
	252
	253	sub _mk_appclass {
ad41e777	254	my $self = shift;
ad41e777	255	my $mod = $self->{mod};
61cfdd57	256	$self->render_file( 'appclass', "$mod.pm" );
	257	}
	258
	259	sub _mk_makefile {
	260	my $self = shift;
	261	my $dir = $self->{dir};
	262	$self->render_file( 'makefile', "$dir\/Makefile.PL" );
	263	}
	264
	265	sub _mk_readme {
	266	my $self = shift;
	267	my $dir = $self->{dir};
	268	$self->render_file( 'readme', "$dir\/README" );
	269	}
	270
	271	sub _mk_changes {
	272	my $self = shift;
	273	my $dir = $self->{dir};
	274	my $time = localtime time;
	275	$self->render_file( 'changes', "$dir\/Changes", { time => $time } );
	276	}
	277
	278	sub _mk_apptest {
	279	my $self = shift;
	280	my $t = $self->{t};
	281	$self->render_file( 'apptest', "$t\/01app.t" );
	282	$self->render_file( 'podtest', "$t\/02pod.t" );
	283	$self->render_file( 'podcoveragetest', "$t\/03podcoverage.t" );
	284	}
	285
	286	sub _mk_cgi {
	287	my $self = shift;
	288	my $script = $self->{script};
	289	$self->render_file( 'cgi', "$script\/cgi.pl" );
	290	chmod 0700, "$script/cgi.pl";
	291	}
	292
	293	sub _mk_fcgi {
	294	my $self = shift;
	295	my $script = $self->{script};
	296	$self->render_file( 'fcgi', "$script\/fcgi.pl" );
	297	chmod 0700, "$script/fcgi.pl";
	298	}
	299
	300	sub _mk_server {
	301	my $self = shift;
	302	my $script = $self->{script};
	303	$self->render_file( 'server', "$script\/server.pl" );
	304	chmod 0700, "$script/server.pl";
	305	}
	306
	307	sub _mk_test {
	308	my $self = shift;
	309	my $script = $self->{script};
	310	$self->render_file( 'test', "$script/test.pl" );
	311	chmod 0700, "$script/test.pl";
	312	}
	313
	314	sub _mk_create {
	315	my $self = shift;
	316	my $script = $self->{script};
	317	$self->render_file( 'create', "$script\/create.pl" );
	318	chmod 0700, "$script/create.pl";
	319	}
320
321	sub _mk_compclass {
322	my $self = shift;
323	my $file = $self->{file};
324	return $self->render_file( 'compclass', "$file" );
325	}
326
327	sub _mk_comptest {
328	my $self = shift;
329	my $test = $self->{test};
330	$self->render_file( 'comptest', "$test" );
331	}
332
333	=head1 HELPERS
334
335	Helpers are classes that provide two methods.
336
337	* mk_compclass - creates the Component class
338	* mk_comptest - creates the Component test
339
340	So when you call C<bin/create view MyView TT>, create would try to execute
341	Catalyst::Helper::View::TT->mk_compclass and
342	Catalyst::Helper::View::TT->mk_comptest.
343
344	See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::CDBI> for
345	examples.
346
347	All helper classes should be under one of the following namespaces.
348
349	Catalyst::Helper::Model::
350	Catalyst::Helper::View::
351	Catalyst::Helper::Controller::
352
353	=head1 SEE ALSO
354
355	L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
356	L<Catalyst::Response>, L<Catalyst>
357
358	=head1 AUTHOR
359
360	Sebastian Riedel, C<sri@oook.de>
361
362	=head1 LICENSE
363
364	This library is free software . You can redistribute it and/or modify it under
365	the same terms as perl itself.
366
367	=cut
368
369	1;
370	__DATA__
371
372	__appclass__
373	package [% name %];
fc7ec1d9	374
	375	use strict;
	376	use Catalyst qw/-Debug/;
	377
61cfdd57	378	our $VERSION = '0.01';
fc7ec1d9	379
61cfdd57	380	[% name %]->config(
	381	name => '[% name %]',
	382	root => '[% base %]/root',
fc7ec1d9	383	);
5811fa3e	384
61cfdd57	385	[% name %]->setup;
fc7ec1d9	386
5a8ed4fe	387	sub default : Private {
61cfdd57	388	my ( $self, $c ) = @_;
61cfdd57	389	$c->res->output('Congratulations, [% name %] is on Catalyst!');
5a8ed4fe	390	}
fc7ec1d9	391
	392	=head1 NAME
	393
61cfdd57	394	[% name %] - A very nice application
fc7ec1d9	395
	396	=head1 SYNOPSIS
	397
	398	Very simple to use
	399
	400	=head1 DESCRIPTION
	401
	402	Very nice application.
	403
	404	=head1 AUTHOR
	405
	406	Clever guy
	407
	408	=head1 LICENSE
	409
	410	This library is free software . You can redistribute it and/or modify it under
	411	the same terms as perl itself.
	412
	413	=cut
	414
	415	1;
fc7ec1d9	416
61cfdd57	417	__makefile__
fc7ec1d9	418	use ExtUtils::MakeMaker;
	419
	420	WriteMakefile(
61cfdd57	421	NAME => '[% name %]',
61cfdd57	422	VERSION_FROM => 'lib/[% class %].pm',
4400b5ef	423	PREREQ_PM => { Catalyst => 5 },
3cb1db8c	424	test => { TESTS => join ' ', ( glob('t/.t'), glob('t//*.t') ) }
fc7ec1d9	425	);
fc7ec1d9	426
61cfdd57	427	__readme__
91864987	428	Run script/server.pl to test the application.
91864987	429
61cfdd57	430	__changes__
91864987	431	This file documents the revision history for Perl extension $name.
91864987	432
61cfdd57	433	0.01 [% time %]
91864987	434	- initial revision, generated by Catalyst
91864987	435
61cfdd57	436	__apptest__
fc7ec1d9	437	use Test::More tests => 2;
61cfdd57	438	use_ok( Catalyst::Test, '[% name %]' );
fc7ec1d9	439
fc7ec1d9	440	ok( request('/')->is_success );
61cfdd57	441
61cfdd57	442	__podtest__
5a8fd7e9	443	use Test::More;
	444
	445	eval "use Test::Pod 1.14";
61cfdd57	446	plan skip_all => 'Test::Pod 1.14 required' if $@;
61cfdd57	447	plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD};
5a8fd7e9	448
5a8fd7e9	449	all_pod_files_ok();
61cfdd57	450
61cfdd57	451	__podcoveragetest__
1df125c9	452	use Test::More;
	453
	454	eval "use Test::Pod::Coverage 1.04";
61cfdd57	455	plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@;
61cfdd57	456	plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD};
1df125c9	457
1df125c9	458	all_pod_coverage_ok();
fc7ec1d9	459
195631f4	460	__cgi__
61cfdd57	461	[% startperl %] -w
61cfdd57	462	BEGIN { $ENV{CATALYST_ENGINE} = 'CGI' }
d8ab1b45	463
	464	use strict;
	465	use FindBin;
61cfdd57	466	use lib "$FindBin::Bin/../lib";
61cfdd57	467	use [% name %];
d8ab1b45	468
61cfdd57	469	[% name %]->run;
d8ab1b45	470
d8ab1b45	471	1;
d8ab1b45	472
	473	=head1 NAME
	474
	475	cgi - Catalyst CGI
	476
	477	=head1 SYNOPSIS
	478
	479	See L<Catalyst::Manual>
	480
	481	=head1 DESCRIPTION
	482
	483	Run a Catalyst application as cgi.
	484
	485	=head1 AUTHOR
	486
61cfdd57	487	Sebastian Riedel, C<sri@oook.de>
d8ab1b45	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
d8ab1b45	497
61cfdd57	498	__fcgi__
61cfdd57	499	[% startperl %] -w
cb8d90e5	500
61cfdd57	501	BEGIN { $ENV{CATALYST_ENGINE} = 'FCGI' }
cb8d90e5	502
	503	use strict;
	504	use FindBin;
61cfdd57	505	use lib "$FindBin::Bin/../lib";
61cfdd57	506	use [% name %];
cb8d90e5	507
61cfdd57	508	[% name %]->run;
cb8d90e5	509
cb8d90e5	510	1;
cb8d90e5	511
	512	=head1 NAME
	513
	514	fcgi - Catalyst FCGI
	515
	516	=head1 SYNOPSIS
	517
	518	See L<Catalyst::Manual>
	519
	520	=head1 DESCRIPTION
	521
	522	Run a Catalyst application as fcgi.
	523
	524	=head1 AUTHOR
	525
61cfdd57	526	Sebastian Riedel, C<sri@oook.de>
cb8d90e5	527
	528	=head1 COPYRIGHT
	529
	530	Copyright 2004 Sebastian Riedel. All rights reserved.
	531
	532	This library is free software. You can redistribute it and/or modify it under
	533	the same terms as perl itself.
	534
	535	=cut
cb8d90e5	536
61cfdd57	537	__server__
61cfdd57	538	[% startperl %] -w
fc7ec1d9	539
42a57832	540	BEGIN {
	541	$ENV{CATALYST_ENGINE} = 'HTTP';
	542	$ENV{CATALYST_SCRIPT_GEN} = [% scriptgen %];
	543	}
585893b9	544
fc7ec1d9	545	use strict;
	546	use Getopt::Long;
	547	use Pod::Usage;
	548	use FindBin;
61cfdd57	549	use lib "$FindBin::Bin/../lib";
61cfdd57	550	use [% name %];
fc7ec1d9	551
61cfdd57	552	my $help = 0;
61cfdd57	553	my $port = 3000;
fc7ec1d9	554
61cfdd57	555	GetOptions( 'help\|?' => \$help, 'port=s' => \$port );
fc7ec1d9	556
195631f4	557	pod2usage(1) if $help;
fc7ec1d9	558
61cfdd57	559	[% name %]->run($port);
fc7ec1d9	560
fc7ec1d9	561	1;
fc7ec1d9	562
	563	=head1 NAME
	564
	565	server - Catalyst Testserver
	566
	567	=head1 SYNOPSIS
	568
91864987	569	server.pl [options]
fc7ec1d9	570
fc7ec1d9	571	Options:
ad41e777	572	-? -help display this help and exits
ad41e777	573	-p -port port (defaults to 3000)
fc7ec1d9	574
03a53815	575	See also:
	576	perldoc Catalyst::Manual
	577	perldoc Catalyst::Manual::Intro
	578
fc7ec1d9	579	=head1 DESCRIPTION
	580
	581	Run a Catalyst Testserver for this application.
	582
	583	=head1 AUTHOR
	584
61cfdd57	585	Sebastian Riedel, C<sri@oook.de>
fc7ec1d9	586
	587	=head1 COPYRIGHT
	588
	589	Copyright 2004 Sebastian Riedel. All rights reserved.
	590
	591	This library is free software. You can redistribute it and/or modify it under
	592	the same terms as perl itself.
	593
	594	=cut
fc7ec1d9	595
61cfdd57	596	__test__
61cfdd57	597	[% startperl %] -w
fc7ec1d9	598
61cfdd57	599	BEGIN { $ENV{CATALYST_ENGINE} = 'Test' }
e646f111	600
fc7ec1d9	601	use strict;
	602	use Getopt::Long;
	603	use Pod::Usage;
	604	use FindBin;
61cfdd57	605	use lib "$FindBin::Bin/../lib";
61cfdd57	606	use [% name %];
fc7ec1d9	607
61cfdd57	608	my $help = 0;
fc7ec1d9	609
61cfdd57	610	GetOptions( 'help\|?' => \$help );
fc7ec1d9	611
61cfdd57	612	pod2usage(1) if ( $help \|\| !$ARGV[0] );
fc7ec1d9	613
61cfdd57	614	print [% name %]->run($ARGV[0])->content . "\n";
fc7ec1d9	615
fc7ec1d9	616	1;
fc7ec1d9	617
	618	=head1 NAME
	619
	620	test - Catalyst Test
	621
	622	=head1 SYNOPSIS
	623
91864987	624	test.pl [options] uri
fc7ec1d9	625
	626	Options:
	627	-help display this help and exits
	628
	629	Examples:
91864987	630	test.pl http://localhost/some_action
91864987	631	test.pl /some_action
fc7ec1d9	632
03a53815	633	See also:
	634	perldoc Catalyst::Manual
	635	perldoc Catalyst::Manual::Intro
	636
fc7ec1d9	637	=head1 DESCRIPTION
	638
	639	Run a Catalyst action from the comand line.
	640
	641	=head1 AUTHOR
	642
61cfdd57	643	Sebastian Riedel, C<sri@oook.de>
fc7ec1d9	644
	645	=head1 COPYRIGHT
	646
	647	Copyright 2004 Sebastian Riedel. All rights reserved.
	648
	649	This library is free software. You can redistribute it and/or modify it under
	650	the same terms as perl itself.
	651
	652	=cut
fc7ec1d9	653
61cfdd57	654	__create__
61cfdd57	655	[% startperl %] -w
fc7ec1d9	656
	657	use strict;
	658	use Getopt::Long;
	659	use Pod::Usage;
	660	use Catalyst::Helper;
	661
61cfdd57	662	my $help = 0;
fc7ec1d9	663
	664	GetOptions( 'help\|?' => \$help );
	665
61cfdd57	666	pod2usage(1) if ( $help \|\| !$ARGV[0] );
fc7ec1d9	667
61cfdd57	668	my $helper = Catalyst::Helper->new;
61cfdd57	669	pod2usage(1) unless $helper->mk_component( '[% name %]', @ARGV );
fc7ec1d9	670
fc7ec1d9	671	1;
fc7ec1d9	672
	673	=head1 NAME
	674
	675	create - Create a new Catalyst Component
	676
	677	=head1 SYNOPSIS
	678
91864987	679	create.pl [options] model\|view\|controller name [helper] [options]
fc7ec1d9	680
	681	Options:
	682	-help display this help and exits
	683
	684	Examples:
91864987	685	create.pl controller My::Controller
	686	create.pl view My::View
	687	create.pl view MyView TT
	688	create.pl view TT TT
	689	create.pl model My::Model
	690	create.pl model SomeDB CDBI dbi:SQLite:/tmp/my.db
	691	create.pl model AnotherDB CDBI dbi:Pg:dbname=foo root 4321
b5524568	692	create.pl Ajax
03a53815	693
	694	See also:
	695	perldoc Catalyst::Manual
	696	perldoc Catalyst::Manual::Intro
fc7ec1d9	697
	698	=head1 DESCRIPTION
	699
	700	Create a new Catalyst Component.
	701
	702	=head1 AUTHOR
	703
	704	Sebastian Riedel, C<sri\@oook.de>
	705
	706	=head1 COPYRIGHT
	707
	708	Copyright 2004 Sebastian Riedel. All rights reserved.
	709
	710	This library is free software. You can redistribute it and/or modify it under
	711	the same terms as perl itself.
	712
	713	=cut
fc7ec1d9	714
61cfdd57	715	__compclass__
	716	package [% class %];
	717
	718	use strict;
	719	use base 'Catalyst::Base';
fc7ec1d9	720
61cfdd57	721	[% IF type == 'C' %]
5a8ed4fe	722	sub default : Private {
ffa15401	723	my ( $self, $c ) = @_;
61cfdd57	724	$c->res->output('Congratulations, [% class %] is on Catalyst!');
5a8ed4fe	725	}
fc7ec1d9	726
61cfdd57	727	[% END %]
fc7ec1d9	728	=head1 NAME
fc7ec1d9	729
61cfdd57	730	[% class %] - A Component
fc7ec1d9	731
	732	=head1 SYNOPSIS
	733
	734	Very simple to use
	735
	736	=head1 DESCRIPTION
	737
	738	Very nice component.
	739
	740	=head1 AUTHOR
	741
	742	Clever guy
	743
	744	=head1 LICENSE
	745
	746	This library is free software . You can redistribute it and/or modify it under
	747	the same terms as perl itself.
	748
	749	=cut
	750
	751	1;
fc7ec1d9	752
61cfdd57	753	__comptest__
61cfdd57	754	[% IF type == 'C' %]
fc7ec1d9	755	use Test::More tests => 3;
61cfdd57	756	use_ok( Catalyst::Test, '[% app %]' );
61cfdd57	757	use_ok('[% class %]');
fc7ec1d9	758
61cfdd57	759	ok( request('[% prefix %]')->is_success );
61cfdd57	760	[% ELSE %]
fc7ec1d9	761	use Test::More tests => 1;
61cfdd57	762	use_ok('[% class %]');
61cfdd57	763	[% END %]