SRI / Mojolicious-1.57 / lib / Mojo.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
—
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

              
package Mojo;
use Mojo::Base -base;
use Carp 'croak';
use Mojo::Home;
use Mojo::Log;
use Mojo::Transaction::HTTP;
use Mojo::Transaction::WebSocket;
use Scalar::Util 'weaken';
has home => sub { Mojo::Home->new };
has log  => sub { Mojo::Log->new };
has on_transaction => sub {
  sub { Mojo::Transaction::HTTP->new }
};
has on_websocket => sub {
  sub { Mojo::Transaction::WebSocket->new(handshake => pop) }
};
has ua => sub {
  my $self = shift;
  # Fresh user agent
  require Mojo::UserAgent;
  my $ua = Mojo::UserAgent->new(app => $self, log => $self->log);
  weaken $ua->{app};
  return $ua;
};
# "Oh, so they have internet on computers now!"
sub new {
  my $self = shift->SUPER::new(@_);
  # Detect home directory
  $self->home->detect(ref $self);
  # Log directory
  $self->log->path($self->home->rel_file('log/mojo.log'))
    if -w $self->home->rel_file('log');
  return $self;
}
# "D’oh."
sub handler { croak 'Method "handler" not implemented in subclass' }
1;
__END__
=head1 NAME
Mojo - The Box!
=head1 SYNOPSIS
  use Mojo::Base 'Mojo';
  # All the complexities of CGI, FastCGI, 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 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> for more!
=head1 ATTRIBUTES
L<Mojo> implements the following attributes.
=head2 C<home>
  my $home = $app->home;
  $app     = $app->home(Mojo::Home->new);
The home directory of your application, by default a L<Mojo::Home> object
which stringifies to the actual path.
=head2 C<log>
  my $log = $app->log;
  $app    = $app->log(Mojo::Log->new);
     
The logging layer of your application, by default a L<Mojo::Log> object.
=head2 C<on_transaction>
  my $cb = $app->on_transaction;
  $app   = $app->on_transaction(sub {...});
Callback to be invoked when a new transaction is needed, by default it builds
a L<Mojo::Transaction::HTTP> object.
=head2 C<on_websocket>
  my $cb = $app->on_websocket;
  $app   = $app->on_websocket(sub {...});
Callback to be invoked for WebSocket handshakes, by default it builds a
L<Mojo::Transaction::WebSocket> object and handles the response for the
handshake request.
=head2 C<ua>
  my $ua = $app->ua;
  $app   = $app->ua(Mojo::UserAgent->new);
A full featured HTTP 1.1 user agent for use in your applications, by default
a L<Mojo::UserAgent> object.
=head1 METHODS
L<Mojo> inherits all methods from L<Mojo::Base> and implements the following
new ones.
=head2 C<new>
  my $app = Mojo->new;
Construct a new L<Mojo> application.
Will automatically detect your home directory and set up logging to
C<log/mojo.log> if there's a log directory.
=head2 C<handler>
  $tx = $app->handler($tx);
The handler is the main entry point to your application or framework and
will be called for each new transaction, usually a L<Mojo::Transaction::HTTP>
or L<Mojo::Transaction::WebSocket> object.
  sub handler {
    my ($self, $tx) = @_;
  }
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>.
=cut