/ 
Web-Simple-0.007
River stage two • 11 direct dependents • 22 total dependents
/ Web::Simple::Application

NAME

Web::Simple::Application - A base class for your Web-Simple application

DESCRIPTION

This is a base class for your Web::Simple application. You probably don't need to construct this class yourself, since Web::Simple does the 'heavy lifting' for you in that regards.

METHODS

This class exposes the following public methods.

default_config

Merges with the config initializer to provide configuration information for your application. For example:

sub default_config {
  (
    title => 'Bloggery',
    posts_dir => $FindBin::Bin.'/posts',
  );
}

Now, the config attribute of $self will be set to a HashRef containing keys 'title' and 'posts_dir'.

The keys from default_config are merged into any config supplied, so if you construct your application like:

MyWebSimpleApp::Web->new(
  config => { title => 'Spoon', environment => 'dev' }
)

then config will contain:

{
  title => 'Spoon',
  posts_dir => '/path/to/myapp/posts',
  environment => 'dev'
}

run_if_script

The run_if_script method is designed to be used at the end of the script or .pm file where your application class is defined - for example:

## my_web_simple_app.pl
#!/usr/bin/env perl
use Web::Simple 'HelloWorld';

{
  package HelloWorld;

  sub dispatch_request {
    sub (GET) {
      [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ]
    },
    sub () {
      [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ]
    }
  }
}

HelloWorld->run_if_script;

This returns a true value, so your file is now valid as a module - so

require 'my_web_simple_app.pl';

my $hw = HelloWorld->new;

will work fine (and you can rename it to lib/HelloWorld.pm later to make it a real use-able module).

However, it detects if it's being run as a script (via testing $0) and if so attempts to do the right thing.

If run under a CGI environment, your application will execute as a CGI.

If run under a FastCGI environment, your application will execute as a FastCGI process (this works both for dynamic shared-hosting-style FastCGI and for apache FastCgiServer style setups).

If run from the commandline with a URL path, it runs a GET request against that path -

$ perl -Ilib examples/hello-world/hello-world.cgi /
200 OK
Content-Type: text/plain

Hello world!

Additionally, you can treat the file as though it were a standard PSGI application file (*.psgi). For example you can start up up with plackup

plackup my_web_simple_app.pl

or starman

starman my_web_simple_app.pl

to_psgi_app

This method is called by "run_if_script" to create the PSGI app coderef for use via Plack and plackup. If you want to globally add middleware, you can override this method:

 use Web::Simple 'HelloWorld';
 use Plack::Builder;

 {
   package HelloWorld;

 
   around 'to_psgi_app', sub {
     my ($orig, $self) = (shift, shift);
     my $app = $self->$orig(@_); 
     builder {
       enable ...; ## whatever middleware you want
       $app;
     };
   };
 }

This method can also be used to mount a Web::Simple application within a separate *.psgi file -

use strictures 1;
use Plack::Builder;
use WSApp;
use AnotherWSApp;

builder {
  mount '/' => WSApp->to_psgi_app;
  mount '/another' => AnotherWSApp->to_psgi_app;
};

This method can be called as a class method, in which case it implicitly calls ->new, or as an object method ... in which case it doesn't.

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;

AUTHOR

Matt S. Trout <mst@shadowcat.co.uk>

CONTRIBUTORS

None required yet. Maybe this module is perfect (hahahahaha ...).

COPYRIGHT

Copyright (c) 2010 the Web::Simple "AUTHOR" and "CONTRIBUTORS" as listed above.

LICENSE

This library is free software and may be distributed under the same terms as perl itself.