make debug output prettier with large widths

[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType / Regex.pm

diff --git a/lib/Catalyst/DispatchType/Regex.pm b/lib/Catalyst/DispatchType/Regex.pm
index 8f99f75..0d6da04 100644 (file)
--- a/lib/Catalyst/DispatchType/Regex.pm
+++ b/lib/Catalyst/DispatchType/Regex.pm
@@ -1,20 +1,90 @@
 package Catalyst::DispatchType::Regex;
 
-use strict;
-use base qw/Catalyst::DispatchType::Path/;
+use Moose;
+extends 'Catalyst::DispatchType::Path';
 
-sub prepare_action {
-    my ($self, $c, $path) = @_;
+use Text::SimpleTable;
+use Catalyst::Utils;
+use Text::Balanced ();
 
-    return if $self->SUPER::prepare_action($c, $path);
+has _compiled => (
+                  is => 'rw',
+                  isa => 'ArrayRef',
+                  required => 1,
+                  default => sub{ [] },
+                 );
 
-    foreach my $compiled (@{$self->{compiled}||[]}) {
-        if ( my @snippets = ( $path =~ $compiled->{re} ) ) {
-            $c->req->action($compiled->{path});
+no Moose;
+
+=head1 NAME
+
+Catalyst::DispatchType::Regex - Regex DispatchType
+
+=head1 SYNOPSIS
+
+See L<Catalyst::DispatchType>.
+
+=head1 DESCRIPTION
+
+Dispatch type managing path-matching behaviour using regexes.  For
+more information on dispatch types, see:
+
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect application authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
+=head1 METHODS
+
+=head2 $self->list($c)
+
+Output a table of all regex actions, and their private equivalent.
+
+=cut
+
+sub list {
+    my ( $self, $c ) = @_;
+    my $avail_width = Catalyst::Utils::term_width() - 9;
+    my $col1_width = ($avail_width * .50) < 35 ? 35 : int($avail_width * .50);
+    my $col2_width = $avail_width - $col1_width;
+    my $re = Text::SimpleTable->new(
+        [ $col1_width, 'Regex' ], [ $col2_width, 'Private' ]
+    );
+    for my $regex ( @{ $self->_compiled } ) {
+        my $action = $regex->{action};
+        $re->row( $regex->{path}, "/$action" );
+    }
+    $c->log->debug( "Loaded Regex actions:\n" . $re->draw . "\n" )
+      if ( @{ $self->_compiled } );
+}
+
+=head2 $self->match( $c, $path )
+
+Checks path against every compiled regex, and offers the action for any regex
+which matches a chance to match the request. If it succeeds, sets action,
+match and captures on $c->req and returns 1. If not, returns 0 without
+altering $c.
+
+=cut
+
+sub match {
+    my ( $self, $c, $path ) = @_;
+
+    return if $self->SUPER::match( $c, $path );
+
+    # Check path against plain text first
+
+    foreach my $compiled ( @{ $self->_compiled } ) {
+        if ( my @captures = ( $path =~ $compiled->{re} ) ) {
+            next unless $compiled->{action}->match($c);
+            $c->req->action( $compiled->{path} );
             $c->req->match($path);
-            $c->req->snippets(\@snippets);
-            $c->action($compiled->{action});
-            $c->namespace($compiled->{action}->prefix);
+            $c->req->captures( \@captures );
+            $c->action( $compiled->{action} );
+            $c->namespace( $compiled->{action}->namespace );
             return 1;
         }
     }
@@ -22,19 +92,93 @@ sub prepare_action {
     return 0;
 }
 
-sub register_action {
+=head2 $self->register( $c, $action )
+
+Registers one or more regex actions for an action object.
+Also registers them as literal paths.
+
+Returns 1 if any regexps were registered.
+
+=cut
+
+sub register {
     my ( $self, $c, $action ) = @_;
-    my $attrs = $action->attributes;
-    my @register = map { @{$_ || []} } @{$attrs}{'Regex', 'Regexp'};
+    my $attrs    = $action->attributes;
+    my @register = @{ $attrs->{'Regex'} || [] };
+
     foreach my $r (@register) {
-        $self->{paths}{$r} = $action;
-        push(@{$self->{compiled}},
-            {
-                re => qr#$r#,
-                action => $action,
-                path => $r,
-            } );
+        $self->register_path( $c, $r, $action );
+        $self->register_regex( $c, $r, $action );
     }
+
+    return 1 if @register;
+    return 0;
 }
 
+=head2 $self->register_regex($c, $re, $action)
+
+Register an individual regex on the action. Usually called from the
+register method.
+
+=cut
+
+sub register_regex {
+    my ( $self, $c, $re, $action ) = @_;
+    push(
+        @{ $self->_compiled },    # and compiled regex for us
+        {
+            re     => qr#$re#,
+            action => $action,
+            path   => $re,
+        }
+    );
+}
+
+=head2 $self->uri_for_action($action, $captures)
+
+returns a URI for this action if it can find a regex attributes that contains
+the correct number of () captures. Note that this may function incorrectly
+in the case of nested captures - if your regex does (...(..))..(..) you'll
+need to pass the first and third captures only.
+
+=cut
+
+sub uri_for_action {
+    my ( $self, $action, $captures ) = @_;
+
+    if (my $regexes = $action->attributes->{Regex}) {
+        REGEX: foreach my $orig (@$regexes) {
+            my $re = "$orig";
+            $re =~ s/^\^//;
+            $re =~ s/\$$//;
+            my $final = '/';
+            my @captures = @$captures;
+            while (my ($front, $rest) = split(/\(/, $re, 2)) {
+                last unless defined $rest;
+                ($rest, $re) =
+                    Text::Balanced::extract_bracketed("(${rest}", '(');
+                next REGEX unless @captures;
+                $final .= $front.shift(@captures);
+            }
+            $final .= $re;
+            next REGEX if @captures;
+            return $final;
+         }
+    }
+    return undef;
+}
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+This library is free software. You can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
+__PACKAGE__->meta->make_immutable;
+
 1;