release 0.07003
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader.pm
index d207c6a..399c231 100644 (file)
@@ -2,18 +2,26 @@ package DBIx::Class::Schema::Loader;
 
 use strict;
 use warnings;
-use base qw/DBIx::Class::Schema Class::Data::Accessor/;
+use base qw/DBIx::Class::Schema Class::Accessor::Grouped/;
 use Carp::Clan qw/^DBIx::Class/;
-use Class::C3;
+use mro 'c3';
 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.04999_09';
-
-__PACKAGE__->mk_classaccessor('_loader_args' => {});
-__PACKAGE__->mk_classaccessors(qw/dump_to_dir _loader_invoked _loader loader_class/);
+our $VERSION = '0.07003';
+
+__PACKAGE__->mk_group_accessors('inherited', qw/
+                                _loader_args
+                                dump_to_dir
+                                _loader_invoked
+                                _loader
+                                loader_class
+                                naming
+                                use_namespaces
+/);
+__PACKAGE__->_loader_args({});
 
 =head1 NAME
 
@@ -30,7 +38,9 @@ DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
       { debug => 1,
         dump_directory => './lib',
       },
-      [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword' ],
+      [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword',
+         { loader_class => 'MyLoader' } # optionally
+      ],
   );
 
   # from the command line or a shell script with dbicdump (distributed
@@ -68,11 +78,12 @@ DBIx::Class::Schema::Loader automates the definition of a
 L<DBIx::Class::Schema> by scanning database table definitions and
 setting up the columns, primary keys, and relationships.
 
-DBIx::Class::Schema::Loader currently supports only the DBI storage type.
-It has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>,
-L<DBD::SQLite>, and L<DBD::Oracle>.  Other DBI drivers may function to
-a greater or lesser degree with this loader, depending on how much of the
-DBI spec they implement, and how standard their implementation is.
+DBIx::Class::Schema::Loader currently supports only the DBI storage type.  It
+has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>,
+L<DBD::SQLite>, L<DBD::Sybase> (for Sybase ASE and MSSSQL), L<DBD::ODBC> (for
+MSSQL) and L<DBD::Oracle>.  Other DBI drivers may function to a greater or
+lesser degree with this loader, depending on how much of the DBI spec they
+implement, and how standard their implementation is.
 
 Patches to make other DBDs work correctly welcome.
 
