From: Sebastian Riedel <sri@labs.kraih.com>
Date: Sat, 22 Oct 2005 07:32:23 +0000 (+0000)
Subject: Cleaned all new classes
X-Git-Tag: 5.7099_04~1137
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=2633d7dc3bb9c0cf7bf3e7cf936d6411fe3ba5aa

Cleaned all new classes
---

diff --git a/lib/Catalyst/ActionContainer.pm b/lib/Catalyst/ActionContainer.pm
index f3ff514..337fdf6 100644
--- a/lib/Catalyst/ActionContainer.pm
+++ b/lib/Catalyst/ActionContainer.pm
@@ -30,15 +30,6 @@ See L<Catalyst>.
 
 =item actions
 
-=item new
-
-=cut
-
-sub new {        # Dumbass constructor
-    my ( $class, $attrs ) = @_;
-    return bless { %{ $attrs || {} } }, $class;
-}
-
 =back
 
 =head1 AUTHOR
diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm
index 4adba13..f8df391 100644
--- a/lib/Catalyst/DispatchType.pm
+++ b/lib/Catalyst/DispatchType.pm
@@ -1,14 +1,46 @@
 package Catalyst::DispatchType;
 
 use strict;
+use base 'Class::Accessor::Fast';
 
-sub new {        # Dumbass constructor
-    my ( $class, $attrs ) = @_;
-    return bless { %{ $attrs || {} } }, $class;
-}
+=head1 NAME
 
-sub prepare_action { die "Abstract method!"; }
+Catalyst::DispatchType - DispatchType Base Class
 
-sub register_action { return; }
+=head1 SYNOPSIS
+
+See L<Catalyst>.
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=over 4
+
+=item $self->match( $c, $path )
+
+=cut
+
+sub match { die "Abstract method!" }
+
+=item $self->register( $c, $action )
+
+=cut
+
+sub register { return }
+
+=back
+
+=head1 AUTHOR
+
+Matt S Trout
+Sebastian Riedel, C<sri@cpan.org>
+
+=head1 COPYRIGHT
+
+This program is free software, you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
 
 1;
diff --git a/lib/Catalyst/DispatchType/Default.pm b/lib/Catalyst/DispatchType/Default.pm
index ab9de5e..ff1f83e 100644
--- a/lib/Catalyst/DispatchType/Default.pm
+++ b/lib/Catalyst/DispatchType/Default.pm
@@ -3,7 +3,25 @@ package Catalyst::DispatchType::Default;
 use strict;
 use base qw/Catalyst::DispatchType/;
 
