NAME

Path::Router - A tool for routing paths

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
      }
  ));
  
  # ... 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.

Hey, wait, this is like RoR!

Yes, this is based on Ruby on Rails ActionController::Routing::Routes, however, it has one important difference.

It is in Perl :)

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
    ));

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.

meta

DEBUGGING

This is still a relatively new module, even though it has been sitting on my drive un-used for over a year now. We are only just now using it at $work, so there still may be bugs lurking. For that very reason I have made the DEBUG flag more accessible so that you can turn on the verbose debug logging with the PATH_ROUTER_DEBUG environment variable.

And possibly help clear out some bugs lurking in the dark corners of this module.

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.little@iinteractive.com>

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.

New	1
Open	0

CPAN RT