X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=659017b010ebf5890c7a3ee0301fb8e4fe576293;hb=f3ea13a83557a591d55a5cf1dc5081d2e0679f38;hp=0af428589404d6d9295a0ebc30003b30da632c34;hpb=bf654ab90bfe99fc20b7c2c74017c842c6d71960;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 0af4285..659017b 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -3,6 +3,7 @@ package DBIx::Class::Schema::Loader::Base; use strict; use warnings; use base qw/Class::Accessor::Grouped Class::C3::Componentised/; +use namespace::autoclean; use Class::C3; use Carp::Clan qw/^DBIx::Class/; use DBIx::Class::Schema::Loader::RelBuilder; @@ -12,11 +13,17 @@ use File::Spec qw//; use Cwd qw//; use Digest::MD5 qw//; use Lingua::EN::Inflect::Number qw//; +use Lingua::EN::Inflect::Phrase qw//; use File::Temp qw//; use Class::Unload; +use Class::Inspector (); +use Data::Dumper::Concise; +use Scalar::Util 'looks_like_number'; +use File::Slurp 'slurp'; +use DBIx::Class::Schema::Loader::Constants 'BY_CASE_TRANSITION'; require DBIx::Class; -our $VERSION = '0.04999_12'; +our $VERSION = '0.07000'; __PACKAGE__->mk_group_ro_accessors('simple', qw/ schema @@ -32,14 +39,13 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ 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 @@ -55,6 +61,10 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ monikers dynamic naming + datetime_timezone + datetime_locale + config_file + loader_class /); @@ -62,6 +72,15 @@ __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 + preserve_case /); =head1 NAME @@ -94,15 +113,15 @@ 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 +Static schemas (ones dumped to disk) will, by default, use the new-style 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. +existing dump made by an older version of L, in +which case the backward compatible RelBuilder will be activated, and the +appropriate monikerization used. Specifying - naming => 'v5' + naming => 'current' will disable the backward-compatible RelBuilder and use the new-style relationship names along with singularized Results, even when @@ -110,7 +129,7 @@ overwriting a dump made with an earlier version. The option also takes a hashref: - naming => { relationships => 'v5', monikers => 'v4' } + naming => { relationships => 'v6', monikers => 'v6' } The keys are: @@ -124,6 +143,10 @@ How to name relationship accessors. How to name Result classes. +=item column_accessors + +How to name column accessors in Result classes. + =back The values can be: @@ -132,15 +155,41 @@ The values can be: =item current -Latest default style, whatever that happens to be. +Latest style, whatever that happens to be. + +=item v4 + +Unsingularlized monikers, C only relationships with no _id stripping. =item v5 -Version 0.05XXX style. +Monikers singularized as whole words, C relationships for FKs on +C constraints, C<_id> stripping for belongs_to relationships. -=item v4 +Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for +the v5 RelBuilder. + +=item v6 + +All monikers and relationships are inflected using +L, and there is more aggressive C<_id> stripping +from relationship names. + +In general, there is very little difference between v5 and v6 schemas. + +=item v7 + +This mode is identical to C mode, except that monikerization of CamelCase +table names is also done correctly. + +CamelCase column names in case-preserving mode will also be handled correctly +for relationship name inflection. See L. + +In this mode, CamelCase L are normalized based on case +transition instead of just being lowercased, so C becomes C. -Version 0.04XXX style. +If you don't have any CamelCase table or column names, you can upgrade without +breaking any of your code. =back @@ -155,6 +204,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. 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 @@ -165,15 +256,10 @@ relationship types override those set in 'all'. For example: relationship_attrs => { - all => { cascade_delete => 0 }, - has_many => { cascade_delete => 1 }, + belongs_to => { is_deferrable => 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. +use this to make your foreign key constraints DEFERRABLE. =head2 debug @@ -203,17 +289,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 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: +The default behavior is to split on case transition and non-alphanumeric +boundaries, singularize the resulting phrase, then join the titlecased words +together. Examples: - Table Name | Moniker Name - --------------------------- - luser | Luser - luser_group | LuserGroup - luser-opts | LuserOpts + Table Name | Moniker Name + --------------------------------- + luser | Luser + luser_group | LuserGroup + luser-opts | LuserOpt + stations_visited | StationVisited + routeChange | RouteChange =head2 inflect_plural @@ -252,7 +338,8 @@ List of additional classes which all of your table classes will use. =head2 components List of additional components to be loaded into all of your table -classes. A good example would be C. +classes. A good example would be +L =head2 resultset_components @@ -263,6 +350,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 @@ -327,15 +417,69 @@ 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 + +Hook for adding extra attributes to the +L for a column. + +Must be a coderef that returns a hashref with the extra attributes. + +Receives the table name, column name and column_info. + +For example: + + custom_column_info => sub { + my ($table_name, $column_name, $column_info) = @_; + + if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') { + return { is_snoopy => 1 }; + } + }, + +This attribute can also be used to set C on a non-datetime +column so it also receives the L and/or L. + +=head2 datetime_timezone + +Sets the timezone attribute for L for all +columns with the DATE/DATETIME/TIMESTAMP data_types. + +=head2 datetime_locale + +Sets the locale attribute for L for all +columns with the DATE/DATETIME/TIMESTAMP data_types. + +=head1 config_file + +File in Perl format, which should return a HASH reference, from which to read +loader options. + +=head1 preserve_case + +Usually column names are lowercased, to make them easier to work with in +L. This option lets you turn this behavior off, if the driver +supports it. + +Drivers for case sensitive databases like Sybase ASE or MSSQL with a +case-sensitive collation will turn this option on unconditionally. + +Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support +setting this option. + =head1 METHODS None of these methods are intended for direct invocation by regular -users of L. Anything you can find here -can also be found via standard L methods somehow. +users of L. Some are proxied via +L. =cut -use constant CURRENT_V => 'v5'; +my $CURRENT_V = 'v7'; + +my @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. @@ -363,6 +507,18 @@ sub new { bless $self => $class; + if (my $config_file = $self->config_file) { + my $config_opts = do $config_file; + + croak "Error reading config from $config_file: $@" if $@; + + croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH'; + + while (my ($k, $v) = each %$config_opts) { + $self->{$k} = $v unless exists $self->{$k}; + } + } + $self->_ensure_arrayref(qw/additional_classes additional_base_classes left_base_classes @@ -370,6 +526,8 @@ sub new { resultset_components /); + $self->_validate_class_args; + push(@{$self->{components}}, 'ResultSetManager') if @{$self->{resultset_components}}; @@ -400,18 +558,28 @@ sub new { $self->{naming} = { relationships => $naming_ver, monikers => $naming_ver, + column_accessors => $naming_ver, }; } if ($self->naming) { for (values %{ $self->naming }) { - $_ = CURRENT_V if $_ eq 'current'; + $_ = $CURRENT_V if $_ eq 'current'; } } $self->{naming} ||= {}; + if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') { + croak 'custom_column_info must be a CODE ref'; + } + $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 +599,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 +612,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,15 +629,56 @@ 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])/; $v = "v$v"; - last if $v eq CURRENT_V || $real_ver =~ /^0\.04999/; + last if $v eq $CURRENT_V || $real_ver =~ /^0\.\d\d999/; if (not %{ $self->naming }) { warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; @@ -470,16 +688,20 @@ 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. +See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base . + +See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading +from version 0.04006. EOF } else { $self->_upgrading_from($v); + last; } - $self->naming->{relationships} ||= $v; - $self->naming->{monikers} ||= $v; + $self->naming->{relationships} ||= $v; + $self->naming->{monikers} ||= $v; + $self->naming->{column_accessors} ||= $v; $self->schema_version_to_dump($real_ver); @@ -489,14 +711,43 @@ EOF 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; @@ -518,6 +769,31 @@ 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) = @_; @@ -529,7 +805,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; @@ -543,23 +819,10 @@ sub _load_external { 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, $_); - } - $self->_ext_stmt($class, - qq|# End of lines loaded from '$real_inc_path' | - ); + 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 @@ -568,9 +831,24 @@ sub _load_external { $warn_handler->(@_) unless $_[0] =~ /^Subroutine \S+ redefined/; }; - do $real_inc_path; + 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) { @@ -578,15 +856,20 @@ sub _load_external { 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. +# These lines were loaded from '$old_real_inc_path', +# based on the Result class name that would have been created by an older +# 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 = slurp $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. +been used by an older version of the Loader. * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the new name of the Result. @@ -597,24 +880,15 @@ EOF $warn_handler->(@_) unless $_[0] =~ /^Subroutine \S+ redefined/; }; - my $code = do { - local ($/, @ARGV) = (undef, $old_real_inc_path); <> - }; - $code =~ s/$old_class/$class/g; eval $code; die $@ if $@; } - while(<$fh>) { - chomp; - $self->_ext_stmt($class, $_); - } + chomp $code; + $self->_ext_stmt($class, $code); $self->_ext_stmt($class, qq|# End of lines loaded from '$old_real_inc_path' | ); - - close($fh) - or croak "Failed to close $old_real_inc_path: $!"; } } @@ -627,7 +901,9 @@ Does the actual schema-construction work. sub load { my $self = shift; - $self->_load_tables($self->_tables_list); + $self->_load_tables( + $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude }) + ); } =head2 rescan @@ -652,13 +928,22 @@ sub rescan { $self->_relbuilder->{schema} = $schema; my @created; - my @current = $self->_tables_list; - foreach my $table ($self->_tables_list) { + my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude }); + + foreach my $table (@current) { if(!exists $self->{_tables}->{$table}) { push(@created, $table); } } + my %current; + @current{@current} = (); + foreach my $table (keys %{ $self->{_tables} }) { + if (not exists $current{$table}) { + $self->_unregister_source_for_table($table); + } + } + my $loaded = $self->_load_tables(@created); return map { $self->monikers->{$_} } @$loaded; @@ -674,36 +959,75 @@ sub _relbuilder { 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->schema, + $self->inflect_plural, + $self->inflect_singular, + $self->relationship_attrs, ); } + elsif ($self->naming->{relationships} eq 'v5') { + require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05; + return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05->new ( + $self->schema, + $self->inflect_plural, + $self->inflect_singular, + $self->relationship_attrs, + ); + } + elsif ($self->naming->{relationships} eq 'v6') { + require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06; + return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06->new ( + $self->schema, + $self->inflect_plural, + $self->inflect_singular, + $self->relationship_attrs, + ); + } - $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new ( - $self->schema, - $self->inflect_plural, - $self->inflect_singular, - $self->relationship_attrs, + return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new ( + $self->schema, + $self->inflect_plural, + $self->inflect_singular, + $self->relationship_attrs, ); } sub _load_tables { my ($self, @tables) = @_; - # First, use _tables_list with constraint and exclude - # to get a list of tables to operate on - - my $constraint = $self->constraint; - my $exclude = $self->exclude; - - @tables = grep { /$constraint/ } @tables if $constraint; - @tables = grep { ! /$exclude/ } @tables if $exclude; - # Save the new tables to the tables list foreach (@tables) { $self->{_tables}->{$_} = 1; } $self->_make_src_class($_) for @tables; + + # sanity-check for moniker clashes + my $inverse_moniker_idx; + for (keys %{$self->monikers}) { + push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_; + } + + my @clashes; + for (keys %$inverse_moniker_idx) { + my $tables = $inverse_moniker_idx->{$_}; + if (@$tables > 1) { + push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'", + join (', ', map { "'$_'" } @$tables), + $_, + ); + } + } + + if (@clashes) { + die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. ' + . 'Either change the naming style, or supply an explicit moniker_map: ' + . join ('; ', @clashes) + . "\n" + ; + } + + $self->_setup_src_meta($_) for @tables; if(!$self->skip_relationships) { @@ -840,9 +1164,12 @@ sub _dump_to_dir { if ($self->use_namespaces) { $schema_text .= qq|__PACKAGE__->load_namespaces|; my $namespace_options; - for my $attr (qw(result_namespace - resultset_namespace - default_resultset_class)) { + + my @attr = qw/resultset_namespace default_resultset_class/; + + unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result'; + + for my $attr (@attr) { if ($self->$attr) { $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n| } @@ -856,7 +1183,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'; @@ -872,6 +1199,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}; } @@ -885,7 +1229,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); @@ -898,27 +1242,25 @@ 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 ($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 - ); + if (my $old_class = $self->_upgrading_classes->{$class}) { + my $old_filename = $self->_get_dump_filename($old_class); - $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); + $text .= qq|$_\n| for @{$self->{_dump_storage}->{$class} || []}; @@ -930,7 +1272,7 @@ sub _write_classfile { if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { - return; + return unless $self->_upgrading_from && $is_schema; } } @@ -1026,6 +1368,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) = @_; @@ -1037,31 +1395,49 @@ 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; +# this was a bad idea, should be ok now without it +# my $table_normalized = lc $table; +# $self->classes->{$table_normalized} = $table_class; +# $self->monikers->{$table_normalized} = $table_moniker; + $self->classes->{$table} = $table_class; - $self->classes->{$table_normalized} = $table_class; $self->monikers->{$table} = $table_moniker; - $self->monikers->{$table_normalized} = $table_moniker; $self->_use ($table_class, @{$self->additional_classes}); $self->_inject($table_class, @{$self->left_base_classes}); @@ -1075,6 +1451,41 @@ sub _make_src_class { $self->_inject($table_class, @{$self->additional_base_classes}); } +sub _resolve_col_accessor_collisions { + my ($self, $col_info) = @_; + + my $base = $self->result_base_class || 'DBIx::Class::Core'; + my @components = map "DBIx::Class::$_", @{ $self->components || [] }; + + my @methods; + + for my $class ($base, @components) { + eval "require ${class};"; + die $@ if $@; + + push @methods, @{ Class::Inspector->methods($class) || [] }; + } + + my %methods; + @methods{@methods} = (); + + while (my ($col, $info) = each %$col_info) { + my $accessor = $info->{accessor} || $col; + + next if $accessor eq 'id'; # special case (very common column) + + if (exists $methods{$accessor}) { + $info->{accessor} = undef; + } + } +} + +sub _make_column_accessor_name { + my ($self, $column_name) = @_; + + return join '_', map lc, split BY_CASE_TRANSITION, $column_name; +} + # Set up metadata (cols, pks, etc) sub _setup_src_meta { my ($self, $table) = @_; @@ -1095,34 +1506,38 @@ sub _setup_src_meta { $self->_dbic_stmt($table_class,'table',$table_name); my $cols = $self->_table_columns($table); - my $col_info; - eval { $col_info = $self->_columns_info_for($table) }; - if($@) { - $self->_dbic_stmt($table_class,'add_columns',@$cols); - } - else { - if ($self->_is_case_sensitive) { - for my $col (keys %$col_info) { - $col_info->{$col}{accessor} = lc $col - if $col ne lc($col); + my $col_info = $self->__columns_info_for($table); + if ($self->preserve_case) { + for my $col (keys %$col_info) { + if ($col ne lc($col)) { + if ((not exists $self->naming->{column_accessors}) || (($self->naming->{column_accessors} =~ /(\d+)/)[0] >= 7)) { + $col_info->{$col}{accessor} = $self->_make_column_accessor_name($col); + } + else { + $col_info->{$col}{accessor} = lc $col; + } } - } else { - $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; } + } + else { + # XXX this needs to go away + $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; + } - my $fks = $self->_table_fk_info($table); + $self->_resolve_col_accessor_collisions($col_info); - for my $fkdef (@$fks) { - for my $col (@{ $fkdef->{local_columns} }) { - $col_info->{$col}{is_foreign_key} = 1; - } + my $fks = $self->_table_fk_info($table); + + for my $fkdef (@$fks) { + for my $col (@{ $fkdef->{local_columns} }) { + $col_info->{$col}{is_foreign_key} = 1; } - $self->_dbic_stmt( - $table_class, - 'add_columns', - map { $_, ($col_info->{$_}||{}) } @$cols - ); } + $self->_dbic_stmt( + $table_class, + 'add_columns', + map { $_, ($col_info->{$_}||{}) } @$cols + ); my %uniq_tag; # used to eliminate duplicate uniqs @@ -1140,6 +1555,21 @@ sub _setup_src_meta { } +sub __columns_info_for { + my ($self, $table) = @_; + + my $result = $self->_columns_info_for($table); + + while (my ($col, $info) = each %$result) { + $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } }; + $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } }; + + $result->{$col} = $info; + } + + return $result; +} + =head2 tables Returns a sorted list of loaded tables, using the original database table @@ -1161,9 +1591,23 @@ sub _default_table2moniker { if ($self->naming->{monikers} eq 'v4') { return join '', map ucfirst, split /[\W_]+/, lc $table; } + elsif ($self->naming->{monikers} eq 'v5') { + return join '', map ucfirst, split /[\W_]+/, + Lingua::EN::Inflect::Number::to_S(lc $table); + } + elsif ($self->naming->{monikers} eq 'v6') { + (my $as_phrase = lc $table) =~ s/_+/ /g; + my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase); + + return join '', map ucfirst, split /\W+/, $inflected; + } + + my @words = map lc, split BY_CASE_TRANSITION, $table; + my $as_phrase = join ' ', @words; - return join '', map ucfirst, split /[\W_]+/, - Lingua::EN::Inflect::Number::to_S(lc $table); + my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase); + + return join '', map ucfirst, split /\W+/, $inflected; } sub _table2moniker { @@ -1230,7 +1674,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; @@ -1250,14 +1694,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" ); @@ -1269,9 +1722,18 @@ sub _make_pod { $self->_pod( $class, join "\n", map { my $s = $attrs->{$_}; - $s = !defined $s ? 'undef' : - length($s) == 0 ? '(empty string)' : - $s; + $s = !defined $s ? 'undef' : + length($s) == 0 ? '(empty string)' : + ref($s) eq 'SCALAR' ? $$s : + ref($s) ? do { + my $dd = Dumper; + $dd->Indent(0); + $dd->Values([$s]); + $dd->Dump; + } : + looks_like_number($s) ? $s : + qq{'$s'} + ; " $_: $s" } sort keys %$attrs, @@ -1306,7 +1768,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) = @_; @@ -1333,7 +1794,54 @@ sub _quote_table_name { return $qt . $table . $qt; } -sub _is_case_sensitive { 0 } +sub _custom_column_info { + my ( $self, $table_name, $column_name, $column_info ) = @_; + + if (my $code = $self->custom_column_info) { + return $code->($table_name, $column_name, $column_info) || {}; + } + return {}; +} + +sub _datetime_column_info { + my ( $self, $table_name, $column_name, $column_info ) = @_; + my $result = {}; + my $type = $column_info->{data_type} || ''; + if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/}) + or ($type =~ /date|timestamp/i)) { + $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone; + $result->{locale} = $self->datetime_locale if $self->datetime_locale; + } + return $result; +} + +sub _lc { + my ($self, $name) = @_; + + return $self->preserve_case ? $name : lc($name); +} + +sub _uc { + my ($self, $name) = @_; + + return $self->preserve_case ? $name : uc($name); +} + +sub _unregister_source_for_table { + my ($self, $table) = @_; + + eval { + local $@; + my $schema = $self->schema; + # in older DBIC it's a private method + my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source'); + $schema->$unregister($self->_table2moniker($table)); + delete $self->monikers->{$table}; + delete $self->classes->{$table}; + delete $self->_upgrading_classes->{$table}; + delete $self->{_tables}{$table}; + }; +} # remove the dump dir from @INC on destruction sub DESTROY { @@ -1372,3 +1880,4 @@ the same terms as Perl itself. =cut 1; +# vim:et sts=4 sw=4 tw=0: