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=03a302186cd5e6b9331f0dafc017a8033293874e;hpb=1fa1884903b09903ce89a3814e41bac9e91eea9d;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 03a3021..39431fa 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -16,7 +16,7 @@ use File::Temp qw//; use Class::Unload; require DBIx::Class; -our $VERSION = '0.04999_13'; +our $VERSION = '0.04999_14'; __PACKAGE__->mk_group_ro_accessors('simple', qw/ schema @@ -38,8 +38,6 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ dump_directory dump_overwrite really_erase_my_files - use_namespaces - result_namespace resultset_namespace default_resultset_class schema_base_class @@ -62,6 +60,14 @@ __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 @@ -155,6 +161,48 @@ 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 @@ -213,7 +261,7 @@ the chunks back together. Examples: --------------------------- luser | Luser luser_group | LuserGroup - luser-opts | LuserOpts + luser-opts | LuserOpt =head2 inflect_plural @@ -263,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 @@ -412,6 +463,11 @@ sub new { $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; } @@ -431,6 +487,8 @@ Dynamic schema detected, will run in 0.04006 mode. Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable to disable this warning. +Also consider setting 'use_namespaces => 1' if/when upgrading. + See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more details. EOF @@ -442,6 +500,13 @@ EOF $self->naming->{relationships} ||= 'v4'; $self->naming->{monikers} ||= 'v4'; + if ($self->use_namespaces) { + $self->_upgrading_from_load_classes(1); + } + else { + $self->use_namespaces(0); + } + return; } @@ -452,9 +517,50 @@ EOF 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; + 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])/; @@ -476,6 +582,7 @@ EOF } else { $self->_upgrading_from($v); + last; } $self->naming->{relationships} ||= $v; @@ -518,17 +625,27 @@ sub _find_class_in_inc { 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->_upgrading_from; + 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}/eg; + $code =~ s/$re/$old_classes{$1} || $1/eg; return $code; } @@ -544,7 +661,7 @@ sub _load_external { my $real_inc_path = $self->_find_class_in_inc($class); my $old_class = $self->_upgrading_classes->{$class} - if $self->_upgrading_from; + if $self->_rewriting; my $old_real_inc_path = $self->_find_class_in_inc($old_class) if $old_class && $old_class ne $class; @@ -580,7 +697,8 @@ sub _load_external { .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| + .qq|# file again via Loader! See skip_load_external to disable\n| + .qq|# this feature.\n| ); chomp $code; $self->_ext_stmt($class, $code); @@ -597,7 +715,7 @@ sub _load_external { # 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. +# upgrade. See skip_load_external to disable this feature. EOF my $code = do { @@ -870,7 +988,7 @@ sub _dump_to_dir { { local $self->{version_to_dump} = $self->schema_version_to_dump; - $self->_write_classfile($schema_class, $schema_text); + $self->_write_classfile($schema_class, $schema_text, 1); } my $result_base_class = $self->result_base_class || 'DBIx::Class::Core'; @@ -886,6 +1004,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}; } @@ -899,7 +1034,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); @@ -912,25 +1047,21 @@ sub _write_classfile { my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename); - if ($self->_upgrading_from) { - my $old_class = $self->_upgrading_classes->{$class}; + if (my $old_class = $self->_upgrading_classes->{$class}) { + my $old_filename = $self->_get_dump_filename($old_class); - if ($old_class && ($old_class ne $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//; + my ($old_custom_content) = $self->_get_custom_content( + $old_class, $old_filename, 0 # do not add default comment + ); - if ($old_custom_content) { - $custom_content = - "\n" . $old_custom_content . "\n" . $custom_content; - } + $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//; - unlink $old_filename; + if ($old_custom_content) { + $custom_content = + "\n" . $old_custom_content . "\n" . $custom_content; } + + unlink $old_filename; } $custom_content = $self->_rewrite_old_classnames($custom_content); @@ -946,7 +1077,7 @@ sub _write_classfile { if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { - return; + return unless $self->_upgrading_from && $is_schema; } } @@ -1042,6 +1173,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) = @_; @@ -1053,24 +1200,40 @@ 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) - } - else { - # Relative namespace - push @result_namespace, $result_namespace; - } + @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) { - local $self->naming->{monikers} = $upgrading_v; + 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); + } + 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; + $self->_upgrading_classes->{$table_class} = $old_class + unless $table_class eq $old_class; } my $table_normalized = lc $table; @@ -1246,7 +1409,7 @@ sub _dbic_stmt { my $method = shift; # generate the pod for this statement, storing it with $self->_pod - $self->_make_pod( $class, $method, @_ ); + $self->_make_pod( $class, $method, @_ ) if $self->generate_pod; my $args = dump(@_); $args = '(' . $args . ')' if @_ < 2; @@ -1266,14 +1429,23 @@ sub _make_pod { if ( $method eq 'table' ) { my ($table) = @_; - $self->_pod( $class, "=head1 NAME" ); - my $table_descr = $class; + my $pcm = $self->pod_comment_mode; + my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc); if ( $self->can('_table_comment') ) { - my $comment = $self->_table_comment($table); - $table_descr .= " - " . $comment if $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" ); @@ -1322,7 +1494,6 @@ sub _pod_cut { $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) = @_;