X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=4786c842ff9d2269a10a43785894bafb8b90fb48;hb=281d0f3e72ad8c7c44e99496bc6b559af7aaa6fa;hp=575345c029f4b536b0d8ef375bc3b4b040e432a2;hpb=651bced22cd79497990dd362723672660a34f3fe;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 575345c..4786c84 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 Class::C3::Componentised/; +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_10'; +our $VERSION = '0.04999_14'; -__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,21 +38,36 @@ __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_accessors(qw/ + +__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 @@ -77,6 +93,11 @@ 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 @@ -95,7 +116,21 @@ overwriting a dump made with an earlier version. The option also takes a hashref: - naming => { relationships => 'v5', results => 'v4' } + 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: @@ -126,6 +161,68 @@ 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. Smaller table +comments are appended to the C section of the documentation, and larger +ones are inserted into C instead. You can force a C +section to be generated with the comment always, only use C, 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 @@ -154,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 @@ -183,7 +281,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 @@ -212,6 +311,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 @@ -263,6 +365,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 @@ -271,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 { @@ -309,6 +426,7 @@ sub new { $self->{monikers} = {}; $self->{classes} = {}; + $self->{_upgrading_classes} = {}; $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} ); $self->{schema} ||= $self->{schema_class}; @@ -326,22 +444,69 @@ sub new { $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 _check_back_compat { my ($self) = @_; -# dynamic schemas will always be in 0.04006 mode - if ($self->{dynamic}) { - no strict 'refs'; - my $class = ref $self || $self; - unshift @{"${class}::ISA"}, - 'DBIx::Class::Schema::Loader::Compat::v0_040'; - Class::C3::reinitialize; +# 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 < 1' if/when upgrading. + +See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more +details. +EOF + } + 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; } @@ -352,22 +517,79 @@ sub _check_back_compat { open(my $fh, '<', $filename) or croak "Cannot open '$filename' for reading: $!"; + my $load_classes = 0; + my $result_namespace = ''; + while (<$fh>) { - if (/^# Created by DBIx::Class::Schema::Loader v((\d+)\.(\d+))/) { - my $real_ver = $1; - my $ver = "v${2}_${3}"; - while (1) { - my $compat_class = "DBIx::Class::Schema::Loader::Compat::${ver}"; - if ($self->load_optional_class($compat_class)) { - no strict 'refs'; - my $class = ref $self || $self; - unshift @{"${class}::ISA"}, $compat_class; - Class::C3::reinitialize; - $self->version_to_dump($real_ver); - last; + 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' + ); } - $ver =~ s/\d\z// or last; } + + # 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; } } @@ -380,50 +602,153 @@ sub _find_file_in_inc { 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)) || ''; + # abs_path throws on Windows for nonexistant files + and eval { Cwd::abs_path($fullpath) } ne + (eval { 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 _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 '$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 @@ -473,12 +798,24 @@ sub rescan { } sub _relbuilder { + no warnings 'uninitialized'; my ($self) = @_; return if $self->{skip_relationships}; - $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new( - $self->schema, $self->inflect_plural, $self->inflect_singular + 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, ); } @@ -506,18 +843,20 @@ sub _load_tables { # The relationship loader needs a working schema $self->{quiet} = 1; local $self->{dump_directory} = $self->{temp_directory}; - $self->_reload_classes(@tables); + $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; + @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}; @@ -526,7 +865,10 @@ 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; @@ -548,7 +890,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}) @@ -556,10 +898,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->ensure_class_loaded($resultset_class) if $has_file; + Class::Unload->unload($resultset_class) if $unload; + $self->_reload_class($resultset_class) if $has_file; } - $self->ensure_class_loaded($class); + $self->_reload_class($class); } push @to_register, [$moniker, $class]; } @@ -570,6 +912,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) = (@_); @@ -628,9 +987,12 @@ 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 = @@ -643,6 +1005,23 @@ sub _dump_to_dir { $self->_write_classfile($src_class, $src_text); } + # 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, + ); + + (my $result_dir = $result_namespace) =~ s{::}{/}g; + $result_dir = $self->dump_directory . '/' . $result_dir; + + unless (my @files = glob "$result_dir/*") { + rmdir $result_dir; + } + } + warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet}; } @@ -656,7 +1035,7 @@ sub _sig_comment { } 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); @@ -669,6 +1048,25 @@ sub _write_classfile { 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} || []}; @@ -680,7 +1078,7 @@ sub _write_classfile { if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { - return; + return unless $self->_upgrading_from && $is_schema; } } @@ -713,7 +1111,9 @@ sub _default_custom_content { } 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; @@ -734,8 +1134,8 @@ sub _get_custom_content { ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s; $buffer .= $line; - croak "Checksum mismatch in '$filename'" - if Digest::MD5::md5_base64($buffer) ne $md5; + 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 = ''; } @@ -749,7 +1149,7 @@ sub _get_custom_content { if !$md5; # Default custom content: - $buffer ||= $self->_default_custom_content; + $buffer ||= $self->_default_custom_content if $add_default; return ($buffer, $md5, $ver, $ts); } @@ -774,6 +1174,22 @@ sub _inject { $self->_raw_stmt($target, "use base qw/ $blist /;") if @_; } +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; +} + # Create class with applicable bases, setup monikers, etc sub _make_src_class { my ($self, $table) = @_; @@ -785,16 +1201,41 @@ sub _make_src_class { my @result_namespace = ($schema_class); if ($self->use_namespaces) { my $result_namespace = $self->result_namespace || 'Result'; - if ($result_namespace =~ /^\+(.*)/) { - # Fully qualified namespace - @result_namespace = ($1) + @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; + + my @result_namespace = @result_namespace; + if ($self->_upgrading_from_load_classes) { + @result_namespace = ($schema_class); } - else { - # Relative namespace - push @result_namespace, $result_namespace; + 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)); + + $self->_upgrading_classes->{$table_class} = $old_class + unless $table_class eq $old_class; } - my $table_class = join(q{::}, @result_namespace, $table_moniker); my $table_normalized = lc $table; $self->classes->{$table} = $table_class; @@ -805,7 +1246,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}; @@ -892,8 +1335,13 @@ 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); } @@ -957,16 +1405,94 @@ 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, @_ ) if $self->generate_pod; + 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) = @_; + 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) @@ -997,6 +1523,13 @@ sub _quote_table_name { 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 @@ -1017,7 +1550,7 @@ L =head1 AUTHOR -See L. +See L and L. =head1 LICENSE