X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=fe381701cf8aaf9b77bf1d377433bfbbc2d4bb5a;hb=7ffafa3740a2199a784a8799d8f885c955b4390a;hp=42f3990a4d72603bb59516889e4a8e060af375b6;hpb=71a6e88a3c8774abfd058d2b87e1be00b6d75a4a;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 42f3990..fe38170 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -13,15 +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::Utils 'split_name'; require DBIx::Class; -our $VERSION = '0.05003'; +our $VERSION = '0.07001'; __PACKAGE__->mk_group_ro_accessors('simple', qw/ schema @@ -48,6 +50,7 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ default_resultset_class schema_base_class result_base_class + use_moose overwrite_modifications relationship_attrs @@ -63,6 +66,7 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ datetime_locale config_file loader_class + qualify_objects /); @@ -78,6 +82,7 @@ __PACKAGE__->mk_group_accessors('simple', qw/ generate_pod pod_comment_mode pod_comment_spillover_length + preserve_case /); =head1 NAME @@ -110,15 +115,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 @@ -126,7 +131,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: @@ -140,6 +145,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: @@ -148,15 +157,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 @@ -223,15 +258,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 @@ -261,17 +291,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 @@ -310,7 +340,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 @@ -420,11 +451,28 @@ columns with the DATE/DATETIME/TIMESTAMP data_types. Sets the locale attribute for L for all columns with the DATE/DATETIME/TIMESTAMP data_types. -=head1 config_file +=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. + =head1 METHODS None of these methods are intended for direct invocation by regular @@ -433,7 +481,7 @@ L. =cut -my $CURRENT_V = 'v5'; +my $CURRENT_V = 'v7'; my @CLASS_ARGS = qw( schema_base_class result_base_class additional_base_classes @@ -517,6 +565,7 @@ sub new { $self->{naming} = { relationships => $naming_ver, monikers => $naming_ver, + column_accessors => $naming_ver, }; } @@ -646,8 +695,10 @@ 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 { @@ -655,8 +706,9 @@ EOF 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); @@ -807,24 +859,23 @@ 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 = 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. @@ -865,14 +916,11 @@ sub load { 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 @@ -884,15 +932,27 @@ sub rescan { my @created; 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 { @@ -905,15 +965,36 @@ 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, ); } @@ -1083,15 +1164,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;\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| } @@ -1115,9 +1204,13 @@ 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;\nextends '$result_base_class';\n\n|; + } + else { + $src_text .= qq|use base '$result_base_class';\n\n|; + } $self->_write_classfile($src_class, $src_text); } @@ -1221,9 +1314,14 @@ sub _write_classfile { } 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|; + my $self = shift; + my $default = qq|\n\n# You can replace this text with custom| + . qq| content, and it will be preserved on regeneration|; + if ($self->use_moose) { + $default .= qq|\nno Moose;\n__PACKAGE__->meta->make_immutable( inline_constructor => 0 );\n1;\n|; + } + $default .= qq|\n1;\n|; + return $default; } sub _get_custom_content { @@ -1373,6 +1471,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_name $column_name; +} + # Set up metadata (cols, pks, etc) sub _setup_src_meta { my ($self, $table) = @_; @@ -1390,26 +1523,55 @@ 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 = $self->__columns_info_for($table); - if ($self->_is_case_sensitive) { - for my $col (keys %$col_info) { - $col_info->{$col}{accessor} = lc $col - if $col ne lc($col); + + while (my ($col, $info) = each %$col_info) { + if ($col =~ /\W/) { + ($info->{accessor} = $col) =~ s/\W+/_/g; + } + } + + 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 { + } + else { + # XXX this needs to go away $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; } + $self->_resolve_col_accessor_collisions($col_info); + my $fks = $self->_table_fk_info($table); - for my $fkdef (@$fks) { + foreach my $fkdef (@$fks) { for my $col (@{ $fkdef->{local_columns} }) { $col_info->{$col}{is_foreign_key} = 1; } } + + my $pks = $self->_table_pk_info($table) || []; + + foreach my $pkcol (@$pks) { + $col_info->{$pkcol}{is_nullable} = 0; + } + $self->_dbic_stmt( $table_class, 'add_columns', @@ -1418,7 +1580,6 @@ sub _setup_src_meta { 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 @@ -1468,9 +1629,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_name $table; + my $as_phrase = join ' ', @words; + + my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase); - return join '', map ucfirst, split /[\W_]+/, - Lingua::EN::Inflect::Number::to_S(lc $table); + return join '', map ucfirst, split /\W+/, $inflected; } sub _table2moniker { @@ -1657,8 +1832,6 @@ 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 ) = @_; @@ -1680,6 +1853,34 @@ sub _datetime_column_info { 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 { my $self = shift;