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_fcgi;
  43     $self->_mk_server;
  44     $self->_mk_test;
  45     $self->_mk_create;
  46     return 1;
  47 }
  48
  49 =head3 mk_component
  50
  51 =cut
  52
  53 sub mk_component {
  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";
  62         eval "require $class";
  63         die qq/Couldn't load helper "$class", "$@"/ if $@;
  64         if ( $class->can('mk_stuff') ) {
  65             return 1 unless $class->mk_stuff( $self, @args );
  66         }
  67     }
  68     else {
  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         }
 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 ) = @_;
 168     if ($tname) { $tname = "$tname.t" }
 169     else {
 170         my $name   = $self->{name};
 171         my $prefix = $name;
 172         $prefix =~ s/::/_/g;
 173         $prefix         = lc $prefix;
 174         $tname          = $prefix . '.t';
 175         $self->{prefix} = $prefix;
 176     }
 177     my $dir  = $self->{test_dir};
 178     my $type = lc $self->{type};
 179     return File::Spec->catfile( $dir, $type, $tname );
 180 }
 181
 182 sub _mk_dirs {
 183     my $self = shift;
 184     $self->mk_dir( $self->{dir} );
 185     $self->{script} = File::Spec->catdir( $self->{dir}, 'script' );
 186     $self->mk_dir( $self->{script} );
 187     $self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' );
 188     $self->mk_dir( $self->{lib} );
 189     $self->{root} = File::Spec->catdir( $self->{dir}, 'root' );
 190     $self->mk_dir( $self->{root} );
 191     $self->{t} = File::Spec->catdir( $self->{dir}, 't' );
 192     $self->mk_dir( $self->{t} );
 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' ) );
 196     $self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) );
 197     $self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} );
 198     $self->mk_dir( $self->{mod} );
 199     $self->{m} = File::Spec->catdir( $self->{mod}, 'M' );
 200     $self->mk_dir( $self->{m} );
 201     $self->{v} = File::Spec->catdir( $self->{mod}, 'V' );
 202     $self->mk_dir( $self->{v} );
 203     $self->{c} = File::Spec->catdir( $self->{mod}, 'C' );
 204     $self->mk_dir( $self->{c} );
 205     $self->{base} = File::Spec->rel2abs( $self->{dir} );
 206 }
 207
 208 sub _mk_appclass {
 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");
 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
 226 sub default : Private {
 227     my ( \$self, \$c ) = \@_;
 228     \$c->res->output('Congratulations, $name is on Catalyst!');
 229 }
 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 {
 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");
 264 use ExtUtils::MakeMaker;
 265
 266 WriteMakefile(
 267     NAME         => '$name',
 268     VERSION_FROM => 'lib/$class.pm',
 269     PREREQ_PM    => { Catalyst => 0 },
 270     test         => { TESTS => join ' ', ( glob('t/*.t'), glob('t/*/*.t') ) }
 271 );
 272 EOF
 273 }
 274
 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
 296 sub _mk_apptest {
 297     my $self = shift;
 298     my $t    = $self->{t};
 299     my $name = $self->{name};
 300     $self->mk_file( "$t\/01app.t", <<"EOF");
 301 use Test::More tests => 2;
 302 use_ok( Catalyst::Test, '$name' );
 303
 304 ok( request('/')->is_success );
 305 EOF
 306     $self->mk_file( "$t\/02pod.t", <<"EOF");
 307 use Test::More;
 308
 309 eval "use Test::Pod 1.14";
 310 plan skip_all => 'Test::Pod 1.14 required' if \$@;
 311 plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};
 312
 313 all_pod_files_ok();
 314 EOF
 315     $self->mk_file( "$t\/03podcoverage.t", <<"EOF");
 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
 324 }
 325
 326 sub _mk_cgi {
 327     my $self   = shift;
 328     my $name   = $self->{name};
 329     my $script = $self->{script};
 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
 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
 380 BEGIN { \$ENV{CATALYST_ENGINE} = 'FCGI' }
 381
 382 use strict;
 383 use FindBin;
 384 use lib "\$FindBin::Bin/../lib";
 385 use $name;
 386
 387 $name->run;
 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
 420 sub _mk_server {
 421     my $self   = shift;
 422     my $name   = $self->{name};
 423     my $script = $self->{script};
 424     $self->mk_file( "$script\/server.pl", <<"EOF");
 425 $Config{startperl} -w
 426
 427 BEGIN { \$ENV{CATALYST_ENGINE} = 'HTTP' }
 428
 429 use strict;
 430 use Getopt::Long;
 431 use Pod::Usage;
 432 use FindBin;
 433 use lib "\$FindBin::Bin/../lib";
 434 use $name;
 435
 436 my \$help = 0;
 437 my \$port = 3000;
 438
 439 GetOptions( 'help|?' => \\\$help, 'port=s' => \\\$port );
 440
 441 pod2usage(1) if \$help;
 442
 443 $name->run(\$port);
 444
 445 1;
 446 __END__
 447
 448 =head1 NAME
 449
 450 server - Catalyst Testserver
 451
 452 =head1 SYNOPSIS
 453
 454 server.pl [options]
 455
 456  Options:
 457    -? -help    display this help and exits
 458    -p -port    port (defaults to 3000)
 459
 460  See also:
 461    perldoc Catalyst::Manual
 462    perldoc Catalyst::Manual::Intro
 463
 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
 481     chmod 0700, "$script/server.pl";
 482 }
 483
 484 sub _mk_test {
 485     my $self   = shift;
 486     my $name   = $self->{name};
 487     my $script = $self->{script};
 488     $self->mk_file( "$script/test.pl", <<"EOF");
 489 $Config{startperl} -w
 490
 491 BEGIN { \$ENV{CATALYST_ENGINE} = 'Test' }
 492
 493 use strict;
 494 use Getopt::Long;
 495 use Pod::Usage;
 496 use FindBin;
 497 use lib "\$FindBin::Bin/../lib";
 498 use $name;
 499
 500 my \$help = 0;
 501
 502 GetOptions( 'help|?' => \\\$help );
 503
 504 pod2usage(1) if ( \$help || !\$ARGV[0] );
 505
 506 print $name->run(\$ARGV[0])->content . "\n";
 507
 508 1;
 509 __END__
 510
 511 =head1 NAME
 512
 513 test - Catalyst Test
 514
 515 =head1 SYNOPSIS
 516
 517 test.pl [options] uri
 518
 519  Options:
 520    -help    display this help and exits
 521
 522  Examples:
 523    test.pl http://localhost/some_action
 524    test.pl /some_action
 525
 526  See also:
 527    perldoc Catalyst::Manual
 528    perldoc Catalyst::Manual::Intro
 529
 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
 547     chmod 0700, "$script/test.pl";
 548 }
 549
 550 sub _mk_create {
 551     my $self   = shift;
 552     my $name   = $self->{name};
 553     my $script = $self->{script};
 554     $self->mk_file( "$script\/create.pl", <<"EOF");
 555 $Config{startperl} -w
 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
 566 pod2usage(1) if ( \$help || !\$ARGV[0] );
 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
 580 create.pl [options] model|view|controller name [helper] [options]
 581
 582  Options:
 583    -help    display this help and exits
 584
 585  Examples:
 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
 593    create.pl Ajax
 594
 595  See also:
 596    perldoc Catalyst::Manual
 597    perldoc Catalyst::Manual::Intro
 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
 616     chmod 0700, "$script/create.pl";
 617 }
 618
 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
 627 sub default : Private {
 628     my ( \$self, \$c ) = \@_;
 629     \$c->res->output('Congratulations, $class is on Catalyst!');
 630 }
 631
 632 EOF
 633     my $file = $self->{file};
 634     return $self->mk_file( "$file", <<"EOF");
 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};
 674     if ( $self->{type} eq 'C' ) {
 675         $self->mk_file( "$test", <<"EOF");
 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 {
 684         $self->mk_file( "$test", <<"EOF");
 685 use Test::More tests => 1;
 686 use_ok('$class');
 687 EOF
 688     }
 689 }
 690
 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
 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;