X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=6895279a9f07a0a9348c1a797b0eb68aa4a7785d;hb=42e785fae547f52e8212d89086eec625dcfdb2bd;hp=ea22c4f4e3411791fc746c069061ec95faa1a770;hpb=61b3350655e40b9f9f7ef3066ce4ce76dcb75107;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 ea22c4f..6895279 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; @@ -14,11 +14,12 @@ use Digest::MD5 qw//; use Lingua::EN::Inflect::Number qw//; use File::Temp qw//; use Class::Unload; +use Class::Inspector (); require DBIx::Class; -our $VERSION = '0.04999_12'; +our $VERSION = '0.05002'; -__PACKAGE__->mk_ro_accessors(qw/ +__PACKAGE__->mk_group_ro_accessors('simple', qw/ schema schema_class @@ -30,32 +31,47 @@ __PACKAGE__->mk_ro_accessors(qw/ components resultset_components skip_relationships + skip_load_external moniker_map + custom_column_info inflect_singular inflect_plural debug 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 - _upgrading_from - /); + datetime_timezone + datetime_locale +/); + -__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 @@ -81,6 +97,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 @@ -144,6 +165,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 @@ -182,7 +265,7 @@ the chunks back together. Examples: --------------------------- luser | Luser luser_group | LuserGroup - luser-opts | LuserOpts + luser-opts | LuserOpt =head2 inflect_plural @@ -232,6 +315,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 @@ -283,6 +369,67 @@ 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. + +=head2 custom_column_info + +Must be a coderef, returing a hashref with the custom column informations. + +Example: + + custom_column_info => sub { + my $info = shift; + # Example from $info hashref: + # $info = { + # 'DECIMAL_DIGITS' => undef, + # 'COLUMN_DEF' => undef, + # 'TABLE_CAT' => undef, + # 'NUM_PREC_RADIX' => undef, + # 'TABLE_SCHEM' => 'TESTS', + # 'BUFFER_LENGTH' => '8', + # 'CHAR_OCTET_LENGTH' => undef, + # 'IS_NULLABLE' => 'NO', + # 'REMARKS' => undef, + # 'COLUMN_SIZE' => '8', + # 'ORDINAL_POSITION' => '1', + # 'COLUMN_NAME' => 'LOADER_TEST9', + # 'TYPE_NAME' => 'VARCHAR2', + # 'NULLABLE' => '0', + # 'DATA_TYPE' => '12', + # 'TABLE_NAME' => 'LOADER_TEST9', + # 'SQL_DATA_TYPE' => '12', + # 'SQL_DATETIME_SUB' => undef + # }; + + if ( $info->{TYPE_NAME} eq 'DATE' ){ + return { timezone => "Europe/Berlin" }; + } + return; + } + +Add to all columns with type DATE the attribute timezone => "Europe/Berlin". + +=head2 datetime_timezone + +Set timezone attribute for L +to all columns with the type DATE. + +=head2 datetime_locale + +Set local attribute for L +to all columns with the type DATE. + =head1 METHODS None of these methods are intended for direct invocation by regular @@ -291,6 +438,13 @@ can also be found via standard L methods somehow. =cut +use constant CURRENT_V => 'v5'; + +use constant CLASS_ARGS => qw( + schema_base_class result_base_class additional_base_classes + left_base_classes additional_classes components resultset_components +); + # ensure that a peice of object data is a valid arrayref, creating # an empty one or encapsulating whatever's there. sub _ensure_arrayref { @@ -324,11 +478,14 @@ sub new { resultset_components /); + $self->_validate_class_args; + push(@{$self->{components}}, 'ResultSetManager') if @{$self->{resultset_components}}; $self->{monikers} = {}; $self->{classes} = {}; + $self->{_upgrading_classes} = {}; $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} ); $self->{schema} ||= $self->{schema_class}; @@ -348,7 +505,7 @@ sub new { $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) { + if ((not ref $self->naming) && defined $self->naming) { my $naming_ver = $self->naming; $self->{naming} = { relationships => $naming_ver, @@ -356,8 +513,20 @@ sub new { }; } + 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; } @@ -369,9 +538,34 @@ sub _check_back_compat { # 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; } @@ -382,33 +576,122 @@ 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; + 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+)/) { - $self->schema_version_to_dump($real_ver); + 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 _validate_class_args { + my $self = shift; + my $args = shift; + + foreach my $k (CLASS_ARGS) { + next unless $self->$k; + + my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k; + foreach my $c (@classes) { + # components default to being under the DBIx::Class namespace unless they + # are preceeded with a '+' + if ( $k =~ m/components$/ && $c !~ s/^\+// ) { + $c = 'DBIx::Class::' . $c; + } + + # 1 == installed, 0 == not installed, undef == invalid classname + my $installed = Class::Inspector->installed($c); + if ( defined($installed) ) { + if ( $installed == 0 ) { + croak qq/$c, as specified in the loader option "$k", is not installed/; + } + } else { + croak qq/$c, as specified in the loader option "$k", is an invalid class name/; + } + } + } +} + 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)) || ''; + # 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; @@ -430,42 +713,128 @@ 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->_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); - 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; - - 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, $_); + 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' | + ); } - $self->_ext_stmt($class, - qq|# End of lines loaded from '$real_inc_path' | - ); - close($fh) - or croak "Failed to close $real_inc_path: $!"; - if ($self->dynamic) { # load the class too - # turn off redefined warnings - local $SIG{__WARN__} = sub {}; - do $real_inc_path; - die $@ if $@; + 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' | + ); } } @@ -516,6 +885,7 @@ sub rescan { } sub _relbuilder { + no warnings 'uninitialized'; my ($self) = @_; return if $self->{skip_relationships}; @@ -528,8 +898,11 @@ sub _relbuilder { ); } - $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->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, ); } @@ -562,7 +935,7 @@ sub _load_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($_) @@ -633,6 +1006,13 @@ sub _reload_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;"; } @@ -696,7 +1076,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'; @@ -712,6 +1092,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}; } @@ -725,7 +1122,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); @@ -738,6 +1135,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} || []}; @@ -749,7 +1165,7 @@ sub _write_classfile { if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { - return; + return unless $self->_upgrading_from && $is_schema; } } @@ -782,7 +1198,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; @@ -803,8 +1221,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 = ''; } @@ -818,7 +1236,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); } @@ -843,6 +1261,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) = @_; @@ -854,16 +1288,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; @@ -963,6 +1422,7 @@ sub tables { # Make a moniker from a table sub _default_table2moniker { + no warnings 'uninitialized'; my ($self, $table) = @_; if ($self->naming->{monikers} eq 'v4') { @@ -1032,30 +1492,72 @@ 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) = @_; - $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" ); - my $i = 0; - foreach ( @_ ) { - $i++; - next unless $i % 2; - $self->_pod( $class, '=head2 ' . $_ ); - my $comment; - $comment = $self->_column_comment( $self->{_class2table}{$class}, ($i - 1) / 2 + 1 ) if $self->can('_column_comment'); - $self->_pod( $class, $comment ) if $comment; + 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)$/ ) { @@ -1067,13 +1569,6 @@ sub _dbic_stmt { $self->_pod_cut( $class ); $self->{_relations_started} { $class } = 1; } - 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; } # Stores a POD documentation @@ -1087,7 +1582,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) = @_; @@ -1116,6 +1610,44 @@ sub _quote_table_name { sub _is_case_sensitive { 0 } +sub _custom_column_info { + my ( $self, $info ) = @_; + + if( ref $self->custom_column_info eq 'CODE' ) { + return $self->custom_column_info->($info); + } + return {}; +} + +sub _datetime_column_info { + my ( $self, $info, $column_info) = @_; + # warn "_datetime_column_info XXXXXXXXX"; + # use Data::Dumper; + # warn Dumper $info; + # warn Dumper $column_info; + my $return = {}; + my $type = lc ( $info->{TYPE_NAME} ); + + if ( + ( defined $column_info->{inflate_datetime} and $column_info->{inflate_datetime} ) + or ( defined $column_info->{inflate_date} and $column_info->{inflate_date} ) + or ( $type eq 'date') + or ( $type eq 'datetime') + or ( $type eq 'timestamp') + ){ + $return->{timezone} = $self->datetime_timezone if $self->datetime_timezone; + $return->{locale} = $self->datetime_locale if $self->datetime_locale; + } + return $return; +} + +# 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