reverting (most of) the whitespace changes
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Controller.pm
index 1e03eed..2e58312 100644 (file)
@@ -1,12 +1,48 @@
 package Catalyst::Controller;
 
-use strict;
-use base qw/Catalyst::Component Catalyst::AttrContainer Class::Accessor::Fast/;
+#switch to BEGIN { extends qw/ ... /; } ?
+use base qw/Catalyst::Component Catalyst::AttrContainer/;
+use Moose;
 
+use Scalar::Util qw/blessed/;
 use Catalyst::Exception;
 use Catalyst::Utils;
 use Class::Inspector;
-use NEXT;
+
+has path_prefix =>
+    (
+     is => 'ro',
+     isa => 'Str',
+     init_arg => 'path',
+     predicate => 'has_path_prefix',
+    );
+
+has action_namespace =>
+    (
+     is => 'ro',
+     isa => 'Str',
+     init_arg => 'namespace',
+     predicate => 'has_action_namespace',
+    );
+
+has actions =>
+    (
+     is => 'rw',
+     isa => 'HashRef',
+     init_arg => undef,
+    );
+
+# isa => 'ClassName|Catalyst' ?
+has _application => (is => 'rw');
+sub _app{ shift->_application(@_) } # eww
+
+sub BUILD {
+    my ($self, $args) = @_;
+    my $action  = delete $args->{action}  || {};
+    my $actions = delete $args->{actions} || {};
+    my $attr_value = $self->merge_config_hashes($actions, $action);
+    $self->actions($attr_value);
+}
 
 =head1 NAME
 
@@ -15,31 +51,29 @@ Catalyst::Controller - Catalyst Controller base class
 =head1 SYNOPSIS
 
   package MyApp::Controller::Search
-  use base qw/Catalyst::Controller;
+  use base qw/Catalyst::Controller/;
 
   sub foo : Local { 
-       my ($self,$c,@args) = @_;
-       ... 
+    my ($self,$c,@args) = @_;
+    ... 
   } # Dispatches to /search/foo
 
 =head1 DESCRIPTION
 
-Controllers are where the actions in the Catalyst framework reside. each
-action is represented by a function with an attribute to identify what kind
-of action it is. See the L<Catalyst::Dispatcher> for more info about how 
-Catalyst dispatches to actions.
+Controllers are where the actions in the Catalyst framework
+reside. Each action is represented by a function with an attribute to
+identify what kind of action it is. See the L<Catalyst::Dispatcher>
+for more info about how Catalyst dispatches to actions.
 
 =cut
 
+#I think both of these could be attributes. doesn't really seem like they need
+#to ble class data. i think that attributes +default would work just fine
 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class/;
 
 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
 __PACKAGE__->_action_class('Catalyst::Action');
 
