NAME

Path::Router - A tool for routing paths

VERSION

version 0.15

SYNOPSIS

  my $router = Path::Router->new;
  $router->add_route('blog' => (
      defaults => {
          controller => 'blog',
          action     => 'index',
      },
      # you can provide a fixed "target"
      # for a match as well, this can be
      # anything you want it to be ...
      target => My::App->get_controller('blog')->get_action('index')
  ));
  $router->add_route('blog/:year/:month/:day' => (
      defaults => {
          controller => 'blog',
          action     => 'show_date',
      },
      # validate with ...
      validations => {
          # ... raw-Regexp refs
          year       => qr/\d{4}/,
          # ... custom Moose types you created
          month      => 'NumericMonth',
          # ... Moose anon-subtypes created inline
          day        => subtype('Int' => where { $_ <= 31 }),
      }
  ));
  $router->add_route('blog/:action/?:id' => (
      defaults => {
          controller => 'blog',
      },
      validations => {
          action  => qr/\D+/,
          id      => 'Int',  # also use plain Moose types too
      }
  ));
  # even include other routers
  $router->include_router( 'polls/' => $another_router );
  # ... in your dispatcher
  # returns a Path::Router::Route::Match object
  my $match = $router->match('/blog/edit/15');
  # ... in your code
  my $uri = $router->uri_for(
      controller => 'blog',
      action     => 'show_date',
      year       => 2006,
      month      => 10,
      day        => 5,
  );

DESCRIPTION

This module provides a way of deconstructing paths into parameters suitable for dispatching on. It also provides the inverse in that it will take a list of parameters, and construct an appropriate uri for it.

Reversable

This module places a high degree of importance on reversability. The value produced by a path match can be passed back in and you will get the same path you originally put in. The result of this is that it removes ambiguity and therefore reduces the number of possible mis-routings.

Verifyable

This module also provides additional tools you can use to test and verify the integrity of your router. These include:

An interactive shell in which you can test various paths and see the match it will return, and also test the reversability of that match.
A Test::Path::Router module which can be used in your applications test suite to easily verify the integrity of your paths.

METHODS

new

add_route ($path, ?%options)

Adds a new route to the end of the routes list.

insert_route ($path, %options)

Adds a new route to the routes list. You may specify an "at" parameter, which would indicate the position where you want to insert your newly created route. The "at" parameter is the "index" position in the list, so it starts at 0.

Examples:

    # You have more than three paths, insert a new route at
    # the 4th item
    $router->insert_route($path => (
        at => 3, %options
    ));
    # If you have less items than the index, then it's the same as
    # as add_route -- it's just appended to the end of the list
    $router->insert_route($path => (
        at => 1_000_000, %options
    ));
    # If you want to prepend, omit "at", or specify 0
    $router->insert_Route($path => (
        at => 0, %options
    ));

include_router ( $path, $other_router )

These extracts all the route from $other_router and includes them into the invocant router and prepends $path to all their paths.

It should be noted that this does not do any kind of redispatch to the $other_router, it actually extracts all the paths from $other_router and inserts them into the invocant router. This means any changes to $other_router after inclusion will not be reflected in the invocant.

routes

match ($path)

Return a Path::Router::Route::Match object for the first route that matches the given $path, or "undef" if no routes match.

uri_for (%path_descriptor)

Find the path that, when passed to "$router->match", would produce the given arguments. Returns the path without any leading "/". Returns "undef" if no routes match.

route_class ($classname)

The class to use for routes. Defaults to Path::Router::Route.

meta

DEBUGGING

You can turn on the verbose debug logging with the "PATH_ROUTER_DEBUG" environment variable.

BUGS

All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT.

AUTHOR

Stevan Little <stevan@cpan.org>

COPYRIGHT AND LICENSE

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Stevan Little <stevan@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2021-01-08

perl v5.32.0