lib/Catalyst/Helper.pm

   1 package Catalyst::Helper;
   2
   3 use strict;
   4 use base 'Class::Accessor::Fast';
   5 use Config;
   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;
  38     $self->_mk_readme;
  39     $self->_mk_changes;
  40     $self->_mk_apptest;
  41     $self->_mk_cgi;
  42     $self->_mk_nphcgi;
  43     $self->_mk_fcgi;
  44     $self->_mk_server;
  45     $self->_mk_test;
  46     $self->_mk_create;
  47     return 1;
  48 }
  49
  50 =head3 mk_component
  51
  52 =cut
  53
  54 sub mk_component {
  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";
  63         eval "require $class";
  64         die qq/Couldn't load helper "$class", "$@"/ if $@;
  65         if ( $class->can('mk_stuff') ) {
  66             return 1 unless $class->mk_stuff( $self, @args );
  67         }
  68     }
  69     else {
  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         }
 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 ) = @_;
 169     if ($tname) { $tname = "$tname.t" }
 170     else {
 171         my $name   = $self->{name};
 172         my $prefix = $name;
 173         $prefix =~ s/::/_/g;
 174         $prefix         = lc $prefix;
 175         $tname          = $prefix . '.t';
 176         $self->{prefix} = $prefix;
 177     }
 178     my $dir  = $self->{test_dir};
 179     my $type = lc $self->{type};
 180     return File::Spec->catfile( $dir, $type, $tname );
 181 }
 182
 183 sub _mk_dirs {
 184     my $self = shift;
 185     $self->mk_dir( $self->{dir} );
 186     $self->{script} = File::Spec->catdir( $self->{dir}, 'script' );
 187     $self->mk_dir( $self->{script} );
 188     $self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' );
 189     $self->mk_dir( $self->{lib} );
 190     $self->{root} = File::Spec->catdir( $self->{dir}, 'root' );
 191     $self->mk_dir( $self->{root} );
 192     $self->{t} = File::Spec->catdir( $self->{dir}, 't' );
 193     $self->mk_dir( $self->{t} );
 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' ) );
 197     $self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) );
 198     $self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} );
 199     $self->mk_dir( $self->{mod} );
 200     $self->{m} = File::Spec->catdir( $self->{mod}, 'M' );
 201     $self->mk_dir( $self->{m} );
 202     $self->{v} = File::Spec->catdir( $self->{mod}, 'V' );
 203     $self->mk_dir( $self->{v} );
 204     $self->{c} = File::Spec->catdir( $self->{mod}, 'C' );
 205     $self->mk_dir( $self->{c} );
 206     $self->{base} = File::Spec->rel2abs( $self->{dir} );
 207 }
 208
 209 sub _mk_appclass {
 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");
 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 {
 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");
 269 use ExtUtils::MakeMaker;
 270
 271 WriteMakefile(
 272     NAME         => '$name',
 273     VERSION_FROM => 'lib/$class.pm',
 274     PREREQ_PM    => { Catalyst => 0 },
 275     test         => { TESTS => join ' ', ( glob('t/*.t'), glob('t/*/*.t') ) }
 276 );
 277 EOF
 278 }
 279
 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
 301 sub _mk_apptest {
 302     my $self = shift;
 303     my $t    = $self->{t};
 304     my $name = $self->{name};
 305     $self->mk_file( "$t\/01app.t", <<"EOF");
 306 use Test::More tests => 2;
 307 use_ok( Catalyst::Test, '$name' );
 308
 309 ok( request('/')->is_success );
 310 EOF
 311     $self->mk_file( "$t\/02podcoverage.t", <<"EOF");
 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
 320 }
 321
 322 sub _mk_cgi {
 323     my $self   = shift;
 324     my $name   = $self->{name};
 325     my $script = $self->{script};
 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};
 373     $self->mk_file( "$script\/nph-cgi.pl", <<"EOF");
 374 $Config{startperl} -w
 375
 376 BEGIN { \$ENV{CATALYST_ENGINE} = 'CGI::NPH' }
 377
 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
 390 nph-cgi - Catalyst CGI
 391
 392 =head1 SYNOPSIS
 393
 394 See L<Catalyst::Manual>
 395
 396 =head1 DESCRIPTION
 397
 398 Run a Catalyst application as nph cgi.
 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
 413     chmod 0700, "$script/nph-cgi.pl";
 414 }
 415
 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
 423 BEGIN { \$ENV{CATALYST_ENGINE} = 'FCGI' }
 424
 425 use strict;
 426 use FindBin;
 427 use lib "\$FindBin::Bin/../lib";
 428 use $name;
 429
 430 $name->run;
 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
 463 sub _mk_server {
 464     my $self   = shift;
 465     my $name   = $self->{name};
 466     my $script = $self->{script};
 467     $self->mk_file( "$script\/server.pl", <<"EOF");
 468 $Config{startperl} -w
 469
 470 BEGIN { \$ENV{CATALYST_ENGINE} = 'Server' }
 471
 472 use strict;
 473 use Getopt::Long;
 474 use Pod::Usage;
 475 use FindBin;
 476 use lib "\$FindBin::Bin/../lib";
 477 use $name;
 478
 479 my \$help = 0;
 480 my \$port = 3000;
 481
 482 GetOptions( 'help|?' => \\\$help, 'port=s' => \\\$port );
 483
 484 pod2usage(1) if \$help;
 485
 486 $name->run(\$port);
 487
 488 1;
 489 __END__
 490
 491 =head1 NAME
 492
 493 server - Catalyst Testserver
 494
 495 =head1 SYNOPSIS
 496
 497 server.pl [options]
 498
 499  Options:
 500    -? -help    display this help and exits
 501    -p -port    port (defaults to 3000)
 502
 503  See also:
 504    perldoc Catalyst::Manual
 505    perldoc Catalyst::Manual::Intro
 506
 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
 524     chmod 0700, "$script/server.pl";
 525 }
 526
 527 sub _mk_test {
 528     my $self   = shift;
 529     my $name   = $self->{name};
 530     my $script = $self->{script};
 531     $self->mk_file( "$script/test.pl", <<"EOF");
 532 $Config{startperl} -w
 533
 534 BEGIN { \$ENV{CATALYST_ENGINE} = 'Test' }
 535
 536 use strict;
 537 use Getopt::Long;
 538 use Pod::Usage;
 539 use FindBin;
 540 use lib "\$FindBin::Bin/../lib";
 541 use $name;
 542
 543 my \$help = 0;
 544
 545 GetOptions( 'help|?' => \\\$help );
 546
 547 pod2usage(1) if ( \$help || !\$ARGV[0] );
 548
 549 print $name->run(\$ARGV[0])->content . "\n";
 550
 551 1;
 552 __END__
 553
 554 =head1 NAME
 555
 556 test - Catalyst Test
 557
 558 =head1 SYNOPSIS
 559
 560 test.pl [options] uri
 561
 562  Options:
 563    -help    display this help and exits
 564
 565  Examples:
 566    test.pl http://localhost/some_action
 567    test.pl /some_action
 568
 569  See also:
 570    perldoc Catalyst::Manual
 571    perldoc Catalyst::Manual::Intro
 572
 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
 590     chmod 0700, "$script/test.pl";
 591 }
 592
 593 sub _mk_create {
 594     my $self   = shift;
 595     my $name   = $self->{name};
 596     my $script = $self->{script};
 597     $self->mk_file( "$script\/create.pl", <<"EOF");
 598 $Config{startperl} -w
 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
 609 pod2usage(1) if ( \$help || !\$ARGV[0] );
 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
 623 create.pl [options] model|view|controller name [helper] [options]
 624
 625  Options:
 626    -help    display this help and exits
 627
 628  Examples:
 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
 636    create.pl Ajax
 637
 638  See also:
 639    perldoc Catalyst::Manual
 640    perldoc Catalyst::Manual::Intro
 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
 659     chmod 0700, "$script/create.pl";
 660 }
 661
 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};
 680     return $self->mk_file( "$file", <<"EOF");
 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};
 720     if ( $self->{type} eq 'C' ) {
 721         $self->mk_file( "$test", <<"EOF");
 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 {
 730         $self->mk_file( "$test", <<"EOF");
 731 use Test::More tests => 1;
 732 use_ok('$class');
 733 EOF
 734     }
 735 }
 736
 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
 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;