- Move config stuff etc. out into Catalyst::Component; Catalyst::Base for things...
Matt S Trout [Wed, 2 Nov 2005 01:20:09 +0000 (01:20 +0000)]
lib/Catalyst/Base.pm
lib/Catalyst/Component.pm [new file with mode: 0644]
lib/Catalyst/Dispatcher.pm

index c7d21f6..f667fea 100644 (file)
@@ -1,14 +1,14 @@
 package Catalyst::Base;
 
 use strict;
-use base qw/Catalyst::AttrContainer Class::Accessor::Fast/;
+use base qw/Catalyst::Component Catalyst::AttrContainer Class::Accessor::Fast/;
 
 use Catalyst::Exception;
 use Catalyst::Utils;
 use Class::Inspector;
 use NEXT;
 
-__PACKAGE__->mk_classdata($_) for qw/_config _dispatch_steps/;
+__PACKAGE__->mk_classdata($_) for qw/_dispatch_steps/;
 
 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
 
@@ -115,95 +115,18 @@ sub _parse_attrs {
 
 =head1 NAME
 
-Catalyst::Base - Catalyst Universal Base Class
+Catalyst::Base - Catalyst Controller Base Class
 
 =head1 SYNOPSIS
 
-    # lib/MyApp/Model/Something.pm
-    package MyApp::Model::Something;
-
-    use base 'Catalyst::Base';
-
-    __PACKAGE__->config( foo => 'bar' );
-
-    sub test {
-        my $self = shift;
-        return $self->{foo};
-    }
-
-    sub forward_to_me {
-        my ( $self, $c ) = @_;
-        $c->response->output( $self->{foo} );
-    }
-    
-    1;
-
-    # Methods can be a request step
-    $c->forward(qw/MyApp::Model::Something forward_to_me/);
-
-    # Or just methods
-    print $c->comp('MyApp::Model::Something')->test;
-
-    print $c->comp('MyApp::Model::Something')->{foo};
 
 =head1 DESCRIPTION
 
-This is the universal base class for Catalyst components
-(Model/View/Controller).
-
-It provides you with a generic new() for instantiation through Catalyst's
-component loader with config() support and a process() method placeholder.
 
 =head1 METHODS
 
 =over 4
 
-=item new($c)
-
-=cut
-
-sub new {
-    my ( $self, $c ) = @_;
-
-    # Temporary fix, some components does not pass context to constructor
-    my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
-
-    return $self->NEXT::new( { %{ $self->config }, %{$arguments} } );
-}
-
-# remember to leave blank lines between the consecutive =item's
-# otherwise the pod tools don't recognize the subsequent =items
-
-=item $c->config
-
-=item $c->config($hashref)
-
-=item $c->config($key, $value, ...)
-
-=cut
-
-sub config {
-    my $self = shift;
-    $self->_config( {} ) unless $self->_config;
-    if (@_) {
-        my $config = @_ > 1 ? {@_} : $_[0];
-        while ( my ( $key, $val ) = each %$config ) {
-            $self->_config->{$key} = $val;
-        }
-    }
-    return $self->_config;
-}
-
-=item $c->process()
-
-=cut
-
-sub process {
-
-    Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] )
-          . " did not override Catalyst::Base::process" );
-}
-
 =back
 
 =head1 SEE ALSO
diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm
new file mode 100644 (file)
index 0000000..097af41
--- /dev/null
@@ -0,0 +1,119 @@
+package Catalyst::Component;
+
+use strict;
+use base qw/Class::Data::Inheritable/;
+use NEXT;
+
+__PACKAGE__->mk_classdata($_) for qw/_config/;
+
+=head1 NAME
+
+Catalyst::Component - Catalyst Component Base Class
+
+=head1 SYNOPSIS
+
+    # lib/MyApp/Model/Something.pm
+    package MyApp::Model::Something;
+
+    use base 'Catalyst::Base';
+
+    __PACKAGE__->config( foo => 'bar' );
+
+    sub test {
+        my $self = shift;
+        return $self->{foo};
+    }
+
+    sub forward_to_me {
+        my ( $self, $c ) = @_;
+        $c->response->output( $self->{foo} );
+    }
+    
+    1;
+
+    # Methods can be a request step
+    $c->forward(qw/MyApp::Model::Something forward_to_me/);
+
+    # Or just methods
+    print $c->comp('MyApp::Model::Something')->test;
+
+    print $c->comp('MyApp::Model::Something')->{foo};
+
+=head1 DESCRIPTION
+
+This is the universal base class for Catalyst components
+(Model/View/Controller).
+
+It provides you with a generic new() for instantiation through Catalyst's
+component loader with config() support and a process() method placeholder.
+
+=head1 METHODS
+
+=over 4
+
+=item new($c)
+
+=cut
+
+sub new {
+    my ( $self, $c ) = @_;
+
+    # Temporary fix, some components does not pass context to constructor
+    my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
+
+    return $self->NEXT::new( { %{ $self->config }, %{$arguments} } );
+}
+
+# remember to leave blank lines between the consecutive =item's
+# otherwise the pod tools don't recognize the subsequent =items
+
+=item $c->config
+
+=item $c->config($hashref)
+
+=item $c->config($key, $value, ...)
+
+=cut
+
+sub config {
+    my $self = shift;
+    $self->_config( {} ) unless $self->_config;
+    if (@_) {
+        my $config = @_ > 1 ? {@_} : $_[0];
+        while ( my ( $key, $val ) = each %$config ) {
+            $self->_config->{$key} = $val;
+        }
+    }
+    return $self->_config;
+}
+
+=item $c->process()
+
+=cut
+
+sub process {
+
+    Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] )
+          . " did not override Catalyst::Component::process" );
+}
+
+=back
+
+=head1 SEE ALSO
+
+L<Catalyst>.
+
+=head1 AUTHOR
+
+Sebastian Riedel, C<sri@cpan.org>
+Marcus Ramberg, C<mramberg@cpan.org>
+Matt S Trout, C<mst@shadowcatsystems.co.uk>
+
+=head1 COPYRIGHT
+
+This program is free software, you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
+1;
index 5d92eb2..851a3b0 100644 (file)
@@ -393,6 +393,7 @@ sub setup_actions {
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>
+Matt S Trout, C<mst@shadowcatsystems.co.uk>
 
 =head1 COPYRIGHT