[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;

=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_cgi;
    $self->_mk_server;
    $self->_mk_cgiserver;
    $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 );
}

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};
    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 },
    test         => { TESTS => join ' ', ( glob('t/*.t'), glob('t/*/*.t') ) }
);
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_cgi {
    my $self   = shift;
    my $name   = $self->{name};
    my $script = $self->{script};
    $self->mk_file( "$script\/nph-cgi.pl", <<"EOF");
$Config{startperl} -w

use strict;
use FindBin;
use lib "\$FindBin::Bin/../lib";
use $name;

$name->run;

1;
__END__

=head1 NAME

nph-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
EOF
    chmod 0700, "$script/nph-cgi.pl";
}

sub _mk_server {
    my $self   = shift;
    my $name   = $self->{name};
    my $script = $self->{script};
    $self->mk_file( "$script\/server.pl", <<"EOF");
$Config{startperl} -w

BEGIN { 
    \$ENV{CATALYST_ENGINE} = 'Server';
}

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;
__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_cgiserver {
    my $self   = shift;
    my $name   = $self->{name};
    my $script = $self->{script};
    $self->mk_file( "$script\/cgi-server.pl", <<"EOF");
$Config{startperl} -w

BEGIN { 
    \$ENV{CATALYST_ENGINE} = 'Server';
}

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

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

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

pod2usage(1) if \$help;

$name->run( \$port, File::Spec->catfile( \$FindBin::Bin, 'nph-cgi.pl' ) );

1;
__END__

=head1 NAME

cgi-server - Catalyst CGI Testserver

=head1 SYNOPSIS

cgi-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 CGI Testserver for this application.

Similar to the regular server but doesn't require a restart
after code changes!

=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/cgi-server.pl";
}

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