-sub prepare_action {
+=head1 NAME
+
+Catalyst::DispatchType::Default - Default DispatchType
+
+=head1 SYNOPSIS
+
+See L<Catalyst>.
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=over 4
+
+=item $self->match( $c, $path )
+
+=cut
+
+sub match {
     my ( $self, $c, $path ) = @_;
     return if $path =~ m!/!;    # Not at root yet, wait for it ...
     my $result = @{ $c->get_action( 'default', $c->req->path, 1 ) || [] }[-1];
@@ -19,4 +37,18 @@ sub prepare_action {
     return 0;
 }
 
+=back
+
+=head1 AUTHOR
+
+Matt S Trout
+Sebastian Riedel, C<sri@cpan.org>
+
+=head1 COPYRIGHT
+
+This program is free software, you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
 1;
diff --git a/lib/Catalyst/DispatchType/Path.pm b/lib/Catalyst/DispatchType/Path.pm
index 7f291db..454f87c 100644
--- a/lib/Catalyst/DispatchType/Path.pm
+++ b/lib/Catalyst/DispatchType/Path.pm
@@ -3,40 +3,63 @@ package Catalyst::DispatchType::Path;
 use strict;
 use base qw/Catalyst::DispatchType/;
 
-sub prepare_action {
-    my ($self, $c, $path) = @_;
+=head1 NAME
+
+Catalyst::DispatchType::Path - Path DispatchType
+
+=head1 SYNOPSIS
+
+See L<Catalyst>.
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=over 4
+
+=item $self->match( $c, $path )
+
+=cut
+
+sub match {
+    my ( $self, $c, $path ) = @_;
 
     if ( my $action = $self->{paths}->{$path} ) {
         $c->req->action($path);
         $c->req->match($path);
         $c->action($action);
-        $c->namespace($action->prefix);
+        $c->namespace( $action->prefix );
         return 1;
     }
 
     return 0;
 }
 
-sub register_action {
+=item $self->register( $c, $action )
+
+=cut
+
+sub register {
     my ( $self, $c, $action ) = @_;
 
     my $attrs = $action->attributes;
     my @register;
 
-    foreach my $r (@{$attrs->{Path} || []}) {
-        unless ($r =~ m!^/!) {    # It's a relative path
-            $r = $action->prefix."/$r";
+    foreach my $r ( @{ $attrs->{Path} || [] } ) {
+        unless ( $r =~ m!^/! ) {    # It's a relative path
+            $r = $action->prefix . "/$r";
         }
-        push(@register, $r);
+        push( @register, $r );
     }
 
-    if ($attrs->{Global} || $attrs->{Absolute}) {
-        push(@register, $action->name); # Register sub name against root
+    if ( $attrs->{Global} || $attrs->{Absolute} ) {
+        push( @register, $action->name );    # Register sub name against root
     }
 
-    if ($attrs->{Local} || $attrs->{Relative}) {
-        push(@register, join('/', $action->prefix, $action->name));
-            # Register sub name as a relative path
+    if ( $attrs->{Local} || $attrs->{Relative} ) {
+        push( @register, join( '/', $action->prefix, $action->name ) );
+
+        # Register sub name as a relative path
     }
 
     foreach my $r (@register) {
@@ -45,4 +68,18 @@ sub register_action {
     }
 }
 
+=back
+
+=head1 AUTHOR
+
+Matt S Trout
+Sebastian Riedel, C<sri@cpan.org>
+
+=head1 COPYRIGHT
+
+This program is free software, you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
 1;
diff --git a/lib/Catalyst/DispatchType/Regex.pm b/lib/Catalyst/DispatchType/Regex.pm
index 0d639b1..c373d2f 100644
--- a/lib/Catalyst/DispatchType/Regex.pm
+++ b/lib/Catalyst/DispatchType/Regex.pm
@@ -3,19 +3,38 @@ package Catalyst::DispatchType::Regex;
 use strict;
 use base qw/Catalyst::DispatchType::Path/;
 
-sub prepare_action {
-    my ($self, $c, $path) = @_;
+=head1 NAME
 
-    return if $self->SUPER::prepare_action($c, $path);
-        # Check path against plain text first
+Catalyst::DispatchType::Regex - Regex DispatchType
 
-    foreach my $compiled (@{$self->{compiled}||[]}) {
+=head1 SYNOPSIS
+
+See L<Catalyst>.
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=over 4
+
+=item $self->match( $c, $path )
+
+=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 @snippets = ( $path =~ $compiled->{re} ) ) {
-            $c->req->action($compiled->{path});
+            $c->req->action( $compiled->{path} );
             $c->req->match($path);
-            $c->req->snippets(\@snippets);
-            $c->action($compiled->{action});
-            $c->namespace($compiled->{action}->prefix);
+            $c->req->snippets( \@snippets );
+            $c->action( $compiled->{action} );
+            $c->namespace( $compiled->{action}->prefix );
             return 1;
         }
     }
@@ -23,19 +42,39 @@ sub prepare_action {
     return 0;
 }
 
-sub register_action {
+=item $self->register( $c, $action )
+
+=cut
+
+sub register {
     my ( $self, $c, $action ) = @_;
     my $attrs = $action->attributes;
-    my @register = map { @{$_ || []} } @{$attrs}{'Regex', 'Regexp'};
+    my @register = map { @{ $_ || [] } } @{$attrs}{ 'Regex', 'Regexp' };
     foreach my $r (@register) {
-        $self->{paths}{$r} = $action; # Register path for superclass
-        push(@{$self->{compiled}},    # and compiled regex for us
+        $self->{paths}{$r} = $action;    # Register path for superclass
+        push(
+            @{ $self->{compiled} },      # and compiled regex for us
             {
-                re => qr#$r#,
+                re     => qr#$r#,
                 action => $action,
-                path => $r,
-            } );
+                path   => $r,
+            }
+        );
     }
 }
 
+=back
+
+=head1 AUTHOR
+
+Matt S Trout
+Sebastian Riedel, C<sri@cpan.org>
+
+=head1 COPYRIGHT
+
+This program is free software, you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
 1;
diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm
index e143b00..96793fa 100644
--- a/lib/Catalyst/Dispatcher.pm
+++ b/lib/Catalyst/Dispatcher.pm
@@ -229,7 +229,7 @@ sub prepare_action {
         # this level
 
         foreach my $type ( @{ $self->dispatch_types } ) {
-            last DESCEND if $type->prepare_action( $c, $path );
+            last DESCEND if $type->match( $c, $path );
         }
 
         # If not, move the last part path to args
@@ -382,7 +382,7 @@ sub set_action {
 
     # Pass the action to our dispatch types so they can register it if reqd.
     foreach my $type ( @{ $self->dispatch_types } ) {
-        $type->register_action( $c, $action );
+        $type->register( $c, $action );
     }
 }