[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_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',
);

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;
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\/02pod.t", <<"EOF");
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();
EOF
    $self->mk_file( "$t\/03podcoverage.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_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} = 'HTTP' }

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

sub default : Private {
    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;
cb8d90e5	42	$self->_mk_fcgi;
fc7ec1d9	43	$self->_mk_server;
	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
5a8ed4fe	226	sub default : Private {
	227	my ( \$self, \$c ) = \@_;
	228	\$c->res->output('Congratulations, $name is on Catalyst!');
	229	}
fc7ec1d9	230
	231	=head1 NAME
	232
	233	$name - A very nice application
	234
	235	=head1 SYNOPSIS
	236
	237	Very simple to use
	238
	239	=head1 DESCRIPTION
	240
	241	Very nice application.
	242
	243	=head1 AUTHOR
	244
	245	Clever guy
	246
	247	=head1 LICENSE
	248
	249	This library is free software . You can redistribute it and/or modify it under
	250	the same terms as perl itself.
	251
	252	=cut
	253
	254	1;
	255	EOF
	256	}
	257
	258	sub _mk_makefile {
ad41e777	259	my $self = shift;
	260	my $name = $self->{name};
	261	my $dir = $self->{dir};
	262	my $class = $self->{class};
	263	$self->mk_file( "$dir\/Makefile.PL", <<"EOF");
fc7ec1d9	264	use ExtUtils::MakeMaker;
	265
	266	WriteMakefile(
	267	NAME => '$name',
	268	VERSION_FROM => 'lib/$class.pm',
3cb1db8c	269	PREREQ_PM => { Catalyst => 0 },
3cb1db8c	270	test => { TESTS => join ' ', ( glob('t/.t'), glob('t//*.t') ) }
fc7ec1d9	271	);
	272	EOF
	273	}
	274
91864987	275	sub _mk_readme {
	276	my $self = shift;
	277	my $dir = $self->{dir};
	278	$self->mk_file( "$dir\/README", <<"EOF");
	279	Run script/server.pl to test the application.
	280	EOF
	281	}
	282
	283	sub _mk_changes {
	284	my $self = shift;
	285	my $name = $self->{name};
	286	my $dir = $self->{dir};
	287	my $time = localtime time;
	288	$self->mk_file( "$dir\/Changes", <<"EOF");
	289	This file documents the revision history for Perl extension $name.
	290
	291	0.01 $time
	292	- initial revision, generated by Catalyst
	293	EOF
	294	}
	295
fc7ec1d9	296	sub _mk_apptest {
	297	my $self = shift;
	298	my $t = $self->{t};
	299	my $name = $self->{name};
ad41e777	300	$self->mk_file( "$t\/01app.t", <<"EOF");
fc7ec1d9	301	use Test::More tests => 2;
	302	use_ok( Catalyst::Test, '$name' );
	303
	304	ok( request('/')->is_success );
	305	EOF
5a8fd7e9	306	$self->mk_file( "$t\/02pod.t", <<"EOF");
	307	use Test::More;
	308
	309	eval "use Test::Pod 1.14";
a5d4355a	310	plan skip_all => 'Test::Pod 1.14 required' if \$@;
a5d4355a	311	plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};
5a8fd7e9	312
	313	all_pod_files_ok();
	314	EOF
	315	$self->mk_file( "$t\/03podcoverage.t", <<"EOF");
1df125c9	316	use Test::More;
	317
	318	eval "use Test::Pod::Coverage 1.04";
	319	plan skip_all => 'Test::Pod::Coverage 1.04 required' if \$@;
	320	plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};
	321
	322	all_pod_coverage_ok();
	323	EOF
