X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper.pm;h=9785aecaee3c590a790cf223ca672d9324b11998;hb=ae133240923d063b2a39dcf1abdada5f917da8c5;hp=9e84b2344bc68b49376da7f0b79c6bc084745a35;hpb=3cd69ff24eb4967ad0d5a856c379a825cf20d39b;p=catagits%2FCatalyst-Devel.git diff --git a/lib/Catalyst/Helper.pm b/lib/Catalyst/Helper.pm index 9e84b23..9785aec 100644 --- a/lib/Catalyst/Helper.pm +++ b/lib/Catalyst/Helper.pm @@ -1,6 +1,8 @@ package Catalyst::Helper; +use Moose; use Config; use File::Spec; +use File::Spec::Unix; use File::Path; use FindBin; use IO::File; @@ -11,23 +13,23 @@ use Catalyst::Utils; use Catalyst::Exception; use Path::Class qw/dir file/; use File::ShareDir qw/dist_dir/; +use YAML::Tiny; +use namespace::autoclean; -my %cache; - -=head1 NAME - -Catalyst::Helper - Bootstrap a Catalyst application - -=head1 SYNOPSIS +with 'MooseX::Emulate::Class::Accessor::Fast'; - catalyst.pl +our $VERSION = '1.41'; +$VERSION =~ tr/_//d; -=cut +my %cache; sub get_sharedir_file { my ($self, @filename) = @_; my $dist_dir; - if (-d "inc/.author" && -f "lib/Catalyst/Helper.pm" + if (exists $ENV{CATALYST_DEVEL_SHAREDIR}) { + $dist_dir = $ENV{CATALYST_DEVEL_SHAREDIR}; + } + elsif (-d "inc/.author" && -f "lib/Catalyst/Helper.pm" ) { # Can't use sharedir if we're in a checkout # this feels horrible, better ideas? $dist_dir = 'share'; @@ -37,7 +39,7 @@ sub get_sharedir_file { } my $file = file( $dist_dir, @filename); Carp::confess("Cannot find $file") unless -r $file; - my $contents = $file->slurp; + my $contents = $file->slurp(iomode => "<:raw"); return $contents; } @@ -67,22 +69,40 @@ sub mk_app { # Needs to be here for PAR require Catalyst; + if($name eq '.') { + if(!-e 'META.yml') { + system perl => 'Makefile.PL' + and Catalyst::Exception->throw(message => q( + Failed to run "perl Makefile.PL". + )); + } + + $name = YAML::Tiny->read('META.yml')->[0]->{'name'}; + $name =~ s/-/::/g; + $self->{dir} = '.'; + } + if ( $name =~ /[^\w:]/ || $name =~ /^\d/ || $name =~ /\b:\b|:{3,}/) { warn "Error: Invalid application name.\n"; return 0; } + + + if(!defined $self->{'dir'}) { + $self->{dir} = $name; + $self->{dir} =~ s/\:\:/-/g; + } + $self->{name } = $name; - $self->{dir } = $name; - $self->{dir } =~ s/\:\:/-/g; $self->{script } = dir( $self->{dir}, 'script' ); $self->{appprefix } = Catalyst::Utils::appprefix($name); $self->{appenv } = Catalyst::Utils::class2env($name); $self->{startperl } = -r '/usr/bin/env' ? '#!/usr/bin/env perl' - : "#!$Config{perlpath} -w"; - $self->{scriptgen } = $Catalyst::Devel::CATALYST_SCRIPT_GEN || 34; + : "#!$Config{perlpath}"; + $self->{scriptgen } = $Catalyst::Devel::CATALYST_SCRIPT_GEN; $self->{catalyst_version} = $Catalyst::VERSION; - $self->{author } = $self->{author} = $ENV{'AUTHOR'} + $self->{author } ||= $ENV{'AUTHOR'} || eval { @{ [ getpwuid($<) ] }[6] } || 'Catalyst developer'; @@ -91,9 +111,9 @@ sub mk_app { my $gen_app = ( $self->{scripts} || $self->{makefile} ) ? 0 : 1; if ($gen_app) { - for ( qw/ _mk_dirs _mk_config _mk_appclass _mk_rootclass _mk_readme - _mk_changes _mk_apptest _mk_images _mk_favicon/ ) { - + for ( qw/ _mk_dirs _mk_config _mk_psgi _mk_appclass _mk_rootclass + _mk_readme _mk_changes _mk_apptest _mk_podtest _mk_podcoveragetest + _mk_images _mk_favicon/ ) { $self->$_; } } @@ -101,15 +121,16 @@ sub mk_app { $self->_mk_makefile; } if ($gen_scripts) { - for ( qw/ _mk_cgi _mk_fastcgi _mk_server - _mk_test _mk_create _mk_information / ) { - $self->$_; + for ( qw/ _mk_cgi _mk_fastcgi _mk_server + _mk_test _mk_create _mk_information + / ) { + $self->$_; + } } return $self->{dir}; } - -## not much of this can really be changed, mk_compclass must be left for +## not much of this can really be changed, mk_compclass must be left for ## backcompat sub mk_component { my $self = shift; @@ -181,17 +202,19 @@ sub mk_component { message => qq/Couldn't load helper "$class", "$@"/ ); } - ## must be left for back compat! ################################### if ( $class->can('mk_compclass') ) { return 1 unless $class->mk_compclass( $self, @args ); } - else { return 1 unless $self->_mk_compclass } + else { + return 1 unless $self->_mk_compclass + } if ( $class->can('mk_comptest') ) { $class->mk_comptest( $self, @args ); } - else { $self->_mk_comptest } - #################################################################### + else { + $self->_mk_comptest + } } # Fallback @@ -233,12 +256,12 @@ sub mk_file { $file .= '.new'; } } - + if ( my $f = IO::File->new("> $file") ) { binmode $f; print $f $content; print qq/created "$file"\n/; - return 1; + return $file; } Catalyst::Exception->throw( message => qq/Couldn't create "$file", "$!"/ ); @@ -266,23 +289,23 @@ sub next_test { # Do not touch this method, *EVER*, it is needed for back compat. ## addendum: we had to split this method so we could have backwards -## compatability. otherwise, we'd have no way to pass stuff from __DATA__ +## compatibility. otherwise, we'd have no way to pass stuff from __DATA__ sub render_file { - my ( $self, $file, $path, $vars ) = @_; + my ( $self, $file, $path, $vars, $perms ) = @_; my $template = $self->get_file( ( caller(0) )[0], $file ); - $self->render_file_contents($template, $path, $vars); + $self->render_file_contents($template, $path, $vars, $perms); } sub render_sharedir_file { - my ( $self, $file, $path, $vars ) = @_; + my ( $self, $file, $path, $vars, $perms ) = @_; my $template = $self->get_sharedir_file( $file ); die("Cannot get template from $file for $self\n") unless $template; - $self->render_file_contents($template, $path, $vars); + $self->render_file_contents($template, $path, $vars, $perms); } sub render_file_contents { - my ( $self, $template, $path, $vars ) = @_; + my ( $self, $template, $path, $vars, $perms ) = @_; $vars ||= {}; my $t = Template->new; return 0 unless $template; @@ -290,7 +313,9 @@ sub render_file_contents { $t->process( \$template, { %{$self}, %$vars }, \$output ) || Catalyst::Exception->throw( message => qq/Couldn't process "$template", / . $t->error() ); - $self->mk_file( $path, $output ); + my $file = $self->mk_file( $path, $output ); + chmod $perms, file($file) if defined $perms; + return $file; } sub _mk_information { @@ -353,7 +378,7 @@ sub _mk_rootclass { sub _mk_makefile { my $self = shift; - $self->{path} = dir( 'lib', split( '::', $self->{name} ) ); + $self->{path} = join('/', 'lib', split( '::', $self->{name} ) ); $self->{path} .= '.pm'; my $dir = $self->{dir}; $self->render_sharedir_file( 'Makefile.PL.tt', file($dir, "Makefile.PL") ); @@ -366,6 +391,14 @@ sub _mk_makefile { } } +sub _mk_psgi { + my $self = shift; + my $dir = $self->{dir}; + my $appprefix = $self->{appprefix}; + $self->render_sharedir_file( 'myapp.psgi.tt', + file( $dir, "$appprefix.psgi" ) ); +} + sub _mk_config { my $self = shift; my $dir = $self->{dir}; @@ -384,14 +417,24 @@ sub _mk_changes { my $self = shift; my $dir = $self->{dir}; my $time = strftime('%Y-%m-%d %H:%M:%S', localtime time); - $self->render_sharedir_file( 'Changes.tt', file($dir, "Changes", { time => $time } ); + $self->render_sharedir_file( 'Changes.tt', file($dir, "Changes"), { time => $time } ); } sub _mk_apptest { my $self = shift; my $t = $self->{t}; $self->render_sharedir_file( file('t', '01app.t.tt'), file($t, "01app.t") ); +} + +sub _mk_podtest { + my $self = shift; + my $t = $self->{t}; $self->render_sharedir_file( file('t', '02pod.t.tt'), file($t, "02pod.t") ); +} + +sub _mk_podcoveragetest { + my $self = shift; + my $t = $self->{t}; $self->render_sharedir_file( file('t', '03podcoverage.t.tt'), file($t, "03podcoverage.t") ); } @@ -399,40 +442,40 @@ sub _mk_cgi { my $self = shift; my $script = $self->{script}; my $appprefix = $self->{appprefix}; - $self->render_sharedir_file( file('script', 'myapp_cgi.pl.tt'), file($script,"$appprefix\_cgi.pl") ); - chmod 0700, file($script,"$appprefix\_cgi.pl"); + $self->render_sharedir_file( file('script', 'myapp_cgi.pl.tt'), + file($script,"$appprefix\_cgi.pl"), undef, 0755 ); } sub _mk_fastcgi { my $self = shift; my $script = $self->{script}; my $appprefix = $self->{appprefix}; - $self->render_sharedir_file( file('script', 'myapp_fastcgi.pl.tt'), file($script, "$appprefix\_fastcgi.pl") ); - chmod 0700, file($script, "$appprefix\_fastcgi.pl"); + $self->render_sharedir_file( file('script', 'myapp_fastcgi.pl.tt'), + file($script, "$appprefix\_fastcgi.pl"), undef, 0755 ); } sub _mk_server { my $self = shift; my $script = $self->{script}; my $appprefix = $self->{appprefix}; - $self->render_sharedir_file( file('script', 'myapp_server.pl.tt'), file($script, "$appprefix\_server.pl") ); - chmod 0700, file($script, "$appprefix\_server.pl"); + $self->render_sharedir_file( file('script', 'myapp_server.pl.tt'), + file($script, "$appprefix\_server.pl"), undef, 0755 ); } sub _mk_test { my $self = shift; my $script = $self->{script}; my $appprefix = $self->{appprefix}; - $self->render_sharedir_file( file('script', 'myapp_test.pl.tt'), file($script, "$appprefix\_test.pl") ); - chmod 0700, file($script, "$appprefix\_test.pl"); + $self->render_sharedir_file( file('script', 'myapp_test.pl.tt'), + file($script, "$appprefix\_test.pl"), undef, 0755 ); } sub _mk_create { my $self = shift; my $script = $self->{script}; my $appprefix = $self->{appprefix}; - $self->render_sharedir_file( file('script', 'myapp_create.pl.tt'), file($script, "$appprefix\_create.pl") ); - chmod 0700, file($script, "$appprefix\_create.pl"); + $self->render_sharedir_file( file('script', 'myapp_create.pl.tt'), + file($script, "$appprefix\_create.pl"), undef, 0755 ); } sub _mk_compclass { @@ -469,23 +512,15 @@ sub _mk_favicon { } -sub _mk_dbic_deploy { - my $self = shift; - my $script = $self->{script}; - my $appprefix = $self->{appprefix}; - $self->render_sharedir_file( file('script', 'myapp_deploy_schema.pl.tt'), file($script, "$appprefix\_deploy_schema.pl") ); - chmod 0700, file($script, "$appprefix\_deploy_schema.pl"); -} - sub _deprecate_file { my ( $self, $file ) = @_; if ( -e $file ) { - my $oldcontent; - if ( my $f = IO::File->new("< $file") ) { + my ($f, $oldcontent); + if ( $f = IO::File->new("< $file") ) { $oldcontent = join( '', (<$f>) ); } my $newfile = $file . '.deprecated'; - if ( my $f = IO::File->new("> $newfile") ) { + if ( $f = IO::File->new("> $newfile") ) { binmode $f; print $f $oldcontent; print qq/created "$newfile"\n/; @@ -498,6 +533,17 @@ sub _deprecate_file { } } +1; +__END__ + +=head1 NAME + +Catalyst::Helper - Bootstrap a Catalyst application + +=head1 SYNOPSIS + + catalyst.pl + =head1 DESCRIPTION This module is used by B to create a set of scripts for a @@ -622,12 +668,13 @@ There is no fallback for this method. These are the methods that the Helper classes can call on the <$helper> object passed to them. -=head2 render_file ($file, $path, $vars) +=head2 render_file ($file, $path, $vars, $perms) Render and create a file from a template in DATA using Template -Toolkit. $file is the relevent chunk of the __DATA__ section, $path is -the path to the file and $vars is the hashref as expected by -L