minor docs update, use connection not connect after manually cloning from composed_schema
[catagits/Catalyst-Model-DBIC-Schema.git] / lib / Catalyst / Model / DBIC / Schema.pm
index 83833c9..789a11d 100644 (file)
@@ -1,14 +1,14 @@
 package Catalyst::Model::DBIC::Schema;
 
 use strict;
-use base qw/Catalyst::Base Class::Accessor::Fast Class::Data::Accessor/;
+use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
 use NEXT;
 use UNIVERSAL::require;
 use Carp;
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
-__PACKAGE__->mk_classdata('composed_schema');
+__PACKAGE__->mk_classaccessor('composed_schema');
 __PACKAGE__->mk_accessors('schema');
 
 =head1 NAME
@@ -55,12 +55,12 @@ Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
     # or, if your schema works on different storage drivers:
     my $newconn = $c->model('Foo')->composed_schema->clone();
     $newconn->storage_type('::LDAP');
-    $newconn->connect(...);
+    $newconn->connection(...);
 
     # and again, a convenience shortcut
     my $newconn = $c->model('Foo')->clone();
     $newconn->storage_type('::LDAP');
-    $newconn->connect(...);
+    $newconn->connection(...);
 
 =head1 DESCRIPTION
 
@@ -74,7 +74,7 @@ This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.
 
 This is the classname of your L<DBIx::Class::Schema> Schema.  It needs
 to be findable in C<@INC>, but it does not need to be underneath
-C<Catalyst::Model::>.
+C<Catalyst::Model::>.  This parameter is required.
 
 =item connect_info
 
@@ -83,6 +83,10 @@ C<storage_type>.  For C<::DBI>, which is the only supported C<storage_type>
 in L<DBIx::Class> at the time of this writing, the 4 parameters are your
 dsn, username, password, and connect options hashref.
 
+This is not required if C<schema_class> already has connection information
+defined in itself (which would be the case for a Schema defined by
+L<DBIx::Class::Schema::Loader>, for instance).
+
 =item storage_type
 
 Allows the use of a different C<storage_type> than what is set in your
@@ -99,6 +103,9 @@ people, until other storage backends become available for L<DBIx::Class>.
 =item new
 
 Instantiates the Model based on the above-documented ->config parameters.
+The only required parameter is C<schema_class>.  C<connect_info> is
+required in the case that C<schema_class> does not already have connection
+information defined for it.
 
 =item schema
 
@@ -138,27 +145,34 @@ Shortcut for ->schema->resultset
 =cut
 
 sub new {
-    my ( $self, $c ) = @_;
-    $self = $self->NEXT::new($c);
+    my $self = shift->NEXT::new(@_);
     
     my $class = ref($self);
     my $model_name = $class;
     $model_name =~ s/^[\w:]+::(?:Model|M):://;
 
-    foreach (qw/ connect_info schema_class /) {
-        croak "->config->{$_} must be defined for this model"
-            unless $self->{$_};
-    }
+    croak "->config->{schema_class} must be defined for this model"
+        unless $self->{schema_class};
 
     my $schema_class = $self->{schema_class};
 
     $schema_class->require
         or croak "Cannot load schema class '$schema_class': $@";
 
+    if( !$self->{connect_info} ) {
+        if($schema_class->storage && $schema_class->storage->connect_info) {
+            $self->{connect_info} = $schema_class->storage->connect_info;
+        }
+        else {
+            croak "Either ->config->{connect_info} must be defined for $class"
+                  . " or $schema_class must have connection defined on it";
+        }
+    }
+
     $self->composed_schema($schema_class->compose_namespace($class));
     $self->schema($self->composed_schema->clone);
     $self->schema->storage_type($self->{storage_type}) if $self->{storage_type};
-    $self->schema->connect(@{$self->{connect_info}});
+    $self->schema->connection(@{$self->{connect_info}});
 
     no strict 'refs';
     foreach my $moniker ($self->schema->sources) {
@@ -171,10 +185,8 @@ sub new {
     return $self;
 }
 
-# convenience method
 sub clone { shift->composed_schema->clone(@_); }
 
-# convenience method
 sub connect { shift->composed_schema->connect(@_); }
 
 =head1 SEE ALSO