Rename to Catalyst-View-Component-SubInclude
nilson [Fri, 30 Jan 2009 18:23:15 +0000 (18:23 +0000)]
17 files changed:
Makefile.PL [new file with mode: 0644]
lib/Catalyst/View/Component/SubInclude.pm [new file with mode: 0644]
lib/Catalyst/View/Component/SubInclude/ESI.pm [new file with mode: 0644]
lib/Catalyst/View/Component/SubInclude/SubRequest.pm [new file with mode: 0644]
t/ESITest/Makefile.PL [new file with mode: 0644]
t/ESITest/esitest.conf [new file with mode: 0644]
t/ESITest/lib/ESITest.pm [new file with mode: 0644]
t/ESITest/lib/ESITest/Controller/Root.pm [new file with mode: 0644]
t/ESITest/lib/ESITest/View/TT.pm [new file with mode: 0644]
t/ESITest/root/favicon.ico [new file with mode: 0644]
t/ESITest/root/index.tt [new file with mode: 0644]
t/ESITest/root/time_include.tt [new file with mode: 0644]
t/ESITest/script/esitest_cgi.pl [new file with mode: 0644]
t/ESITest/script/esitest_create.pl [new file with mode: 0644]
t/ESITest/script/esitest_fastcgi.pl [new file with mode: 0644]
t/ESITest/script/esitest_server.pl [new file with mode: 0644]
t/ESITest/script/esitest_test.pl [new file with mode: 0644]

