X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=39431fab789da1bf71204767141dc67199d9fe21;hb=0e097542050a7756eb6a6299e0743ccbdd51608a;hp=be0600f9a76b8e031e8adf8b0624a6f3defc8c3f;hpb=06f6541ca97da4e9e289b1c28c803779aff2f5d8;p=dbsrgits%2FDBIx-Class-Schema-Loader.git diff --git a/lib/DBIx/Class/Schema/Loader/Base.pm b/lib/DBIx/Class/Schema/Loader/Base.pm index be0600f..39431fa 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -2,19 +2,23 @@ package DBIx::Class::Schema::Loader::Base; use strict; use warnings; -use base qw/Class::Accessor::Fast/; +use base qw/Class::Accessor::Grouped Class::C3::Componentised/; use Class::C3; use Carp::Clan qw/^DBIx::Class/; -use UNIVERSAL::require; use DBIx::Class::Schema::Loader::RelBuilder; use Data::Dump qw/ dump /; use POSIX qw//; +use File::Spec qw//; use Cwd qw//; +use Digest::MD5 qw//; +use Lingua::EN::Inflect::Number qw//; +use File::Temp qw//; +use Class::Unload; require DBIx::Class; -our $VERSION = '0.03999_01'; +our $VERSION = '0.04999_14'; -__PACKAGE__->mk_ro_accessors(qw/ +__PACKAGE__->mk_group_ro_accessors('simple', qw/ schema schema_class @@ -26,20 +30,45 @@ __PACKAGE__->mk_ro_accessors(qw/ components resultset_components skip_relationships + skip_load_external moniker_map inflect_singular inflect_plural debug dump_directory dump_overwrite + really_erase_my_files + resultset_namespace + default_resultset_class + schema_base_class + result_base_class + overwrite_modifications - legacy_default_inflections + relationship_attrs db_schema _tables classes + _upgrading_classes monikers - /); + dynamic + naming +/); + + +__PACKAGE__->mk_group_accessors('simple', qw/ + version_to_dump + schema_version_to_dump + _upgrading_from + _upgrading_from_load_classes + _downgrading_to_load_classes + _rewriting_result_namespace + use_namespaces + result_namespace + generate_pod + pod_comment_mode + pod_comment_spillover_length +/); =head1 NAME @@ -57,13 +86,143 @@ classes, and implements the common functionality between them. =head1 CONSTRUCTOR OPTIONS These constructor options are the base options for -L. Available constructor options are: +L. Available constructor options are: =head2 skip_relationships Skip setting up relationships. The default is to attempt the loading of relationships. +=head2 skip_load_external + +Skip loading of other classes in @INC. The default is to merge all other classes +with the same name found in @INC into the schema file we are creating. + +=head2 naming + +Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX +relationship names and singularized Results, unless you're overwriting an +existing dump made by a 0.04XXX version of L, in +which case the backward compatible RelBuilder will be activated, and +singularization will be turned off. + +Specifying + + naming => 'v5' + +will disable the backward-compatible RelBuilder and use +the new-style relationship names along with singularized Results, even when +overwriting a dump made with an earlier version. + +The option also takes a hashref: + + naming => { relationships => 'v5', monikers => 'v4' } + +The keys are: + +=over 4 + +=item relationships + +How to name relationship accessors. + +=item monikers + +How to name Result classes. + +=back + +The values can be: + +=over 4 + +=item current + +Latest default style, whatever that happens to be. + +=item v5 + +Version 0.05XXX style. + +=item v4 + +Version 0.04XXX style. + +=back + +Dynamic schemas will always default to the 0.04XXX relationship names and won't +singularize Results for backward compatibility, to activate the new RelBuilder +and singularization put this in your C file: + + __PACKAGE__->naming('current'); + +Or if you prefer to use 0.05XXX features but insure that nothing breaks in the +next major version upgrade: + + __PACKAGE__->naming('v5'); + +=head2 generate_pod + +By default POD will be generated for columns and relationships, using database +metadata for the text if available and supported. + +Reading database metadata (e.g. C) is only +supported for Postgres right now. + +Set this to C<0> to turn off all POD generation. + +=head2 pod_comment_mode + +Controls where table comments appear in the generated POD. By default table +comments are appended to the C section of the documentation. You can +force a C section to be generated with the comment instead, or +choose the length threshold at which the comment is forced into the +description. + +=over 4 + +=item name + +Use C section only. + +=item description + +Force C always. + +=item auto + +Use C if length > L, this is the +default. + +=back + +=head2 pod_comment_spillover_length + +When pod_comment_mode is set to C, this is the length of the comment at +which it will be forced into a separate description section. + +The default is C<60> + +=head2 relationship_attrs + +Hashref of attributes to pass to each generated relationship, listed +by type. Also supports relationship type 'all', containing options to +pass to all generated relationships. Attributes set for more specific +relationship types override those set in 'all'. + +For example: + + relationship_attrs => { + all => { cascade_delete => 0 }, + has_many => { cascade_delete => 1 }, + }, + +will set the C option to 0 for all generated relationships, +except for C, which will have cascade_delete as 1. + +NOTE: this option is not supported if v4 backward-compatible naming is +set either globally (naming => 'v4') or just for relationships. + =head2 debug If set to true, each constructive L statement the loader @@ -92,16 +251,17 @@ a scalar moniker. If the hash entry does not exist, or the function returns a false value, the code falls back to default behavior for that table name. -The default behavior is: C, -which is to say: lowercase everything, split up the table name into chunks -anywhere a non-alpha-numeric character occurs, change the case of first letter -of each chunk to upper case, and put the chunks back together. Examples: +The default behavior is to singularize the table name, and: C, which is to say: lowercase everything, +split up the table name into chunks anywhere a non-alpha-numeric character +occurs, change the case of first letter of each chunk to upper case, and put +the chunks back together. Examples: Table Name | Moniker Name --------------------------- luser | Luser luser_group | LuserGroup - luser-opts | LuserOpts + luser-opts | LuserOpt =head2 inflect_plural @@ -115,6 +275,15 @@ L. As L above, but for singularizing relationship names. Default behavior is to utilize L. +=head2 schema_base_class + +Base class for your schema classes. Defaults to 'DBIx::Class::Schema'. + +=head2 result_base_class + +Base class for your table classes (aka result classes). Defaults to +'DBIx::Class::Core'. + =head2 additional_base_classes List of additional base classes all of your table classes will use. @@ -140,18 +309,17 @@ classes. A good example would be C. Component C will be automatically added to the above C list if this option is set. -=head2 legacy_default_inflections +=head2 use_namespaces -Setting this option changes the default fallback for L to -utilize L, and L to a no-op. -Those choices produce substandard results, but might be necessary to support -your existing code if you started developing on a version prior to 0.03 and -don't wish to go around updating all your relationship names to the new -defaults. +This is now the default, to go back to L pass +a C<0>. -This option will continue to be supported until at least version 0.05xxx, -but may dissappear sometime thereafter. It is recommended that you update -your code to use the newer-style inflections when you have the time. +Generate result class names suitable for +L and call that instead of +L. When using this option you can also +specify any of the options for C (i.e. C, +C, C), and they will be added +to the call (and the generated result class names adjusted appropriately). =head2 dump_directory @@ -165,11 +333,7 @@ in memory. The created schema class will have the same classname as the one on which you are setting this option (and the ResultSource classes will be -based on this name as well). Therefore it is wise to note that if you -point the C option of a schema class at the live libdir -where that class is currently located, it will overwrite itself with a -manual version of itself. This might be a really good or bad thing -depending on your situation and perspective. +based on this name as well). Normally you wouldn't hard-code this setting in your schema class, as it is meant for one-time manual usage. @@ -179,9 +343,40 @@ recommended way to access this functionality. =head2 dump_overwrite -If set to a true value, the dumping code will overwrite existing files. -The default is false, which means the dumping code will skip the already -existing files. +Deprecated. See L below, which does *not* mean +the same thing as the old C setting from previous releases. + +=head2 really_erase_my_files + +Default false. If true, Loader will unconditionally delete any existing +files before creating the new ones from scratch when dumping a schema to disk. + +The default behavior is instead to only replace the top portion of the +file, up to and including the final stanza which contains +C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> +leaving any customizations you placed after that as they were. + +When C is not set, if the output file already exists, +but the aforementioned final stanza is not found, or the checksum +contained there does not match the generated contents, Loader will +croak and not touch the file. + +You should really be using version control on your schema classes (and all +of the rest of your code for that matter). Don't blame me if a bug in this +code wipes something out when it shouldn't have, you've been warned. + +=head2 overwrite_modifications + +Default false. If false, when updating existing files, Loader will +refuse to modify any Loader-generated code that has been modified +since its last run (as determined by the checksum Loader put in its +comment lines). + +If true, Loader will discard any manual modifications that have been +made to Loader-generated code. + +Again, you should be using version control on your schema classes. Be +careful with this option. =head1 METHODS @@ -191,6 +386,8 @@ can also be found via standard L methods somehow. =cut +use constant CURRENT_V => 'v5'; + # ensure that a peice of object data is a valid arrayref, creating # an empty one or encapsulating whatever's there. sub _ensure_arrayref { @@ -217,7 +414,6 @@ sub new { bless $self => $class; - $self->{db_schema} ||= ''; $self->_ensure_arrayref(qw/additional_classes additional_base_classes left_base_classes @@ -230,57 +426,327 @@ sub new { $self->{monikers} = {}; $self->{classes} = {}; + $self->{_upgrading_classes} = {}; $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} ); $self->{schema} ||= $self->{schema_class}; + croak "dump_overwrite is deprecated. Please read the" + . " DBIx::Class::Schema::Loader::Base documentation" + if $self->{dump_overwrite}; + + $self->{dynamic} = ! $self->{dump_directory}; + $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX', + TMPDIR => 1, + CLEANUP => 1, + ); + + $self->{dump_directory} ||= $self->{temp_directory}; + + $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION); + $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION); + + if ((not ref $self->naming) && defined $self->naming) { + my $naming_ver = $self->naming; + $self->{naming} = { + relationships => $naming_ver, + monikers => $naming_ver, + }; + } + + if ($self->naming) { + for (values %{ $self->naming }) { + $_ = CURRENT_V if $_ eq 'current'; + } + } + $self->{naming} ||= {}; + + $self->_check_back_compat; + + $self->use_namespaces(1) unless defined $self->use_namespaces; + $self->generate_pod(1) unless defined $self->generate_pod; + $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode; + $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length; + $self; } -sub _load_external { - my $self = shift; +sub _check_back_compat { + my ($self) = @_; + +# dynamic schemas will always be in 0.04006 mode, unless overridden + if ($self->dynamic) { +# just in case, though no one is likely to dump a dynamic schema + $self->schema_version_to_dump('0.04006'); + + if (not %{ $self->naming }) { + warn <dump_directory) - if $self->dump_directory; +Also consider setting 'use_namespaces => 1' if/when upgrading. - foreach my $table_class (values %{$self->classes}) { - $table_class->require; - if($@ && $@ !~ /^Can't locate /) { - croak "Failed to load external class definition" - . " for '$table_class': $@"; +See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more +details. +EOF } - next if $@; # "Can't locate" error + else { + $self->_upgrading_from('v4'); + } + + $self->naming->{relationships} ||= 'v4'; + $self->naming->{monikers} ||= 'v4'; + if ($self->use_namespaces) { + $self->_upgrading_from_load_classes(1); + } + else { + $self->use_namespaces(0); + } + + return; + } + +# otherwise check if we need backcompat mode for a static schema + my $filename = $self->_get_dump_filename($self->schema_class); + return unless -e $filename; + + open(my $fh, '<', $filename) + or croak "Cannot open '$filename' for reading: $!"; + + my $load_classes = 0; + my $result_namespace = ''; + + while (<$fh>) { + if (/^__PACKAGE__->load_classes;/) { + $load_classes = 1; + } elsif (/result_namespace => '([^']+)'/) { + $result_namespace = $1; + } elsif (my ($real_ver) = + /^# Created by DBIx::Class::Schema::Loader v(\d+\.\d+)/) { + + if ($load_classes && (not defined $self->use_namespaces)) { + warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; + +'load_classes;' static schema detected, turning off 'use_namespaces'. + +Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment +variable to disable this warning. + +See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more +details. +EOF + $self->use_namespaces(0); + } + elsif ($load_classes && $self->use_namespaces) { + $self->_upgrading_from_load_classes(1); + } + elsif ((not $load_classes) && defined $self->use_namespaces + && (not $self->use_namespaces)) { + $self->_downgrading_to_load_classes( + $result_namespace || 'Result' + ); + } + elsif ((not defined $self->use_namespaces) + || $self->use_namespaces) { + if (not $self->result_namespace) { + $self->result_namespace($result_namespace || 'Result'); + } + elsif ($result_namespace ne $self->result_namespace) { + $self->_rewriting_result_namespace( + $result_namespace || 'Result' + ); + } + } + + # XXX when we go past .0 this will need fixing + my ($v) = $real_ver =~ /([1-9])/; + $v = "v$v"; + + last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/; + + if (not %{ $self->naming }) { + warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; + +Version $real_ver static schema detected, turning on backcompat mode. + +Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable +to disable this warning. + +See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more +details. +EOF + } + else { + $self->_upgrading_from($v); + last; + } + + $self->naming->{relationships} ||= $v; + $self->naming->{monikers} ||= $v; + + $self->schema_version_to_dump($real_ver); + + last; + } + } + close $fh; +} + +sub _find_file_in_inc { + my ($self, $file) = @_; + + foreach my $prefix (@INC) { + my $fullpath = File::Spec->catfile($prefix, $file); + return $fullpath if -f $fullpath + and Cwd::abs_path($fullpath) ne + (Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || ''); + } + + return; +} + +sub _class_path { + my ($self, $class) = @_; + + my $class_path = $class; + $class_path =~ s{::}{/}g; + $class_path .= '.pm'; + + return $class_path; +} + +sub _find_class_in_inc { + my ($self, $class) = @_; + + return $self->_find_file_in_inc($self->_class_path($class)); +} + +sub _rewriting { + my $self = shift; + + return $self->_upgrading_from + || $self->_upgrading_from_load_classes + || $self->_downgrading_to_load_classes + || $self->_rewriting_result_namespace + ; +} + +sub _rewrite_old_classnames { + my ($self, $code) = @_; + + return $code unless $self->_rewriting; + + my %old_classes = reverse %{ $self->_upgrading_classes }; + + my $re = join '|', keys %old_classes; + $re = qr/\b($re)\b/; + + $code =~ s/$re/$old_classes{$1} || $1/eg; + + return $code; +} + +sub _load_external { + my ($self, $class) = @_; + + return if $self->{skip_load_external}; + + # so that we don't load our own classes, under any circumstances + local *INC = [ grep $_ ne $self->dump_directory, @INC ]; + + my $real_inc_path = $self->_find_class_in_inc($class); + + my $old_class = $self->_upgrading_classes->{$class} + if $self->_rewriting; + + my $old_real_inc_path = $self->_find_class_in_inc($old_class) + if $old_class && $old_class ne $class; + + return unless $real_inc_path || $old_real_inc_path; + + if ($real_inc_path) { # If we make it to here, we loaded an external definition - warn qq/# Loaded external class definition for '$table_class'\n/ + warn qq/# Loaded external class definition for '$class'\n/ if $self->debug; - if($abs_dump_dir) { - my $class_path = $table_class; - $class_path =~ s{::}{/}g; - $class_path .= '.pm'; - my $filename = Cwd::abs_path($INC{$class_path}); - croak 'Failed to locate actual external module file for ' - . "'$table_class'" - if !$filename; - next if($filename =~ /^$abs_dump_dir/); - open(my $fh, '<', $filename) - or croak "Failed to open $filename for reading: $!"; - $self->_raw_stmt($table_class, - q|# These lines loaded from user-supplied external file: | - ); - while(<$fh>) { - chomp; - $self->_raw_stmt($table_class, $_); - } - $self->_raw_stmt($table_class, - q|# End of lines loaded from user-supplied external file | - ); - close($fh) - or croak "Failed to close $filename: $!"; + open(my $fh, '<', $real_inc_path) + or croak "Failed to open '$real_inc_path' for reading: $!"; + my $code = do { local $/; <$fh> }; + close($fh) + or croak "Failed to close $real_inc_path: $!"; + $code = $self->_rewrite_old_classnames($code); + + if ($self->dynamic) { # load the class too + # kill redefined warnings + my $warn_handler = $SIG{__WARN__} || sub { warn @_ }; + local $SIG{__WARN__} = sub { + $warn_handler->(@_) + unless $_[0] =~ /^Subroutine \S+ redefined/; + }; + eval $code; + die $@ if $@; } + + $self->_ext_stmt($class, + qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n| + .qq|# They are now part of the custom portion of this file\n| + .qq|# for you to hand-edit. If you do not either delete\n| + .qq|# this section or remove that file from \@INC, this section\n| + .qq|# will be repeated redundantly when you re-create this\n| + .qq|# file again via Loader! See skip_load_external to disable\n| + .qq|# this feature.\n| + ); + chomp $code; + $self->_ext_stmt($class, $code); + $self->_ext_stmt($class, + qq|# End of lines loaded from '$real_inc_path' | + ); + } + + if ($old_real_inc_path) { + open(my $fh, '<', $old_real_inc_path) + or croak "Failed to open '$old_real_inc_path' for reading: $!"; + $self->_ext_stmt($class, <<"EOF"); + +# These lines were loaded from '$old_real_inc_path', +# based on the Result class name that would have been created by an 0.04006 +# version of the Loader. For a static schema, this happens only once during +# upgrade. See skip_load_external to disable this feature. +EOF + + my $code = do { + local ($/, @ARGV) = (undef, $old_real_inc_path); <> + }; + $code = $self->_rewrite_old_classnames($code); + + if ($self->dynamic) { + warn <<"EOF"; + +Detected external content in '$old_real_inc_path', a class name that would have +been used by an 0.04006 version of the Loader. + +* PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the +new name of the Result. +EOF + # kill redefined warnings + my $warn_handler = $SIG{__WARN__} || sub { warn @_ }; + local $SIG{__WARN__} = sub { + $warn_handler->(@_) + unless $_[0] =~ /^Subroutine \S+ redefined/; + }; + eval $code; + die $@ if $@; + } + + chomp $code; + $self->_ext_stmt($class, $code); + $self->_ext_stmt($class, + qq|# End of lines loaded from '$old_real_inc_path' | + ); } } @@ -293,15 +759,173 @@ Does the actual schema-construction work. sub load { my $self = shift; - $self->_load_classes; - $self->_load_relationships if ! $self->skip_relationships; - $self->_load_external; - $self->_dump_to_dir if $self->dump_directory; + $self->_load_tables($self->_tables_list); +} + +=head2 rescan + +Arguments: schema + +Rescan the database for newly added tables. Does +not process drops or changes. Returns a list of +the newly added table monikers. + +The schema argument should be the schema class +or object to be affected. It should probably +be derived from the original schema_class used +during L. + +=cut + +sub rescan { + my ($self, $schema) = @_; + + $self->{schema} = $schema; + $self->_relbuilder->{schema} = $schema; + + my @created; + my @current = $self->_tables_list; + foreach my $table ($self->_tables_list) { + if(!exists $self->{_tables}->{$table}) { + push(@created, $table); + } + } + + my $loaded = $self->_load_tables(@created); + + return map { $self->monikers->{$_} } @$loaded; +} + +sub _relbuilder { + no warnings 'uninitialized'; + my ($self) = @_; + + return if $self->{skip_relationships}; + + if ($self->naming->{relationships} eq 'v4') { + require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040; + return $self->{relbuilder} ||= + DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new( + $self->schema, $self->inflect_plural, $self->inflect_singular + ); + } + + $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new ( + $self->schema, + $self->inflect_plural, + $self->inflect_singular, + $self->relationship_attrs, + ); +} + +sub _load_tables { + my ($self, @tables) = @_; + + # First, use _tables_list with constraint and exclude + # to get a list of tables to operate on + + my $constraint = $self->constraint; + my $exclude = $self->exclude; + + @tables = grep { /$constraint/ } @tables if $constraint; + @tables = grep { ! /$exclude/ } @tables if $exclude; + + # Save the new tables to the tables list + foreach (@tables) { + $self->{_tables}->{$_} = 1; + } + + $self->_make_src_class($_) for @tables; + $self->_setup_src_meta($_) for @tables; + + if(!$self->skip_relationships) { + # The relationship loader needs a working schema + $self->{quiet} = 1; + local $self->{dump_directory} = $self->{temp_directory}; + $self->_reload_classes(\@tables); + $self->_load_relationships($_) for @tables; + $self->{quiet} = 0; + + # Remove that temp dir from INC so it doesn't get reloaded + @INC = grep $_ ne $self->dump_directory, @INC; + } + + $self->_load_external($_) + for map { $self->classes->{$_} } @tables; + + # Reload without unloading first to preserve any symbols from external + # packages. + $self->_reload_classes(\@tables, 0); # Drop temporary cache delete $self->{_cache}; - 1; + return \@tables; +} + +sub _reload_classes { + my ($self, $tables, $unload) = @_; + + my @tables = @$tables; + $unload = 1 unless defined $unload; + + # so that we don't repeat custom sections + @INC = grep $_ ne $self->dump_directory, @INC; + + $self->_dump_to_dir(map { $self->classes->{$_} } @tables); + + unshift @INC, $self->dump_directory; + + my @to_register; + my %have_source = map { $_ => $self->schema->source($_) } + $self->schema->sources; + + for my $table (@tables) { + my $moniker = $self->monikers->{$table}; + my $class = $self->classes->{$table}; + + { + no warnings 'redefine'; + local *Class::C3::reinitialize = sub {}; + use warnings; + + Class::Unload->unload($class) if $unload; + my ($source, $resultset_class); + if ( + ($source = $have_source{$moniker}) + && ($resultset_class = $source->resultset_class) + && ($resultset_class ne 'DBIx::Class::ResultSet') + ) { + my $has_file = Class::Inspector->loaded_filename($resultset_class); + Class::Unload->unload($resultset_class) if $unload; + $self->_reload_class($resultset_class) if $has_file; + } + $self->_reload_class($class); + } + push @to_register, [$moniker, $class]; + } + + Class::C3->reinitialize; + for (@to_register) { + $self->schema->register_class(@$_); + } +} + +# We use this instead of ensure_class_loaded when there are package symbols we +# want to preserve. +sub _reload_class { + my ($self, $class) = @_; + + my $class_path = $self->_class_path($class); + delete $INC{ $class_path }; + +# kill redefined warnings + my $warn_handler = $SIG{__WARN__} || sub { warn @_ }; + local $SIG{__WARN__} = sub { + $warn_handler->(@_) + unless $_[0] =~ /^Subroutine \S+ redefined/; + }; + eval "require $class;"; } sub _get_dump_filename { @@ -315,88 +939,228 @@ sub _ensure_dump_subdirs { my ($self, $class) = (@_); my @name_parts = split(/::/, $class); - pop @name_parts; + pop @name_parts; # we don't care about the very last element, + # which is a filename + my $dir = $self->dump_directory; - foreach (@name_parts) { - $dir .= q{/} . $_; - if(! -d $dir) { + while (1) { + if(!-d $dir) { mkdir($dir) or croak "mkdir('$dir') failed: $!"; } + last if !@name_parts; + $dir = File::Spec->catdir($dir, shift @name_parts); } } sub _dump_to_dir { - my ($self) = @_; + my ($self, @classes) = @_; + + my $schema_class = $self->schema_class; + my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema'; my $target_dir = $self->dump_directory; + warn "Dumping manual schema for $schema_class to directory $target_dir ...\n" + unless $self->{dynamic} or $self->{quiet}; + + my $schema_text = + qq|package $schema_class;\n\n| + . qq|# Created by DBIx::Class::Schema::Loader\n| + . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n| + . qq|use strict;\nuse warnings;\n\n| + . qq|use base '$schema_base_class';\n\n|; + + if ($self->use_namespaces) { + $schema_text .= qq|__PACKAGE__->load_namespaces|; + my $namespace_options; + for my $attr (qw(result_namespace + resultset_namespace + default_resultset_class)) { + if ($self->$attr) { + $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n| + } + } + $schema_text .= qq|(\n$namespace_options)| if $namespace_options; + $schema_text .= qq|;\n|; + } + else { + $schema_text .= qq|__PACKAGE__->load_classes;\n|; + } - my $schema_class = $self->schema_class; + { + local $self->{version_to_dump} = $self->schema_version_to_dump; + $self->_write_classfile($schema_class, $schema_text, 1); + } - croak "Must specify target directory for dumping!" if ! $target_dir; + my $result_base_class = $self->result_base_class || 'DBIx::Class::Core'; - warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"; + foreach my $src_class (@classes) { + my $src_text = + qq|package $src_class;\n\n| + . qq|# Created by DBIx::Class::Schema::Loader\n| + . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n| + . qq|use strict;\nuse warnings;\n\n| + . qq|use base '$result_base_class';\n\n|; - if(! -d $target_dir) { - mkdir($target_dir) or croak "mkdir('$target_dir') failed: $!"; + $self->_write_classfile($src_class, $src_text); } - my $verstr = $DBIx::Class::Schema::Loader::VERSION; - my $datestr = POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime); - my $tagline = qq|# Created by DBIx::Class::Schema::Loader v$verstr @ $datestr|; + # remove Result dir if downgrading from use_namespaces, and there are no + # files left. + if (my $result_ns = $self->_downgrading_to_load_classes + || $self->_rewriting_result_namespace) { + my $result_namespace = $self->_result_namespace( + $schema_class, + $result_ns, + ); - $self->_ensure_dump_subdirs($schema_class); + (my $result_dir = $result_namespace) =~ s{::}{/}g; + $result_dir = $self->dump_directory . '/' . $result_dir; - my $schema_fn = $self->_get_dump_filename($schema_class); - if (-f $schema_fn && !$self->dump_overwrite) { - warn "$schema_fn exists, will not overwrite\n"; + unless (my @files = glob "$result_dir/*") { + rmdir $result_dir; + } } - else { - open(my $schema_fh, '>', $schema_fn) - or croak "Cannot open $schema_fn for writing: $!"; - print $schema_fh qq|package $schema_class;\n\n$tagline\n\n|; - print $schema_fh qq|use strict;\nuse warnings;\n\n|; - print $schema_fh qq|use base 'DBIx::Class::Schema';\n\n|; - print $schema_fh qq|__PACKAGE__->load_classes;\n|; - print $schema_fh qq|\n1;\n\n|; - close($schema_fh) - or croak "Cannot close $schema_fn: $!"; - } - - foreach my $src_class (sort keys %{$self->{_dump_storage}}) { - $self->_ensure_dump_subdirs($src_class); - my $src_fn = $self->_get_dump_filename($src_class); - if (-f $src_fn && !$self->dump_overwrite) { - warn "$src_fn exists, will not overwrite\n"; - next; - } - open(my $src_fh, '>', $src_fn) - or croak "Cannot open $src_fn for writing: $!"; - print $src_fh qq|package $src_class;\n\n$tagline\n\n|; - print $src_fh qq|use strict;\nuse warnings;\n\n|; - print $src_fh qq|use base 'DBIx::Class';\n\n|; - print $src_fh qq|$_\n| - for @{$self->{_dump_storage}->{$src_class}}; - print $src_fh qq|\n1;\n\n|; - close($src_fh) - or croak "Cannot close $src_fn: $!"; - } - - warn "Schema dump completed.\n"; + + warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet}; + +} + +sub _sig_comment { + my ($self, $version, $ts) = @_; + return qq|\n\n# Created by DBIx::Class::Schema::Loader| + . qq| v| . $version + . q| @ | . $ts + . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|; +} + +sub _write_classfile { + my ($self, $class, $text, $is_schema) = @_; + + my $filename = $self->_get_dump_filename($class); + $self->_ensure_dump_subdirs($class); + + if (-f $filename && $self->really_erase_my_files) { + warn "Deleting existing file '$filename' due to " + . "'really_erase_my_files' setting\n" unless $self->{quiet}; + unlink($filename); + } + + my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename); + + if (my $old_class = $self->_upgrading_classes->{$class}) { + my $old_filename = $self->_get_dump_filename($old_class); + + my ($old_custom_content) = $self->_get_custom_content( + $old_class, $old_filename, 0 # do not add default comment + ); + + $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//; + + if ($old_custom_content) { + $custom_content = + "\n" . $old_custom_content . "\n" . $custom_content; + } + + unlink $old_filename; + } + + $custom_content = $self->_rewrite_old_classnames($custom_content); + + $text .= qq|$_\n| + for @{$self->{_dump_storage}->{$class} || []}; + + # Check and see if the dump is infact differnt + + my $compare_to; + if ($old_md5) { + $compare_to = $text . $self->_sig_comment($old_ver, $old_ts); + + + if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { + return unless $self->_upgrading_from && $is_schema; + } + } + + $text .= $self->_sig_comment( + $self->version_to_dump, + POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime) + ); + + open(my $fh, '>', $filename) + or croak "Cannot open '$filename' for writing: $!"; + + # Write the top half and its MD5 sum + print $fh $text . Digest::MD5::md5_base64($text) . "\n"; + + # Write out anything loaded via external partial class file in @INC + print $fh qq|$_\n| + for @{$self->{_ext_storage}->{$class} || []}; + + # Write out any custom content the user has added + print $fh $custom_content; + + close($fh) + or croak "Error closing '$filename': $!"; +} + +sub _default_custom_content { + return qq|\n\n# You can replace this text with custom| + . qq| content, and it will be preserved on regeneration| + . qq|\n1;\n|; +} + +sub _get_custom_content { + my ($self, $class, $filename, $add_default) = @_; + + $add_default = 1 unless defined $add_default; + + return ($self->_default_custom_content) if ! -f $filename; + + open(my $fh, '<', $filename) + or croak "Cannot open '$filename' for reading: $!"; + + my $mark_re = + qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n}; + + my $buffer = ''; + my ($md5, $ts, $ver); + while(<$fh>) { + if(!$md5 && /$mark_re/) { + $md5 = $2; + my $line = $1; + + # Pull out the previous version and timestamp + ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s; + + $buffer .= $line; + croak "Checksum mismatch in '$filename', the auto-generated part of the file has been modified outside of this loader. Aborting.\nIf you want to overwrite these modifications, set the 'overwrite_modifications' loader option.\n" + if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5; + + $buffer = ''; + } + else { + $buffer .= $_; + } + } + + croak "Cannot not overwrite '$filename' without 'really_erase_my_files'," + . " it does not appear to have been generated by Loader" + if !$md5; + + # Default custom content: + $buffer ||= $self->_default_custom_content if $add_default; + + return ($buffer, $md5, $ver, $ts); } sub _use { my $self = shift; my $target = shift; - my $evalstr; foreach (@_) { warn "$target: use $_;" if $self->debug; $self->_raw_stmt($target, "use $_;"); - $_->require or croak ($_ . "->require: $@"); - $evalstr .= "package $target; use $_;"; } - eval $evalstr if $evalstr; - croak $@ if $@; } sub _inject { @@ -407,93 +1171,152 @@ sub _inject { my $blist = join(q{ }, @_); warn "$target: use base qw/ $blist /;" if $self->debug && @_; $self->_raw_stmt($target, "use base qw/ $blist /;") if @_; - foreach (@_) { - $_->require or croak ($_ . "->require: $@"); - $schema_class->inject_base($target, $_); +} + +sub _result_namespace { + my ($self, $schema_class, $ns) = @_; + my @result_namespace; + + if ($ns =~ /^\+(.*)/) { + # Fully qualified namespace + @result_namespace = ($1) } + else { + # Relative namespace + @result_namespace = ($schema_class, $ns); + } + + return wantarray ? @result_namespace : join '::', @result_namespace; } -# Load and setup classes -sub _load_classes { - my $self = shift; +# Create class with applicable bases, setup monikers, etc +sub _make_src_class { + my ($self, $table) = @_; my $schema = $self->schema; my $schema_class = $self->schema_class; - my $constraint = $self->constraint; - my $exclude = $self->exclude; - my @tables = sort $self->_tables_list; - warn "No tables found in database, nothing to load" if !@tables; + my $table_moniker = $self->_table2moniker($table); + my @result_namespace = ($schema_class); + if ($self->use_namespaces) { + my $result_namespace = $self->result_namespace || 'Result'; + @result_namespace = $self->_result_namespace( + $schema_class, + $result_namespace, + ); + } + my $table_class = join(q{::}, @result_namespace, $table_moniker); + + if ((my $upgrading_v = $self->_upgrading_from) + || $self->_rewriting) { + local $self->naming->{monikers} = $upgrading_v + if $upgrading_v; - if(@tables) { - @tables = grep { /$constraint/ } @tables if $constraint; - @tables = grep { ! /$exclude/ } @tables if $exclude; + my @result_namespace = @result_namespace; + if ($self->_upgrading_from_load_classes) { + @result_namespace = ($schema_class); + } + elsif (my $ns = $self->_downgrading_to_load_classes) { + @result_namespace = $self->_result_namespace( + $schema_class, + $ns, + ); + } + elsif ($ns = $self->_rewriting_result_namespace) { + @result_namespace = $self->_result_namespace( + $schema_class, + $ns, + ); + } + + my $old_class = join(q{::}, @result_namespace, + $self->_table2moniker($table)); - warn "All tables excluded by constraint/exclude, nothing to load" - if !@tables; + $self->_upgrading_classes->{$table_class} = $old_class + unless $table_class eq $old_class; } - $self->{_tables} = \@tables; + my $table_normalized = lc $table; + $self->classes->{$table} = $table_class; + $self->classes->{$table_normalized} = $table_class; + $self->monikers->{$table} = $table_moniker; + $self->monikers->{$table_normalized} = $table_moniker; - foreach my $table (@tables) { - my $table_moniker = $self->_table2moniker($table); - my $table_class = $schema_class . q{::} . $table_moniker; + $self->_use ($table_class, @{$self->additional_classes}); + $self->_inject($table_class, @{$self->left_base_classes}); - my $table_normalized = lc $table; - $self->classes->{$table} = $table_class; - $self->classes->{$table_normalized} = $table_class; - $self->monikers->{$table} = $table_moniker; - $self->monikers->{$table_normalized} = $table_moniker; + if (my @components = @{ $self->components }) { + $self->_dbic_stmt($table_class, 'load_components', @components); + } + + $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components}) + if @{$self->resultset_components}; + $self->_inject($table_class, @{$self->additional_base_classes}); +} - no warnings 'redefine'; - local *Class::C3::reinitialize = sub { }; - use warnings; +# Set up metadata (cols, pks, etc) +sub _setup_src_meta { + my ($self, $table) = @_; - { no strict 'refs'; @{"${table_class}::ISA"} = qw/DBIx::Class/ } + my $schema = $self->schema; + my $schema_class = $self->schema_class; - $self->_use ($table_class, @{$self->additional_classes}); - $self->_inject($table_class, @{$self->additional_base_classes}); + my $table_class = $self->classes->{$table}; + my $table_moniker = $self->monikers->{$table}; - $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, qw/PK::Auto Core/); + my $table_name = $table; + my $name_sep = $self->schema->storage->sql_maker->name_sep; - $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components}) - if @{$self->resultset_components}; - $self->_inject($table_class, @{$self->left_base_classes}); + if ($name_sep && $table_name =~ /\Q$name_sep\E/) { + $table_name = \ $self->_quote_table_name($table_name); } - Class::C3::reinitialize; + $self->_dbic_stmt($table_class,'table',$table_name); - foreach my $table (@tables) { - my $table_class = $self->classes->{$table}; - my $table_moniker = $self->monikers->{$table}; + my $cols = $self->_table_columns($table); + my $col_info; + eval { $col_info = $self->_columns_info_for($table) }; + if($@) { + $self->_dbic_stmt($table_class,'add_columns',@$cols); + } + else { + if ($self->_is_case_sensitive) { + for my $col (keys %$col_info) { + $col_info->{$col}{accessor} = lc $col + if $col ne lc($col); + } + } else { + $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; + } - $self->_dbic_stmt($table_class,'table',$table); + my $fks = $self->_table_fk_info($table); - my $cols = $self->_table_columns($table); - my $col_info; - eval { $col_info = $self->_columns_info_for($table) }; - if($@) { - $self->_dbic_stmt($table_class,'add_columns',@$cols); - } - else { - my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info; - $self->_dbic_stmt( - $table_class, - 'add_columns', - map { $_, ($col_info_lc{$_}||{}) } @$cols - ); + for my $fkdef (@$fks) { + for my $col (@{ $fkdef->{local_columns} }) { + $col_info->{$col}{is_foreign_key} = 1; + } } + $self->_dbic_stmt( + $table_class, + 'add_columns', + map { $_, ($col_info->{$_}||{}) } @$cols + ); + } - my $pks = $self->_table_pk_info($table) || []; - @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks) - : carp("$table has no primary key"); + my %uniq_tag; # used to eliminate duplicate uniqs - my $uniqs = $self->_table_uniq_info($table) || []; - $self->_dbic_stmt($table_class,'add_unique_constraint',@$_) for (@$uniqs); + my $pks = $self->_table_pk_info($table) || []; + @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks) + : carp("$table has no primary key"); + $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq - $schema_class->register_class($table_moniker, $table_class); - $schema->register_class($table_moniker, $table_class) if $schema ne $schema_class; + my $uniqs = $self->_table_uniq_info($table) || []; + for (@$uniqs) { + my ($name, $cols) = @$_; + next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates + $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols); } + } =head2 tables @@ -506,10 +1329,22 @@ names. sub tables { my $self = shift; - return @{$self->_tables}; + return keys %{$self->_tables}; } # Make a moniker from a table +sub _default_table2moniker { + no warnings 'uninitialized'; + my ($self, $table) = @_; + + if ($self->naming->{monikers} eq 'v4') { + return join '', map ucfirst, split /[\W_]+/, lc $table; + } + + return join '', map ucfirst, split /[\W_]+/, + Lingua::EN::Inflect::Number::to_S(lc $table); +} + sub _table2moniker { my ( $self, $table ) = @_; @@ -522,33 +1357,24 @@ sub _table2moniker { $moniker = $self->moniker_map->($table); } - $moniker ||= join '', map ucfirst, split /[\W_]+/, lc $table; + $moniker ||= $self->_default_table2moniker($table); return $moniker; } sub _load_relationships { - my $self = shift; + my ($self, $table) = @_; - # Construct the fk_info RelBuilder wants to see, by - # translating table names to monikers in the _fk_info output - my %fk_info; - foreach my $table ($self->tables) { - my $tbl_fk_info = $self->_table_fk_info($table); - foreach my $fkdef (@$tbl_fk_info) { - $fkdef->{remote_source} = - $self->monikers->{delete $fkdef->{remote_table}}; - } - my $moniker = $self->monikers->{$table}; - $fk_info{$moniker} = $tbl_fk_info; + my $tbl_fk_info = $self->_table_fk_info($table); + foreach my $fkdef (@$tbl_fk_info) { + $fkdef->{remote_source} = + $self->monikers->{delete $fkdef->{remote_table}}; } + my $tbl_uniq_info = $self->_table_uniq_info($table); - my $relbuilder = DBIx::Class::Schema::Loader::RelBuilder->new( - $self->schema_class, \%fk_info, $self->inflect_plural, - $self->inflect_singular - ); + my $local_moniker = $self->monikers->{$table}; + my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info); - my $rel_stmts = $relbuilder->generate_code; foreach my $src_class (sort keys %$rel_stmts) { my $src_stmts = $rel_stmts->{$src_class}; foreach my $stmt (@$src_stmts) { @@ -578,28 +1404,129 @@ sub _tables_list { croak "ABSTRACT METHOD" } # Execute a constructive DBIC class method, with debug/dump_to_dir hooks. sub _dbic_stmt { - my $self = shift; - my $class = shift; + my $self = shift; + my $class = shift; my $method = shift; - if(!$self->debug && !$self->dump_directory) { - $class->$method(@_); - return; - } + # generate the pod for this statement, storing it with $self->_pod + $self->_make_pod( $class, $method, @_ ) if $self->generate_pod; my $args = dump(@_); $args = '(' . $args . ')' if @_ < 2; my $stmt = $method . $args . q{;}; warn qq|$class\->$stmt\n| if $self->debug; - $class->$method(@_); $self->_raw_stmt($class, '__PACKAGE__->' . $stmt); + return; +} + +# generates the accompanying pod for a DBIC class method statement, +# storing it with $self->_pod +sub _make_pod { + my $self = shift; + my $class = shift; + my $method = shift; + + if ( $method eq 'table' ) { + my ($table) = @_; + my $pcm = $self->pod_comment_mode; + my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc); + if ( $self->can('_table_comment') ) { + $comment = $self->_table_comment($table); + $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length); + $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows)); + $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows)); + } + $self->_pod( $class, "=head1 NAME" ); + my $table_descr = $class; + $table_descr .= " - " . $comment if $comment and $comment_in_name; + $self->{_class2table}{ $class } = $table; + $self->_pod( $class, $table_descr ); + if ($comment and $comment_in_desc) { + $self->_pod( $class, "=head1 DESCRIPTION" ); + $self->_pod( $class, $comment ); + } + $self->_pod_cut( $class ); + } elsif ( $method eq 'add_columns' ) { + $self->_pod( $class, "=head1 ACCESSORS" ); + my $col_counter = 0; + my @cols = @_; + while( my ($name,$attrs) = splice @cols,0,2 ) { + $col_counter++; + $self->_pod( $class, '=head2 ' . $name ); + $self->_pod( $class, + join "\n", map { + my $s = $attrs->{$_}; + $s = !defined $s ? 'undef' : + length($s) == 0 ? '(empty string)' : + $s; + + " $_: $s" + } sort keys %$attrs, + ); + + if( $self->can('_column_comment') + and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter) + ) { + $self->_pod( $class, $comment ); + } + } + $self->_pod_cut( $class ); + } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) { + $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ; + my ( $accessor, $rel_class ) = @_; + $self->_pod( $class, "=head2 $accessor" ); + $self->_pod( $class, 'Type: ' . $method ); + $self->_pod( $class, "Related object: L<$rel_class>" ); + $self->_pod_cut( $class ); + $self->{_relations_started} { $class } = 1; + } +} + +# Stores a POD documentation +sub _pod { + my ($self, $class, $stmt) = @_; + $self->_raw_stmt( $class, "\n" . $stmt ); +} + +sub _pod_cut { + my ($self, $class ) = @_; + $self->_raw_stmt( $class, "\n=cut\n" ); } # Store a raw source line for a class (for dumping purposes) sub _raw_stmt { my ($self, $class, $stmt) = @_; - push(@{$self->{_dump_storage}->{$class}}, $stmt) if $self->dump_directory; + push(@{$self->{_dump_storage}->{$class}}, $stmt); +} + +# Like above, but separately for the externally loaded stuff +sub _ext_stmt { + my ($self, $class, $stmt) = @_; + push(@{$self->{_ext_storage}->{$class}}, $stmt); +} + +sub _quote_table_name { + my ($self, $table) = @_; + + my $qt = $self->schema->storage->sql_maker->quote_char; + + return $table unless $qt; + + if (ref $qt) { + return $qt->[0] . $table . $qt->[1]; + } + + return $qt . $table . $qt; +} + +sub _is_case_sensitive { 0 } + +# remove the dump dir from @INC on destruction +sub DESTROY { + my $self = shift; + + @INC = grep $_ ne $self->dump_directory, @INC; } =head2 monikers @@ -620,6 +1547,15 @@ names, as above in L. L +=head1 AUTHOR + +See L and L. + +=head1 LICENSE + +This library is free software; you can redistribute it and/or modify it under +the same terms as Perl itself. + =cut 1;