fc7ec1d9	324	}
fc7ec1d9	325
bc024080	326	sub _mk_cgi {
	327	my $self = shift;
	328	my $name = $self->{name};
	329	my $script = $self->{script};
d8ab1b45	330	$self->mk_file( "$script\/cgi.pl", <<"EOF");
	331	$Config{startperl} -w
	332
	333	BEGIN { \$ENV{CATALYST_ENGINE} = 'CGI' }
	334
	335	use strict;
	336	use FindBin;
	337	use lib "\$FindBin::Bin/../lib";
	338	use $name;
	339
	340	$name->run;
	341
	342	1;
	343	__END__
	344
	345	=head1 NAME
	346
	347	cgi - Catalyst CGI
	348
	349	=head1 SYNOPSIS
	350
	351	See L<Catalyst::Manual>
	352
	353	=head1 DESCRIPTION
	354
	355	Run a Catalyst application as cgi.
	356
	357	=head1 AUTHOR
	358
	359	Sebastian Riedel, C<sri\@oook.de>
	360
	361	=head1 COPYRIGHT
	362
	363	Copyright 2004 Sebastian Riedel. All rights reserved.
	364
	365	This library is free software. You can redistribute it and/or modify it under
	366	the same terms as perl itself.
	367
	368	=cut
	369	EOF
	370	chmod 0700, "$script/cgi.pl";
	371	}
	372
cb8d90e5	373	sub _mk_fcgi {
	374	my $self = shift;
	375	my $name = $self->{name};
	376	my $script = $self->{script};
	377	$self->mk_file( "$script\/fcgi.pl", <<"EOF");
	378	$Config{startperl} -w
	379
ffb41d94	380	BEGIN { \$ENV{CATALYST_ENGINE} = 'FCGI' }
cb8d90e5	381
	382	use strict;
	383	use FindBin;
	384	use lib "\$FindBin::Bin/../lib";
cb8d90e5	385	use $name;
cb8d90e5	386
ffb41d94	387	$name->run;
cb8d90e5	388
	389	1;
	390	__END__
	391
	392	=head1 NAME
	393
	394	fcgi - Catalyst FCGI
	395
	396	=head1 SYNOPSIS
	397
	398	See L<Catalyst::Manual>
	399
	400	=head1 DESCRIPTION
	401
	402	Run a Catalyst application as fcgi.
	403
	404	=head1 AUTHOR
	405
	406	Sebastian Riedel, C<sri\@oook.de>
	407
	408	=head1 COPYRIGHT
	409
	410	Copyright 2004 Sebastian Riedel. All rights reserved.
	411
	412	This library is free software. You can redistribute it and/or modify it under
	413	the same terms as perl itself.
	414
	415	=cut
	416	EOF
	417	chmod 0700, "$script/fcgi.pl";
	418	}
	419
