X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FRelBuilder.pm;h=64d9366359588803c583dcaeec37a79504ee13c9;hb=59388920507cf773795544ab948421ec58e20d1f;hp=96318b4e779aabaf983f0b41ed8c953fd127a474;hpb=9b1dd93554ec8f70923940e2ae88e2e0260d0b55;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 96318b4..64d9366 100644
--- a/lib/DBIx/Class/Schema/Loader/RelBuilder.pm
+++ b/lib/DBIx/Class/Schema/Loader/RelBuilder.pm
@@ -7,8 +7,9 @@ use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
 use Scalar::Util 'weaken';
 use Lingua::EN::Inflect::Phrase ();
+use Lingua::EN::Tagger ();
 use DBIx::Class::Schema::Loader::Utils 'split_name';
-use File::Slurp 'slurp';
+use File::Slurp 'read_file';
 use Try::Tiny;
 use Class::Unload ();
 use Class::Inspector ();
@@ -44,9 +45,14 @@ Arguments: $base object
 
 =head2 generate_code
 
-Arguments: local_moniker (scalar), fk_info (arrayref)
+Arguments: 
+    
+    {
+        local_moniker (scalar) => [ fk_info (arrayref), uniq_info (arrayref) ]
+        ...
+    }
 
-This generates the code for the relationships of a given table.
+This generates the code for the relationships of each table.
 
 C<local_moniker> is the moniker name of the table which had the REFERENCES
 statements.  The fk_info arrayref's contents should take the form:
@@ -65,6 +71,17 @@ statements.  The fk_info arrayref's contents should take the form:
         # ...
     ],
 
+The uniq_info arrayref's contents should take the form:
+
+    [
+        [
+            uniq_constraint_name         => [ 'col1', 'col2' ],
+        ],
+        [
+            another_uniq_constraint_name => [ 'col1', 'col2' ],
+        ],
+    ],
+
 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:
@@ -89,7 +106,9 @@ __PACKAGE__->mk_group_accessors('simple', qw/
     inflect_singular
     relationship_attrs
     rel_collision_map
+    rel_name_map
     _temp_classes
+    __tagger
 /);
 
 sub new {
@@ -111,6 +130,7 @@ sub new {
         inflect_singular   => $base->inflect_singular,
         relationship_attrs => $base->relationship_attrs,
         rel_collision_map  => $base->rel_collision_map,
+        rel_name_map       => $base->rel_name_map,
         _temp_classes      => [],
     };
 
@@ -134,16 +154,26 @@ sub _inflect_plural {
 
     return '' if !defined $relname || $relname eq '';
 
+    my $result;
+    my $mapped = 0;
+
     if( ref $self->inflect_plural eq 'HASH' ) {
-        return $self->inflect_plural->{$relname}
-            if exists $self->inflect_plural->{$relname};
+        if (exists $self->inflect_plural->{$relname}) {
+            $result = $self->inflect_plural->{$relname};
+            $mapped = 1;
+        }
     }
     elsif( ref $self->inflect_plural eq 'CODE' ) {
         my $inflected = $self->inflect_plural->($relname);
-        return $inflected if $inflected;
+        if ($inflected) {
+            $result = $inflected;
+            $mapped = 1;
+        }
     }
 
-    return $self->_to_PL($relname);
+    return ($result, $mapped) if $mapped;
+
+    return ($self->_to_PL($relname), 0);
 }
 
 # Singularize a relationship name
@@ -152,16 +182,26 @@ sub _inflect_singular {
 
     return '' if !defined $relname || $relname eq '';
 
+    my $result;
+    my $mapped = 0;
+
     if( ref $self->inflect_singular eq 'HASH' ) {
-        return $self->inflect_singular->{$relname}
-            if exists $self->inflect_singular->{$relname};
+        if (exists $self->inflect_singular->{$relname}) {
+            $result = $self->inflect_singular->{$relname};
+            $mapped = 1;
+        }
     }
     elsif( ref $self->inflect_singular eq 'CODE' ) {
         my $inflected = $self->inflect_singular->($relname);
-        return $inflected if $inflected;
+        if ($inflected) {
+            $result = $inflected;
+            $mapped = 1;
+        }
     }
 
-    return $self->_to_S($relname);
+    return ($result, $mapped) if $mapped;
+
+    return ($self->_to_S($relname), 0);
 }
 
 sub _to_PL {
@@ -192,7 +232,6 @@ sub _default_relationship_attrs { +{
     might_have => {
         cascade_delete => 0,
         cascade_copy   => 0,
-        cascade_update => 0,
     },
     belongs_to => {
         on_delete => 'CASCADE',
@@ -281,10 +320,10 @@ sub _remote_relname {
         my ($col) = values %{$cond};
         $col = $self->_normalize_name($col);
         $col =~ s/_id$//;
-        $remote_relname = $self->_inflect_singular($col);
+        ($remote_relname) = $self->_inflect_singular($col);
     }
     else {
-        $remote_relname = $self->_inflect_singular($self->_normalize_name($remote_table));
+        ($remote_relname) = $self->_inflect_singular($self->_normalize_name($remote_table));
     }
 
     return $remote_relname;
@@ -295,7 +334,9 @@ sub _resolve_relname_collision {
 
     return $relname if $relname eq 'id'; # this shouldn't happen, but just in case
 
-    if ($self->base->_is_result_class_method($relname)) {
+    my $table = $self->base->tables->{$moniker};
+
+    if ($self->base->_is_result_class_method($relname, $table)) {
         if (my $map = $self->rel_collision_map) {
             for my $re (keys %$map) {
                 if (my @matches = $relname =~ /$re/) {
@@ -305,7 +346,7 @@ sub _resolve_relname_collision {
         }
 
         my $new_relname = $relname;
-        while ($self->base->_is_result_class_method($new_relname)) {
+        while ($self->base->_is_result_class_method($new_relname, $table)) {
             $new_relname .= '_rel'
         }
 
@@ -322,97 +363,278 @@ EOF
 }
 
 sub generate_code {
-    my ($self, $local_moniker, $rels, $uniqs) = @_;
+    my ($self, $tables) = @_;
+    
+    # make a copy to destroy
+    my @tables = @$tables;
 
     my $all_code = {};
 
-    my $local_class = $self->schema->class($local_moniker);
+    while (my ($local_moniker, $rels, $uniqs) = @{ shift @tables || [] }) {
+        my $local_class = $self->schema->class($local_moniker);
 
-    my %counters;
-    foreach my $rel (@$rels) {
-        next if !$rel->{remote_source};
-        $counters{$rel->{remote_source}}++;
-    }
+        my %counters;
+        foreach my $rel (@$rels) {
+            next if !$rel->{remote_source};
+            $counters{$rel->{remote_source}}++;
+        }
 
-    foreach my $rel (@$rels) {
-        my $remote_moniker = $rel->{remote_source}
-            or next;
+        foreach my $rel (@$rels) {
+            my $remote_moniker = $rel->{remote_source}
+                or next;
 
-        my $remote_class   = $self->schema->class($remote_moniker);
-        my $remote_obj     = $self->schema->source($remote_moniker);
-        my $remote_cols    = $rel->{remote_columns} || [ $remote_obj->primary_columns ];
+            my $remote_class   = $self->schema->class($remote_moniker);
+            my $remote_obj     = $self->schema->source($remote_moniker);
+            my $remote_cols    = $rel->{remote_columns} || [ $remote_obj->primary_columns ];
 
-        my $local_cols     = $rel->{local_columns};
+            my $local_cols     = $rel->{local_columns};
 
-        if($#$local_cols != $#$remote_cols) {
-            croak "Column count mismatch: $local_moniker (@$local_cols) "
-                . "$remote_moniker (@$remote_cols)";
-        }
+            if($#$local_cols != $#$remote_cols) {
+                croak "Column count mismatch: $local_moniker (@$local_cols) "
+                    . "$remote_moniker (@$remote_cols)";
+            }
+
+            my %cond;
+            foreach my $i (0 .. $#$local_cols) {
+                $cond{$remote_cols->[$i]} = $local_cols->[$i];
+            }
 
-        my %cond;
-        foreach my $i (0 .. $#$local_cols) {
-            $cond{$remote_cols->[$i]} = $local_cols->[$i];
+            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,
+                  },
+                }
+            );
+
+            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,
+                  },
+                }
+            );
         }
+    }
 
-        my ( $local_relname, $remote_relname, $remote_method ) =
-            $self->_relnames_and_method( $local_moniker, $rel, \%cond,  $uniqs, \%counters );
+    # disambiguate rels with the same name
+    foreach my $class (keys %$all_code) {
+        my $dups = $self->_duplicates($all_code->{$class});
 
-        $remote_relname = $self->_resolve_relname_collision($local_moniker,  $local_cols,  $remote_relname);
-        $local_relname  = $self->_resolve_relname_collision($remote_moniker, $remote_cols, $local_relname);
+        $self->_disambiguate($all_code->{$class}, $dups) if $dups;
+    }
+
+    $self->_cleanup;
+
+    return $all_code;
+}
+
+sub _duplicates {
+    my ($self, $rels) = @_;
+
+    my @rels = map [ $_->{args}[0] => $_ ], @$rels;
+    my %rel_names;
+    $rel_names{$_}++ foreach map $_->[0], @rels;
+
+    my @dups = grep $rel_names{$_} > 1, keys %rel_names;
+
+    my %dups;
+
+    foreach my $dup (@dups) {
+        $dups{$dup} = [ map $_->[1], grep { $_->[0] eq $dup } @rels ];
+    }
+
+    return if not %dups;
+
+    return \%dups;
+}
+
+sub _tagger {
+    my $self = shift;
+
+    $self->__tagger(Lingua::EN::Tagger->new) unless $self->__tagger;
+
+    return $self->__tagger;
+}
+
+sub _adjectives {
+    my ($self, @cols) = @_;
+
+    my @adjectives;
+
+    foreach my $col (@cols) {
+        my @words = split_name $col;
+
+        my $tagged = $self->_tagger->get_readable(join ' ', @words);
+
+        push @adjectives, $tagged =~ m{\G(\w+)/JJ\s+}g;
+    }
 
-        push(@{$all_code->{$local_class}},
-            { method => 'belongs_to',
-              args => [ $remote_relname,
-                        $remote_class,
-                        \%cond,
-                        $self->_remote_attrs($local_moniker, $local_cols),
-              ],
+    return @adjectives;
+}
+
+sub _disambiguate {
+    my ($self, $all_rels, $dups) = @_;
+
+    foreach my $dup (keys %$dups) {
+        my @rels = @{ $dups->{$dup} };
+
+        foreach my $rel (@rels) {
+            next if $rel->{method} eq 'belongs_to';
+
+            my @to_cols = apply { s/^foreign\.//i }
+                keys %{ $rel->{args}[2] };
+
+            my @adjectives = $self->_adjectives(@to_cols);
+
+            # If there are no adjectives, and there is only one might_have
+            # rel to that class, we hardcode 'active'.
+
+            my $to_class = $rel->{args}[1];
+
+            if ((not @adjectives)
+                && (grep { $_->{method} eq 'might_have'
+                           && $_->{args}[1] eq $to_class } @$all_rels) == 1) {
+
+                @adjectives = 'active';
             }
-        );
 
-        my %rev_cond = reverse %cond;
-        for (keys %rev_cond) {
-            $rev_cond{"foreign.$_"} = "self.".$rev_cond{$_};
-            delete $rev_cond{$_};
-        }
+            if (@adjectives) {
+                my $rel_name = join '_', sort(@adjectives), $rel->{args}[0];
+
+                ($rel_name) = $rel->{method} eq 'might_have' ?
+                    $self->_inflect_singular($rel_name)
+                    :
+                    $self->_inflect_plural($rel_name);
+
+                my ($local_class, $local_moniker, $remote_moniker)
+                    = @{ $rel->{extra} }
+                        {qw/local_class local_moniker remote_moniker/};
 
-        push(@{$all_code->{$remote_class}},
-            { method => $remote_method,
-              args => [ $local_relname,
-                        $local_class,
-                        \%rev_cond,
-			$self->_relationship_attrs($remote_method),
-              ],
+                my @from_cols = apply { s/^self\.//i }
+                    values %{ $rel->{args}[2] };
+
+                ($rel_name) = $self->_rel_name_map($rel_name, $rel->{method}, $local_class, $local_moniker, \@from_cols, $to_class, $remote_moniker, \@to_cols);
+
+                $rel_name = $self->_resolve_relname_collision($local_moniker, \@from_cols, $rel_name);
+
+                $rel->{args}[0] = $rel_name;
             }
-        );
+        }
     }
 
-    return $all_code;
+    # Check again for duplicates, since the heuristics above may not have resolved them all.
+
+    if ($dups = $self->_duplicates($all_rels)) {
+        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), $_
+            ], @{ $dups->{$dup} };
+
+            my $rel_num = 2;
+
+            foreach my $rel (@rels[1 .. $#rels]) {
+                my $inflect_type = $rel->{method} eq 'has_many' ?
+                    'inflect_plural'
+                    :
+                    'inflect_singular';
+
+                my $inflect_method = "_$inflect_type";
+
+                my $relname_new_uninflected = $rel->{args}[0] . "_$rel_num";
+
+                $rel_num++;
+
+                my ($local_class, $local_moniker, $remote_moniker)
+                    = @{ $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 ($relname_new, $inflect_mapped) =
+                    $self->$inflect_method($relname_new_uninflected);
+
+                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.
+EOF
+
+                $relname_new = $self->_resolve_relname_collision($local_moniker, \@from_cols, $relname_new);
+
+                $rel->{args}[0] = $relname_new;
+            }
+        }
+    }
 }
 
 sub _relnames_and_method {
     my ( $self, $local_moniker, $rel, $cond, $uniqs, $counters ) = @_;
 
-    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( $remote_obj->from, $cond);
+    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( $remote_obj->from, $cond);
 
-    my $local_cols     = $rel->{local_columns};
-    my $local_table    = $self->schema->source($local_moniker)->from;
-    my $local_class    = $self->schema->class($local_moniker);
-    my $local_source   = $self->schema->source($local_moniker);
+    my $local_cols      = $rel->{local_columns};
+    my $local_table     = $self->schema->source($local_moniker)->from;
+    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 ($local_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) {
-        $remote_method = 'might_have';
-        $local_relname = $self->_inflect_singular($local_relname_uninflected);
+        $remote_method   = 'might_have';
+        ($local_relname) = $self->_inflect_singular($local_relname_uninflected);
     }
 
     # If more than one rel between this pair of tables, use the local
@@ -424,7 +646,7 @@ sub _relnames_and_method {
             my $class = "${remote_class}Temporary";
 
             if (not Class::Inspector->loaded($class)) {
-                my $code = slurp $existing_remote_file;
+                my $code = read_file($existing_remote_file, binmode => ':encoding(UTF-8)');
 
                 $code =~ s/(?<=package $remote_class)/Temporary/g;
 
@@ -452,19 +674,64 @@ sub _relnames_and_method {
             $local_relname =~ s/_id$//;
 
             $local_relname_uninflected = $local_relname;
-            $local_relname = $self->_inflect_plural($local_relname);
+            ($local_relname) = $self->_inflect_plural($local_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);
+                ($local_relname) = $self->_inflect_singular($local_relname_uninflected);
             }
         }
     }
 
-    return ( $local_relname, $remote_relname, $remote_method );
+    return ($local_relname, $remote_relname, $remote_method);
+}
+
+sub _rel_name_map {
+    my ($self, $relname, $method, $local_class, $local_moniker, $local_cols,
+        $remote_class, $remote_moniker, $remote_cols) = @_;
+
+    my $info = {
+        name           => $relname,
+        type           => $method,
+        local_class    => $local_class,
+        local_moniker  => $local_moniker,
+        local_columns  => $local_cols,
+        remote_class   => $remote_class,
+        remote_moniker => $remote_moniker,
+        remote_columns => $remote_cols,
+    };
+
+    my $new_name = $relname;
+
+    my $map = $self->rel_name_map;
+    my $mapped = 0;
+
+    if ('HASH' eq ref($map)) {
+        my $name = $info->{name};
+        my $moniker = $info->{local_moniker};
+        if ($map->{$moniker} and 'HASH' eq ref($map->{$moniker})
+            and $map->{$moniker}{$name}
+        ) {
+            $new_name = $map->{$moniker}{$name};
+            $mapped   = 1;
+        }
+        elsif ($map->{$name} and not 'HASH' eq ref($map->{$name})) {
+            $new_name = $map->{$name};
+            $mapped   = 1;
+        }
+    }
+    elsif ('CODE' eq ref($map)) {
+        my $name = $map->($info);
+        if ($name) {
+            $new_name = $name;
+            $mapped   = 1;
+        }
+    }
+
+    return ($new_name, $mapped);
 }
 
-sub cleanup {
+sub _cleanup {
     my $self = shift;
 
     for my $class (@{ $self->_temp_classes }) {