release for 0.07, ->require and connect_info args stuff
[catagits/Catalyst-Model-DBIC-Schema.git] / lib / Catalyst / Helper / Model / DBIC / SchemaLoader.pm
index 87ab7ef..9cf27ab 100644 (file)
@@ -1,4 +1,4 @@
-package Catalyst::Helper::Model::DBIC::SchemaInlineLoader;
+package Catalyst::Helper::Model::DBIC::SchemaLoader;
 
 use strict;
 use warnings;
@@ -6,21 +6,32 @@ use Carp;
 
 =head1 NAME
 
-Catalyst::Helper::Model::DBIC::SchemaInlineLoader - Helper for AutoLoaded DBIC Schema Models
+Catalyst::Helper::Model::DBIC::SchemaLoader - Helper for AutoLoaded DBIC Schema Models
 
 =head1 SYNOPSIS
 
-    script/create.pl model Foo DBIC::SchemaInlineLoader dsn user password
+  script/myapp_create.pl model Foo DBIC::SchemaLoader [ connect info arguments ]
 
-    Where:
-      Foo is the short name for the Model class being generated
-      dsn, user, and password are the connection info
+  Where:
+    Foo is the short name for the Model class being generated
+    connect_info arguments are the same as what DBIx::Class::Schema::connect
+      expects, and are storage_type-specific.  For DBI-based storage, these
+      arguments are the dsn, username, password, and connect options,
+      respectively.
+
+=head1 TYPICAL EXAMPLE
+
+  script/myapp_create.pl model Foo DBIC::SchemaLoader dbi:mysql:foodb myuname mypass '{ AutoCommit => 1 }'
 
 =head1 DESCRIPTION
 
-This helper generates a Catalyst::Model::DBIC::Schema class based upon a
-generated inline DBIx::Class::Schema::Loader definition.  Nothing external
-to the generated class is required.
+This helper generates two classes:
+
+First, it generates a L<DBIx::Class::Schema::Loader> class at
+F<lib/MyApp/SchemaLoader/Foo.pm> based on your supplied dsn/user/pass.
+
+Then, it generates a L<Catalyst::Model::DBIC::Schema> at
+F<lib/MyApp/M/Foo.pm>, which references the above-generated loader.
 
 Models generated by this Helper require the seperate package
 L<DBIx::Class::Schema::Loader> to be installed.  It is on the recommended
@@ -33,11 +44,26 @@ list for this package, but is not required for installation.
 =cut
 
 sub mk_compclass {
-    my ( $self, $helper, $dsn, $user, $pass ) = @_;
+    my ($self, $helper, @connect_info) = @_;
+
+    for(@connect_info) {
+        $_ = qq{'$_'} if $_ !~ /^\s*[[{]/;
+    }
+
+    $helper->{loader_class} = $helper->{class};
+    $helper->{loader_class} =~ s/\:\:M(?:odel)?\:\:/::SchemaLoader::/;
+    my @loader_parts = split(/\:\:/, $helper->{loader_class});
+    my $loader_file_part = pop @loader_parts;
+
+    my $loader_dir  = File::Spec->catfile( $helper->{base}, 'lib', @loader_parts );
+    my $loader_file = File::Spec->catfile( $loader_dir, $loader_file_part . '.pm' );
+
+    $helper->mk_dir($loader_dir);
+    $helper->{connect_info} = \@connect_info;
+
+    $helper->mk_dir( $loader_dir );
+    $helper->render_file( 'loaderclass', $loader_file );
 
-    $helper->{dsn}          = $dsn  || '';
-    $helper->{user}         = $user || '';
-    $helper->{pass}         = $pass || '';
 
     my $file = $helper->{file};
     $helper->render_file( 'compclass', $file );
@@ -53,8 +79,8 @@ 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::SchemaInlineLoader>
+L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema>,
+L<Catalyst::Helper::Model::DBIC::Schema>
 
 =head1 AUTHOR
 
@@ -71,39 +97,61 @@ it under the same terms as Perl itself.
 
 __DATA__
 
-__compclass__
-package [% %]_[% class %]::Schema;
+=begin pod_to_ignore
+
+__loaderclass__
+package [% loader_class %];
 
 use strict;
 use base qw/DBIx::Class::Schema::Loader/;
 
 __PACKAGE__->load_from_connection(
-    dsn     => '[% dsn %]',
-    user    => '[% user %]',
-    pass    => '[% pass %]',
-    options => {
-                  RaiseError         => 1,
-                  PrintError         => 0,
-                  ShowErrorStatement => 1,
-                  TraceLevel         => 0,
-                  AutoCommit         => 1,
-                },
+    connect_info => [
+        [% FOREACH arg = connect_info %][% arg %],
+        [% END %]
+    ],
     relationships => 1,
     # debug => 1,
 );
 
+=head1 NAME
+
+[% loader_class %] - Loader-generated DBIx::Class::Schema class
+
+=head1 SYNOPSIS
+
+See L<[% app %]>
+
+=head1 DESCRIPTION
+
+Generated by L<Catalyst::Model::DBIC::Schema> for use in L<[% class %]>
+
+=head1 AUTHOR
+
+[% author %]
+
+=head1 LICENSE
+
+This library is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
+
+1;
+
+__compclass__
 package [% class %];
 
 use strict;
 use base 'Catalyst::Model::DBIC::Schema';
 
 __PACKAGE__->config(
-    schema_class => '_[% class %]::Schema',
+    schema_class => '[% loader_class %]',
 );
 
 =head1 NAME
 
-[% class %] - Catalyst DBIC Plain Model
+[% class %] - Catalyst DBIC Schema Model
 
 =head1 SYNOPSIS
 
@@ -111,7 +159,8 @@ See L<[% app %]>
 
 =head1 DESCRIPTION
 
-Catalyst::Model::DBIC::Schema Model
+L<Catalyst::Model::DBIC::Schema> Model using L<DBIx::Class::Schema::Loader>
+generated Schema: L<[% loader_class %]>
 
 =head1 AUTHOR
 
@@ -125,3 +174,4 @@ it under the same terms as Perl itself.
 =cut
 
 1;
+