-__PACKAGE__->mk_accessors( qw/_application/ );
-
-### _app as alias
-*_app = *_application;
 
 sub _DISPATCH : Private {
     my ( $self, $c ) = @_;
@@ -88,14 +122,14 @@ sub _END : Private {
     return !@{ $c->error };
 }
 
-sub new {
+around new => sub {
+    my $orig = shift;
     my $self = shift;
     my $app = $_[0];
-    my $new = $self->NEXT::new(@_);
+    my $new = $self->$orig(@_);
     $new->_application( $app );
     return $new;
-}
-
+};
 
 sub action_for {
     my ( $self, $name ) = @_;
@@ -103,38 +137,68 @@ sub action_for {
     return $app->dispatcher->get_action($name, $self->action_namespace);
 }
 
-sub action_namespace {
-    my ( $self, $c ) = @_;
-    unless ( $c ) {
-        $c = ($self->isa('Catalyst') ? $self : $self->_application);
+around action_namespace => sub {
+    my ( $orig, $self, $c ) = @_;
+
+    if( ref($self) ){
+        return $self->$orig if $self->has_action_namespace;
+    } else {
+        return $self->config->{namespace} if exists $self->config->{namespace};
     }
-    my $hash = (ref $self ? $self : $self->config); # hate app-is-class
-    return $hash->{namespace} if exists $hash->{namespace};
-    return Catalyst::Utils::class2prefix( ref($self) || $self,
-        $c->config->{case_sensitive} )
-      || '';
-}
 
-sub path_prefix {
-    my ( $self, $c ) = @_;
-    unless ( $c ) {
-        $c = ($self->isa('Catalyst') ? $self : $self->_application);
+    #the following looks like a possible target for a default setting. i am not
+    #making the below the builder because i don't know if $c will vary from
+    #call to call, which would affect case sensitivitysettings -- groditi
+    my $case_s;
+    if( $c ){
+        $case_s = $c->config->{case_sensitive};
+    } else {
+        if ($self->isa('Catalyst')) {
+            $case_s = $self->config->{case_sensitive};
+        } else {
+            if (ref $self) {
+                $case_s = $self->_application->config->{case_sensitive};
+            } else {
+                confess("Can't figure out case_sensitive setting");
+            }
+        }
     }
-    my $hash = (ref $self ? $self : $self->config); # hate app-is-class
-    return $hash->{path} if exists $hash->{path};
-    return shift->action_namespace(@_);
-}
+
+    return Catalyst::Utils::class2prefix(ref($self) || $self, $case_s) || '';
+};
+
+
+around path_prefix => sub {
+    my $orig = shift;
+    my $self = shift;
+    if( ref($self) ){
+      return $self->$orig if $self->has_path_prefix;
+    } else {
+      return $self->config->{path} if exists $self->config->{path};
+    }
+    return $self->action_namespace(@_);
+};
 
 
 sub register_actions {
     my ( $self, $c ) = @_;
     my $class = ref $self || $self;
+    #this is still not correct for some reason.
     my $namespace = $self->action_namespace($c);
     my %methods;
-    $methods{ $self->can($_) } = $_
-      for @{ Class::Inspector->methods($class) || [] };
+    if( $self->can('meta') ){
+      my $meta = $self->meta;
+      %methods = map{ $_->{code}->body => $_->{name} }
+        grep {$_->{class} ne 'Moose::Object'} #ignore Moose::Object methods
+          $meta->compute_all_applicable_methods;
+    } else { #until we are sure there's no moose stuff left...
+      $methods{ $self->can($_) } = $_
+        for @{ Class::Inspector->methods($class) || [] };
+    }
 
     # Advanced inheritance support for plugins and the like
+    #to be modified to use meta->superclasses
+    #moose todo: migrate to eliminate CDI compat
     my @action_cache;
     {
         no strict 'refs';
@@ -156,7 +220,7 @@ sub register_actions {
               if $c->debug;
             next;
         }
-        my $reverse = $namespace ? "$namespace/$method" : $method;
+        my $reverse = $namespace ? "${namespace}/${method}" : $method;
         my $action = $self->create_action(
             name       => $method,
             code       => $code,
@@ -178,10 +242,7 @@ sub create_action {
                     ? $args{attributes}{ActionClass}[0]
                     : $self->_action_class);
 
-    unless ( Class::Inspector->loaded($class) ) {
-        require Class::Inspector->filename($class);
-    }
-    
+    Class::MOP::load_class($class);
     return $class->new( \%args );
 }
 
@@ -204,15 +265,24 @@ sub _parse_attrs {
         }
     }
 
-    my $hash = (ref $self ? $self : $self->config); # hate app-is-class
-
-    if (exists $hash->{actions} || exists $hash->{action}) {
-      my $a = $hash->{actions} || $hash->{action};
-      %raw_attributes = ((exists $a->{'*'} ? %{$a->{'*'}} : ()),
-                         %raw_attributes,
-                         (exists $a->{$name} ? %{$a->{$name}} : ()));
+    #I know that the original behavior was to ignore action if actions was set
+    # but i actually think this may be a little more sane? we can always remove
+    # the merge behavior quite easily and go back to having actions have
+    # presedence over action by modifying the keys. i honestly think this is
+    # superior while mantaining really high degree of compat
+    my $actions;
+    if( ref($self) ) {
+        $actions = $self->actions;
+    } else {
+        my $cfg = $self->config;
+        $actions = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
     }
 
+    %raw_attributes = ((exists $actions->{'*'} ? %{$actions->{'*'}} : ()),
+                       %raw_attributes,
+                       (exists $actions->{$name} ? %{$actions->{$name}} : ()));
+
+
     my %final_attributes;
 
     foreach my $key (keys %raw_attributes) {
@@ -222,8 +292,8 @@ sub _parse_attrs {
         foreach my $value (ref($raw) eq 'ARRAY' ? @$raw : $raw) {
 
             my $meth = "_parse_${key}_attr";
-            if ( $self->can($meth) ) {
-                ( $key, $value ) = $self->$meth( $c, $name, $value );
+            if ( my $code = $self->can($meth) ) {
+                ( $key, $value ) = $self->$code( $c, $name, $value );
             }
             push( @{ $final_attributes{$key} }, $value );
         }
@@ -292,29 +362,25 @@ sub _parse_MyAction_attr {
     return ( 'ActionClass', $value );
 }
 
-sub _parse_PathPrefix_attr {
-    my ( $self, $c, $name, $value ) = @_;
-    return PathPart => $self->path_prefix;
-}
-
 1;
 
 __END__
 
 =head1 CONFIGURATION
 
-As any other L<Catalyst::Component>, controllers have a config 
-hash, accessable through $self->config from the controller actions.
-Some settings are in use by the Catalyst framework:
+Like any other L<Catalyst::Component>, controllers have a config hash,
+accessible through $self->config from the controller actions.  Some
+settings are in use by the Catalyst framework:
 
 =head2 namespace
 
-This spesifies the internal namespace the controller should be bound to. By default
-the controller is bound to the uri version of the controller name. For instance
-controller 'MyApp::Controller::Foo::Bar' will be bound to 'foo/bar'. The default Root 
-controller is an example of setting namespace to ''. 
+This specifies the internal namespace the controller should be bound
+to. By default the controller is bound to the URI version of the
+controller name. For instance controller 'MyApp::Controller::Foo::Bar'
+will be bound to 'foo/bar'. The default Root controller is an example
+of setting namespace to '' (the null string).
 
-=head2 prefix 
+=head2 path 
 
 Sets 'path_prefix', as described below.
 
@@ -327,36 +393,37 @@ $self->_application.
 
 =head2 $self->action_for('name')
 
-Returns the Catalyst::Action object (if any) for a given method name in
-this component.
+Returns the Catalyst::Action object (if any) for a given method name
+in this component.
 
 =head2 $self->register_actions($c)
 
-Finds all applicable actions for this component, creates Catalyst::Action
-objects (using $self->create_action) for them and registers them with
-$c->dispatcher.
+Finds all applicable actions for this component, creates
+Catalyst::Action objects (using $self->create_action) for them and
+registers them with $c->dispatcher.
 
 =head2 $self->action_namespace($c)
 
-Returns the private namespace for actions in this component. Defaults to a value
-from the controller name (for e.g. MyApp::Controller::Foo::Bar becomes
-"foo/bar") or can be overriden from the "namespace" config key.
+Returns the private namespace for actions in this component. Defaults
+to a value from the controller name (for
+e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
+overridden from the "namespace" config key.
 
 
 =head2 $self->path_prefix($c)
 
-Returns the default path prefix for :Local, :LocalRegex and relative :Path
-actions in this component. Defaults to the action_namespace or can be
-overriden from the "path" config key.
+Returns the default path prefix for :Local, :LocalRegex and relative
+:Path actions in this component. Defaults to the action_namespace or
+can be overridden from the "path" config key.
 
 =head2 $self->create_action(%args)
 
-Called with a hash of data to be use for construction of a new Catalyst::Action
-(or appropriate sub/alternative class) object.
+Called with a hash of data to be use for construction of a new
+Catalyst::Action (or appropriate sub/alternative class) object.
 
 Primarily designed for the use of register_actions.
 
-=head2 $self->_application  
+=head2 $self->_application
 
 =head2 $self->_app
 
@@ -369,7 +436,7 @@ Marcus Ramberg C<mramberg@cpan.org>
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
+This program is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
 
 =cut