—

              
package Mojo;
use Mojo::Base -base;
# "Professor: These old Doomsday devices are dangerously unstable. I'll rest
#             easier not knowing where they are."
use Carp 'croak';
use Mojo::Home;
use Mojo::Log;
use Mojo::Transaction::HTTP;
use Mojo::UserAgent;
use Scalar::Util 'weaken';
has home => sub { Mojo::Home->new };
has log  => sub { Mojo::Log->new };
has ua   => sub {
  my $self = shift;
  my $ua = Mojo::UserAgent->new;
  weaken $ua->server->app($self)->{app};
  weaken $self;
  $ua->on(error => sub { $self->log->error($_[1]) });
  return $ua;
};
sub build_tx { Mojo::Transaction::HTTP->new }
sub config { shift->_dict(config => @_) }
sub handler { croak 'Method "handler" not implemented in subclass' }
sub new {
  my $self = shift->SUPER::new(@_);
  # Check if we have a log directory
  my $home = $self->home;
  $home->detect(ref $self) unless @{$home->parts};
  $self->log->path($home->rel_file('log/mojo.log'))
    if -w $home->rel_file('log');
  return $self;
}
sub _dict {
  my ($self, $name) = (shift, shift);
  # Hash
  my $dict = $self->{$name} ||= {};
  return $dict unless @_;
  # Get
  return $dict->{$_[0]} unless @_ > 1 || ref $_[0];
  # Set
  %$dict = (%$dict, %{ref $_[0] ? $_[0] : {@_}});
  return $self;
}
1;
HideShow 128 lines of Pod
=encoding utf8
=head1 NAME
Mojo - Duct tape for the HTML5 web!
=head1 SYNOPSIS
  package MyApp;
  use Mojo::Base 'Mojo';
  # All the complexities of CGI, PSGI, HTTP and WebSockets get reduced to a
  # single method call!
  sub handler {
    my ($self, $tx) = @_;
    # Request
    my $method = $tx->req->method;
    my $path   = $tx->req->url->path;
    # Response
    $tx->res->code(200);
    $tx->res->headers->content_type('text/plain');
    $tx->res->body("$method request for $path!");
    # Resume transaction
    $tx->resume;
  }
=head1 DESCRIPTION
Mojo provides a flexible runtime environment for Perl real-time web
frameworks. It provides all the basic tools and helpers needed to write
simple web applications and higher level web frameworks, such as
L<Mojolicious>.
See L<Mojolicious::Guides> for more!
=head1 ATTRIBUTES
L<Mojo> implements the following attributes.
=head2 home
  my $home = $app->home;
  $app     = $app->home(Mojo::Home->new);
The home directory of your application, defaults to a L<Mojo::Home> object
which stringifies to the actual path.
  # Generate portable path relative to home directory
  my $path = $app->home->rel_file('data/important.txt');
=head2 log
  my $log = $app->log;
  $app    = $app->log(Mojo::Log->new);
The logging layer of your application, defaults to a L<Mojo::Log> object.
  # Log debug message
  $app->log->debug('It works!');
=head2 ua
  my $ua = $app->ua;
  $app   = $app->ua(Mojo::UserAgent->new);
A full featured HTTP user agent for use in your applications, defaults to a
L<Mojo::UserAgent> object. Note that this user agent should not be used in
plugins, since non-blocking requests that are already in progress will
interfere with new blocking ones.
  # Perform blocking request
  say $app->ua->get('example.com')->res->body;
=head1 METHODS
L<Mojo> inherits all methods from L<Mojo::Base> and implements the following
new ones.
=head2 build_tx
  my $tx = $app->build_tx;
Transaction builder, defaults to building a L<Mojo::Transaction::HTTP>
object.
=head2 config
  my $hash = $app->config;
  my $foo  = $app->config('foo');
  $app     = $app->config({foo => 'bar'});
  $app     = $app->config(foo => 'bar');
Application configuration.
  # Remove value
  my $foo = delete $app->config->{foo};
=head2 handler
  $app->handler(Mojo::Transaction::HTTP->new);
The handler is the main entry point to your application or framework and will
be called for each new transaction, which will usually be a
L<Mojo::Transaction::HTTP> or L<Mojo::Transaction::WebSocket> object. Meant to
be overloaded in a subclass.
  sub handler {
    my ($self, $tx) = @_;
    ...
  }
=head2 new
  my $app = Mojo->new;
Construct a new L<Mojo> application. Will automatically detect your home
directory if necessary and set up logging to C<log/mojo.log> if there's a
C<log> directory.
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>.
=cut