X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader.pm;h=d100408d790d206bb4ba6009a554887599449e0b;hb=306bf770bf08b06f92863808b1938f2fc704acb0;hp=a1fa4ebeab529194a5be159521d96d36831c1a1d;hpb=c899395bfbd09ba1a62396a603db6c7457cc300d;p=dbsrgits%2FDBIx-Class-Schema-Loader.git diff --git a/lib/DBIx/Class/Schema/Loader.pm b/lib/DBIx/Class/Schema/Loader.pm index a1fa4eb..d100408 100644 --- a/lib/DBIx/Class/Schema/Loader.pm +++ b/lib/DBIx/Class/Schema/Loader.pm @@ -7,14 +7,16 @@ use MRO::Compat; use mro 'c3'; use Carp::Clan qw/^DBIx::Class/; use Scalar::Util 'weaken'; -use Sub::Name 'subname'; +use Sub::Util 'set_subname'; use DBIx::Class::Schema::Loader::Utils 'array_eq'; +use Try::Tiny; +use Hash::Merge 'merge'; use namespace::clean; # 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.07015'; +our $VERSION = '0.07047'; __PACKAGE__->mk_group_accessors('inherited', qw/ _loader_args @@ -27,57 +29,59 @@ __PACKAGE__->mk_group_accessors('inherited', qw/ /); __PACKAGE__->_loader_args({}); +=encoding UTF-8 + =head1 NAME DBIx::Class::Schema::Loader - Create a DBIx::Class::Schema based on a database =head1 SYNOPSIS - ### use this module to generate a set of class files - - # in a script - use DBIx::Class::Schema::Loader qw/ make_schema_at /; - make_schema_at( - 'My::Schema', - { debug => 1, - dump_directory => './lib', - }, - [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword', - { loader_class => 'MyLoader' } # optionally - ], - ); - - # from the command line or a shell script with dbicdump (distributed - # with this module). Do `perldoc dbicdump` for usage. - dbicdump -o dump_directory=./lib \ - -o components='["InflateColumn::DateTime"]' \ - -o debug=1 \ - My::Schema \ - 'dbi:Pg:dbname=foo' \ - myuser \ - mypassword + ### use this module to generate a set of class files - ### or generate and load classes at runtime - # note: this technique is not recommended - # for use in production code - - package My::Schema; - use base qw/DBIx::Class::Schema::Loader/; + # in a script + use DBIx::Class::Schema::Loader qw/ make_schema_at /; + make_schema_at( + 'My::Schema', + { debug => 1, + dump_directory => './lib', + }, + [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword', + { loader_class => 'MyLoader' } # optionally + ], + ); - __PACKAGE__->loader_options( - constraint => '^foo.*', - # debug => 1, - ); + # from the command line or a shell script with dbicdump (distributed + # with this module). Do `perldoc dbicdump` for usage. + dbicdump -o dump_directory=./lib \ + -o components='["InflateColumn::DateTime"]' \ + -o debug=1 \ + My::Schema \ + 'dbi:Pg:dbname=foo' \ + myuser \ + mypassword + + ### or generate and load classes at runtime + # note: this technique is not recommended + # for use in production code + + package My::Schema; + use base qw/DBIx::Class::Schema::Loader/; + + __PACKAGE__->loader_options( + constraint => '^foo.*', + # debug => 1, + ); - #### in application code elsewhere: + #### in application code elsewhere: - use My::Schema; + use My::Schema; - my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs); - # -or- - my $schema1 = "My::Schema"; $schema1->connection(as above); + my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs); + # -or- + my $schema1 = "My::Schema"; $schema1->connection(as above); -=head1 DESCRIPTION +=head1 DESCRIPTION DBIx::Class::Schema::Loader automates the definition of a L by scanning database table definitions and setting up @@ -170,10 +174,15 @@ sub _invoke_loader { my $args = $self->_loader_args; - # set up the schema/schema_class arguments - $args->{schema} = $self; + # temporarily copy $self's storage to class + my $class_storage = $class->storage; + if (ref $self) { + $class->storage($self->storage); + $class->storage->set_schema($class); + } + + $args->{schema} = $class; $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 defined $self->use_namespaces; @@ -186,14 +195,76 @@ sub _invoke_loader { }; my $impl = $loader_class || "DBIx::Class::Schema::Loader" . $self->storage_type; - eval { $self->ensure_class_loaded($impl) }; - croak qq/Could not load loader_class "$impl": "$@"/ if $@; + try { + $self->ensure_class_loaded($impl) + } + catch { + croak qq/Could not load loader_class "$impl": "$_"/; + }; - $self->loader($impl->new(%$args)); - $self->loader->load; - $self->_loader_invoked(1); + $class->loader($impl->new(%$args)); + $class->loader->load; + $class->_loader_invoked(1); - $self; + # copy to $self + if (ref $self) { + $self->loader($class->loader); + $self->_loader_invoked(1); + + $self->_merge_state_from($class); + } + + # restore $class's storage + $class->storage($class_storage); + + return $self; +} + +# FIXME This needs to be moved into DBIC at some point, otherwise we are +# maintaining things to do with DBIC guts, which we have no business of +# maintaining. But at the moment it would be just dead code in DBIC, so we'll +# maintain it here. +sub _merge_state_from { + my ($self, $from) = @_; + + my $orig_class_mappings = $self->class_mappings; + my $orig_source_registrations = $self->source_registrations; + + $self->_copy_state_from($from); + + $self->class_mappings(merge($orig_class_mappings, $self->class_mappings)) + if $orig_class_mappings; + + $self->source_registrations(merge($orig_source_registrations, $self->source_registrations)) + if $orig_source_registrations; +} + +sub _copy_state_from { + my $self = shift; + my ($from) = @_; + + # older DBIC's do not have this method + if (try { DBIx::Class->VERSION('0.08197'); 1 }) { + return $self->next::method(@_); + } + else { + # this is a copy from DBIC git master pre 0.08197 + $self->class_mappings({ %{$from->class_mappings} }); + $self->source_registrations({ %{$from->source_registrations} }); + + foreach my $moniker ($from->sources) { + my $source = $from->source($moniker); + my $new = $source->new($source); + # we use extra here as we want to leave the class_mappings as they are + # but overwrite the source_registrations entry with the new source + $self->register_extra_source($moniker => $new); + } + + if ($from->storage) { + $self->storage($from->storage); + $self->storage->set_schema($self); + } + } } =head2 connection @@ -270,7 +341,7 @@ sub connection { # ->load_components and we are now in a different place in the mro. no warnings 'redefine'; - local *connection = subname __PACKAGE__.'::connection' => sub { + local *connection = set_subname __PACKAGE__.'::connection' => sub { my $self = shift; $self->next::method(@_); }; @@ -457,10 +528,16 @@ sub make_schema_at { @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/; } - eval { $target->_loader_invoked(0) }; + $target->_loader_invoked(0); $target->loader_options($opts); - $target->connection(@$connect_info); + + my $temp_schema = $target->connect(@$connect_info); + + $target->storage($temp_schema->storage); + $target->storage->set_schema($target); + + return $target; } =head2 rescan @@ -534,70 +611,85 @@ Based on L by Sebastian Riedel Based upon the work of IKEBE Tomohiro -=head1 AUTHOR +=head1 AUTHORS -blblack: Brandon Black +Caelum: Rafael Kitover -=head1 CONTRIBUTORS +Dag-Erling Smørgrav -ilmari: Dagfinn Ilmari MannsEker +Matias E. Fernandez + +SineSwiper: Brendan Byrd + +TSUNODA Kazuya + +acmoore: Andrew Moore + +alnewkirk: Al Newkirk + +andrewalker: André Walker + +angelixd: Paul C. Mantz + +arc: Aaron Crane arcanez: Justin Hunter ash: Ash Berlin -btilly: Ben Tilly - -Caelum: Rafael Kitover +blblack: Brandon Black -TSUNODA Kazuya +bphillips: Brian Phillips -rbo: Robert Bohne +btilly: Ben Tilly -ribasushi: Peter Rabbitson +domm: Thomas Klausner gugu: Andrey Kostenko +hobbs: Andrew Rodland + +ilmari: Dagfinn Ilmari MannsEker + jhannah: Jay Hannah -rbuels: Robert Buels +jnap: John Napiorkowski -timbunce: Tim Bunce +kane: Jos Boumans -mst: Matt S. Trout +mattp: Matt Phillips -mstratman: Mark A. Stratman +mephinet: Philipp Gortan -kane: Jos Boumans +moritz: Moritz Lenz -waawaamilk: Nigel McNie +mst: Matt S. Trout -acmoore: Andrew Moore +mstratman: Mark A. Stratman -bphillips: Brian Phillips +oalders: Olaf Alders -schwern: Michael G. Schwern +rbo: Robert Bohne -SineSwiper: Brendan Byrd +rbuels: Robert Buels -hobbs: Andrew Rodland +ribasushi: Peter Rabbitson -domm: Thomas Klausner +schwern: Michael G. Schwern spb: Stephen Bennett -Matias E. Fernandez +timbunce: Tim Bunce -alnewkirk: Al Newkirk +waawaamilk: Nigel McNie ... and lots of other folks. If we forgot you, please write the current maintainer or RT. =head1 COPYRIGHT & LICENSE -Copyright (c) 2006 - 2009 by the aforementioned -L and -L. +Copyright (c) 2006 - 2015 by the aforementioned +L. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.