fc7ec1d9	420	sub _mk_server {
91864987	421	my $self = shift;
	422	my $name = $self->{name};
	423	my $script = $self->{script};
	424	$self->mk_file( "$script\/server.pl", <<"EOF");
f1d0b7ea	425	$Config{startperl} -w
fc7ec1d9	426
ca61af20	427	BEGIN { \$ENV{CATALYST_ENGINE} = 'HTTP' }
585893b9	428
fc7ec1d9	429	use strict;
	430	use Getopt::Long;
	431	use Pod::Usage;
	432	use FindBin;
	433	use lib "\$FindBin::Bin/../lib";
585893b9	434	use $name;
fc7ec1d9	435
	436	my \$help = 0;
	437	my \$port = 3000;
	438
	439	GetOptions( 'help\|?' => \\\$help, 'port=s' => \\\$port );
	440
	441	pod2usage(1) if \$help;
	442
585893b9	443	$name->run(\$port);
fc7ec1d9	444
	445	1;
	446	__END__
	447
	448	=head1 NAME
	449
	450	server - Catalyst Testserver
	451
	452	=head1 SYNOPSIS
	453
91864987	454	server.pl [options]
fc7ec1d9	455
fc7ec1d9	456	Options:
ad41e777	457	-? -help display this help and exits
ad41e777	458	-p -port port (defaults to 3000)
fc7ec1d9	459
03a53815	460	See also:
	461	perldoc Catalyst::Manual
	462	perldoc Catalyst::Manual::Intro
	463
fc7ec1d9	464	=head1 DESCRIPTION
	465
	466	Run a Catalyst Testserver for this application.
	467
	468	=head1 AUTHOR
	469
	470	Sebastian Riedel, C<sri\@oook.de>
	471
	472	=head1 COPYRIGHT
	473
	474	Copyright 2004 Sebastian Riedel. All rights reserved.
	475
	476	This library is free software. You can redistribute it and/or modify it under
	477	the same terms as perl itself.
	478
	479	=cut
	480	EOF
91864987	481	chmod 0700, "$script/server.pl";
fc7ec1d9	482	}
	483
	484	sub _mk_test {
91864987	485	my $self = shift;
	486	my $name = $self->{name};
	487	my $script = $self->{script};
	488	$self->mk_file( "$script/test.pl", <<"EOF");
f1d0b7ea	489	$Config{startperl} -w
fc7ec1d9	490
e646f111	491	BEGIN { \$ENV{CATALYST_ENGINE} = 'Test' }
e646f111	492
fc7ec1d9	493	use strict;
	494	use Getopt::Long;
	495	use Pod::Usage;
	496	use FindBin;
	497	use lib "\$FindBin::Bin/../lib";
e646f111	498	use $name;
fc7ec1d9	499
	500	my \$help = 0;
	501
	502	GetOptions( 'help\|?' => \\\$help );
	503
	504	pod2usage(1) if ( \$help \|\| !\$ARGV[0] );
	505
e646f111	506	print $name->run(\$ARGV[0])->content . "\n";
fc7ec1d9	507
	508	1;
	509	__END__
	510
	511	=head1 NAME
	512
	513	test - Catalyst Test
	514
	515	=head1 SYNOPSIS
	516
91864987	517	test.pl [options] uri
fc7ec1d9	518
	519	Options:
	520	-help display this help and exits
	521
	522	Examples:
91864987	523	test.pl http://localhost/some_action
91864987	524	test.pl /some_action
fc7ec1d9	525
03a53815	526	See also:
	527	perldoc Catalyst::Manual
	528	perldoc Catalyst::Manual::Intro
	529
fc7ec1d9	530	=head1 DESCRIPTION
	531
	532	Run a Catalyst action from the comand line.
	533
	534	=head1 AUTHOR
	535
	536	Sebastian Riedel, C<sri\@oook.de>
	537
	538	=head1 COPYRIGHT
	539
	540	Copyright 2004 Sebastian Riedel. All rights reserved.
	541
	542	This library is free software. You can redistribute it and/or modify it under
	543	the same terms as perl itself.
	544
	545	=cut
	546	EOF
91864987	547	chmod 0700, "$script/test.pl";
fc7ec1d9	548	}
	549
	550	sub _mk_create {
91864987	551	my $self = shift;
	552	my $name = $self->{name};
	553	my $script = $self->{script};
	554	$self->mk_file( "$script\/create.pl", <<"EOF");
f1d0b7ea	555	$Config{startperl} -w
fc7ec1d9	556
	557	use strict;
	558	use Getopt::Long;
	559	use Pod::Usage;
	560	use Catalyst::Helper;
	561
	562	my \$help = 0;
	563
	564	GetOptions( 'help\|?' => \$help );
	565
b5524568	566	pod2usage(1) if ( \$help \|\| !\$ARGV[0] );
fc7ec1d9	567
	568	my \$helper = Catalyst::Helper->new;
	569	pod2usage(1) unless \$helper->mk_component( '$name', \@ARGV );
	570
	571	1;
	572	__END__
	573
	574	=head1 NAME
	575
	576	create - Create a new Catalyst Component
	577
	578	=head1 SYNOPSIS
	579
91864987	580	create.pl [options] model\|view\|controller name [helper] [options]
fc7ec1d9	581
	582	Options:
	583	-help display this help and exits
	584
	585	Examples:
91864987	586	create.pl controller My::Controller
	587	create.pl view My::View
	588	create.pl view MyView TT
	589	create.pl view TT TT
	590	create.pl model My::Model
	591	create.pl model SomeDB CDBI dbi:SQLite:/tmp/my.db
	592	create.pl model AnotherDB CDBI dbi:Pg:dbname=foo root 4321
b5524568	593	create.pl Ajax
03a53815	594
	595	See also:
	596	perldoc Catalyst::Manual
	597	perldoc Catalyst::Manual::Intro
fc7ec1d9	598
	599	=head1 DESCRIPTION
	600
	601	Create a new Catalyst Component.
	602
	603	=head1 AUTHOR
	604
	605	Sebastian Riedel, C<sri\@oook.de>
	606
	607	=head1 COPYRIGHT
	608
	609	Copyright 2004 Sebastian Riedel. All rights reserved.
	610
	611	This library is free software. You can redistribute it and/or modify it under
	612	the same terms as perl itself.
	613
	614	=cut
	615	EOF
91864987	616	chmod 0700, "$script/create.pl";
fc7ec1d9	617	}
fc7ec1d9	618
fc7ec1d9	619	sub _mk_compclass {
	620	my $self = shift;
	621	my $app = $self->{app};
	622	my $class = $self->{class};
	623	my $type = $self->{type};
	624	my $action = '';
	625	$action = <<"EOF" if $type eq 'C';
	626
5a8ed4fe	627	sub default : Private {
	628	my ( \$self, \$c ) = \@_;
	629	\$c->res->output('Congratulations, $class is on Catalyst!');
	630	}
fc7ec1d9	631
fc7ec1d9	632	EOF
fc7ec1d9	633	my $file = $self->{file};
ad41e777	634	return $self->mk_file( "$file", <<"EOF");
fc7ec1d9	635	package $class;
	636
	637	use strict;
	638	use base 'Catalyst::Base';
	639	$action
	640	=head1 NAME
	641
	642	$class - A Component
	643
	644	=head1 SYNOPSIS
	645
	646	Very simple to use
	647
	648	=head1 DESCRIPTION
	649
	650	Very nice component.
	651
	652	=head1 AUTHOR
	653
	654	Clever guy
	655
	656	=head1 LICENSE
	657
	658	This library is free software . You can redistribute it and/or modify it under
	659	the same terms as perl itself.
	660
	661	=cut
	662
	663	1;
	664	EOF
	665	}
	666
	667	sub _mk_comptest {
	668	my $self = shift;
	669	my $prefix = $self->{prefix};
	670	my $type = $self->{type};
	671	my $class = $self->{class};
	672	my $app = $self->{app};
	673	my $test = $self->{test};
fc7ec1d9	674	if ( $self->{type} eq 'C' ) {
ad41e777	675	$self->mk_file( "$test", <<"EOF");
fc7ec1d9	676	use Test::More tests => 3;
	677	use_ok( Catalyst::Test, '$app' );
	678	use_ok('$class');
	679
	680	ok( request('$prefix')->is_success );
	681	EOF
	682	}
	683	else {
ad41e777	684	$self->mk_file( "$test", <<"EOF");
fc7ec1d9	685	use Test::More tests => 1;
	686	use_ok('$class');
	687	EOF
	688	}
	689	}
	690
7833fdfc	691	=head1 HELPERS
	692
	693	Helpers are classes that provide two methods.
	694
	695	* mk_compclass - creates the Component class
	696	* mk_comptest - creates the Component test
	697
	698	So when you call C<bin/create view MyView TT>, create would try to execute
	699	Catalyst::Helper::View::TT->mk_compclass and
	700	Catalyst::Helper::View::TT->mk_comptest.
	701
	702	See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::CDBI> for
	703	examples.
	704
	705	All helper classes should be under one of the following namespaces.
	706
	707	Catalyst::Helper::Model::
	708	Catalyst::Helper::View::
	709	Catalyst::Helper::Controller::
	710
fc7ec1d9	711	=head1 SEE ALSO
	712
	713	L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
	714	L<Catalyst::Response>, L<Catalyst>
	715
	716	=head1 AUTHOR
	717
	718	Sebastian Riedel, C<sri@oook.de>
	719
	720	=head1 LICENSE
	721
	722	This library is free software . You can redistribute it and/or modify it under
	723	the same terms as perl itself.
	724
	725	=cut
	726
	727	1;