X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=83947a80c0622a67cb94a16b03f5aeb740ae476f;hb=19b7d71c67672e15f11ca6772963170fd6c6b588;hp=08a685fe56d9959d72bdf90bd8cb64f008873219;hpb=fca5431b25d9445bb0b948b525822d7e5643c624;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 08a685f..83947a8 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,12 +13,16 @@ 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'; require DBIx::Class; -our $VERSION = '0.05002'; +our $VERSION = '0.07000'; __PACKAGE__->mk_group_ro_accessors('simple', qw/ schema @@ -33,6 +38,7 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ skip_relationships skip_load_external moniker_map + custom_column_info inflect_singular inflect_plural debug @@ -54,6 +60,10 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ monikers dynamic naming + datetime_timezone + datetime_locale + config_file + loader_class /); @@ -101,15 +111,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 @@ -117,7 +127,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: @@ -139,15 +149,42 @@ 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-sensitive mode will also be handled correctly +for relationship name inflection. + +Currently, only Sybase ASE, MSSQL with CS/BIN collation and Firebird without +the L +option are in case-sensitive mode. + +If you don't have any CamelCase table or column names, you can upgrade without +breaking any of your code. =back @@ -221,9 +258,6 @@ For example: will set the C option to 0 for all generated relationships, except for C, which will have cascade_delete as 1. -NOTE: this option is not supported if v4 backward-compatible naming is -set either globally (naming => 'v4') or just for relationships. - =head2 debug If set to true, each constructive L statement the loader @@ -252,17 +286,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 @@ -379,17 +413,54 @@ 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 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'; -use constant CLASS_ARGS => qw( +my @CLASS_ARGS = qw( schema_base_class result_base_class additional_base_classes left_base_classes additional_classes components resultset_components ); @@ -420,6 +491,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 @@ -464,11 +547,15 @@ sub new { 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; @@ -574,7 +661,7 @@ EOF my ($v) = $real_ver =~ /([1-9])/; $v = "v$v"; - last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/; + last if $v eq $CURRENT_V || $real_ver =~ /^0\.\d\d999/; if (not %{ $self->naming }) { warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; @@ -584,8 +671,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 { @@ -608,7 +697,7 @@ sub _validate_class_args { my $self = shift; my $args = shift; - foreach my $k (CLASS_ARGS) { + foreach my $k (@CLASS_ARGS) { next unless $self->$k; my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k; @@ -755,9 +844,7 @@ sub _load_external { # upgrade. See skip_load_external to disable this feature. EOF - my $code = do { - local ($/, @ARGV) = (undef, $old_real_inc_path); <> - }; + my $code = slurp $old_real_inc_path; $code = $self->_rewrite_old_classnames($code); if ($self->dynamic) { @@ -796,7 +883,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 @@ -821,8 +910,8 @@ 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); } @@ -843,36 +932,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) { @@ -1009,9 +1137,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| } @@ -1273,11 +1404,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}); @@ -1291,6 +1424,35 @@ 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; + } + } +} + # Set up metadata (cols, pks, etc) sub _setup_src_meta { my ($self, $table) = @_; @@ -1311,34 +1473,32 @@ 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); + 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); + } } else { - if ($self->_is_case_sensitive) { - for my $col (keys %$col_info) { - $col_info->{$col}{accessor} = lc $col - if $col ne lc($col); - } - } else { - $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; - } + # 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 @@ -1356,6 +1516,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 @@ -1377,9 +1552,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 /(?<=[[:lower:]])[\W_]*(?=[[:upper:]])|[\W_]+/, $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 { @@ -1496,8 +1685,15 @@ sub _make_pod { my $s = $attrs->{$_}; $s = !defined $s ? 'undef' : length($s) == 0 ? '(empty string)' : - ref($s) eq 'SCALAR' ? $$s : - $s + 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" @@ -1561,6 +1757,27 @@ sub _quote_table_name { 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; +} + # remove the dump dir from @INC on destruction sub DESTROY { my $self = shift; @@ -1598,3 +1815,4 @@ the same terms as Perl itself. =cut 1; +# vim:et sts=4 sw=4 tw=0: