X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FWeb%2FSimple.pm;h=a334187e76928d961ecf1833a10ee4e380dbf8bd;hb=20645c5fa990200aa5e75011113659c4513c4c50;hp=47d7a0edc5b7905638d6da7eb49fc0f58bbc0c66;hpb=7c03cd612110f7b5d84ae20100bc13ce58d36050;p=catagits%2FWeb-Simple.git diff --git a/lib/Web/Simple.pm b/lib/Web/Simple.pm index 47d7a0e..a334187 100644 --- a/lib/Web/Simple.pm +++ b/lib/Web/Simple.pm @@ -6,7 +6,7 @@ use warnings::illegalproto (); use Moo (); use Web::Dispatch::Wrapper (); -our $VERSION = '0.013'; +our $VERSION = '0.020'; sub import { my ($class, $app_package) = @_; @@ -30,6 +30,8 @@ sub _export_into { $INC{"${name}.pm"} = 'Set by "use Web::Simple;" invocation'; } +1; + =head1 NAME Web::Simple - A quick and easy way to build simple web applications @@ -130,6 +132,16 @@ so that perl will not attempt to load the application again even if is encountered in other code. +One important thing to remember when using + + NameOfApplication->run_if_script; + +At the end of your app is that this call will create an instance of your app +for you automatically, regardless of context. An easier way to think of this +would be if the method were more verbosely named + + NameOfApplication->run_request_if_script_else_turn_coderef_for_psgi; + =head1 DISPATCH STRATEGY L despite being straightforward to use, has a powerful system @@ -203,7 +215,7 @@ cleverness). If you want to return a PSGI sub you have to wrap it into an array ref. sub dispatch_request { - [ sub { + [ sub { my $respond = shift; # This is pure PSGI here, so read perldoc PSGI } ] @@ -211,10 +223,10 @@ array ref. If you return a subroutine with a prototype, the prototype is treated as a match specification - and if the test is passed, the body of the -sub is called as a method any matched arguments (see below for more details). +sub is called as a method and passed any matched arguments (see below for more details). -You can also return a plain subroutine which will be called with just $env -- remember that in this case if you need $self you -must- close over it. +You can also return a plain subroutine which will be called with just C<$env> +- remember that in this case if you need C<$self> you B close over it. If you return a normal object, L will simply return it upwards on the assumption that a response_filter (or some arbitrary L) @@ -226,6 +238,20 @@ somewhere will convert it to something useful. This allows: sub (/user/*) { $self->users->get($_[1]) }, } +An alternative to using prototypes to declare a match specification for a given +route is to provide a Dancer like key-value list: + + sub dispatch_request { + my $self = shift; + ( + '.html' => sub { response_filter { $self->render_zoom($_[0]) } }, + '/user/*' => sub { $self->users->get($_[1]) }< + ) + } + +This can be useful in situations where you are generating a dispatch table +programmatically, where setting a subroutines protoype is difficult. + to render a user object to HTML, if there is an incoming URL such as: http://myweb.org/user/111.html @@ -238,8 +264,8 @@ This user object 'bubbles up' through all the wrapping middleware until it hits the C we defined, after which the return is converted to a true html response. -However, two types of object are treated specially - a Plack::App object -will have its C<->to_app> method called and be used as a dispatcher: +However, two types of object are treated specially - a C object +will have its C method called and be used as a dispatcher: sub dispatch_request { my $self = shift; @@ -247,7 +273,7 @@ will have its C<->to_app> method called and be used as a dispatcher: ... } -A Plack::Middleware object will be used as a filter for the rest of the +A L object will be used as a filter for the rest of the dispatch being returned into: ## responds to /admin/track_usage AND /admin/delete_accounts @@ -265,7 +291,7 @@ dispatch being returned into: }, } -Note that this is for the dispatch being -returned- to, so if you want to +Note that this is for the dispatch being B to, so if you want to provide it inline you need to do: ## ALSO responds to /admin/track_usage AND /admin/delete_accounts @@ -319,7 +345,7 @@ also match more than one part: sub (/domain/*/user/*) { my ($self, $domain, $user) = @_; -and so on. To match an arbitrary number of parts, use - +and so on. To match an arbitrary number of parts, use C<**>: sub (/page/**) { my ($self, $match) = @_; @@ -331,9 +357,9 @@ This will result in a single element for the entire match. Note that you can do to match an arbitrary number of parts up to but not including some final part. -Note: Since Web::Simple handles a concept of file extensions, * and ** +Note: Since Web::Simple handles a concept of file extensions, C<*> and C<**> matchers will not by default match things after a final dot, and this -can be modified by using *.* and **.* in the final position, i.e.: +can be modified by using C<*.*> and C<**.*> in the final position, e.g.: /one/* matches /one/two.three and captures "two" /one/*.* matches /one/two.three and captures "two.three" @@ -344,7 +370,7 @@ Finally, sub (/foo/...) { -Will match C on the beginning of the path -and- strip it. This is +Will match C on the beginning of the path B strip it. This is designed to be used to construct nested dispatch structures, but can also prove useful for having e.g. an optional language specification at the start of a path. @@ -400,7 +426,7 @@ when it is contained in this type of path match. It matches to an empty path. =head4 Naming your patch matches -Any */**/*.*/**.* match can be followed with :name to make it into a named +Any C<*>, C<**>, C<*.*>, or C<**.*> match can be followed with C<:name> to make it into a named match, so: sub (/*:one/*:two/*:three/*:four) { @@ -438,7 +464,7 @@ This makes it necessary to be explicit about the trailing slash. sub (.html) { will match .html from the path (assuming the subroutine itself returns -something, of course). This is normally used for rendering - e.g. +something, of course). This is normally used for rendering - e.g.: sub (.html) { response_filter { $self->render_html($_[1]) } @@ -459,10 +485,9 @@ Query and body parameters can be match via The body spec will match if the request content is either application/x-www-form-urlencoded or multipart/form-data - the latter -of which is required for uploads, which are now handled experimentally -- see below. +of which is required for uploads - see below. -The param spec is elements of one of the following forms - +The param spec is elements of one of the following forms: param~ # optional parameter param= # required parameter @@ -475,16 +500,16 @@ The param spec is elements of one of the following forms - * # include all other parameters in hashref @* # include all other parameters as multiple in hashref -separated by the & character. The arguments added to the request are -one per non-:/* parameter (scalar for normal, arrayref for multiple), -plus if any :/* specs exist a hashref containing those values. +separated by the C<&> character. The arguments added to the request are +one per non-C<:>/C<*> parameter (scalar for normal, arrayref for multiple), +plus if any C<:>/C<*> specs exist a hashref containing those values. Please note that if you specify a multiple type parameter match, you are ensured of getting an arrayref for the value, EVEN if the current incoming request has only one value. However if a parameter is specified as single and multiple values are found, the last one will be used. -For example to match a page parameter with an optional order_by parameter one +For example to match a C parameter with an optional C parameter one would write: sub (?page=&order_by~) { @@ -515,7 +540,7 @@ You can also mix these, so: my ($self, $foo, $bar, $params); where $bar is an arrayref (possibly an empty one), and $params contains -arrayref values for all parameters -not- mentioned and a scalar value for +arrayref values for all parameters B mentioned and a scalar value for the 'coffee' parameter. Note, in the case where you combine arrayref, single parameter and named @@ -523,11 +548,7 @@ hashref style, the arrayref and single parameters will appear in C<@_> in the order you defined them in the protoype, but all hashrefs will merge into a single C<$params>, as in the example above. -=head3 Upload matches (EXPERIMENTAL) - -Note: This feature is experimental. This means that it may not remain -100% in its current form. If we change it, notes on updating your code -will be added to the L section below. +=head3 Upload matches sub (*foo=) { # param specifier can be anything valid for query or body @@ -600,7 +621,7 @@ which will never match! =head3 Whitespace -Note that for legibility you are permitted to use whitespace - +Note that for legibility you are permitted to use whitespace: sub (GET + /user/*) { @@ -609,17 +630,56 @@ from subroutine prototypes, so this is equivalent to sub (GET+/user/*) { +=head3 Accessing parameters via C<%_> + +If your dispatch specification causes your dispatch subroutine to receive +a hash reference as its first argument, the contained named parameters +will be accessible via C<%_>. + +This can be used to access your path matches, if they are named: + + sub (GET + /foo/:path_part) { + [ 200, + ['Content-type' => 'text/plain'], + ["We are in $_{path_part}"], + ]; + } + +Or, if your first argument would be a hash reference containing named +query parameters: + + sub (GET + /foo + ?:some_param=) { + [ 200, + ['Content-type' => 'text/plain'], + ["We received $_{some_param} as parameter"], + ]; + } + +Of course this also works when all you are doing is slurping the whole set +of parameters by their name: + + sub (GET + /foo + ?*) { + [ 200, + ['Content-type' => 'text/plain'], + [exists($_{foo}) ? "Received a foo: $_{foo}" : "No foo!"], + ], + } + +Note that only the first hash reference will be available via C<%_>. If +you receive additional hash references, you will need to access them as +usual. + =head3 Accessing the PSGI env hash In some cases you may wish to get the raw PSGI env hash - to do this, -you can either use a plain sub - +you can either use a plain sub: sub { my ($env) = @_; ... } -or use the PSGI_ENV constant exported to retrieve it: +or use the C constant exported to retrieve it from C<@_>: sub (GET + /foo + ?some_param=) { my $param = $_[1]; @@ -661,9 +721,9 @@ It creates and returns a special dispatcher that always matches, and instead of continuing dispatch re-delegates it to the start of the dispatch process, but with the path of the request altered to the supplied URL. -Thus if you receive a POST to '/some/url' and return a redispatch to -'/other/url', the dispatch behaviour will be exactly as if the same POST -request had been made to '/other/url' instead. +Thus if you receive a POST to C and return a redispatch to +C, the dispatch behaviour will be exactly as if the same POST +request had been made to C instead. Note, this is not the same as returning an HTTP 3xx redirect as a response; rather it is a much more efficient internal process. @@ -684,15 +744,15 @@ dispatch {} has gone away - instead, you write: ... } -Note that this method is still -returning- the dispatch code - just like -dispatch did. +Note that this method is still B the dispatch code - just like +C did. -Also note that you need the 'my $self = shift' since the magic $self +Also note that you need the C<< my $self = shift >> since the magic $self variable went away. =item * the magic $self variable went away. -Just add 'my $self = shift;' while writing your 'sub dispatch_request {' +Just add C<< my $self = shift; >> while writing your C<< sub dispatch_request { >> like a normal perl method. =item * subdispatch deleted - all dispatchers can now subdispatch @@ -798,6 +858,8 @@ Robin Edwards Andrew Rodland (hobbs) +Robert Sedlacek (phaylon) + =head1 COPYRIGHT Copyright (c) 2011 the Web::Simple L and L @@ -809,5 +871,3 @@ This library is free software and may be distributed under the same terms as perl itself. =cut - -1;