package Web::Simple::Application;
-use strict;
-use warnings FATAL => 'all';
+use Moo;
+
+has 'config' => (
+ is => 'ro',
+ default => sub {
+ my ($self) = @_;
+ +{ $self->default_config }
+ },
+ trigger => sub {
+ my ($self, $value) = @_;
+ my %default = $self->default_config;
+ my @not = grep !exists $value->{$_}, keys %default;
+ @{$value}{@not} = @default{@not};
+ }
+);
-{
- package Web::Simple::Dispatcher;
+sub default_config { () }
- sub _is_dispatcher {
- ref($_[1])
- and "$_[1]" =~ /\w+=[A-Z]/
- and $_[1]->isa(__PACKAGE__);
- }
+has '_dispatcher' => (is => 'lazy');
- sub next {
- @_ > 1
- ? $_[0]->{next} = $_[1]
- : shift->{next}
- }
+sub _build__dispatcher {
+ my $self = shift;
+ require Web::Dispatch;
+ require Web::Simple::DispatchNode;
+ my $final = $self->_build_final_dispatcher;
+ Web::Dispatch->new(
+ app => sub { $self->dispatch_request(@_), $final },
+ node_class => 'Web::Simple::DispatchNode',
+ node_args => { app_object => $self }
+ );
+}
- sub set_next {
- $_[0]->{next} = $_[1];
- $_[0]
- }
+sub _build_final_dispatcher {
+ [ 404, [ 'Content-type', 'text/plain' ], [ 'Not found' ] ]
+}
- sub dispatch {
- my ($self, $env, @args) = @_;
- my $next = $self->next;
- if (my ($env_delta, @match) = $self->_match_against($env)) {
- if (my ($result) = $self->_execute_with(@args, @match)) {
- if ($self->_is_dispatcher($result)) {
- $next = $result->set_next($next);
- $env = { %$env, %$env_delta };
- } else {
- return $result;
- }
- }
- }
- return $next->dispatch($env, @args);
- }
+sub run_if_script {
+ # ->to_psgi_app is true for require() but also works for plackup
+ return $_[0]->to_psgi_app if caller(1);
+ my $self = ref($_[0]) ? $_[0] : $_[0]->new;
+ $self->run(@_);
+}
- sub _match_against {
- return ({}, $_[1]) unless $_[0]->{match};
- $_[0]->{match}->($_[1]);
- }
+sub _run_cgi {
+ my $self = shift;
+ require Plack::Server::CGI;
+ Plack::Server::CGI->run($self->to_psgi_app);
+}
- sub _execute_with {
- $_[0]->{call}->(@_);
- }
+sub _run_fcgi {
+ my $self = shift;
+ require Plack::Server::FCGI;
+ Plack::Server::FCGI->run($self->to_psgi_app);
}
-sub new {
- my ($class, $data) = @_;
- my $config = { $class->_default_config, %{($data||{})->{config}||{}} };
- bless({ config => $config }, $class);
+sub to_psgi_app {
+ my $self = ref($_[0]) ? $_[0] : $_[0]->new;
+ $self->_dispatcher->to_app;
}
-sub _setup_default_config {
- my $class = shift;
- {
- no strict 'refs';
- if (${"${class}::_default_config"}{CODE}) {
- $class->_cannot_call_twice('_setup_default_config', 'default_config');
- }
+sub run {
+ my $self = shift;
+ if ($ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}) {
+ return $self->_run_fcgi;
+ } elsif ($ENV{GATEWAY_INTERFACE}) {
+ return $self->_run_cgi;
}
- my @defaults = (@_, $class->_default_config);
- {
- no strict 'refs';
- *{"${class}::_default_config"} = sub { @defaults };
+ unless (@ARGV && $ARGV[0] =~ m{^/}) {
+ return $self->_run_cli(@ARGV);
}
-}
-sub _default_config { () }
+ my $path = shift @ARGV;
-sub config {
- shift->{config};
-}
+ require HTTP::Request::Common;
+ require Plack::Test;
+ local *GET = \&HTTP::Request::Common::GET;
-sub _construct_response_filter {
- my $code = $_[1];
- $_[0]->_build_dispatcher({
- call => sub {
- my ($d, $self, $env) = (shift, shift, shift);
- $self->_run_with_self($code, $d->next->dispatch($env, $self, @_));
- },
- });
+ my $request = GET($path);
+ my $response;
+ Plack::Test::test_psgi($self->to_psgi_app, sub { $response = shift->($request) });
+ print $response->as_string;
}
-sub _construct_redispatch {
- my ($self, $new_path) = @_;
- $self->_build_dispatcher({
- call => sub {
- shift;
- my ($self, $env) = @_;
- $self->_dispatch({ %{$env}, PATH_INFO => $new_path })
- }
- })
+sub _run_cli {
+ my $self = shift;
+ die $self->_cli_usage;
}
-sub _build_dispatch_parser {
- require Web::Simple::DispatchParser;
- return Web::Simple::DispatchParser->new;
+sub _cli_usage {
+ "To run this script in CGI test mode, pass a URL path beginning with /:\n".
+ "\n".
+ " $0 /some/path\n".
+ " $0 /\n"
}
-sub _cannot_call_twice {
- my ($class, $method, $sub) = @_;
- my $error = "Cannot call ${method} twice for ${class}";
- if ($sub) {
- $error .= " - did you call Web::Simple's ${sub} export twice?";
- }
- die $error;
-}
+1;
-sub _setup_dispatcher {
- my ($class, $dispatch_subs) = @_;
- {
- no strict 'refs';
- if (${"${class}::_dispatcher"}{CODE}) {
- $class->_cannot_call_twice('_setup_dispatcher', 'dispatch');
- }
- }
- my $parser = $class->_build_dispatch_parser;
- my ($root, $last);
- foreach my $dispatch_sub (@$dispatch_subs) {
- my $proto = prototype $dispatch_sub;
- my $matcher = (
- defined($proto)
- ? $parser->parse_dispatch_specification($proto)
- : undef
+=head1 NAME
+
+Web::Simple::Application - A base class for your Web-Simple applications
+
+=head1 DESCRIPTION
+
+This is a base class for your L<Web::Simple> application. You probably don't
+need to construct this class yourself, since L<Web::Simple> does the 'heavy
+lifting' for you in that regards.
+
+=head1 METHODS
+
+This class exposes the follow public methods.
+
+=head2 default_config
+
+Provide configuration information to your application, for example:
+
+ sub default_config {
+ (
+ title => 'Bloggery',
+ posts_dir => $FindBin::Bin.'/posts',
);
- my $new = $class->_build_dispatcher({
- match => $matcher,
- call => sub { shift;
- shift->_run_with_self($dispatch_sub, @_)
- },
- });
- $root ||= $new;
- $last = $last ? $last->next($new) : $new;
}
- $last->next($class->_build_final_dispatcher);
+
+Now, C<$self> will have an attribute C<config> which will be set to a HashRef
+containing keys 'title' and 'posts_dir'.
+
+=head2 run_if_script
+
+In the case where you wish to run you L<Web::Simple> based application as a
+stand alone CGI application, you can simple do:
+
+ ## my_web_simple_app.pl
+ use MyWebSimpleApp::Web;
+ MyWebSimpleApp::Web->run_if_script.
+
+Or (even more simply) just inline the entire application:
+
+ ## my_web_simple_app.pl
+ #!/usr/bin/env perl
+ use Web::Simple 'HelloWorld';
+
{
- no strict 'refs';
- *{"${class}::_dispatcher"} = sub { $root };
+ package HelloWorld;
+
+ sub dispatch_request {
+ sub (GET) {
+ [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
+ },
+ sub () {
+ [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
+ }
+ }
}
-}
-sub _build_dispatcher {
- bless($_[1], 'Web::Simple::Dispatcher');
-}
+ HelloWorld->run_if_script;
-sub _build_final_dispatcher {
- shift->_build_dispatcher({
- call => sub {
- [
- 500, [ 'Content-type', 'text/plain' ],
- [ 'The management apologises but we have no idea how to handle that' ]
- ]
- }
- })
-}
+=head2 to_psgi_app
-sub _dispatch {
- my ($self, $env) = @_;
- $self->_dispatcher->dispatch($env, $self);
-}
+Given a L<Web::Simple> application root namespace, return it in a form suitable
+to run in inside a L<Plack> container, or in L<Plack::Builder> or in a C<*.psgi>
+file:
-sub _run_with_self {
- my ($self, $run, @args) = @_;
- my $class = ref($self);
- no strict 'refs';
- local *{"${class}::self"} = \$self;
- $self->$run(@args);
-}
+ ## app.psgi
+ use strictures 1;
+ use Plack::Builder;
+ use MyWebSimpleApp::Web;
-sub run_if_script {
- return 1 if caller(1); # 1 so we can be the last thing in the file
- my $class = shift;
- my $self = $class->new;
- $self->run(@_);
-}
+ builder {
+ ## enable middleware
+ enable 'StackTrace';
+ enable 'Debug';
-sub _run_cgi {
- my $self = shift;
- require Web::Simple::HackedPlack;
- Plack::Server::CGI->run(sub { $self->_dispatch(@_) });
-}
+ ## return application
+ MyWebSimpleApp::Web->to_psgi_app;
+ };
-sub run {
- my $self = shift;
- if ($ENV{GATEWAY_INTERFACE}) {
- return $self->_run_cgi;
- }
- my $path = shift(@ARGV) or die "No path passed - use $0 / for root";
+This could be run via C<plackup>, etc. Please note the L<Plack::Builder> DSL
+is optional, if you are enabling L<Plack::Middleware> internally in your
+L<Web::Simple> application; your app.psgi could be as simple as:
- require HTTP::Request::AsCGI;
- require HTTP::Request::Common;
- local *GET = \&HTTP::Request::Common::GET;
+ use MyWebSimpleApp::Web;
+ MyWebSimpleApp::Web->to_psgi_app;
- my $request = GET($path);
- my $c = HTTP::Request::AsCGI->new($request)->setup;
- $self->_run_cgi;
- $c->restore;
- print $c->response->as_string;
-}
+As always, mix and match the pieces you actually need and remember the
+L<Web::Simple> philosophy of trying to keep it as minimal and simple as possible.
-1;
+=head2 run
+
+Used for running your application under stand-alone CGI and FCGI modes. Also
+useful for testing:
+
+ my $app = MyWebSimpleApp::Web->new;
+ my $c = HTTP::Request::AsCGI->new(@args)->setup;
+ $app->run;
+
+=head1 AUTHOR
+
+Matt S. Trout <mst@shadowcat.co.uk>
+
+=head1 CONTRIBUTORS
+
+None required yet. Maybe this module is perfect (hahahahaha ...).
+
+=head1 COPYRIGHT
+
+Copyright (c) 2009 the Web::Simple L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
projects / catagits/Web-Simple.git / blobdiff