File Coverage

blib/lib/Mojolicious/Plugin/ConfigRoutes.pm

Criterion	Covered	Total	%
statement	6	43	13.9
branch	0	32	0.0
condition	0	6	0.0
subroutine	2	3	66.6
pod	1	1	100.0
total	9	85	10.5

package Mojolicious::Plugin::ConfigRoutes;
use Mojo::Base 'Mojolicious::Plugin';

use File::Spec::Functions 'file_name_is_absolute';

our $VERSION=0.04;

sub register {
  my ($self, $app, $conf) = @_;
  my $r = $app->routes;# Router

  my @routes;
  if (ref($conf) eq 'HASH') {
	if ($conf->{'file'}) {
		$conf->{file} = $app->home->rel_file($conf->{file}) unless file_name_is_absolute $conf->{file};
		my @do;
		if (-e $conf->{file}) {@do = do $conf->{file};}
		else {die qq{Config routes file [$conf->{file}] missing, maybe you need to create it?\n};}
		my $do = {@do} if @do > 1; # вернулся список, тогда ключ=>значение
		$do = $do[0] if @do == 1;

		if (ref($do) eq 'HASH') {
			push @{$conf->{namespaces}}, @{$do->{namespaces}} if $do->{namespaces} && ref($do->{namespaces}) eq 'ARRAY';# общее переключение папка с контроллерами маршрутов
			push @{$conf->{routes}}, @{$do->{routes}} if $do->{routes} && ref($do->{routes}) eq 'ARRAY';
		} elsif (ref($do) eq 'ARRAY') {# просто маршруты [...]
			push @{$conf->{routes}}, @$do;
		}
	}
	if ($conf->{routes}) {
		push @routes, @{$conf->{routes}};
	}
	push @{$r->namespaces}, @{$conf->{namespaces}} if $conf->{namespaces};

  } elsif (ref($conf) eq 'ARRAY') {
	push @routes, @$conf;
  }


  for my $t (@routes) {
    my $_r = $r;# будет цепочка объектов для маршрута
    for( my $i = 0; $i < @$t; $i += 2 ) {
      my $m = $t->[$i]; # method
      my $a = $t->[$i+1];# args to meth
      if (my $meth = $_r->can($m)) {
        #!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! НЕЛЬЗЯ ИСПОЛЬЗОВАТЬ $_r!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
        #~ $app->log->debug("Apply method for $_r->$m(", (map {"\t'".join("' => '", grep {defined;} @$a[($_*2)..($_*2+1)])."',"} (0..($#$a/2))), ")",);#$app->dumper($a),
        $_r = $_r->$meth(ref($a) ? (ref($a) eq 'ARRAY' ? @$a : %$a) : $a);# apply method
      } else {
        $app->log->warn("Can't method [$m] for [$_r]",);#, will be applied as attr
      }
    }
  }

  $app->log->debug("Маршруты: ", $app->dumper($r));
}


=encoding utf8

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

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

Hello all! Nice health! Good thinks!

¡ ¡ ¡ ALL GLORY TO GLORIA ! ! !

=head1 NAME

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

=head1 VERSION

Version 0.03

=head1 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.

=head1 OPTIONS

L supports the following options.

=head2 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.

=over 4

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

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

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

=back

=head2 routes

Value is array ref of the arranged routes [[],[],...[],]:

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

Methods of L 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->;
    ...
    # becomes structure
    $app->plugin(ConfigRoutes =>{routes => [[bridge=>'/foo', to=>'foo#for', route=>'/bar', to=>{controller=>'bar', action=>'bar',...}, ...], [], ...]);


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.

=head2 namespaces

Value is array ref of L

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


=head1 NOTE

If pointed  and  options together then  aplly first and  routes after.

The  and namespaces from  are similar.

=head1 EXAMPLES of config file

=head2 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{...},},
        ],
      ],
    );

=head2 Array ref - only routes

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

=head1 AUTHOR

Mikhail Che, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.


=head1 SUPPORT

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

    perldoc Mojolicious::Plugin::ConfigRoutes


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 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:

L

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.


=cut



1;