Bump version for release

[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader.pm

diff --git a/lib/DBIx/Class/Schema/Loader.pm b/lib/DBIx/Class/Schema/Loader.pm
index c08d29a..2d9a52f 100644 (file)
--- a/lib/DBIx/Class/Schema/Loader.pm
+++ b/lib/DBIx/Class/Schema/Loader.pm
@@ -11,10 +11,10 @@ use Scalar::Util qw/ weaken /;
 # Always remember to do all digits for the version even if they're 0
 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
 # brain damage and presumably various other packaging systems too
-our $VERSION = '0.04001';
+our $VERSION = '0.04999_06';
 
 __PACKAGE__->mk_classaccessor('_loader_args' => {});
-__PACKAGE__->mk_classaccessors(qw/dump_to_dir _loader_invoked _loader/);
+__PACKAGE__->mk_classaccessors(qw/dump_to_dir _loader_invoked _loader loader_class/);
 
 =head1 NAME
 
@@ -69,8 +69,30 @@ the road.
 
 =head1 METHODS
 
+=head2 loader_class
+
+=over 4
+
+=item Argument: $loader_class
+
+=back
+
+Set the loader class to be instantiated when L</connection> is called.
+If the classname starts with "::", "DBIx::Class::Schema::Loader" is
+prepended. Defaults to L<DBIx::Class::Schema/storage_type> (which must
+start with "::" when using L<DBIx::Class::Schema::Loader>).
+
+This is mostly useful for subclassing existing loaders or in conjunction
+with L</dump_to_dir>.
+
 =head2 loader_options
 
+=over 4
+
+=item Argument: \%loader_options
+
+=back
+
 Example in Synopsis above demonstrates a few common arguments.  For
 detailed information on all of the arguments, most of which are
 only useful in fairly complex scenarios, see the
@@ -106,7 +128,9 @@ sub _invoke_loader {
     $args->{dump_directory} ||= $self->dump_to_dir;
 
     # XXX this only works for relative storage_type, like ::DBI ...
-    my $impl = "DBIx::Class::Schema::Loader" . $self->storage_type;
+    my $impl = $self->loader_class
+      || "DBIx::Class::Schema::Loader" . $self->storage_type;
+    $impl = "DBIx::Class::Schema::Loader${impl}" if $impl =~ /^::/;
     $impl->require or
       croak qq/Could not load storage_type loader "$impl": / .
             qq/"$UNIVERSAL::require::ERROR"/;
@@ -120,11 +144,20 @@ sub _invoke_loader {
 
 =head2 connection
 
-See L<DBIx::Class::Schema> for basic usage.
+=over 4
+
+=item Arguments: @args
+
+=item Return Value: $new_schema
 
-If the final argument is a hashref, and it contains a key C<loader_options>,
-that key will be deleted, and its value will be used for the loader options,
-just as if set via the L</loader_options> method above.
+=back
+
+See L<DBIx::Class::Schema/connection> for basic usage.
+
+If the final argument is a hashref, and it contains the keys C<loader_options>
+or C<loader_class>, those keys will be deleted, and their values value will be
+used for the loader options or class, respectively, just as if set via the
+L</loader_options> or L</loader_class> methods above.
 
 The actual auto-loading operation (the heart of this module) will be invoked
 as soon as the connection information is defined.
@@ -135,10 +168,12 @@ sub connection {
     my $self = shift;
 
     if($_[-1] && ref $_[-1] eq 'HASH') {
-        if(my $loader_opts = delete $_[-1]->{loader_options}) {
-            $self->loader_options($loader_opts);
-            pop @_ if !keys %{$_[-1]};
+        for my $option (qw/ loader_class loader_options /) {
+            if(my $value = delete $_[-1]->{$option}) {
+                $self->$option($value);
+            }
         }
+        pop @_ if !keys %{$_[-1]};
     }
 
     $self = $self->next::method(@_);
@@ -153,7 +188,7 @@ sub connection {
 
 =head2 clone
 
-See L<DBIx::Class::Schema>.
+See L<DBIx::Class::Schema/clone>.
 
 =cut
 
@@ -172,7 +207,11 @@ sub clone {
 
 =head2 dump_to_dir
 
-Argument: directory name.
+=over 4
+
+=item Argument: $directory
+
+=back
 
 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
 or any derived schema class will cause all affected schemas to dump
@@ -238,6 +277,14 @@ sub import {
 
 =head2 make_schema_at
 
+=over 4
+
+=item Arguments: $schema_name, \%loader_options, \@connect_info
+
+=item Return Value: $schema_name
+
+=back
+
 This simple function allows one to create a Loader-based schema
 in-memory on the fly without any on-disk class files of any
 kind.  When used with the C<dump_directory> option, you can
@@ -287,6 +334,12 @@ sub make_schema_at {
 
 =head2 rescan
 
+=over 4
+
+=item Return Value: @new_monikers
+
+=back
+
 Re-scans the database for newly added tables since the initial
 load, and adds them to the schema at runtime, including relationships,
 etc.  Does not process drops or changes.