meta-updates related to 0.16 release
[catagits/Catalyst-Model-DBIC-Schema.git] / lib / Catalyst / Model / DBIC / Schema.pm
index b0e8ac8..1c1f36c 100644 (file)
@@ -5,9 +5,10 @@ use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
 use NEXT;
 use UNIVERSAL::require;
 use Carp;
+use Data::Dumper;
 require DBIx::Class;
 
-our $VERSION = '0.13';
+our $VERSION = '0.16';
 
 __PACKAGE__->mk_classaccessor('composed_schema');
 __PACKAGE__->mk_accessors('schema');
@@ -38,20 +39,20 @@ Actor in MyApp/Schema/FilmDB/Actor.pm:
 
   package MyApp::Schema::FilmDB::Actor;
   use base qw/DBIx::Class/
-  
+
   __PACKAGE__->load_components(qw/Core/);
   __PACKAGE__->table('actor');
-  
+
   ...
 
 and a Role in MyApp/Schema/Role.pm:
 
   package MyApp::Schema::FilmDB::Role;
   use base qw/DBIx::Class/
-  
+
   __PACKAGE__->load_components(qw/Core/);
   __PACKAGE__->table('role');
-  
+
   ...    
 
 Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's 
@@ -64,7 +65,7 @@ MyApp/Model/FilmDB.pm:
 
   package MyApp::Model::FilmDB;
   use base qw/Catalyst::Model::DBIC::Schema/;
-  
+
   __PACKAGE__->config(
       schema_class => 'MyApp::Schema::FilmDB',
       connect_info => [
@@ -88,11 +89,11 @@ You can also use it to set up DBIC authentication with
 Authentication::Store::DBIC in MyApp.pm:
 
   package MyApp;
-  
+
   use Catalyst qw/... Authentication::Store::DBIC/;
-  
+
   ...
-  
+
   __PACKAGE__->config->{authentication}{dbic} = {
       user_class      => 'FilmDB::Actor',
       user_field      => 'name',
@@ -106,42 +107,39 @@ documentation in the L<DBIx::Class> distribution.
 
 Some examples are given below:
 
-    # to access schema methods directly:
-    $c->model('FilmDB')->schema->source(...);
+  # to access schema methods directly:
+  $c->model('FilmDB')->schema->source(...);
 
-    # to access the source object, resultset, and class:
-    $c->model('FilmDB')->source(...);
-    $c->model('FilmDB')->resultset(...);
-    $c->model('FilmDB')->class(...);
+  # to access the source object, resultset, and class:
+  $c->model('FilmDB')->source(...);
+  $c->model('FilmDB')->resultset(...);
+  $c->model('FilmDB')->class(...);
 
-    # For resultsets, there's an even quicker shortcut:
-    $c->model('FilmDB::Actor')
-    # is the same as $c->model('FilmDB')->resultset('Actor')
+  # For resultsets, there's an even quicker shortcut:
+  $c->model('FilmDB::Actor')
+  # is the same as $c->model('FilmDB')->resultset('Actor')
 
-    # To get the composed schema for making new connections:
-    my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
+  # To get the composed schema for making new connections:
+  my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
 
-    # Or the same thing via a convenience shortcut:
-    my $newconn = $c->model('FilmDB')->connect(...);
+  # Or the same thing via a convenience shortcut:
+  my $newconn = $c->model('FilmDB')->connect(...);
 
-    # or, if your schema works on different storage drivers:
-    my $newconn = $c->model('FilmDB')->composed_schema->clone();
-    $newconn->storage_type('::LDAP');
-    $newconn->connection(...);
+  # or, if your schema works on different storage drivers:
+  my $newconn = $c->model('FilmDB')->composed_schema->clone();
+  $newconn->storage_type('::LDAP');
+  $newconn->connection(...);
 
-    # and again, a convenience shortcut
-    my $newconn = $c->model('FilmDB')->clone();
-    $newconn->storage_type('::LDAP');
-    $newconn->connection(...);
+  # and again, a convenience shortcut
+  my $newconn = $c->model('FilmDB')->clone();
+  $newconn->storage_type('::LDAP');
+  $newconn->connection(...);
 
 =head1 DESCRIPTION
 
 This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.  See
-the documentation for L<Catalyst::Helper::Model::DBIC::Schema> and
-L<Catalyst::Helper::Model::DBIC::SchemaLoader> for information
-on generating these Models via Helper scripts.  The latter of the two
-will also generated a L<DBIx::Class::Schema::Loader>-based Schema class
-for you.
+the documentation for L<Catalyst::Helper::Model::DBIC::Schema> for
+information on generating these Models via Helper scripts.
 
 =head1 CONFIG PARAMETERS
 
@@ -173,29 +171,29 @@ specify these options.  You would know it if you needed them.
 
 Examples:
 
-    connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
-
-    connect_info => [
-                      'dbi:SQLite:dbname=foo.db',
-                      {
-                        on_connect_do => [
-                          'PRAGMA synchronous = OFF',
-                        ],
-                      }
-                    ],
-
-    connect_info => [
-                      'dbi:Pg:dbname=mypgdb',
-                      'postgres',
-                      '',
-                      { AutoCommit => 0 },
-                      {
-                        on_connect_do => [
-                          'some SQL statement',
-                          'another SQL statement',
-                        ],
-                      }
-                    ],
+  connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
+
+  connect_info => [
+                    'dbi:SQLite:dbname=foo.db',
+                    {
+                      on_connect_do => [
+                        'PRAGMA synchronous = OFF',
+                      ],
+                    }
+                  ],
+
+  connect_info => [
+                    'dbi:Pg:dbname=mypgdb',
+                    'postgres',
+                    '',
+                    { AutoCommit => 0 },
+                    {
+                      on_connect_do => [
+                        'some SQL statement',
+                        'another SQL statement',
+                      ],
+                    }
+                  ],
 
 =item storage_type
 
@@ -280,7 +278,9 @@ sub new {
         }
         else {
             croak "Either ->config->{connect_info} must be defined for $class"
-                  . " or $schema_class must have connect info defined on it";
+                  . " or $schema_class must have connect info defined on it"
+                 . "Here's what we got:\n"
+                 . Dumper($self);
         }
     }
 
@@ -358,8 +358,7 @@ L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
 Stuff related to DBIC and this Model style:
 
 L<DBIx::Class>, L<DBIx::Class::Schema>,
-L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
-L<Catalyst::Helper::Model::DBIC::SchemaLoader>
+L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>
 
 =head1 AUTHOR