X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=25b8f86f6e6cdbb34d445986662599b134ded257;hb=f22644d75f6f7bc63bc695c32ad6dd59e7af359b;hp=e0c84b13b9f3b172d8a24346fa2ec5b3c096562b;hpb=457c3335f7fba02629f65407ad3bf515fe90887a;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 e0c84b1..25b8f86 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -2,7 +2,7 @@ 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 DBIx::Class::Schema::Loader::RelBuilder; @@ -16,9 +16,9 @@ use File::Temp qw//; use Class::Unload; require DBIx::Class; -our $VERSION = '0.04999_07'; +our $VERSION = '0.04999_13'; -__PACKAGE__->mk_ro_accessors(qw/ +__PACKAGE__->mk_group_ro_accessors('simple', qw/ schema schema_class @@ -30,6 +30,7 @@ __PACKAGE__->mk_ro_accessors(qw/ components resultset_components skip_relationships + skip_load_external moniker_map inflect_singular inflect_plural @@ -37,18 +38,32 @@ __PACKAGE__->mk_ro_accessors(qw/ dump_directory dump_overwrite really_erase_my_files - use_namespaces result_namespace resultset_namespace default_resultset_class schema_base_class result_base_class + overwrite_modifications + + 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 + use_namespaces +/); =head1 NAME @@ -73,6 +88,94 @@ L. Available constructor options ar 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 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 @@ -101,16 +204,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 @@ -130,7 +234,8 @@ 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'. +Base class for your table classes (aka result classes). Defaults to +'DBIx::Class::Core'. =head2 additional_base_classes @@ -159,6 +264,9 @@ C list if this option is set. =head2 use_namespaces +This is now the default, to go back to L pass +a C<0>. + Generate result class names suitable for L and call that instead of L. When using this option you can also @@ -210,6 +318,19 @@ 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 None of these methods are intended for direct invocation by regular @@ -218,6 +339,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 { @@ -256,6 +379,7 @@ sub new { $self->{monikers} = {}; $self->{classes} = {}; + $self->{_upgrading_classes} = {}; $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} ); $self->{schema} ||= $self->{schema_class}; @@ -265,18 +389,124 @@ sub new { if $self->{dump_overwrite}; $self->{dynamic} = ! $self->{dump_directory}; - $self->{dump_directory} ||= File::Temp::tempdir( 'dbicXXXX', + $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX', TMPDIR => 1, CLEANUP => 1, ); - $self->{relbuilder} = DBIx::Class::Schema::Loader::RelBuilder->new( - $self->schema, $self->inflect_plural, $self->inflect_singular - ) if !$self->{skip_relationships}; + $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; } +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 <_upgrading_from('v4'); + } + + $self->naming->{relationships} ||= 'v4'; + $self->naming->{monikers} ||= 'v4'; + + $self->use_namespaces(0) unless defined $self->use_namespaces; + + 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; + + while (<$fh>) { + if (/^__PACKAGE__->load_classes;/) { + $load_classes = 1; + } elsif (/^# Created by DBIx::Class::Schema::Loader v((\d+)\.(\d+))/) { + my $real_ver = $1; + + # XXX when we go past .0 this will need fixing + my ($v) = $real_ver =~ /([1-9])/; + $v = "v$v"; + + $self->_upgrading_from_load_classes($load_classes) + unless defined $self->use_namespaces; + + 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); + + $self->use_namespaces(0) unless defined $self->use_namespaces; + + last; + } + } + close $fh; +} + sub _find_file_in_inc { my ($self, $file) = @_; @@ -284,49 +514,141 @@ sub _find_file_in_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)) || ''; + (Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || ''); } return; } -sub _load_external { +sub _class_path { my ($self, $class) = @_; my $class_path = $class; $class_path =~ s{::}{/}g; $class_path .= '.pm'; - my $real_inc_path = $self->_find_file_in_inc($class_path); - - return if !$real_inc_path; - - # If we make it to here, we loaded an external definition - warn qq/# Loaded external class definition for '$class'\n/ - if $self->debug; - - croak 'Failed to locate actual external module file for ' - . "'$class'" - if !$real_inc_path; - open(my $fh, '<', $real_inc_path) - or croak "Failed to open '$real_inc_path' for reading: $!"; - $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!\n| - ); - while(<$fh>) { - chomp; - $self->_ext_stmt($class, $_); + return $class_path; +} + +sub _find_class_in_inc { + my ($self, $class) = @_; + + return $self->_find_file_in_inc($self->_class_path($class)); +} + +sub _rewrite_old_classnames { + my ($self, $code) = @_; + + return $code unless $self->_upgrading_from; + + 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->_upgrading_from; + + 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 '$class'\n/ + if $self->debug; + + 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' | + ); } - $self->_ext_stmt($class, - qq|# End of lines loaded from '$real_inc_path' | - ); - close($fh) - or croak "Failed to close $real_inc_path: $!"; } =head2 load @@ -360,7 +682,7 @@ sub rescan { my ($self, $schema) = @_; $self->{schema} = $schema; - $self->{relbuilder}{schema} = $schema; + $self->_relbuilder->{schema} = $schema; my @created; my @current = $self->_tables_list; @@ -375,6 +697,28 @@ sub rescan { 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) = @_; @@ -398,15 +742,21 @@ sub _load_tables { if(!$self->skip_relationships) { # The relationship loader needs a working schema $self->{quiet} = 1; - $self->_reload_classes(@tables); + 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; - $self->_reload_classes(@tables); + # Reload without unloading first to preserve any symbols from external + # packages. + $self->_reload_classes(\@tables, 0); # Drop temporary cache delete $self->{_cache}; @@ -415,7 +765,13 @@ sub _load_tables { } sub _reload_classes { - my ($self, @tables) = @_; + 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); @@ -434,7 +790,7 @@ sub _reload_classes { local *Class::C3::reinitialize = sub {}; use warnings; - Class::Unload->unload($class); + Class::Unload->unload($class) if $unload; my ($source, $resultset_class); if ( ($source = $have_source{$moniker}) @@ -442,10 +798,10 @@ sub _reload_classes { && ($resultset_class ne 'DBIx::Class::ResultSet') ) { my $has_file = Class::Inspector->loaded_filename($resultset_class); - Class::Unload->unload($resultset_class); - $self->schema->ensure_class_loaded($resultset_class) if $has_file; + Class::Unload->unload($resultset_class) if $unload; + $self->_reload_class($resultset_class) if $has_file; } - $self->schema->ensure_class_loaded($class); + $self->_reload_class($class); } push @to_register, [$moniker, $class]; } @@ -456,6 +812,23 @@ sub _reload_classes { } } +# 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 { my ($self, $class) = (@_); @@ -492,6 +865,8 @@ sub _dump_to_dir { 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|; @@ -512,13 +887,18 @@ sub _dump_to_dir { $schema_text .= qq|__PACKAGE__->load_classes;\n|; } - $self->_write_classfile($schema_class, $schema_text); + { + local $self->{version_to_dump} = $self->schema_version_to_dump; + $self->_write_classfile($schema_class, $schema_text, 1); + } - my $result_base_class = $self->result_base_class || 'DBIx::Class'; + my $result_base_class = $self->result_base_class || 'DBIx::Class::Core'; 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|; @@ -529,8 +909,16 @@ sub _dump_to_dir { } +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) = @_; + my ($self, $class, $text, $is_schema) = @_; my $filename = $self->_get_dump_filename($class); $self->_ensure_dump_subdirs($class); @@ -541,18 +929,46 @@ sub _write_classfile { unlink($filename); } - my $custom_content = $self->_get_custom_content($class, $filename); - $custom_content ||= qq|\n\n# You can replace this text with custom| - . qq| content, and it will be preserved on regeneration| - . qq|\n1;\n|; + 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} || []}; - $text .= qq|\n\n# Created by DBIx::Class::Schema::Loader| - . qq| v| . $DBIx::Class::Schema::Loader::VERSION - . q| @ | . POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime) - . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|; + # 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: $!"; @@ -571,24 +987,38 @@ sub _write_classfile { 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) = @_; + my ($self, $class, $filename, $add_default) = @_; + + $add_default = 1 unless defined $add_default; + + return ($self->_default_custom_content) if ! -f $filename; - return 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 $found = 0; my $buffer = ''; + my ($md5, $ts, $ver); while(<$fh>) { - if(!$found && /$mark_re/) { - $found = 1; - $buffer .= $1; - croak "Checksum mismatch in '$filename'" - if Digest::MD5::md5_base64($buffer) ne $2; + 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 = ''; } @@ -599,9 +1029,12 @@ sub _get_custom_content { croak "Cannot not overwrite '$filename' without 'really_erase_my_files'," . " it does not appear to have been generated by Loader" - if !$found; + if !$md5; + + # Default custom content: + $buffer ||= $self->_default_custom_content if $add_default; - return $buffer; + return ($buffer, $md5, $ver, $ts); } sub _use { @@ -646,6 +1079,16 @@ sub _make_src_class { } my $table_class = join(q{::}, @result_namespace, $table_moniker); + if (my $upgrading_v = $self->_upgrading_from) { + local $self->naming->{monikers} = $upgrading_v; + + my $old_class = join(q{::}, @result_namespace, + $self->_table2moniker($table)); + + $self->_upgrading_classes->{$table_class} = $old_class + unless $table_class eq $old_class; + } + my $table_normalized = lc $table; $self->classes->{$table} = $table_class; $self->classes->{$table_normalized} = $table_class; @@ -655,7 +1098,9 @@ sub _make_src_class { $self->_use ($table_class, @{$self->additional_classes}); $self->_inject($table_class, @{$self->left_base_classes}); - $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, 'Core'); + 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}; @@ -672,7 +1117,14 @@ sub _setup_src_meta { my $table_class = $self->classes->{$table}; my $table_moniker = $self->monikers->{$table}; - $self->_dbic_stmt($table_class,'table',$table); + my $table_name = $table; + my $name_sep = $self->schema->storage->sql_maker->name_sep; + + if ($name_sep && $table_name =~ /\Q$name_sep\E/) { + $table_name = \ $self->_quote_table_name($table_name); + } + + $self->_dbic_stmt($table_class,'table',$table_name); my $cols = $self->_table_columns($table); my $col_info; @@ -681,17 +1133,26 @@ sub _setup_src_meta { $self->_dbic_stmt($table_class,'add_columns',@$cols); } else { - my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info; + 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 }; + } + my $fks = $self->_table_fk_info($table); + for my $fkdef (@$fks) { for my $col (@{ $fkdef->{local_columns} }) { - $col_info_lc{$col}->{is_foreign_key} = 1; + $col_info->{$col}{is_foreign_key} = 1; } } $self->_dbic_stmt( $table_class, 'add_columns', - map { $_, ($col_info_lc{$_}||{}) } @$cols + map { $_, ($col_info->{$_}||{}) } @$cols ); } @@ -725,6 +1186,18 @@ sub 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 ) = @_; @@ -737,8 +1210,7 @@ sub _table2moniker { $moniker = $self->moniker_map->($table); } - $moniker ||= join '', map ucfirst, split /[\W_]+/, - Lingua::EN::Inflect::Number::to_S(lc $table); + $moniker ||= $self->_default_table2moniker($table); return $moniker; } @@ -754,7 +1226,7 @@ sub _load_relationships { my $tbl_uniq_info = $self->_table_uniq_info($table); my $local_moniker = $self->monikers->{$table}; - my $rel_stmts = $self->{relbuilder}->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info); + my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info); foreach my $src_class (sort keys %$rel_stmts) { my $src_stmts = $rel_stmts->{$src_class}; @@ -785,18 +1257,88 @@ 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; + # generate the pod for this statement, storing it with $self->_pod + $self->_make_pod( $class, $method, @_ ); + my $args = dump(@_); $args = '(' . $args . ')' if @_ < 2; my $stmt = $method . $args . q{;}; warn qq|$class\->$stmt\n| if $self->debug; $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) = @_; + $self->_pod( $class, "=head1 NAME" ); + my $table_descr = $class; + if ( $self->can('_table_comment') ) { + my $comment = $self->_table_comment($table); + $table_descr .= " - " . $comment if $comment; + } + $self->{_class2table}{ $class } = $table; + $self->_pod( $class, $table_descr ); + $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) = @_; @@ -809,6 +1351,29 @@ sub _ext_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 Returns a hashref of loaded table to moniker mappings. There will @@ -827,6 +1392,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;