/ 
Mojolicious-Plugin-ConfigRoutes-0.03
/ Mojolicious::Plugin::ConfigRoutes

ПРИВЕТСТВИЕ SALUTE

Доброго всем! Доброго здоровья! Доброго духа!

Hello all! Nice health! Good thinks!

¡ ¡ ¡ ALL GLORY TO GLORIA ! ! !

NAME

Mojolicious::Plugin::ConfigRoutes - is a Perl-ish configuration of routes plugin.

VERSION

Version 0.03

SYNOPSIS

$app->plugin(ConfigRoutes =>{...});
$app->plugin(ConfigRoutes =>[[...], [...], ..., [...],]);
...

This plugin can launch many times.

Array ref of array refs is arranged description of routes. The format is described on option routes below.

Hash ref has the following options.

OPTIONS

Mojolicious::Plugin::ConfigRoutes supports the following options.

file

$app->plugin(ConfigRoutes =>{file => 'ConfigRoutes.pm'});

File name or full path to configuration file that do (perldoc -f do) and must create list or array ref or hash ref.

  • Returned list would be consider as pairs of key=>value. Keys are namespaces and routes. Values are arranged array refs, see options below.

  • Returned hash ref with pairs of key=>value. Keys are namespaces and routes. Values are arranged array refs, see options below.

  • Returned array ref would be consider as arranged routes, see format on option routes below.

routes

Value is array ref of the arranged routes [[<route 1>],[<route 2>],...[<route N>],]:

$app->plugin(ConfigRoutes =>{routes => [[<method1 of module Mojolicious::Routes::Route> => <value>, <method2 of module Mojolicious::Routes::Route> => <value>, ... ],...]});

Methods of Mojolicious::Routes::Route as keys in one route must be strongly arranged pairs with their values in order to apply to $app->routes object. For example:

# the standard in startup
$r->bridge('/foo')->to('foo#foo')->route('/bar')->to(controller=>'bar', action=>'bar',...)->...;
$r-><next route>;
...
# becomes structure
$app->plugin(ConfigRoutes =>{routes => [[bridge=>'/foo', to=>'foo#for', route=>'/bar', to=>{controller=>'bar', action=>'bar',...}, ...], [<next route>], ...]);

Values of keys(methods) within route can be $scalar or [array ref] or {hash ref}. Array ref and hash ref are treated as lists when apply to their methods.

namespaces

Value is array ref of http://mojolicio.us/perldoc/Mojolicious/Routes#namespaces

$app->plugin(ConfigRoutes =>{namespaces => ['Foo::Bar::Controller']});

NOTE

If pointed <file> and <routes> options together then <routes> aplly first and <file> routes after.

The <namespaces> and namespaces from <file> are similar.

EXAMPLES of config file

List or hash ref allow options

(# or {
  namespaces=>['MyFoo1', 'MyFoo2'],
  routes => [
    [
      bridge=>'/my',
      to=>'Auth#user',
      route=>'/profile/:action/:user',
      to=>{controller=>'profile',},
      name=>'UserProfile',
    ],
    [,
      get=>'...',
      to=>{cb=>sub{...},},
    ],
  ],
);

Array ref - only routes

[
    [
      bridge=>'/my',
      to=>'Auth#user',
      route=>'/profile/:action/:user',
      to=>{controller=>'profile',},
      name=>'UserProfile',
    ],
    [,
      get=>'/',
      to=>{cb=>sub{...},},
    ],
];

AUTHOR

Mikhail Che, <mche [пёсик] aukama.dyndns.org>

BUGS

Please report any bugs or feature requests to bug-mojolicious-plugin-configroutes at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mojolicious-Plugin-ConfigRoutes. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Mojolicious::Plugin::ConfigRoutes

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Mikhail Che.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.