2.09 - maintain the order that plugins are loaded, add tests for Maypole::Application...

[maypole.git] / lib / Maypole / Application.pm

diff --git a/lib/Maypole/Application.pm b/lib/Maypole/Application.pm
index 4e8b624bf180303ada4ef2c7c2938c2473344f79..4f61f42742810235743822e7b795d8293393764e 100644 (file)
--- a/lib/Maypole/Application.pm
+++ b/lib/Maypole/Application.pm
@@ -2,46 +2,110 @@ package Maypole::Application;
 
 use strict;
 use warnings;
+use UNIVERSAL::require;
+use Maypole;
+use Maypole::Config;
 
 our @ISA;
+our $VERSION = '2.09';
 
 sub import {
-    my ( $self, @plugins ) = @_;
-    return unless $plugins[0];
+    my ( $class, @plugins ) = @_;
     my $caller = caller(0);
+
+    my $autosetup=0;
+    my @plugin_modules;
+    {
+        foreach (@plugins) {
+            if    (/^\-Setup$/) { $autosetup++; }
+            elsif (/^\-Debug$/) {
+                no strict 'refs';
+                *{"$caller\::debug"} = sub { 1 };
+                warn "Debugging enabled";
+            }
+            elsif (/^-.*$/) { warn "Unknown flag: $_" }
+            else {
+                my $plugin = "Maypole::Plugin::$_";
+                if ($plugin->require) {
+                    push @plugin_modules, "Maypole::Plugin::$_";
+                    warn "Loaded plugin: $plugin"
+                        if $caller->can('debug') && $caller->debug;
+                } else {
+                    warn qq(Loading plugin "$plugin" failed: )
+                        . $UNIVERSAL::require::ERROR;
+                }
+            }
+        }
+    }
     no strict 'refs';
-    push @{"${caller}::ISA"}, $self;
-    "Maypole::$_"->require && unshift @ISA, "Maypole::$_" foreach (@plugins);
+    push @{"${caller}::ISA"}, @plugin_modules, $class;
+    $caller->config(Maypole::Config->new);
+    $caller->setup() if $autosetup;
 }
 
 if ( $ENV{MOD_PERL} ) {
-    require Apache::MVC;
-    push @ISA, qw(Apache::MVC);
+    Apache::MVC->require or die "Loading Apache frontend failed: $@";
+    push @ISA, 'Apache::MVC';
 }
 else {
-    require CGI::Maypole;
-    push @ISA, qw(CGI::Maypole);
+    CGI::Maypole->require or die "Loading CGI frontend failed: $@";
+    push @ISA, 'CGI::Maypole';
 }
 
 1;
 
 =head1 NAME
 
-Maypole::Application - Maypole Universal Frontend
+Maypole::Application - Universal Maypole Frontend
 
 =head1 SYNOPSIS
 
     use Maypole::Application;
 
+    use Maypole::Application qw(Config::YAML);
+
+    use Maypole::Application qw(-Debug Config::YAML -Setup);
+
+    use Maypole::Application qw(Config::YAML Loader -Setup -Debug);
+
 =head1 DESCRIPTION
 
 This is a universal frontend for mod_perl1, mod_perl2 and CGI.
 
-You can omit the Maypole:: prefix from plugins.
-So Maypole::Config::YAML becomes Config::YAML.
+You can omit the Maypole::Plugin:: prefix from plugins.
+So Maypole::Plugin::Config::YAML becomes Config::YAML.
 
     use Maypole::Application qw(Config::YAML);
 
+You can also set special flags like -Setup and -Debug.
+
+    use Maypole::Application qw(-Debug Config::YAML -Setup);
+
+The position of plugins and flags in the chain is important,
+because they are loaded/executed in the same order they appear.
+
+=head2 -Setup
+
+    use Maypole::Application qw(-Setup);
+
+is equivalent to
+
+    use Maypole::Application;
+    MyApp->setup;
+
+Note that no options are passed to C<setup()>. You must ensure that the
+required model config parameters are set in C<MyApp-E<gt>config>. See
+L<Maypole::Config> for more information.
+
+=head2 -Debug
+
+    use Maypole::Application qw(-Debug);
+
+is equivalent to
+
+    use Maypole::Application;
+    sub debug { 1 }
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@oook.de>
@@ -50,3 +114,5 @@ Idea by Marcus Ramberg, C<marcus@thefeed.no>
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
+
+=cut