File Coverage

blib/lib/Mojolicious/Plugin/AutoRoute.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch	5	6	83.3
condition	4	5	80.0
subroutine	5	5	100.0
pod	1	1	100.0
total	42	44	95.4

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

use File::Find 'find';

our $VERSION = '0.21';

sub register {
  my ($self, $app, $conf) = @_;

  # Parent route
  my $r = $conf->{route} || $app->routes;

  # Template Base
  my $template_base_dirs = $app->renderer->paths;

  # Top directory
  my $top_dir = $conf->{top_dir} || 'auto';
  $top_dir =~ s#^/##;
  $top_dir =~ s#/$##;

  # Search templates
  my @templates;
  for my $template_base_dir (@$template_base_dirs) {
    $template_base_dir =~ s#/$##;
    my $template_dir = "$template_base_dir/$top_dir";

    if (-d $template_dir) {
      # Find templates
      find(sub {
        my $template_abs = $File::Find::name;
        my $template = $template_abs;
        $template =~ s/\Q$template_dir\///;

        if ($template =~ s/\.html\.ep$//) {
          push @templates, $template;
        }
      }, $template_dir);
    }
  }

  # Register routes
  for my $template (@templates) {
    my $route_path = $template eq 'index' ? '/' : $template;

    # Route
    $r->route("/$route_path")
      ->to(cb => sub { shift->render("/$top_dir/$template", 'mojo.maybe' => 1) });
  }
}

1;

=head1 NAME

Mojolicious::Plugin::AutoRoute - Mojolicious Plugin to create routes automatically

=head1 SYNOPSIS

  # Mojolicious
  $self->plugin('AutoRoute');

  # Mojolicious::Lite
  plugin 'AutoRoute';

  # With option
  plugin 'AutoRoute', route => $r;

=head1 DESCRIPTION

L is a L plugin
to create routes automatically.

Routes corresponding to URL is created .

  TEMPLATES                           ROUTES
  templates/auto/index.html.ep        # /
                /foo.html.ep          # /foo
                /foo/bar.html.ep      # /foo/bar
                /foo/bar/baz.html.ep  # /foo/bar/baz

If you like C, this plugin is very good.
You only put file into C directory.

=head1 EXAMPLE

  use Mojolicious::Lite;
  use Mojolicious::Plugin::AutoRoute::Util 'template';

  # AutoRoute
  plugin 'AutoRoute';

  # Custom routes
  get '/create/:id' => template '/create';

  @@ auto/index.html.ep
  /

  @@ auto/foo.html.ep
  /foo

  @@ auto/bar.html.ep
  /bar

  @@ auto/foo/bar/baz.html.ep
  /foo/bar/baz

  @@ auto/json.html.ep
  <%
    $self->render(json => {foo => 1});
    return;
  %>

  @@ create.html.ep
  /create/<%= $id %>

=head1 OPTIONS

=head2 route

  route => $route;

You can set parent route if you need.
This is L object.
Default is C<$app->routes>.

=head2 top_dir

  top_dir => 'myauto'

Top directory. default is C.

=head1 TIPS

If you want to create custom route, use C method.

  # Mojolicious Lite
  any '/foo' => sub { shift->render_maybe('/foo') };

  # Mojolicious
  $r->any('/foo' => sub { shift->render_maybe('/foo') };

For backwrod comaptible, you can use C