added documentation
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Script / Server.pm
index dafde85..1fcedad 100644 (file)
@@ -11,7 +11,6 @@ use lib "$Bin/../lib";
 use Pod::Usage;
 use Moose;
 use Catalyst::Restarter;
-#use Catalyst::Engine::HTTP;
 use namespace::autoclean;
 
 with 'MooseX::Getopt';
@@ -19,138 +18,148 @@ with 'MooseX::Getopt';
 has debug => (
     traits => [qw(Getopt)],
     cmd_aliases => 'd',
-    isa => 'Bool', 
+    isa => 'Bool',
     is => 'ro',
-    documentation => qq{
-    -d --debug force debug mode    
-    }
+    documentation => qq{ force debug mode }
 
 );
 
-has help => ( 
+has help => (
     traits => [qw(Getopt)],
     cmd_aliases => 'h',
-    isa => 'Bool',   
-    is => 'ro', 
-    documentation => qq{
-    -h --help display this help and exits    
-    },  
+    isa => 'Bool',
+    is => 'ro',
+    documentation => qq{ display this help and exits },
 );
 
-has host => ( 
-    isa => 'Str',    
-    is => 'ro', 
-    , 
-    default =>  "localhost" 
+has host => (
+    isa => 'Str',
+    is => 'ro',
+    default =>  "localhost",
+    documentation => qq{ specify a host for the server to run on }
 );
 
-has fork => ( 
+has fork => (
     traits => [qw(Getopt)],
     cmd_aliases => 'f',
     isa => 'Bool',
-    is => 'ro', 
-     
+    is => 'ro',
+    documentation => qq{ fork the server }
 );
 
-has listen => ( 
+has listen => (
     traits => [qw(Getopt)],
     cmd_aliases => 'l',
     isa => 'Int',
-    is => 'ro', 
-    , 
-    default => "3000" 
+    is => 'ro',
+    default => "3000",
+    documentation => qq{ specify a different listening port }
 );
 
-has pidfile => ( 
+has pidfile => (
     traits => [qw(Getopt)],
     cmd_aliases => 'pid',
-    isa => 'Str',    
-    is => 'ro', 
-     
+    isa => 'Str',
+    is => 'ro',
+    documentation => qq{ specify a pidfile }
 );
 
-has keepalive => ( 
+has keepalive => (
     traits => [qw(Getopt)],
     cmd_aliases => 'k',
-    isa => 'Bool',   
-    is => 'ro', 
-    , 
-     
+    isa => 'Bool',
+    is => 'ro',
+    documentation => qq{ server keepalive },
+
 );
 
-has background => ( 
+has background => (
     traits => [qw(Getopt)],
     cmd_aliases => 'bg',
-    isa => 'Bool',   
-    is => 'ro', 
+    isa => 'Bool',
+    is => 'ro',
+    documentation => qq{ run in the background }
 );
 
 
-has _app => ( 
-    reader   => 'app', 
+has _app => (
+    reader   => 'app',
     init_arg => 'app',
     traits => [qw(NoGetopt)],
-    isa => 'Str',    
-    is => 'ro', 
-); 
+    isa => 'Str',
+    is => 'ro',
+);
 
 has restart => (
     traits => [qw(Getopt)],
-    cmd_aliases => 'r', 
-    isa => 'Bool',   
-    is => 'ro', 
-     
-); 
+    cmd_aliases => 'r',
+    isa => 'Bool',
+    is => 'ro',
+    documentation => qq{ use Catalyst::Restarter to detect code changes }
+);
 
 has restart_directory => (
     traits => [qw(Getopt)],
     cmd_aliases => 'rdir',
-    isa => 'Str',
+    isa => 'ArrayRef[Str]',
     is  => 'ro',
+    predicate => '_has_restart_directory',
+    documentation => qq{ restarter directory to watch }
 );
 
-has restart_delay => ( 
+has restart_delay => (
     traits => [qw(Getopt)],
     cmd_aliases => 'rdel',
-    isa => 'Int',    
-    is => 'ro', 
-     
+    isa => 'Int',
+    is => 'ro',
+    predicate => '_has_restart_delay',
+    documentation => qq{ set a restart delay }
 );
 
-has restart_regex => ( 
+has restart_regex => (
     traits => [qw(Getopt)],
     cmd_aliases => 'rxp',
-    isa => 'Str',    
-    is => 'ro', 
-     
+    isa => 'Str',
+    is => 'ro',
+    predicate => '_has_restart_regex',
+    documentation => qq{ restart regex }
 );
 
-has follow_symlinks => ( 
+has follow_symlinks => (
     traits => [qw(Getopt)],
     cmd_aliases => 'sym',
-    isa => 'Bool',   
-    is => 'ro', 
-     
+    isa => 'Bool',
+    is => 'ro',
+    predicate => '_has_follow_symlinks',
+    documentation => qq{ follow symbolic links }
+
 );
 
 sub usage {
     my ($self) = shift;
-    
+
     return pod2usage();
 
 }
 
-my @argv = @ARGV;
 
 sub run {
-    my $self = shift;
-    
+    my ($self) = shift;
+
     $self->usage if $self->help;
-    
+
     if ( $self->debug ) {
         $ENV{CATALYST_DEBUG} = 1;
     }
 
+    # If we load this here, then in the case of a restarter, it does not
+    # need to be reloaded for each restart.
+    require Catalyst;
+
+    # If this isn't done, then the Catalyst::Devel tests for the restarter
+    # fail.
+    $| = 1 if $ENV{HARNESS_ACTIVE};
+
     if ( $self->restart ) {
         die "Cannot run in the background and also watch for changed files.\n"
             if $self->background;
@@ -160,61 +169,46 @@ sub run {
         my $subclass = Catalyst::Restarter->pick_subclass;
 
         my %args;
-        $args{follow_symlinks} = $self->follow_symlinks;
-        $args{directories}     = $self->restart_directory;
-        $args{sleep_interval}  = $self->restart_delay;
-        $args{filter} = qr/$self->restart_regex/;
+        $args{follow_symlinks} = $self->follow_symlinks
+            if $self->_has_follow_symlinks;
+        $args{directories}     = $self->restart_directory
+            if $self->_has_restart_directory;
+        $args{sleep_interval}  = $self->restart_delay
+            if $self->_has_restart_delay;
+        $args{filter} = qr/$self->restart_regex/
+            if $self->_has_restart_regex;
 
         my $restarter = $subclass->new(
             %args,
-            start_sub => $self->runner,
-            argv      => $self->ARGV,
+            start_sub => sub { $self->_run },
+            argv      => \$self->ARGV,
         );
 
         $restarter->run_and_watch;
     }
     else {
-        $self->runner;
+        $self->_run;
     }
 
 
-}    
-sub runner {
+}
+
+sub _run {
     my ($self) = shift;
-    
-    # If we load this here, then in the case of a restarter, it does not
-    # need to be reloaded for each restart.
-    require Catalyst;
 
-    # If this isn't done, then the Catalyst::Devel tests for the restarter
-    # fail.
-    $| = 1 if $ENV{HARNESS_ACTIVE};
-    
-    
-    $self->usage if $self->help;
     my $app = $self->app;
     Class::MOP::load_class($app);
 
-    if ( $self->debug ) {
-        $ENV{CATALYST_DEBUG} = 1;
-    }
-
-    
     $app->run(
         $self->listen, $self->host,
-        {  
+        {
            'fork'            => $self->fork,
            keepalive         => $self->keepalive,
            background        => $self->background,
            pidfile           => $self->pidfile,
            keepalive         => $self->keepalive,
-           restart           => $self->restart,
-           restart_delay     => $self->restart_delay,
-           restart_regex     => qr/$self->restart_regex/,
-           restart_directory => $self->restart_directory,
            follow_symlinks   => $self->follow_symlinks,
-        }  
+        }
     );
 }