1 package Module::Install::Catalyst;
6 require Module::Install::Base;
7 @ISA = qw/Module::Install::Base/;
11 use File::Copy::Recursive 'rcopy';
19 qw/Build Build.PL Changes MANIFEST META.yml Makefile.PL Makefile README
20 _build blib lib script t inc .*\.svn \.git _darcs \.bzr \.hg
21 debian build-stamp install-stamp configure-stamp/;
30 Module::Install::Catalyst - Module::Install extension for Catalyst
34 use inc::Module::Install;
37 all_from 'lib/MyApp.pm';
39 requires 'Catalyst::Runtime' => '5.7014';
41 catalyst_ignore('.*temp');
42 catalyst_ignore('.*tmp');
48 L<Module::Install> extension for Catalyst.
54 Calls L<catalyst_files> and L<catalyst_par>. Should be the last catalyst*
55 command called in C<Makefile.PL>.
62 *** Module::Install::Catalyst
64 $self->catalyst_files;
67 *** Module::Install::Catalyst finished.
73 Collect a list of all files a Catalyst application consists of and copy it
74 inside the blib/lib/ directory. Files and directories that match the modules
75 ignore list are excluded (see L<catalyst_ignore> and L<catalyst_ignore_all>).
86 CATFILES: for my $name ( readdir CATDIR ) {
87 for my $ignore (@IGNORE) {
88 next CATFILES if $name =~ /^$ignore$/;
89 next CATFILES if $name !~ /\w/;
94 my @path = split '-', $self->name;
95 for my $orig (@files) {
96 my $path = File::Spec->catdir( 'blib', 'lib', @path, $orig );
97 rcopy( $orig, $path );
101 =head2 catalyst_ignore_all(\@ignore)
103 This function replaces the built-in default ignore list with the given list.
107 sub catalyst_ignore_all {
108 my ( $self, $ignore ) = @_;
112 =head2 catalyst_ignore(\@ignore)
114 Add a regexp to the list of ignored patterns. Can be called multiple times.
118 sub catalyst_ignore {
119 my ( $self, @ignore ) = @_;
120 push @IGNORE, @ignore;
123 =head2 catalyst_par($name)
127 # Workaround for a namespace conflict
129 my ( $self, $par ) = @_;
133 my $name = $self->name;
136 my $class_string = join "', '", @CLASSES;
137 $class_string = "'$class_string'" if $class_string;
138 local $Data::Dumper::Indent = 0;
139 local $Data::Dumper::Terse = 1;
140 local $Data::Dumper::Pad = ' ';
141 my $paropts_string = Dumper(\%PAROPTS) || "{ }";
142 $self->postamble(<<EOF);
144 \t\$(NOECHO) \$(PERL) -Ilib -Minc::Module::Install -MModule::Install::Catalyst -e"Catalyst::Module::Install::_catalyst_par( '$par', '$name', { CLASSES => [$class_string], PAROPTS => $paropts_string, ENGINE => '$ENGINE', SCRIPT => '$SCRIPT', USAGE => q#$usage# } )"
147 Please run "make catalyst_par" to create the PAR package!
151 =head2 catalyst_par_core($core)
155 sub catalyst_par_core {
156 my ( $self, $core ) = @_;
157 $core ? ( $PAROPTS{'B'} = $core ) : $PAROPTS{'B'}++;
160 =head2 catalyst_par_classes(@clases)
164 sub catalyst_par_classes {
165 my ( $self, @classes ) = @_;
166 push @CLASSES, @classes;
169 =head2 catalyst_par_engine($engine)
173 sub catalyst_par_engine {
174 my ( $self, $engine ) = @_;
178 =head2 catalyst_par_multiarch($multiarch)
182 sub catalyst_par_multiarch {
183 my ( $self, $multiarch ) = @_;
184 $multiarch ? ( $PAROPTS{'m'} = $multiarch ) : $PAROPTS{'m'}++;
187 =head2 catalyst_par_options($optstring)
189 This command can be used in Makefile.PL to customise the PAR creation process.
190 The parameter "$optstring" contains a string with arguments in identical syntax
191 as arguments of B<pp> command from L<PAR::Packer> package.
195 # part of your Makefile.PL
197 catalyst_par_options("--verbose=2 -f Bleach -z 9");
198 # verbose mode; use filter 'Bleach'; zip with compression level 9
201 Note1: There is no reason to use catalyst_par_options() command multiple times
202 as you can spacify in "$optstring" as many options as you want. Still, it
203 is supported to call catalyst_par_options() more than once. In that case the
204 specified options are merged (collisions are handled on principle "later wins").
205 BEWARE: you are discouraged from using parameters -a -A -X -f -F -I -l -M in
206 multiple catalyst_par_options() as they are not merged but replaced as you would
209 Note2: By default the options "-x -p -o=<appname>.par" are set and option "-n"
210 is unset. This default always overrides whatever you specify by
211 catalyst_par_options().
215 sub catalyst_par_options {
216 my ( $self, $optstring ) = @_;
217 eval "use PAR::Packer ()";
219 warn "WARNING: catalyst_par_options ignored - you need PAR::Packer\n"
222 my $p = Getopt::Long::Parser->new(config => ['no_ignore_case']);
224 require Text::ParseWords;
226 local @ARGV = Text::ParseWords::shellwords($optstring);
227 $p->getoptions(\%o, PAR::Packer->options);
229 %PAROPTS = ( %PAROPTS, %o);
233 =head2 catalyst_par_script($script)
237 sub catalyst_par_script {
238 my ( $self, $script ) = @_;
242 =head2 catalyst_par_usage($usage)
246 sub catalyst_par_usage {
247 my ( $self, $usage ) = @_;
251 package Catalyst::Module::Install;
255 use File::Copy::Recursive 'rmove';
259 my ( $par, $class_name, $opts ) = @_;
261 my $ENGINE = $opts->{ENGINE};
262 my $CLASSES = $opts->{CLASSES} || [];
263 my $USAGE = $opts->{USAGE};
264 my $SCRIPT = $opts->{SCRIPT};
265 my $PAROPTS = $opts->{PAROPTS};
267 my $name = $class_name;
270 $par ||= "$name.par";
271 my $engine = $ENGINE || 'CGI';
275 die "Please install PAR\n" if $@;
276 eval "use PAR::Packer ()";
277 die "Please install PAR::Packer\n" if $@;
278 eval "use App::Packer::PAR ()";
279 die "Please install App::Packer::PAR\n" if $@;
280 eval "use Module::ScanDeps ()";
281 die "Please install Module::ScanDeps\n" if $@;
283 my $root = $FindBin::Bin;
284 $class_name =~ s/-/::/g;
285 my $path = File::Spec->catfile( 'blib', 'lib', split( '::', $class_name ) );
287 unless ( -f $path ) {
288 print qq/Not writing PAR, "$path" doesn't exist\n/;
291 print qq/Writing PAR "$par"\n/;
292 chdir File::Spec->catdir( $root, 'blib' );
294 my $par_pl = 'par.pl';
297 my $version = $Catalyst::VERSION;
298 my $class = $class_name;
301 $classes .= " require $_;\n" for @$CLASSES;
305 my $usage = $USAGE || <<"EOF";
307 [parl] $name\[.par] [script] [arguments]
310 parl $name.par $name\_server.pl -r
314 my $script = $SCRIPT;
315 my $tmp_file = IO::File->new("> $par_pl ");
316 print $tmp_file <<"EOF";
317 if ( \$ENV{PAR_PROGNAME} ) {
318 my \$zip = \$PAR::LibCache{\$ENV{PAR_PROGNAME}}
319 || Archive::Zip->new(__FILE__);
320 my \$script = '$script';
321 \$ARGV[0] ||= \$script if \$script;
322 if ( ( \@ARGV == 0 ) || ( \$ARGV[0] eq '-h' ) || ( \$ARGV[0] eq '-help' )) {
323 my \@members = \$zip->membersMatching('.*script/.*\.pl');
324 my \$list = " Available scripts:\\n";
325 for my \$member ( \@members ) {
326 my \$name = \$member->fileName;
327 \$name =~ /(\\w+\\.pl)\$/;
329 next if \$name =~ /^main\.pl\$/;
330 next if \$name =~ /^par\.pl\$/;
331 \$list .= " \$name\\n";
338 my \$file = shift \@ARGV;
339 \$file =~ s/^.*[\\/\\\\]//;
340 \$file =~ s/\\.[^.]*\$//i;
341 my \$member = eval { \$zip->memberNamed("./script/\$file.pl") };
342 die qq/Can't open perl script "\$file"\n/ unless \$member;
343 PAR::_run_member( \$member, 1 );
348 \$ENV{CATALYST_ENGINE} = '$engine';
351 require Catalyst::Helper;
352 require Catalyst::Test;
353 require Catalyst::Engine::HTTP;
354 require Catalyst::Engine::CGI;
355 require Catalyst::Controller;
356 require Catalyst::Model;
357 require Catalyst::View;
358 require Getopt::Long;
367 local $SIG{__WARN__} = sub { };
368 open my $olderr, '>&STDERR';
369 open STDERR, '>', File::Spec->devnull;
372 # take user defined options first and override them with harcoded defaults
378 # do not replace the whole $opt{'a'} array; just push required default value
379 push @{$opt{'a'}}, grep( !/par.pl/, glob '.' );
381 App::Packer::PAR->new(
382 frontend => 'Module::ScanDeps',
383 backend => 'PAR::Packer',
389 open STDERR, '>&', $olderr;
393 rmove( File::Spec->catfile( 'blib', $par ), $par );
399 Catalyst Contributors, see Catalyst.pm
403 This library is free software. You can redistribute it and/or modify it under
404 the same terms as Perl itself.