X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FWeb%2FSimple.pm;h=aba056f706f2d06dde7b45e6da27fb6ae0bbad6c;hb=1d2f4b67ca3f3dedd1a9a1863cee2b01a446baaa;hp=1e350e03743f76780b0fe8d430a23552c489fa61;hpb=cb12d2a32b35b292b35a9146d55a11f86db87954;p=catagits%2FWeb-Simple.git diff --git a/lib/Web/Simple.pm b/lib/Web/Simple.pm index 1e350e0..aba056f 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.008'; +our $VERSION = '0.018'; 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 @@ -39,18 +41,15 @@ Web::Simple - A quick and easy way to build simple web applications #!/usr/bin/env perl - use Web::Simple 'HelloWorld'; + package HelloWorld; + use Web::Simple; - { - package HelloWorld; - - sub dispatch_request { - sub (GET) { - [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ] - }, - sub () { - [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ] - } + sub dispatch_request { + sub (GET) { + [ 200, [ 'Content-type', 'text/plain' ], [ 'Hello world!' ] ] + }, + sub () { + [ 405, [ 'Content-type', 'text/plain' ], [ 'Method not allowed' ] ] } } @@ -60,9 +59,17 @@ If you save this file into your cgi-bin as C and then visit: http://my.server.name/cgi-bin/hello-world.cgi/ -you'll get the "Hello world!" string output to your browser. For more complex -examples and non-CGI deployment, see below. To get help with L, -please connect to the irc.perl.org IRC network and join #web-simple. +you'll get the "Hello world!" string output to your browser. At the same time +this file will also act as a class module, so you can save it as HelloWorld.pm +and use it as-is in test scripts or other deployment mechanisms. + +Note that you should retain the ->run_if_script even if your app is a +module, since this additionally makes it valid as a .psgi file, which can +be extremely useful during development. + +For more complex examples and non-CGI deployment, see +L. To get help with L, please connect to +the irc.perl.org IRC network and join #web-simple. =head1 DESCRIPTION @@ -82,7 +89,7 @@ C based one: This sets up your package (in this case "NameOfApplication" is your package) so that it inherits from L and imports L, -as well as installs a C constant for convenience, as well as some +as well as installs a C constant for convenience, as well as some other subroutines. Importing L will automatically make your code use the C and @@ -193,6 +200,17 @@ However, generally, instead of that, you return a set of dispatch subs: ... } +Well, a sub is a valid PSGI response too (for ultimate streaming and async +cleverness). If you want to return a PSGI sub you have to wrap it into an +array ref. + + sub dispatch_request { + [ sub { + my $respond = shift; + # This is pure PSGI here, so read perldoc PSGI + } ] + } + 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). @@ -306,22 +324,32 @@ also match more than one part: and so on. To match an arbitrary number of parts, use - sub (/page/**) { + my ($self, $match) = @_; -This will result in an element per /-separated part so matched. Note that -you can do +This will result in a single element for the entire match. Note that you can do sub (/page/**/edit) { 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 ** +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.: + + /one/* matches /one/two.three and captures "two" + /one/*.* matches /one/two.three and captures "two.three" + /** matches /one/two.three and captures "one/two" + /**.* matches /one/two.three and captures "one/two.three" + Finally, sub (/foo/...) { -Will match /foo/ on the beginning of the path -and- 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. +Will match C on the beginning of the path -and- 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. Note that the '...' is a "maybe something here, maybe not" so the above specification will match like this: @@ -330,14 +358,82 @@ specification will match like this: /foo/ # match and strip path to '/' /foo/bar/baz # match and strip path to '/bar/baz' -Note: Since Web::Simple handles a concept of file extensions, * and ** -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.: +Almost the same, - /one/* matches /one/two.three and captures "two" - /one/*.* matches /one/two.three and captures "two.three" - /** matches /one/two.three and captures "one/two" - /**.* matches /one/two.three and captures "one/two.three" + sub (/foo...) { + +Will match on C, but also include C. Otherwise it +operates the same way as C. + + /foo # match and strip path to '' + /foo/ # match and strip path to '/' + /foo/bar/baz # match and strip path to '/bar/baz' + +Please note the difference between C and C. In +the first case, this is expecting to find something after C (and fails to +match if nothing is found), while in the second case we can match both C +and C. The following are roughly the same: + + sub (/foo) { 'I match /foo' }, + sub (/foo/...) { + sub (/bar) { 'I match /foo/bar' }, + sub (/*) { 'I match /foo/{id}' }, + } + +Versus + + sub (/foo...) { + sub (~) { 'I match /foo' }, + sub (/bar) { 'I match /foo/bar' }, + sub (/*) { 'I match /foo/{id}' }, + } + +You may prefer the latter example should you wish to take advantage of +subdispatchers to scope common activities. For example: + + sub (/user...) { + my $user_rs = $schema->resultset('User'); + sub (~) { $user_rs }, + sub (/*) { $user_rs->find($_[1]) }, + } + +You should note the special case path match C which is only meaningful +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 +match, so: + + sub (/*:one/*:two/*:three/*:four) { + "I match /1/2/3/4 capturing { one => 1, two => 2, three => 3, four => 4 }" + } + + sub (/**.*:allofit) { + "I match anything capturing { allofit => \$whole_path }" + } + +In the specific case of a simple single-* match, the * may be omitted, to +allow you to write: + + sub (/:one/:two/:three/:four) { + "I match /1/2/3/4 capturing { one => 1, two => 2, three => 3, four => 4 }" + } + +=head4 C and C are different specs + +As you may have noticed with the difference between C and +C, trailing slashes in path specs are significant. This is +intentional and necessary to retain the ability to use relative links on +websites. Let's demonstrate on this link: + + bar + +If the user loads the url C and clicks on this link, they will be +sent to C. However when they are on the url C and click this +link, then they will be sent to C. + +This makes it necessary to be explicit about the trailing slash. =head3 Extension matches @@ -426,14 +522,10 @@ the 'coffee' parameter. Note, in the case where you combine arrayref, single parameter and named 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 +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 @@ -572,7 +664,7 @@ Thus if you receive a POST to '/some/url' and return a redispatch to request had been made to '/other/url' 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. +rather it is a much more efficient internal process. =head1 CHANGES BETWEEN RELEASES @@ -623,6 +715,8 @@ As of 0.005, you can instead write simply: ) } +=back + =head2 Changes since Antiquated Perl =over 4 @@ -674,15 +768,37 @@ Gitweb is on http://git.shadowcat.co.uk/ and the clone URL is: =head1 AUTHOR -Matt S. Trout +Matt S. Trout (mst) =head1 CONTRIBUTORS -None required yet. Maybe this module is perfect (hahahahaha ...). +Devin Austin (dhoss) + +Arthur Axel 'fREW' Schmidt + +gregor herrmann (gregoa) + +John Napiorkowski (jnap) + +Josh McMichael + +Justin Hunter (arcanez) + +Kjetil Kjernsmo + +markie + +Christian Walde (Mithaldu) + +nperez + +Robin Edwards + +Andrew Rodland (hobbs) =head1 COPYRIGHT -Copyright (c) 2010 the Web::Simple L and L +Copyright (c) 2011 the Web::Simple L and L as listed above. =head1 LICENSE @@ -691,5 +807,3 @@ This library is free software and may be distributed under the same terms as perl itself. =cut - -1;