diff --git a/Makefile.PL b/Makefile.PL
new file mode 100644 (file)
index 0000000..55d5179
--- /dev/null
@@ -0,0 +1,18 @@
+# IMPORTANT: if you delete this file your app will not work as
+# expected.  you have been warned
+use inc::Module::Install;
+
+name 'Catalyst-View-Component-SubInclude';
+all_from 'lib/Catalyst/View/Component/SubInclude.pm';
+
+requires 'Catalyst::Runtime' => '5.7014';
+requires 'Catalyst::Plugin::SubRequest';
+requires 'Moose';
+requires 'Moose::Role';
+requires 'Carp';
+requires 'namespace::clean';
+
+catalyst;
+
+auto_install;
+WriteAll;
diff --git a/lib/Catalyst/View/Component/SubInclude.pm b/lib/Catalyst/View/Component/SubInclude.pm
new file mode 100644 (file)
index 0000000..a17a890
--- /dev/null
@@ -0,0 +1,40 @@
+package Catalyst::View::Component::SubInclude;
+use Moose::Role;
+
+use Carp qw/croak/;
+use namespace::clean qw/croak/;
+
+has 'subinclude_plugin' => (
+    is => 'rw',
+    isa => 'ClassName'
+); 
+
+around 'new' => sub {
+    my $next = shift;
+    my $class = shift;
+    
+    my $self = $class->$next( @_ );
+    
+    my $subinclude_plugin = $self->config->{subinclude_plugin} || 'SubRequest';
+    my $subinclude_class  = __PACKAGE__ . '::' . $subinclude_plugin;
+    
+    eval "require $subinclude_class";
+    croak "Error requiring $subinclude_class: $@" if $@;
+
+    $self->subinclude_plugin( $subinclude_class );
+    
+    $self;
+};
+
+around 'render' => sub {
+    my $next = shift;
+    my ($self, $c, @args) = @_;
+    
+    $c->stash->{subinclude} = sub {
+        $self->subinclude_plugin->generate_subinclude( $c, @_ );
+    };
+
+    $self->$next( $c, @args );
+};
+
+1;
diff --git a/lib/Catalyst/View/Component/SubInclude/ESI.pm b/lib/Catalyst/View/Component/SubInclude/ESI.pm
new file mode 100644 (file)
index 0000000..f2e02b9
--- /dev/null
@@ -0,0 +1,12 @@
+package Catalyst::View::Component::SubInclude::ESI;
+use warnings;
+use strict;
+
+sub generate_subinclude {
+    my $class = shift;
+    my $c     = shift;
+    my $url = $c->uri_for( @_ );
+    return '<!--esi <esi:include src="' . $url->path . '" /> -->';
+}
+
+1;
diff --git a/lib/Catalyst/View/Component/SubInclude/SubRequest.pm b/lib/Catalyst/View/Component/SubInclude/SubRequest.pm
new file mode 100644 (file)
index 0000000..cbf1886
--- /dev/null
@@ -0,0 +1,15 @@
+package Catalyst::View::Component::SubInclude::SubRequest;
+use warnings;
+use strict;
+
+sub generate_subinclude {
+    my ($class, $c, $path, $params) = @_;
+    my $stash = {};
+
+    croak "subincludes through subrequests require Catalyst::Plugin::SubRequest"
+        unless $c->can('sub_request');
+
+    $c->sub_request( $path, $stash, $params );
+}
+
+1;
diff --git a/t/ESITest/Makefile.PL b/t/ESITest/Makefile.PL
new file mode 100644 (file)
index 0000000..a14c1d5
--- /dev/null
@@ -0,0 +1,19 @@
+# IMPORTANT: if you delete this file your app will not work as
+# expected.  you have been warned
+use inc::Module::Install;
+
+name 'ESITest';
+all_from 'lib/ESITest.pm';
+
+requires 'Catalyst::Runtime' => '5.7014';
+requires 'Catalyst::Plugin::ConfigLoader';
+requires 'Catalyst::Plugin::Static::Simple';
+requires 'Catalyst::Action::RenderView';
+requires 'parent';
+requires 'Config::General'; # This should reflect the config file format you've chosen
+                 # See Catalyst::Plugin::ConfigLoader for supported formats
+catalyst;
+
+install_script glob('script/*.pl');
+auto_install;
+WriteAll;
diff --git a/t/ESITest/esitest.conf b/t/ESITest/esitest.conf
new file mode 100644 (file)
index 0000000..851c247
--- /dev/null
@@ -0,0 +1,5 @@
+name ESITest
+
+<View::TT>
+  subinclude_plugin   SubRequest
+</View::TT>
diff --git a/t/ESITest/lib/ESITest.pm b/t/ESITest/lib/ESITest.pm
new file mode 100644 (file)
index 0000000..7b2f026
--- /dev/null
@@ -0,0 +1,23 @@
+package ESITest;
+
+use strict;
+use warnings;
+
+use Catalyst::Runtime '5.70';
+
+use parent qw/Catalyst/;
+use Catalyst qw/
+    -Debug
+    ConfigLoader
+    Static::Simple
+    SubRequest
+/;
+
+our $VERSION = '0.01';
+
+
+__PACKAGE__->config( name => 'ESITest' );
+
+__PACKAGE__->setup();
+
+1;
diff --git a/t/ESITest/lib/ESITest/Controller/Root.pm b/t/ESITest/lib/ESITest/Controller/Root.pm
new file mode 100644 (file)
index 0000000..97945ac
--- /dev/null
@@ -0,0 +1,20 @@
+package ESITest::Controller::Root;
+
+use strict;
+use warnings;
+use parent 'Catalyst::Controller';
+
+__PACKAGE__->config->{namespace} = '';
+
+sub index :Path :Args(0) {
+    my ( $self, $c ) = @_;
+}
+
+sub time_include : Local Args(0) {
+    my ( $self, $c ) = @_;
+    $c->stash->{current_time} = localtime();
+}
+
+sub end : ActionClass('RenderView') {}
+
+1;
diff --git a/t/ESITest/lib/ESITest/View/TT.pm b/t/ESITest/lib/ESITest/View/TT.pm
new file mode 100644 (file)
index 0000000..03f141a
--- /dev/null
@@ -0,0 +1,9 @@
+package ESITest::View::TT;
+use Moose;
+
+extends 'Catalyst::View::TT';
+with 'Catalyst::View::Component::SubInclude';
+
+__PACKAGE__->config( TEMPLATE_EXTENSION => '.tt' );
+
+1;
diff --git a/t/ESITest/root/favicon.ico b/t/ESITest/root/favicon.ico
new file mode 100644 (file)
index 0000000..5ad723d
Binary files /dev/null and b/t/ESITest/root/favicon.ico differ
diff --git a/t/ESITest/root/index.tt b/t/ESITest/root/index.tt
new file mode 100644 (file)
index 0000000..73d6926
--- /dev/null
@@ -0,0 +1,2 @@
+ESI Test, will include /time_include<br/>
+[% subinclude('/time_include') %]
diff --git a/t/ESITest/root/time_include.tt b/t/ESITest/root/time_include.tt
new file mode 100644 (file)
index 0000000..43120f9
--- /dev/null
@@ -0,0 +1 @@
+Current time is: [% current_time %]
\ No newline at end of file
diff --git a/t/ESITest/script/esitest_cgi.pl b/t/ESITest/script/esitest_cgi.pl
new file mode 100644 (file)
index 0000000..3dfe327
--- /dev/null
@@ -0,0 +1,37 @@
+#!C:\Perl\bin\perl.exe -w
+
+BEGIN { $ENV{CATALYST_ENGINE} ||= 'CGI' }
+
+use strict;
+use warnings;
+use FindBin;
+use lib "$FindBin::Bin/../lib";
+use ESITest;
+
+ESITest->run;
+
+1;
+
+=head1 NAME
+
+esitest_cgi.pl - Catalyst CGI
+
+=head1 SYNOPSIS
+
+See L<Catalyst::Manual>
+
+=head1 DESCRIPTION
+
+Run a Catalyst application as a cgi script.
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+
+This library is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
diff --git a/t/ESITest/script/esitest_create.pl b/t/ESITest/script/esitest_create.pl
new file mode 100644 (file)
index 0000000..b35f16b
--- /dev/null
@@ -0,0 +1,74 @@
+#!C:\Perl\bin\perl.exe -w
+
+use strict;
+use warnings;
+use Getopt::Long;
+use Pod::Usage;
+use Catalyst::Helper;
+
+my $force = 0;
+my $mech  = 0;
+my $help  = 0;
+
+GetOptions(
+    'nonew|force'    => \$force,
+    'mech|mechanize' => \$mech,
+    'help|?'         => \$help
+ );
+
+pod2usage(1) if ( $help || !$ARGV[0] );
+
+my $helper = Catalyst::Helper->new( { '.newfiles' => !$force, mech => $mech } );
+
+pod2usage(1) unless $helper->mk_component( 'ESITest', @ARGV );
+
+1;
+
+=head1 NAME
+
+esitest_create.pl - Create a new Catalyst Component
+
+=head1 SYNOPSIS
+
+esitest_create.pl [options] model|view|controller name [helper] [options]
+
+ Options:
+   -force        don't create a .new file where a file to be created exists
+   -mechanize    use Test::WWW::Mechanize::Catalyst for tests if available
+   -help         display this help and exits
+
+ Examples:
+   esitest_create.pl controller My::Controller
+   esitest_create.pl controller My::Controller BindLex
+   esitest_create.pl -mechanize controller My::Controller
+   esitest_create.pl view My::View
+   esitest_create.pl view MyView TT
+   esitest_create.pl view TT TT
+   esitest_create.pl model My::Model
+   esitest_create.pl model SomeDB DBIC::Schema MyApp::Schema create=dynamic\
+   dbi:SQLite:/tmp/my.db
+   esitest_create.pl model AnotherDB DBIC::Schema MyApp::Schema create=static\
+   dbi:Pg:dbname=foo root 4321
+
+ See also:
+   perldoc Catalyst::Manual
+   perldoc Catalyst::Manual::Intro
+
+=head1 DESCRIPTION
+
+Create a new Catalyst Component.
+
+Existing component files are not overwritten.  If any of the component files
+to be created already exist the file will be written with a '.new' suffix.
+This behavior can be suppressed with the C<-force> option.
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+This library is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
diff --git a/t/ESITest/script/esitest_fastcgi.pl b/t/ESITest/script/esitest_fastcgi.pl
new file mode 100644 (file)
index 0000000..3d733b7
--- /dev/null
@@ -0,0 +1,79 @@
+#!C:\Perl\bin\perl.exe -w
+
+BEGIN { $ENV{CATALYST_ENGINE} ||= 'FastCGI' }
+
+use strict;
+use warnings;
+use Getopt::Long;
+use Pod::Usage;
+use FindBin;
+use lib "$FindBin::Bin/../lib";
+use ESITest;
+
+my $help = 0;
+my ( $listen, $nproc, $pidfile, $manager, $detach, $keep_stderr );
+GetOptions(
+    'help|?'      => \$help,
+    'listen|l=s'  => \$listen,
+    'nproc|n=i'   => \$nproc,
+    'pidfile|p=s' => \$pidfile,
+    'manager|M=s' => \$manager,
+    'daemon|d'    => \$detach,
+    'keeperr|e'   => \$keep_stderr,
+);
+
+pod2usage(1) if $help;
+
+ESITest->run( 
+    $listen, 
+    {   nproc   => $nproc,
+        pidfile => $pidfile, 
+        manager => $manager,
+        detach  => $detach,
+       keep_stderr => $keep_stderr,
+    }
+);
+
+1;
+
+=head1 NAME
+
+esitest_fastcgi.pl - Catalyst FastCGI
+
+=head1 SYNOPSIS
+
+esitest_fastcgi.pl [options]
+ Options:
+   -? -help      display this help and exits
+   -l -listen    Socket path to listen on
+                 (defaults to standard input)
+                 can be HOST:PORT, :PORT or a
+                 filesystem path
+   -n -nproc     specify number of processes to keep
+                 to serve requests (defaults to 1,
+                 requires -listen)
+   -p -pidfile   specify filename for pid file
+                 (requires -listen)
+   -d -daemon    daemonize (requires -listen)
+   -M -manager   specify alternate process manager
+                 (FCGI::ProcManager sub-class)
+                 or empty string to disable
+   -e -keeperr   send error messages to STDOUT, not
+                 to the webserver
+
+=head1 DESCRIPTION
+
+Run a Catalyst application as fastcgi.
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+This library is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
diff --git a/t/ESITest/script/esitest_server.pl b/t/ESITest/script/esitest_server.pl
new file mode 100644 (file)
index 0000000..aa50702
--- /dev/null
@@ -0,0 +1,115 @@
+#!C:\Perl\bin\perl.exe -w
+
+BEGIN { 
+    $ENV{CATALYST_ENGINE} ||= 'HTTP';
+    $ENV{CATALYST_SCRIPT_GEN} = 31;
+    require Catalyst::Engine::HTTP;
+}  
+
+use strict;
+use warnings;
+use Getopt::Long;
+use Pod::Usage;
+use FindBin;
+use lib "$FindBin::Bin/../lib";
+use lib "$FindBin::Bin/../../../lib";
+
+my $debug             = 0;
+my $fork              = 0;
+my $help              = 0;
+my $host              = undef;
+my $port              = $ENV{ESITEST_PORT} || $ENV{CATALYST_PORT} || 3000;
+my $keepalive         = 0;
+my $restart           = $ENV{ESITEST_RELOAD} || $ENV{CATALYST_RELOAD} || 0;
+my $restart_delay     = 1;
+my $restart_regex     = '(?:/|^)(?!\.#).+(?:\.yml$|\.yaml$|\.conf|\.pm)$';
+my $restart_directory = undef;
+my $follow_symlinks   = 0;
+
+my @argv = @ARGV;
+
+GetOptions(
+    'debug|d'             => \$debug,
+    'fork'                => \$fork,
+    'help|?'              => \$help,
+    'host=s'              => \$host,
+    'port=s'              => \$port,
+    'keepalive|k'         => \$keepalive,
+    'restart|r'           => \$restart,
+    'restartdelay|rd=s'   => \$restart_delay,
+    'restartregex|rr=s'   => \$restart_regex,
+    'restartdirectory=s@' => \$restart_directory,
+    'followsymlinks'      => \$follow_symlinks,
+);
+
+pod2usage(1) if $help;
+
+if ( $restart && $ENV{CATALYST_ENGINE} eq 'HTTP' ) {
+    $ENV{CATALYST_ENGINE} = 'HTTP::Restarter';
+}
+if ( $debug ) {
+    $ENV{CATALYST_DEBUG} = 1;
+}
+
+# This is require instead of use so that the above environment
+# variables can be set at runtime.
+require ESITest;
+
+ESITest->run( $port, $host, {
+    argv              => \@argv,
+    'fork'            => $fork,
+    keepalive         => $keepalive,
+    restart           => $restart,
+    restart_delay     => $restart_delay,
+    restart_regex     => qr/$restart_regex/,
+    restart_directory => $restart_directory,
+    follow_symlinks   => $follow_symlinks,
+} );
+
+1;
+
+=head1 NAME
+
+esitest_server.pl - Catalyst Testserver
+
+=head1 SYNOPSIS
+
+esitest_server.pl [options]
+
+ Options:
+   -d -debug          force debug mode
+   -f -fork           handle each request in a new process
+                      (defaults to false)
+   -? -help           display this help and exits
+      -host           host (defaults to all)
+   -p -port           port (defaults to 3000)
+   -k -keepalive      enable keep-alive connections
+   -r -restart        restart when files get modified
+                      (defaults to false)
+   -rd -restartdelay  delay between file checks
+   -rr -restartregex  regex match files that trigger
+                      a restart when modified
+                      (defaults to '\.yml$|\.yaml$|\.conf|\.pm$')
+   -restartdirectory  the directory to search for
+                      modified files, can be set mulitple times
+                      (defaults to '[SCRIPT_DIR]/..')
+   -follow_symlinks   follow symlinks in search directories
+                      (defaults to false. this is a no-op on Win32)
+ See also:
+   perldoc Catalyst::Manual
+   perldoc Catalyst::Manual::Intro
+
+=head1 DESCRIPTION
+
+Run a Catalyst Testserver for this application.
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+This library is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
diff --git a/t/ESITest/script/esitest_test.pl b/t/ESITest/script/esitest_test.pl
new file mode 100644 (file)
index 0000000..f920cf4
--- /dev/null
@@ -0,0 +1,53 @@
+#!C:\Perl\bin\perl.exe -w
+
+use strict;
+use warnings;
+use Getopt::Long;
+use Pod::Usage;
+use FindBin;
+use lib "$FindBin::Bin/../lib";
+use Catalyst::Test 'ESITest';
+
+my $help = 0;
+
+GetOptions( 'help|?' => \$help );
+
+pod2usage(1) if ( $help || !$ARGV[0] );
+
+print request($ARGV[0])->content . "\n";
+
+1;
+
+=head1 NAME
+
+esitest_test.pl - Catalyst Test
+
+=head1 SYNOPSIS
+
+esitest_test.pl [options] uri
+
+ Options:
+   -help    display this help and exits
+
+ Examples:
+   esitest_test.pl http://localhost/some_action
+   esitest_test.pl /some_action
+
+ See also:
+   perldoc Catalyst::Manual
+   perldoc Catalyst::Manual::Intro
+
+=head1 DESCRIPTION
+
+Run a Catalyst action from the command line.
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+This library is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut