[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_nphcgi;
    $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 );
}

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\/cgi.pl", <<"EOF");
$Config{startperl} -w

BEGIN { \$ENV{CATALYST_ENGINE} = 'CGI' }

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

$name->run;

1;
__END__

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

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

BEGIN { \$ENV{CATALYST_ENGINE} = 'CGI::NPH' }

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

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

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

$name->run;

1;
__END__

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