File Coverage

blib/lib/Mojolicious/Plugin/AutoRoute.pm

Criterion	Covered	Total	%
statement	30	31	96.7
branch	6	8	75.0
condition	4	5	80.0
subroutine	5	5	100.0
pod	1	1	100.0
total	46	50	92.0

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

use File::Find 'find';

our $VERSION = '0.23';

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;

    # Mojolicious compatibility
    my $any_method_name;
    if ($Mojolicious::VERSION >= '8.67') {
      $any_method_name = 'any'
    }
    else {
      $any_method_name = 'route'
    }

    # Route
    $r->$any_method_name("/$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.

If you put templates into C directory,
the corresponding routes is created automatically.

For example:

  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

I like PHP simplicity. All thing needed is that you put PHP files into some directory,
and write program. You don't need to create routes manually.

This plugin gives PHP simplicity to L.

=head1 EXAMPLE

  use Mojolicious::Lite;

  # AutoRoute
  plugin 'AutoRoute';

  # Custom routes
  get '/create/:id' => sub { shift->render_maybe('/create') };

  app->start;

  __DATA__

  @@ 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