@@ -132,7 +143,7 @@ already been made is useless.
 
 sub loader_options {
     my $self = shift;
-    
+
     my %args = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
     $self->_loader_args(\%args);
 
@@ -150,13 +161,19 @@ sub _invoke_loader {
     $args->{schema_class} = $class;
     weaken($args->{schema}) if ref $self;
     $args->{dump_directory} ||= $self->dump_to_dir;
+    $args->{naming} = $self->naming if $self->naming;
+    $args->{use_namespaces} = $self->use_namespaces if $self->use_namespaces;
 
     # XXX this only works for relative storage_type, like ::DBI ...
-    my $impl = $self->loader_class
-      || "DBIx::Class::Schema::Loader" . $self->storage_type;
-    $impl = "DBIx::Class::Schema::Loader${impl}" if $impl =~ /^::/;
+    my $loader_class = $self->loader_class;
+    if ($loader_class) {
+        $loader_class = "DBIx::Class::Schema::Loader${loader_class}" if $loader_class =~ /^::/;
+        $args->{loader_class} = $loader_class;
+    };
+
+    my $impl = $loader_class || "DBIx::Class::Schema::Loader" . $self->storage_type;
     eval { $self->ensure_class_loaded($impl) };
-    croak qq/Could not load storage_type loader "$impl": "$@"/ if $@;
+    croak qq/Could not load loader_class "$impl": "$@"/ if $@;
 
     $self->_loader($impl->new(%$args));
     $self->_loader->load;
@@ -285,16 +302,27 @@ Examples:
 
 sub import {
     my $self = shift;
+
     return if !@_;
+
+    my $cpkg = (caller)[0];
+
     foreach my $opt (@_) {
         if($opt =~ m{^dump_to_dir:(.*)$}) {
             $self->dump_to_dir($1)
         }
         elsif($opt eq 'make_schema_at') {
             no strict 'refs';
-            my $cpkg = (caller)[0];
             *{"${cpkg}::make_schema_at"} = \&make_schema_at;
         }
+        elsif($opt eq 'naming') {
+            no strict 'refs';
+            *{"${cpkg}::naming"} = sub { $self->naming(@_) };
+        }
+        elsif($opt eq 'use_namespaces') {
+            no strict 'refs';
+            *{"${cpkg}::use_namespaces"} = sub { $self->use_namespaces(@_) };
+        }
     }
 }
 
@@ -317,6 +345,8 @@ memory at runtime without generating on-disk class files.
 For a complete list of supported loader_options, see
 L<DBIx::Class::Schema::Loader::Base>
 
+The last hashref in the C<\@connect_info> can specify the L</loader_class>.
+
 This function can be imported in the usual way, as illustrated in
 these Examples:
 
@@ -326,7 +356,9 @@ these Examples:
     make_schema_at(
         'New::Schema::Name',
         { debug => 1 },
-        [ 'dbi:Pg:dbname="foo"','postgres' ],
+        [ 'dbi:Pg:dbname="foo"','postgres','',
+          { loader_class => 'MyLoader' } # optionally
+        ],
     );
 
     # Inside a script, specifying a dump directory in which to write
@@ -335,9 +367,14 @@ these Examples:
     make_schema_at(
         'New::Schema::Name',
         { debug => 1, dump_directory => './lib' },
-        [ 'dbi:Pg:dbname="foo"','postgres' ],
+        [ 'dbi:Pg:dbname="foo"','postgres','',
+          { loader_class => 'MyLoader' } # optionally
+        ],
     );
 
+The last hashref in the C<\@connect_info> is checked for loader arguments such
+as C<loader_options> and C<loader_class>, see L</connection> for more details.
+
 =cut
 
 sub make_schema_at {
@@ -348,6 +385,8 @@ sub make_schema_at {
         @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/;
     }
 
+    eval { $target->_loader_invoked(0) };
+
     $target->loader_options($opts);
     $target->connection(@$connect_info);
 }
@@ -370,6 +409,43 @@ Returns a list of the new monikers added.
 
 sub rescan { my $self = shift; $self->_loader->rescan($self) }
 
+=head2 naming
+
+=over 4
+
+=item Arguments: \%opts | $ver
+
+=back
+
+Controls the naming options for backward compatibility, see
+L<DBIx::Class::Schema::Loader::Base/naming> for details.
+
+To upgrade a dynamic schema, use:
+
+    __PACKAGE__->naming('current');
+
+Can be imported into your dump script and called as a function as well:
+
+    naming('v4');
+
+=head2 use_namespaces
+
+=over 4
+
+=item Arguments: 1|0
+
+=back
+
+Controls the use_namespaces options for backward compatibility, see
+L<DBIx::Class::Schema::Loader::Base/use_namespaces> for details.
+
+To upgrade a dynamic schema, use:
+
+    __PACKAGE__->use_namespaces(1);
+
+Can be imported into your dump script and called as a function as well:
+
+    use_namespaces(1);
 
 =head1 KNOWN ISSUES
 
@@ -389,20 +465,71 @@ arrayref of schemas to load.
 In "normal" L<DBIx::Class::Schema> usage, manually-defined
 source classes and relationships have no problems crossing vendor schemas.
 
-=head1 AUTHOR
+=head1 ACKNOWLEDGEMENTS
 
-Brandon Black, C<blblack@gmail.com>
+Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
+in a bug report or suggestion.
 
 Based on L<DBIx::Class::Loader> by Sebastian Riedel
 
 Based upon the work of IKEBE Tomohiro
 
-=head1 THANK YOU
+=head1 AUTHOR
 
-Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
-in a bug report or suggestion.
+blblack: Brandon Black <blblack@gmail.com>
+
+=head1 CONTRIBUTORS
+
+ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
+
+arcanez: Justin Hunter <justin.d.hunter@gmail.com>
+
+ash: Ash Berlin <ash@cpan.org>
+
+Caelum: Rafael Kitover <rkitover@cpan.org>
+
+TSUNODA Kazuya <drk@drk7.jp>
+
+rbo: Robert Bohne <rbo@cpan.org>
+
+ribasushi: Peter Rabbitson <ribasushi@cpan.org>
+
+gugu: Andrey Kostenko <a.kostenko@rambler-co.ru>
+
+jhannah: Jay Hannah <jay@jays.net>
+
+rbuels: Robert Buels <rmb32@cornell.edu>
+
+timbunce: Tim Bunce <timb@cpan.org>
+
+mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
+
+kane: Jos Boumans <kane@cpan.org>
+
+waawaamilk: Nigel McNie <nigel@mcnie.name>
+
+acmoore: Andrew Moore <amoore@cpan.org>
+
+bphillips: Brian Phillips <bphillips@cpan.org>
+
+schwern: Michael G. Schwern <mschwern@cpan.org>
+
+hobbs: Andrew Rodland <arodland@cpan.org>
+
+domm: Thomas Klausner <domm@plix.at>
+
+spb: Stephen Bennett <spb@exherbo.org>
+
+Matias E. Fernandez <mfernandez@pisco.ch>
+
+... and lots of other folks. If we forgot you, please write the current
+maintainer or RT.
+
+=head1 COPYRIGHT & LICENSE
 
-=head1 LICENSE
+Copyright (c) 2006 - 2009 by the aforementioned
+L<DBIx::Class::Schema::Loader/AUTHOR> and
+L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
 
 This library is free software; you can redistribute it and/or modify it under
 the same terms as Perl itself.
@@ -414,3 +541,4 @@ L<DBIx::Class>, L<DBIx::Class::Manual::ExampleSchema>
 =cut
 
 1;
+# vim:et sts=4 sw=4 tw=0: