X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FRelBuilder.pm;h=08acde0f1ac845968ccae730266e3eab5297e63a;hb=dc783fab900d073db1fb0e86b709cbb65bd364b7;hp=0f4005e258de3c21e478303f7a83253636d7c81a;hpb=ea3b8f030cb1cd0c41558e757c9d6f0081f8bc05;p=dbsrgits%2FDBIx-Class-Schema-Loader.git diff --git a/lib/DBIx/Class/Schema/Loader/RelBuilder.pm b/lib/DBIx/Class/Schema/Loader/RelBuilder.pm index 0f4005e..08acde0 100644 --- a/lib/DBIx/Class/Schema/Loader/RelBuilder.pm +++ b/lib/DBIx/Class/Schema/Loader/RelBuilder.pm @@ -6,9 +6,9 @@ use base 'Class::Accessor::Grouped'; use mro 'c3'; use Carp::Clan qw/^DBIx::Class/; use Scalar::Util 'weaken'; -use DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file/; +use DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file array_eq apply uniq/; use Try::Tiny; -use List::MoreUtils qw/apply uniq any/; +use List::Util qw/all any first/; use namespace::clean; use Lingua::EN::Inflect::Phrase (); use Lingua::EN::Tagger (); @@ -17,12 +17,12 @@ use String::ToIdentifier::EN::Unicode (); use Class::Unload (); use Class::Inspector (); -our $VERSION = '0.07010'; +our $VERSION = '0.07045'; # Glossary: # -# remote_relname -- name of relationship from the local table referring to the remote table -# local_relname -- name of relationship from the remote table referring to the local table +# local_relname -- name of relationship from the local table referring to the remote table +# remote_relname -- name of relationship from the remote table referring to the local table # remote_method -- relationship type from remote table to local table, usually has_many =head1 NAME @@ -46,8 +46,8 @@ Arguments: $loader object =head2 generate_code -Arguments: - +Arguments: + [ [ local_moniker1 (scalar), fk_info1 (arrayref), uniq_info1 (arrayref) ] [ local_moniker2 (scalar), fk_info2 (arrayref), uniq_info2 (arrayref) ] @@ -94,16 +94,18 @@ This method will return the generated relationships as a hashref keyed on the class names. The values are arrayrefs of hashes containing method name and arguments, like so: - { - 'Some::Source::Class' => [ - { method => 'belongs_to', arguments => [ 'col1', 'Another::Source::Class' ], - { method => 'has_many', arguments => [ 'anothers', 'Yet::Another::Source::Class', 'col15' ], - ], - 'Another::Source::Class' => [ - # ... - ], - # ... - } + { + 'Some::Source::Class' => [ + { method => 'belongs_to', arguments => [ + 'col1', 'Another::Source::Class' ] }, + { method => 'has_many', arguments => [ + 'anothers', 'Yet::Another::Source::Class', 'col15' ] }, + ], + 'Another::Source::Class' => [ + # ... + ], + # ... + } =cut @@ -115,6 +117,7 @@ __PACKAGE__->mk_group_accessors('simple', qw/ relationship_attrs rel_collision_map rel_name_map + allow_extra_m2m_cols _temp_classes __tagger /); @@ -133,12 +136,11 @@ sub new { my $self = { loader => $loader, - schema => $loader->schema, - inflect_plural => $loader->inflect_plural, - inflect_singular => $loader->inflect_singular, - relationship_attrs => $loader->relationship_attrs, - rel_collision_map => $loader->rel_collision_map, - rel_name_map => $loader->rel_name_map, + (map { $_ => $loader->$_ } qw( + schema inflect_plural inflect_singular + relationship_attrs rel_collision_map + rel_name_map allow_extra_m2m_cols + )), _temp_classes => [], }; @@ -148,8 +150,8 @@ sub new { # validate the relationship_attrs arg if( defined $self->relationship_attrs ) { - ref $self->relationship_attrs eq 'HASH' - or croak "relationship_attrs must be a hashref"; + (ref $self->relationship_attrs eq 'HASH' || ref $self->relationship_attrs eq 'CODE') + or croak "relationship_attrs must be a hashref or coderef"; } return $self; @@ -248,24 +250,39 @@ sub _default_relationship_attrs { +{ }, } } -# accessor for options to be passed to each generated relationship -# type. take single argument, the relationship type name, and returns -# either a hashref (if some options are set), or nothing +# Accessor for options to be passed to each generated relationship type. takes +# the relationship type name and optionally any attributes from the database +# (such as FK ON DELETE/UPDATE and DEFERRABLE clauses), and returns a +# hashref or undef if nothing is set. +# +# The attributes from the database override the default attributes, which in +# turn are overridden by user supplied attributes. sub _relationship_attrs { - my ( $self, $reltype ) = @_; + my ( $self, $reltype, $db_attrs, $params ) = @_; my $r = $self->relationship_attrs; my %composite = ( %{ $self->_default_relationship_attrs->{$reltype} || {} }, - %{ $r->{all} || {} } + %{ $db_attrs || {} }, + ( + ref $r eq 'HASH' ? ( + %{ $r->{all} || {} }, + %{ $r->{$reltype} || {} }, + ) + : + () + ), ); - if( my $specific = $r->{$reltype} ) { - while( my ($k,$v) = each %$specific ) { - $composite{$k} = $v; - } + if (ref $r eq 'CODE') { + $params->{attrs} = \%composite; + + my %ret = %{ $r->(%$params) || {} }; + + %composite = %ret if %ret; } - return \%composite; + + return %composite ? \%composite : undef; } sub _strip_id_postfix { @@ -276,26 +293,15 @@ sub _strip_id_postfix { return $name; } -sub _array_eq { - my ($self, $a, $b) = @_; - - return unless @$a == @$b; - - for (my $i = 0; $i < @$a; $i++) { - return unless $a->[$i] eq $b->[$i]; - } - return 1; -} - sub _remote_attrs { - my ($self, $local_moniker, $local_cols) = @_; + my ($self, $local_moniker, $local_cols, $fk_attrs, $params) = @_; - # get our base set of attrs from _relationship_attrs, if present - my $attrs = $self->_relationship_attrs('belongs_to') || {}; + # get our set of attrs from _relationship_attrs, which uses the FK attrs if available + my $attrs = $self->_relationship_attrs('belongs_to', $fk_attrs, $params) || {}; - # If the referring column is nullable, make 'belongs_to' an + # If any referring column is nullable, make 'belongs_to' an # outer join, unless explicitly set by relationship_attrs - my $nullable = grep { $self->schema->source($local_moniker)->column_info($_)->{is_nullable} } @$local_cols; + my $nullable = first { $self->schema->source($local_moniker)->column_info($_)->{is_nullable} } @$local_cols; $attrs->{join_type} = 'LEFT' if $nullable && !defined $attrs->{join_type}; return $attrs; @@ -321,22 +327,22 @@ sub _normalize_name { return join '_', map lc, @words; } -sub _remote_relname { +sub _local_relname { my ($self, $remote_table, $cond) = @_; - my $remote_relname; + my $local_relname; # for single-column case, set the remote relname to the column # name, to make filter accessors work, but strip trailing _id if(scalar keys %{$cond} == 1) { my ($col) = values %{$cond}; $col = $self->_strip_id_postfix($self->_normalize_name($col)); - ($remote_relname) = $self->_inflect_singular($col); + ($local_relname) = $self->_inflect_singular($col); } else { - ($remote_relname) = $self->_inflect_singular($self->_normalize_name($remote_table)); + ($local_relname) = $self->_inflect_singular($self->_normalize_name($remote_table)); } - return $remote_relname; + return $local_relname; } sub _resolve_relname_collision { @@ -373,7 +379,7 @@ EOF sub generate_code { my ($self, $tables) = @_; - + # make a copy to destroy my @tables = @$tables; @@ -404,63 +410,97 @@ sub generate_code { } my %cond; - foreach my $i (0 .. $#$local_cols) { - $cond{$remote_cols->[$i]} = $local_cols->[$i]; - } + @cond{@$remote_cols} = @$local_cols; my ( $local_relname, $remote_relname, $remote_method ) = $self->_relnames_and_method( $local_moniker, $rel, \%cond, $uniqs, \%counters ); my $local_method = 'belongs_to'; - ($remote_relname) = $self->_rel_name_map($remote_relname, $local_method, $local_class, $local_moniker, $local_cols, $remote_class, $remote_moniker, $remote_cols); - ($local_relname) = $self->_rel_name_map($local_relname, $remote_method, $remote_class, $remote_moniker, $remote_cols, $local_class, $local_moniker, $local_cols); - - $remote_relname = $self->_resolve_relname_collision($local_moniker, $local_cols, $remote_relname); - $local_relname = $self->_resolve_relname_collision($remote_moniker, $remote_cols, $local_relname); - - push(@{$all_code->{$local_class}}, - { method => $local_method, - args => [ $remote_relname, - $remote_class, - \%cond, - $self->_remote_attrs($local_moniker, $local_cols), - ], - extra => { - local_class => $local_class, - local_moniker => $local_moniker, - remote_moniker => $remote_moniker, - }, - } + ($local_relname) = $self->_rel_name_map( + $local_relname, $local_method, + $local_class, $local_moniker, $local_cols, + $remote_class, $remote_moniker, $remote_cols, + ); + ($remote_relname) = $self->_rel_name_map( + $remote_relname, $remote_method, + $remote_class, $remote_moniker, $remote_cols, + $local_class, $local_moniker, $local_cols, + ); + + $local_relname = $self->_resolve_relname_collision( + $local_moniker, $local_cols, $local_relname, + ); + $remote_relname = $self->_resolve_relname_collision( + $remote_moniker, $remote_cols, $remote_relname, ); + my $rel_attrs_params = { + rel_name => $local_relname, + rel_type => $local_method, + local_source => $self->schema->source($local_moniker), + remote_source => $self->schema->source($remote_moniker), + local_table => $rel->{local_table}, + local_cols => $local_cols, + remote_table => $rel->{remote_table}, + remote_cols => $remote_cols, + }; + + push @{$all_code->{$local_class}}, { + method => $local_method, + args => [ + $local_relname, + $remote_class, + \%cond, + $self->_remote_attrs($local_moniker, $local_cols, $rel->{attrs}, $rel_attrs_params), + ], + extra => { + local_class => $local_class, + local_moniker => $local_moniker, + remote_moniker => $remote_moniker, + }, + }; + my %rev_cond = reverse %cond; for (keys %rev_cond) { $rev_cond{"foreign.$_"} = "self.".$rev_cond{$_}; delete $rev_cond{$_}; } - push(@{$all_code->{$remote_class}}, - { method => $remote_method, - args => [ $local_relname, - $local_class, - \%rev_cond, - $self->_relationship_attrs($remote_method), - ], - extra => { - local_class => $remote_class, - local_moniker => $remote_moniker, - remote_moniker => $local_moniker, - }, - } - ); + $rel_attrs_params = { + rel_name => $remote_relname, + rel_type => $remote_method, + local_source => $self->schema->source($remote_moniker), + remote_source => $self->schema->source($local_moniker), + local_table => $rel->{remote_table}, + local_cols => $remote_cols, + remote_table => $rel->{local_table}, + remote_cols => $local_cols, + }; + + push @{$all_code->{$remote_class}}, { + method => $remote_method, + args => [ + $remote_relname, + $local_class, + \%rev_cond, + $self->_relationship_attrs($remote_method, {}, $rel_attrs_params), + ], + extra => { + local_class => $remote_class, + local_moniker => $remote_moniker, + remote_moniker => $local_moniker, + }, + }; } } + $self->_generate_m2ms($all_code); + # disambiguate rels with the same name foreach my $class (keys %$all_code) { my $dups = $self->_duplicates($all_code->{$class}); - $self->_disambiguate($all_code->{$class}, $dups) if $dups; + $self->_disambiguate($all_code, $class, $dups) if $dups; } $self->_cleanup; @@ -468,6 +508,112 @@ sub generate_code { return $all_code; } +# Find classes with only 2 FKs which are the PK and make many_to_many bridges for them. +sub _generate_m2ms { + my ($self, $all_code) = @_; + + LINK_CLASS: + foreach my $link_class (sort keys %$all_code) { + my @rels = grep $_->{method} eq 'belongs_to', @{$all_code->{$link_class}}; + next unless @rels == 2; + + my @class; + foreach my $this (0, 1) { + my $that = $this ? 0 : 1; + my %class; + $class[$this] = \%class; + $class{local_moniker} = $rels[$this]{extra}{remote_moniker}; + $class{remote_moniker} = $rels[$that]{extra}{remote_moniker}; + + $class{class} = $rels[$this]{args}[1]; + + my %link_cols = map { $_ => 1 } apply { s/^self\.//i } values %{ $rels[$this]{args}[2] }; + + $class{link_table_rel} = first { + $_->{method} eq 'has_many' + and + $_->{args}[1] eq $link_class + and + all { $link_cols{$_} } apply { s/^foreign\.//i } keys %{$_->{args}[2]} + } @{ $all_code->{$class{class}} }; + + next LINK_CLASS unless $class{link_table_rel}; + + $class{link_table_rel_name} = $class{link_table_rel}{args}[0]; + + $class{link_rel} = $rels[$that]{args}[0]; + + $class{from_cols} = [ apply { s/^self\.//i } values %{ + $class{link_table_rel}->{args}[2] + } ]; + + $class{to_cols} = [ apply { s/^foreign\.//i } keys %{ $rels[$that]{args}[2] } ]; + + $class{from_link_cols} = [ apply { s/^self\.//i } values %{ $rels[$this]{args}[2] } ]; + } + + my $link_moniker = $rels[0]{extra}{local_moniker}; + + my @link_table_cols = + @{[ $self->schema->source($link_moniker)->columns ]}; + + my @link_table_primary_cols = + @{[ $self->schema->source($link_moniker)->primary_columns ]}; + + next unless array_eq( + [ sort +uniq @{$class[0]{from_link_cols}}, @{$class[1]{from_link_cols}} ], + [ sort @link_table_primary_cols ], + ) && ($self->allow_extra_m2m_cols || @link_table_cols == @link_table_primary_cols); + + foreach my $this (0, 1) { + my $that = $this ? 0 : 1; + ($class[$this]{m2m_relname}) = $self->_rel_name_map( + ($self->_inflect_plural($class[$this]{link_rel}))[0], + 'many_to_many', + @{$class[$this]}{qw(class local_moniker from_cols)}, + $class[$that]{class}, + @{$class[$this]}{qw(remote_moniker to_cols)}, + { + link_class => $link_class, + link_moniker => $link_moniker, + link_rel_name => $class[$this]{link_table_rel_name}, + }, + ); + + $class[$this]{m2m_relname} = $self->_resolve_relname_collision( + @{$class[$this]}{qw(local_moniker from_cols m2m_relname)}, + ); + } + + for my $this (0, 1) { + my $that = $this ? 0 : 1; + + push @{$all_code->{$class[$this]{class}}}, { + method => 'many_to_many', + args => [ + @{$class[$this]}{qw(m2m_relname link_table_rel_name link_rel)}, + $self->_relationship_attrs('many_to_many', {}, { + rel_type => 'many_to_many', + rel_name => $class[$this]{class2_relname}, + local_source => $self->schema->source($class[$this]{local_moniker}), + remote_source => $self->schema->source($class[$this]{remote_moniker}), + local_table => $self->loader->class_to_table->{$class[$this]{class}}, + local_cols => $class[$this]{from_cols}, + remote_table => $self->loader->class_to_table->{$class[$that]{class}}, + remote_cols => $class[$that]{from_cols}, + }) || (), + ], + extra => { + local_class => $class[$this]{class}, + link_class => $link_class, + local_moniker => $class[$this]{local_moniker}, + remote_moniker => $class[$this]{remote_moniker}, + }, + }; + } + } +} + sub _duplicates { my ($self, $rels) = @_; @@ -523,7 +669,7 @@ sub _name_to_identifier { } sub _disambiguate { - my ($self, $all_rels, $dups) = @_; + my ($self, $all_code, $in_class, $dups) = @_; DUP: foreach my $dup (keys %$dups) { my @rels = @{ $dups->{$dup} }; @@ -564,7 +710,7 @@ sub _disambiguate { } foreach my $rel (@rels) { - next if $rel->{method} eq 'belongs_to'; + next if $rel->{method} =~ /^(?:belongs_to|many_to_many)\z/; my @to_cols = apply { s/^foreign\.//i } keys %{ $rel->{args}[2] }; @@ -578,7 +724,7 @@ sub _disambiguate { if ((not @adjectives) && (grep { $_->{method} eq 'might_have' - && $_->{args}[1] eq $to_class } @$all_rels) == 1) { + && $_->{args}[1] eq $to_class } @{ $all_code->{$in_class} }) == 1) { @adjectives = 'active'; } @@ -609,17 +755,22 @@ sub _disambiguate { # Check again for duplicates, since the heuristics above may not have resolved them all. - if ($dups = $self->_duplicates($all_rels)) { + if ($dups = $self->_duplicates($all_code->{$in_class})) { foreach my $dup (keys %$dups) { # sort by method my @rels = map $_->[1], sort { $a->[0] <=> $b->[0] } map [ - ($_->{method} eq 'belongs_to' ? 3 : $_->{method} eq 'has_many' ? 2 : 1), $_ + { + belongs_to => 3, + has_many => 2, + might_have => 1, + many_to_many => 0, + }->{$_->{method}}, $_ ], @{ $dups->{$dup} }; my $rel_num = 2; foreach my $rel (@rels[1 .. $#rels]) { - my $inflect_type = $rel->{method} eq 'has_many' ? + my $inflect_type = $rel->{method} =~ /^(?:many_to_many|has_many)\z/ ? 'inflect_plural' : 'inflect_singular'; @@ -634,13 +785,25 @@ sub _disambiguate { = @{ $rel->{extra} } {qw/local_class local_moniker remote_moniker/}; - my @from_cols = apply { s/^self\.//i } - values %{ $rel->{args}[2] }; - - my @to_cols = apply { s/^foreign\.//i } - keys %{ $rel->{args}[2] }; - - my $to_class = $rel->{args}[1]; + my (@from_cols, @to_cols, $to_class); + + if ($rel->{method} eq 'many_to_many') { + @from_cols = apply { s/^self\.//i } values %{ + (first { $_->{args}[0] eq $rel->{args}[1] } @{ $all_code->{$local_class} }) + ->{args}[2] + }; + @to_cols = apply { s/^foreign\.//i } keys %{ + (first { $_->{args}[0] eq $rel->{args}[2] } + @{ $all_code->{ $rel->{extra}{link_class} } }) + ->{args}[2] + }; + $to_class = $self->schema->source($remote_moniker)->result_class; + } + else { + @from_cols = apply { s/^self\.//i } values %{ $rel->{args}[2] }; + @to_cols = apply { s/^foreign\.//i } keys %{ $rel->{args}[2] }; + $to_class = $rel->{args}[1]; + } my ($relname_new, $inflect_mapped) = $self->$inflect_method($relname_new_uninflected); @@ -648,14 +811,14 @@ sub _disambiguate { my $rel_name_mapped; ($relname_new, $rel_name_mapped) = $self->_rel_name_map($relname_new, $rel->{method}, $local_class, $local_moniker, \@from_cols, $to_class, $remote_moniker, \@to_cols); - + my $mapped = $inflect_mapped || $rel_name_mapped; warn <<"EOF" unless $mapped; Could not find a proper name for relationship '$relname_new' in source '$local_moniker' for columns '@{[ join ',', @from_cols ]}'. Supply a value in -'$inflect_type' or 'rel_name_map' for '$relname_new_uninflected' to name this -relationship. +'$inflect_type' for '$relname_new_uninflected' or 'rel_name_map' for +'$relname_new' to name this relationship. EOF $relname_new = $self->_resolve_relname_collision($local_moniker, \@from_cols, $relname_new); @@ -672,23 +835,23 @@ sub _relnames_and_method { my $remote_moniker = $rel->{remote_source}; my $remote_obj = $self->schema->source( $remote_moniker ); my $remote_class = $self->schema->class( $remote_moniker ); - my $remote_relname = $self->_remote_relname( $rel->{remote_table}, $cond); + my $local_relname = $self->_local_relname( $rel->{remote_table}, $cond); my $local_cols = $rel->{local_columns}; my $local_table = $rel->{local_table}; my $local_class = $self->schema->class($local_moniker); my $local_source = $self->schema->source($local_moniker); - my $local_relname_uninflected = $self->_normalize_name($local_table); - my ($local_relname) = $self->_inflect_plural($self->_normalize_name($local_table)); + my $remote_relname_uninflected = $self->_normalize_name($local_table); + my ($remote_relname) = $self->_inflect_plural($self->_normalize_name($local_table)); my $remote_method = 'has_many'; # If the local columns have a UNIQUE constraint, this is a one-to-one rel - if ($self->_array_eq([ $local_source->primary_columns ], $local_cols) || - grep { $self->_array_eq($_->[1], $local_cols) } @$uniqs) { + if (array_eq([ $local_source->primary_columns ], $local_cols) || + first { array_eq($_->[1], $local_cols) } @$uniqs) { $remote_method = 'might_have'; - ($local_relname) = $self->_inflect_singular($local_relname_uninflected); + ($remote_relname) = $self->_inflect_singular($remote_relname_uninflected); } # If more than one rel between this pair of tables, use the local @@ -712,26 +875,26 @@ sub _relnames_and_method { push @{ $self->_temp_classes }, $class; } - if ($class->has_relationship($local_relname)) { + if ($class->has_relationship($remote_relname)) { my $rel_cols = [ sort { $a cmp $b } apply { s/^foreign\.//i } - (keys %{ $class->relationship_info($local_relname)->{cond} }) ]; + (keys %{ $class->relationship_info($remote_relname)->{cond} }) ]; - $relationship_exists = 1 if $self->_array_eq([ sort @$local_cols ], $rel_cols); + $relationship_exists = 1 if array_eq([ sort @$local_cols ], $rel_cols); } } if (not $relationship_exists) { my $colnames = q{_} . $self->_normalize_name(join '_', @$local_cols); - $remote_relname .= $colnames if keys %$cond > 1; + $local_relname .= $colnames if keys %$cond > 1; - $local_relname = $self->_strip_id_postfix($self->_normalize_name($local_table . $colnames)); + $remote_relname = $self->_strip_id_postfix($self->_normalize_name($local_table . $colnames)); - $local_relname_uninflected = $local_relname; - ($local_relname) = $self->_inflect_plural($local_relname); + $remote_relname_uninflected = $remote_relname; + ($remote_relname) = $self->_inflect_plural($remote_relname); # if colnames were added and this is a might_have, re-inflect if ($remote_method eq 'might_have') { - ($local_relname) = $self->_inflect_singular($local_relname_uninflected); + ($remote_relname) = $self->_inflect_singular($remote_relname_uninflected); } } } @@ -741,9 +904,10 @@ sub _relnames_and_method { sub _rel_name_map { my ($self, $relname, $method, $local_class, $local_moniker, $local_cols, - $remote_class, $remote_moniker, $remote_cols) = @_; + $remote_class, $remote_moniker, $remote_cols, $extra) = @_; my $info = { + %{$extra || {}}, name => $relname, type => $method, local_class => $local_class, @@ -754,9 +918,13 @@ sub _rel_name_map { remote_columns => $remote_cols, }; - my $new_name = $relname; + $self->_run_user_map($self->rel_name_map, $info); +} + +sub _run_user_map { + my ($self, $map, $info) = @_; - my $map = $self->rel_name_map; + my $new_name = $info->{name}; my $mapped = 0; if ('HASH' eq ref($map)) { @@ -774,7 +942,14 @@ sub _rel_name_map { } } elsif ('CODE' eq ref($map)) { - my $name = $map->($info); + my $cb = sub { + my ($cb_map) = @_; + croak "reentered rel_name_map must be a hashref" + unless 'HASH' eq ref($cb_map); + my ($cb_name, $cb_mapped) = $self->_run_user_map($cb_map, $info); + return $cb_mapped && $cb_name; + }; + my $name = $map->($info, $cb); if ($name) { $new_name = $name; $mapped = 1; @@ -794,9 +969,9 @@ sub _cleanup { $self->_temp_classes([]); } -=head1 AUTHOR +=head1 AUTHORS -See L and L. +See L. =head1 LICENSE