X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-Schema-Loader.git;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=84bee4082bc4ec1b34222aca2fbfe44826e71aac;hp=a4861225304f7ef41d1a3f64044c78caa4f97ce8;hb=6947b5d664d1e4136dfe8d410f821e0a4bdaba31;hpb=492dce8da93ceb9dd348cd8fd155ecb08bf95093 diff --git a/lib/DBIx/Class/Schema/Loader/Base.pm b/lib/DBIx/Class/Schema/Loader/Base.pm index a486122..84bee40 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -3,7 +3,7 @@ package DBIx::Class::Schema::Loader::Base; use strict; use warnings; use base qw/Class::Accessor::Grouped Class::C3::Componentised/; -use Class::C3; +use mro 'c3'; use Carp::Clan qw/^DBIx::Class/; use DBIx::Class::Schema::Loader::RelBuilder; use Data::Dump qw/ dump /; @@ -12,11 +12,19 @@ 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; -require DBIx::Class; +use Class::Inspector (); +use Scalar::Util 'looks_like_number'; +use File::Slurp 'slurp'; +use DBIx::Class::Schema::Loader::Utils qw/split_name dumper_squashed eval_without_redefine_warnings/; +use DBIx::Class::Schema::Loader::Optional::Dependencies (); +use Try::Tiny; +use DBIx::Class (); +use namespace::clean; -our $VERSION = '0.04999_14'; +our $VERSION = '0.07002'; __PACKAGE__->mk_group_ro_accessors('simple', qw/ schema @@ -32,6 +40,7 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ skip_relationships skip_load_external moniker_map + custom_column_info inflect_singular inflect_plural debug @@ -42,7 +51,8 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ default_resultset_class schema_base_class result_base_class - overwrite_modifications + use_moose + overwrite_modifications relationship_attrs @@ -53,6 +63,11 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ monikers dynamic naming + datetime_timezone + datetime_locale + config_file + loader_class + qualify_objects /); @@ -66,6 +81,9 @@ __PACKAGE__->mk_group_accessors('simple', qw/ use_namespaces result_namespace generate_pod + pod_comment_mode + pod_comment_spillover_length + preserve_case /); =head1 NAME @@ -98,15 +116,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 @@ -114,7 +132,7 @@ overwriting a dump made with an earlier version. The option also takes a hashref: - naming => { relationships => 'v5', monikers => 'v4' } + naming => { relationships => 'v7', monikers => 'v7' } The keys are: @@ -128,6 +146,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: @@ -136,15 +158,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. -Version 0.04XXX style. +=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. + +If you don't have any CamelCase table or column names, you can upgrade without +breaking any of your code. =back @@ -154,18 +202,53 @@ and singularization put this in your C file: __PACKAGE__->naming('current'); -Or if you prefer to use 0.05XXX features but insure that nothing breaks in the +Or if you prefer to use 0.07XXX features but insure that nothing breaks in the next major version upgrade: - __PACKAGE__->naming('v5'); + __PACKAGE__->naming('v7'); =head2 generate_pod By default POD will be generated for columns and relationships, using database -metadata for the text if available and supported (Postgres only so far.) +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 @@ -176,15 +259,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 => 0 }, }, -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 turn off DEFERRABLE on your foreign key constraints. =head2 debug @@ -214,17 +292,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 | LuserOpt + Table Name | Moniker Name + --------------------------------- + luser | Luser + luser_group | LuserGroup + luser-opts | LuserOpt + stations_visited | StationVisited + routeChange | RouteChange =head2 inflect_plural @@ -263,7 +341,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 @@ -341,15 +420,82 @@ 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. + +=head2 config_file + +File in Perl format, which should return a HASH reference, from which to read +loader options. + +=head2 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. + +=head2 qualify_objects + +Set to true to prepend the L to table names for C<< +__PACKAGE__->table >> calls, and to some other things like Oracle sequences. + +=head2 use_moose + +Creates Schema and Result classes that use L, L and +L. The default content after the md5 sum also makes the +classes immutable. + +It is safe to upgrade your existing Schema to 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. @@ -375,8 +521,25 @@ sub new { my $self = { %args }; + # don't lose undef options + for (values %$self) { + $_ = 0 unless defined $_; + } + 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 @@ -384,6 +547,15 @@ sub new { resultset_components /); + $self->_validate_class_args; + + if ($self->use_moose) { + if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) { + die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n", + DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose'); + } + } + push(@{$self->{components}}, 'ResultSetManager') if @{$self->{resultset_components}}; @@ -414,20 +586,27 @@ 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; } @@ -475,22 +654,21 @@ EOF my $filename = $self->_get_dump_filename($self->schema_class); return unless -e $filename; - open(my $fh, '<', $filename) - or croak "Cannot open '$filename' for reading: $!"; + my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) = + $self->_parse_generated_file($filename); - my $load_classes = 0; - my $result_namespace = ''; + return unless $old_ver; - while (<$fh>) { - 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+)/) { + # determine if the existing schema was dumped with use_moose => 1 + if (! defined $self->use_moose) { + $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm; + } - if ($load_classes && (not defined $self->use_namespaces)) { - warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; + my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0; + my $result_namespace = do { ($old_gen =~ /result_namespace => '([^']+)'/) ? $1 : '' }; + + if ($load_classes && (not defined $self->use_namespaces)) { + warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; 'load_classes;' static schema detected, turning off 'use_namespaces'. @@ -500,61 +678,84 @@ 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' - ); - } - } + $self->use_namespaces(0); + } + elsif ($load_classes && $self->use_namespaces) { + $self->_upgrading_from_load_classes(1); + } + elsif ((not $load_classes) && defined $self->use_namespaces && ! $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"; + # XXX when we go past .0 this will need fixing + my ($v) = $old_ver =~ /([1-9])/; + $v = "v$v"; - last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/; + return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/); - if (not %{ $self->naming }) { - warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; + if (not %{ $self->naming }) { + warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; -Version $real_ver static schema detected, turning on backcompat mode. +Version $old_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($old_ver); + } + else { + $self->_upgrading_from($v); + } +} - $self->schema_version_to_dump($real_ver); +sub _validate_class_args { + my $self = shift; + my $args = shift; - last; + 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/; + } } } - close $fh; } sub _find_file_in_inc { @@ -563,8 +764,9 @@ 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; @@ -642,14 +844,7 @@ sub _load_external { $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 $@; + eval_without_redefine_warnings($code); } $self->_ext_stmt($class, @@ -669,38 +864,28 @@ sub _load_external { } if ($old_real_inc_path) { - open(my $fh, '<', $old_real_inc_path) - or croak "Failed to open '$old_real_inc_path' for reading: $!"; + my $code = slurp $old_real_inc_path; + $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 +# 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 = 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. +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. 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 $@; + eval_without_redefine_warnings($code); } chomp $code; @@ -720,21 +905,20 @@ 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 Arguments: schema -Rescan the database for newly added tables. Does -not process drops or changes. Returns a list of -the newly added table monikers. +Rescan the database for changes. Returns a list of the newly added table +monikers. -The schema argument should be the schema class -or object to be affected. It should probably -be derived from the original schema_class used -during L. +The schema argument should be the schema class or object to be affected. It +should probably be derived from the original schema_class used during L. =cut @@ -745,58 +929,89 @@ 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 $loaded = $self->_load_tables(@created); + my %current; + @current{@current} = (); + foreach my $table (keys %{ $self->{_tables} }) { + if (not exists $current{$table}) { + $self->_unregister_source_for_table($table); + } + } + + delete $self->{_dump_storage}; + delete $self->{_relations_started}; + + my $loaded = $self->_load_tables(@current); - return map { $self->monikers->{$_} } @$loaded; + return map { $self->monikers->{$_} } @created; } sub _relbuilder { - no warnings 'uninitialized'; my ($self) = @_; return if $self->{skip_relationships}; - if ($self->naming->{relationships} eq 'v4') { - require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040; - return $self->{relbuilder} ||= - DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new( - $self->schema, $self->inflect_plural, $self->inflect_singular - ); - } + return $self->{relbuilder} ||= do { - $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new ( - $self->schema, - $self->inflect_plural, - $self->inflect_singular, - $self->relationship_attrs, - ); + no warnings 'uninitialized'; + my $relbuilder_suff = + {qw{ + v4 ::Compat::v0_040 + v5 ::Compat::v0_05 + v6 ::Compat::v0_06 + }} + ->{ $self->naming->{relationships}}; + + my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff; + eval "require $relbuilder_class"; die $@ if $@; + $relbuilder_class->new( $self ); + + }; } 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) { @@ -847,9 +1062,12 @@ sub _reload_classes { { no warnings 'redefine'; - local *Class::C3::reinitialize = sub {}; + local *Class::C3::reinitialize = sub {}; # to speed things up, reinitialized below use warnings; + if (my $mc = $self->_moose_metaclass($class)) { + $mc->make_mutable; + } Class::Unload->unload($class) if $unload; my ($source, $resultset_class); if ( @@ -858,6 +1076,9 @@ sub _reload_classes { && ($resultset_class ne 'DBIx::Class::ResultSet') ) { my $has_file = Class::Inspector->loaded_filename($resultset_class); + if (my $mc = $self->_moose_metaclass($resultset_class)) { + $mc->make_mutable; + } Class::Unload->unload($resultset_class) if $unload; $self->_reload_class($resultset_class) if $has_file; } @@ -872,6 +1093,15 @@ sub _reload_classes { } } +sub _moose_metaclass { + return undef unless $INC{'Class/MOP.pm'}; # if CMOP is not loaded the class could not have loaded in the 1st place + + my $mc = Class::MOP::class_of($_[1]) + or return undef; + + return $mc->isa('Moose::Meta::Class') ? $mc : undef; +} + # We use this instead of ensure_class_loaded when there are package symbols we # want to preserve. sub _reload_class { @@ -881,12 +1111,10 @@ sub _reload_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 { + eval_without_redefine_warnings ("require $class"); }; - eval "require $class;"; + die "Failed to reload class $class: $@" if $@; } sub _get_dump_filename { @@ -927,15 +1155,23 @@ sub _dump_to_dir { qq|package $schema_class;\n\n| . qq|# Created by DBIx::Class::Schema::Loader\n| . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n| - . qq|use strict;\nuse warnings;\n\n| - . qq|use base '$schema_base_class';\n\n|; + . qq|use strict;\nuse warnings;\n\n|; + if ($self->use_moose) { + $schema_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|; + } + else { + $schema_text .= qq|use base '$schema_base_class';\n\n|; + } 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| } @@ -959,9 +1195,21 @@ sub _dump_to_dir { qq|package $src_class;\n\n| . qq|# Created by DBIx::Class::Schema::Loader\n| . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n| - . qq|use strict;\nuse warnings;\n\n| - . qq|use base '$result_base_class';\n\n|; + . qq|use strict;\nuse warnings;\n\n|; + if ($self->use_moose) { + $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;|; + # these options 'use base' which is compile time + if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) { + $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n\n|; + } + else { + $src_text .= qq|\nextends '$result_base_class';\n\n|; + } + } + else { + $src_text .= qq|use base '$result_base_class';\n\n|; + } $self->_write_classfile($src_class, $src_text); } @@ -1004,25 +1252,55 @@ sub _write_classfile { warn "Deleting existing file '$filename' due to " . "'really_erase_my_files' setting\n" unless $self->{quiet}; unlink($filename); - } + } - my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename); + my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) + = $self->_parse_generated_file($filename); - if (my $old_class = $self->_upgrading_classes->{$class}) { - my $old_filename = $self->_get_dump_filename($old_class); + if (! $old_gen && -f $filename) { + croak "Cannot overwrite '$filename' without 'really_erase_my_files'," + . " it does not appear to have been generated by Loader" + } - my ($old_custom_content) = $self->_get_custom_content( - $old_class, $old_filename, 0 # do not add default comment - ); + my $custom_content = $old_custom || ''; + + # prepend extra custom content from a *renamed* class (singularization effect) + if (my $renamed_class = $self->_upgrading_classes->{$class}) { + my $old_filename = $self->_get_dump_filename($renamed_class); - $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//; + if (-f $old_filename) { + my $extra_custom = ($self->_parse_generated_file ($old_filename))[4]; - if ($old_custom_content) { - $custom_content = - "\n" . $old_custom_content . "\n" . $custom_content; + $extra_custom =~ s/\n\n# You can replace.*\n1;\n//; + + $custom_content = join ("\n", '', $extra_custom, $custom_content) + if $extra_custom; + + unlink $old_filename; } + } + + $custom_content ||= $self->_default_custom_content; - unlink $old_filename; + # If upgrading to use_moose=1 replace default custom content with default Moose custom content. + # If there is already custom content, which does not have the Moose content, add it. + if ($self->use_moose) { + + my $non_moose_custom_content = do { + local $self->{use_moose} = 0; + $self->_default_custom_content; + }; + + if ($custom_content eq $non_moose_custom_content) { + $custom_content = $self->_default_custom_content; + } + elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) { + $custom_content .= $self->_default_custom_content; + } + } + elsif (defined $self->use_moose && $old_gen) { + croak 'It is not possible to "downgrade" a schema that was loaded with use_moose => 1 to use_moose => 0, due to differing custom content' + if $old_gen =~ /use \s+ MooseX?\b/x; } $custom_content = $self->_rewrite_old_classnames($custom_content); @@ -1035,8 +1313,6 @@ sub _write_classfile { my $compare_to; if ($old_md5) { $compare_to = $text . $self->_sig_comment($old_ver, $old_ts); - - if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { return unless $self->_upgrading_from && $is_schema; } @@ -1064,54 +1340,58 @@ sub _write_classfile { or croak "Error closing '$filename': $!"; } -sub _default_custom_content { - return qq|\n\n# You can replace this text with custom| - . qq| content, and it will be preserved on regeneration| - . qq|\n1;\n|; +sub _default_moose_custom_content { + return qq|\n__PACKAGE__->meta->make_immutable;|; } -sub _get_custom_content { - my ($self, $class, $filename, $add_default) = @_; +sub _default_custom_content { + my $self = shift; + my $default = qq|\n\n# You can replace this text with custom| + . qq| code or comments, and it will be preserved on regeneration|; + if ($self->use_moose) { + $default .= $self->_default_moose_custom_content; + } + $default .= qq|\n1;\n|; + return $default; +} - $add_default = 1 unless defined $add_default; +sub _parse_generated_file { + my ($self, $fn) = @_; - return ($self->_default_custom_content) if ! -f $filename; + return unless -f $fn; - open(my $fh, '<', $filename) - or croak "Cannot open '$filename' for reading: $!"; + open(my $fh, '<', $fn) + or croak "Cannot open '$fn' for reading: $!"; - my $mark_re = + my $mark_re = qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n}; - my $buffer = ''; - my ($md5, $ts, $ver); + my ($md5, $ts, $ver, $gen); while(<$fh>) { - if(!$md5 && /$mark_re/) { + if(/$mark_re/) { + my $pre_md5 = $1; $md5 = $2; - my $line = $1; - # Pull out the previous version and timestamp - ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s; + # Pull out the version and timestamp from the line above + ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\Z/m; - $buffer .= $line; - croak "Checksum mismatch in '$filename', the auto-generated part of the file has been modified outside of this loader. Aborting.\nIf you want to overwrite these modifications, set the 'overwrite_modifications' loader option.\n" - if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5; + $gen .= $pre_md5; + croak "Checksum mismatch in '$fn', 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($gen) ne $md5; - $buffer = ''; + last; } else { - $buffer .= $_; + $gen .= $_; } } - croak "Cannot not overwrite '$filename' without 'really_erase_my_files'," - . " it does not appear to have been generated by Loader" - if !$md5; + my $custom = do { local $/; <$fh> } + if $md5; - # Default custom content: - $buffer ||= $self->_default_custom_content if $add_default; + close ($fh); - return ($buffer, $md5, $ver, $ts); + return ($gen, $md5, $ver, $ts, $custom); } sub _use { @@ -1127,11 +1407,13 @@ sub _use { sub _inject { my $self = shift; my $target = shift; - my $schema_class = $self->schema_class; my $blist = join(q{ }, @_); - warn "$target: use base qw/ $blist /;" if $self->debug && @_; - $self->_raw_stmt($target, "use base qw/ $blist /;") if @_; + + return unless $blist; + + warn "$target: use base qw/$blist/;" if $self->debug; + $self->_raw_stmt($target, "use base qw/$blist/;"); } sub _result_namespace { @@ -1197,11 +1479,13 @@ sub _make_src_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}); @@ -1215,6 +1499,45 @@ 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, $self->use_moose ? 'Moose::Object' : ()) { + eval "require ${class};"; + die $@ if $@; + + push @methods, @{ Class::Inspector->methods($class) || [] }; + push @methods, @{ Class::Inspector->methods('UNIVERSAL') || [] }; + } + + my %methods; + @methods{@methods} = (); + + # futureproof meta + $methods{meta} = undef; + + 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_name $column_name; +} + # Set up metadata (cols, pks, etc) sub _setup_src_meta { my ($self, $table) = @_; @@ -1232,41 +1555,63 @@ sub _setup_src_meta { $table_name = \ $self->_quote_table_name($table_name); } - $self->_dbic_stmt($table_class,'table',$table_name); + my $full_table_name = ($self->qualify_objects ? ($self->db_schema . '.') : '') . (ref $table_name ? $$table_name : $table_name); + + # be careful to not create refs Data::Dump can "optimize" + $full_table_name = \do {"".$full_table_name} if ref $table_name; + + $self->_dbic_stmt($table_class, 'table', $full_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); + my $col_info = $self->__columns_info_for($table); + + while (my ($col, $info) = each %$col_info) { + if ($col =~ /\W/) { + ($info->{accessor} = $col) =~ s/\W+/_/g; + } } - else { - if ($self->_is_case_sensitive) { - for my $col (keys %$col_info) { - $col_info->{$col}{accessor} = lc $col - if $col ne lc($col); + + if ($self->preserve_case) { + while (my ($col, $info) = each %$col_info) { + if ($col ne lc($col)) { + if ((not exists $self->naming->{column_accessors}) || (($self->naming->{column_accessors} =~ /(\d+)/)[0] >= 7)) { + $info->{accessor} = $self->_make_column_accessor_name($info->{accessor} || $col); + } + else { + $info->{accessor} = lc($info->{accessor} || $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); + + foreach 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 - ); } + my $pks = $self->_table_pk_info($table) || []; + + foreach my $pkcol (@$pks) { + $col_info->{$pkcol}{is_nullable} = 0; + } + + $self->_dbic_stmt( + $table_class, + 'add_columns', + map { $_, ($col_info->{$_}||{}) } @$cols + ); + my %uniq_tag; # used to eliminate duplicate uniqs - my $pks = $self->_table_pk_info($table) || []; @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks) : carp("$table has no primary key"); $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq @@ -1280,6 +1625,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 @@ -1301,9 +1661,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; + } - return join '', map ucfirst, split /[\W_]+/, - Lingua::EN::Inflect::Number::to_S(lc $table); + my @words = map lc, split_name $table; + my $as_phrase = join ' ', @words; + + my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase); + + return join '', map ucfirst, split /\W+/, $inflected; } sub _table2moniker { @@ -1370,7 +1744,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; @@ -1388,42 +1762,46 @@ sub _make_pod { my $class = shift; my $method = shift; - return unless $self->generate_pod; - if ( $method eq 'table' ) { my ($table) = @_; + my $pcm = $self->pod_comment_mode; + my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc); + $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; - if ( $self->can('_table_comment') ) { - my $comment = $self->_table_comment($table); - $table_descr .= " - " . $comment if $comment; - } + $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 = @_; + my @cols = @_; while( my ($name,$attrs) = splice @cols,0,2 ) { - $col_counter++; + $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( $class, + join "\n", map { + my $s = $attrs->{$_}; + $s = !defined $s ? 'undef' : + length($s) == 0 ? '(empty string)' : + ref($s) eq 'SCALAR' ? $$s : + ref($s) ? dumper_squashed $s : + looks_like_number($s) ? $s : qq{'$s'}; + + " $_: $s" + } sort keys %$attrs, + ); + if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter, $name)) { + $self->_pod( $class, $comment ); + } } $self->_pod_cut( $class ); } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) { @@ -1437,6 +1815,36 @@ sub _make_pod { } } +sub _filter_comment { + my ($self, $txt) = @_; + + $txt = '' if not defined $txt; + + $txt =~ s/(?:\015?\012|\015\012?)/\n/g; + + return $txt; +} + +sub __table_comment { + my $self = shift; + + if (my $code = $self->can('_table_comment')) { + return $self->_filter_comment($self->$code(@_)); + } + + return ''; +} + +sub __column_comment { + my $self = shift; + + if (my $code = $self->can('_column_comment')) { + return $self->_filter_comment($self->$code(@_)); + } + + return ''; +} + # Stores a POD documentation sub _pod { my ($self, $class, $stmt) = @_; @@ -1474,7 +1882,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 { @@ -1513,3 +1968,4 @@ the same terms as Perl itself. =cut 1; +# vim:et sts=4 sw=4 tw=0: