Change from NEXT to MRO::Compat - RT#40628

[catagits/Catalyst-Plugin-Static-Simple.git] / lib / Catalyst / Plugin / Static / Simple.pm

diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm
index 95de6b0..6d93423 100644 (file)
--- a/lib/Catalyst/Plugin/Static/Simple.pm
+++ b/lib/Catalyst/Plugin/Static/Simple.pm
@@ -7,8 +7,9 @@ use File::stat;
 use File::Spec ();
 use IO::File ();
 use MIME::Types ();
+use MRO::Compat;
 
-our $VERSION = '0.19';
+our $VERSION = '0.21';
 
 __PACKAGE__->mk_accessors( qw/_static_file _static_debug_message/ );
 
@@ -22,7 +23,11 @@ sub prepare_action {
     # is the URI in a static-defined path?
     foreach my $dir ( @{ $config->{dirs} } ) {
         my $dir_re = quotemeta $dir;
-        my $re = ( $dir =~ m{^qr/}xms ) ? eval $dir : qr/^${dir_re}/;
+        
+        # strip trailing slashes, they'll be added in our regex
+        $dir_re =~ s{/$}{};
+        
+        my $re = ( $dir =~ m{^qr/}xms ) ? eval $dir : qr{^${dir_re}/};
         if ($@) {
             $c->error( "Error compiling static dir regex '$dir': $@" );
         }
@@ -34,6 +39,7 @@ sub prepare_action {
                 $c->_debug_msg( "404: file not found: $path" )
                     if $config->{debug};
                 $c->res->status( 404 );
+                $c->res->content_type( 'text/html' );
             }
         }
     }
@@ -44,7 +50,7 @@ sub prepare_action {
         $c->_locate_static_file( $path );
     }
     
-    return $c->NEXT::ACTUAL::prepare_action(@_);
+    return $c->next::method(@_);
 }
 
 sub dispatch {
@@ -59,7 +65,7 @@ sub dispatch {
         return $c->_serve_static;
     }
     else {
-        return $c->NEXT::ACTUAL::dispatch(@_);
+        return $c->next::method(@_);
     }
 }
 
@@ -71,13 +77,13 @@ sub finalize {
         $c->log->debug( 'Static::Simple: ' . join q{ }, @{$c->_debug_msg} );
     }
     
-    return $c->NEXT::ACTUAL::finalize(@_);
+    return $c->next::method(@_);
 }
 
 sub setup {
     my $c = shift;
     
-    $c->NEXT::setup(@_);
+    $c->next::method(@_);
     
     if ( Catalyst->VERSION le '5.33' ) {
         require File::Slurp;
@@ -209,6 +215,7 @@ sub serve_static_file {
         $c->_debug_msg( "404: file not found: $full_path" )
             if $config->{debug};
         $c->res->status( 404 );
+        $c->res->content_type( 'text/html' );
         return;
     }
 
@@ -267,9 +274,12 @@ Catalyst::Plugin::Static::Simple - Make serving static pages painless.
 
     use Catalyst;
     MyApp->setup( qw/Static::Simple/ );
-    # that's it; static content is automatically served by
-    # Catalyst, though you can configure things or bypass
-    # Catalyst entirely in a production environment
+    # that's it; static content is automatically served by Catalyst
+    # from the application's root directory, though you can configure
+    # things or bypass Catalyst entirely in a production environment
+    #
+    # one caveat: the files must be served from an absolute path
+    # (i.e. /images/foo.png)
 
 =head1 DESCRIPTION
 
@@ -431,13 +441,14 @@ is automatically enabled when running Catalyst in -Debug mode.
     
 =head1 USING WITH APACHE
 
-While Static::Simple will work just fine serving files through Catalyst in
-mod_perl, for increased performance, you may wish to have Apache handle the
-serving of your static files.  To do this, simply use a dedicated directory
-for your static files and configure an Apache Location block for that
-directory.  This approach is recommended for production installations.
+While Static::Simple will work just fine serving files through Catalyst
+in mod_perl, for increased performance you may wish to have Apache
+handle the serving of your static files directly. To do this, simply use
+a dedicated directory for your static files and configure an Apache
+Location block for that directory  This approach is recommended for
+production installations.
 
-    <Location /static>
+    <Location /myapp/static>
         SetHandler default-handler
     </Location>
 
@@ -446,6 +457,29 @@ through Catalyst. You can leave Static::Simple as part of your
 application, and it will continue to function on a development server,
 or using Catalyst's built-in server.
 
+In practice, your Catalyst application is probably (i.e. should be)
+structured in the recommended way (i.e., that generated by bootstrapping
+the application with the C<catalyst.pl> script, with a main directory
+under which is a C<lib/> directory for module files and a C<root/>
+directory for templates and static files). Thus, unless you break up
+this structure when deploying your app by moving the static files to a
+different location in your filesystem, you will need to use an Alias
+directive in Apache to point to the right place. You will then need to
+add a Directory block to give permission for Apache to serve these
+files. The final configuration will look something like this:
+
+    Alias /myapp/static /filesystem/path/to/MyApp/root/static
+    <Directory /filesystem/path/to/MyApp/root/static>
+        allow from all
+    </Directory>
+    <Location /myapp/static>
+        SetHandler default-handler
+    </Location>
+
+If you are running in a VirtualHost, you can just set the DocumentRoot
+location to the location of your root directory; see 
+L<Catalyst::Engine::Apache2::MP20>.
+
 =head1 PUBLIC METHODS
 
 =head2 serve_static_file $file_path