X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FRelBuilder.pm;h=7d533b49d05a5c8af8d37969c2664345f9469527;hb=5c06aa08ab17d9d0e8437a990b5717238deeb8fd;hp=53457495eedd824ee3c7f7357563bc2fd849a1cd;hpb=dc379dc68c7a7d620e16ee91c0c57a0b875081bd;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 5345749..7d533b4 100644
--- a/lib/DBIx/Class/Schema/Loader/RelBuilder.pm
+++ b/lib/DBIx/Class/Schema/Loader/RelBuilder.pm
@@ -8,8 +8,7 @@ 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 DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file/;
 use Try::Tiny;
 use Class::Unload ();
 use Class::Inspector ();
@@ -41,7 +40,7 @@ is module is not (yet) for external use.
 
 =head2 new
 
-Arguments: $base object
+Arguments: $loader object
 
 =head2 generate_code
 
@@ -100,18 +99,19 @@ arguments, like so:
 =cut
 
 __PACKAGE__->mk_group_accessors('simple', qw/
-    base
+    loader
     schema
     inflect_plural
     inflect_singular
     relationship_attrs
     rel_collision_map
+    rel_name_map
     _temp_classes
     __tagger
 /);
 
 sub new {
-    my ( $class, $base ) = @_;
+    my ($class, $loader) = @_;
 
     # from old POD about this constructor:
     # C<$schema_class> should be a schema class name, where the source
@@ -123,23 +123,24 @@ sub new {
     # are better documented in L<DBIx::Class::Schema::Loader::Base>.
 
     my $self = {
-        base               => $base,
-        schema             => $base->schema,
-        inflect_plural     => $base->inflect_plural,
-        inflect_singular   => $base->inflect_singular,
-        relationship_attrs => $base->relationship_attrs,
-        rel_collision_map  => $base->rel_collision_map,
+        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,
         _temp_classes      => [],
     };
 
-    weaken $self->{base}; #< don't leak
+    weaken $self->{loader}; #< don't leak
 
     bless $self => $class;
 
     # 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'
+            or croak "relationship_attrs must be a hashref";
     }
 
     return $self;
@@ -152,16 +153,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
@@ -170,16 +181,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 {
@@ -231,9 +252,9 @@ sub _relationship_attrs {
     );
 
     if( my $specific = $r->{$reltype} ) {
-	while( my ($k,$v) = each %$specific ) {
-	    $composite{$k} = $v;
-	}
+        while( my ($k,$v) = each %$specific ) {
+            $composite{$k} = $v;
+        }
     }
     return \%composite;
 }
@@ -298,10 +319,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;
@@ -312,9 +333,9 @@ sub _resolve_relname_collision {
 
     return $relname if $relname eq 'id'; # this shouldn't happen, but just in case
 
-    my $table = $self->base->tables->{$moniker};
+    my $table = $self->loader->tables->{$moniker};
 
-    if ($self->base->_is_result_class_method($relname, $table)) {
+    if ($self->loader->_is_result_class_method($relname, $table)) {
         if (my $map = $self->rel_collision_map) {
             for my $re (keys %$map) {
                 if (my @matches = $relname =~ /$re/) {
@@ -324,7 +345,7 @@ sub _resolve_relname_collision {
         }
 
         my $new_relname = $relname;
-        while ($self->base->_is_result_class_method($new_relname, $table)) {
+        while ($self->loader->_is_result_class_method($new_relname, $table)) {
             $new_relname .= '_rel'
         }
 
@@ -379,19 +400,25 @@ sub generate_code {
 
             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);
+            $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 => 'belongs_to',
+                { method => $local_method,
                   args => [ $remote_relname,
                             $remote_class,
                             \%cond,
                             $self->_remote_attrs($local_moniker, $local_cols),
                   ],
                   extra => {
-                      moniker => $local_moniker,
+                      local_class    => $local_class,
+                      local_moniker  => $local_moniker,
+                      remote_moniker => $remote_moniker,
                   },
                 }
             );
@@ -410,7 +437,9 @@ sub generate_code {
                             $self->_relationship_attrs($remote_method),
                   ],
                   extra => {
-                      moniker => $remote_moniker,
+                      local_class    => $remote_class,
+                      local_moniker  => $remote_moniker,
+                      remote_moniker => $local_moniker,
                   },
                 }
             );
@@ -502,17 +531,21 @@ sub _disambiguate {
             if (@adjectives) {
                 my $rel_name = join '_', sort(@adjectives), $rel->{args}[0];
 
-                $rel_name = $rel->{method} eq 'might_have' ?
+                ($rel_name) = $rel->{method} eq 'might_have' ?
                     $self->_inflect_singular($rel_name)
                     :
                     $self->_inflect_plural($rel_name);
 
-                my $moniker = $rel->{extra}{moniker};
+                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] };
 
-                $rel_name = $self->_resolve_relname_collision($moniker, \@from_cols, $rel_name);
+                ($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;
             }
@@ -538,23 +571,40 @@ sub _disambiguate {
 
                 my $inflect_method = "_$inflect_type";
 
-                my $relname_new_uninflected =
-                    $self->_inflect_singular($rel->{args}[0]) . "_$rel_num";
+                my $relname_new_uninflected = $rel->{args}[0] . "_$rel_num";
 
                 $rel_num++;
 
-                my $relname_new = $self->$inflect_method($relname_new_uninflected);
-
-                my $moniker = $rel->{extra}{moniker};
+                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] };
 
-                warn <<"EOF";
-Could not find a proper name for relationship '$relname_new' in source '$moniker' for columns '@{[ join ',', @from_cols ]}'.
-Supply a value in '$inflect_type' for '$relname_new_uninflected' to name this relationship.
+                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;
             }
         }
@@ -564,26 +614,26 @@ EOF
 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
@@ -591,11 +641,11 @@ sub _relnames_and_method {
     if ($counters->{$remote_moniker} > 1) {
         my $relationship_exists = 0;
 
-        if (-f (my $existing_remote_file = $self->base->get_dump_filename($remote_class))) {
+        if (-f (my $existing_remote_file = $self->loader->get_dump_filename($remote_class))) {
             my $class = "${remote_class}Temporary";
 
             if (not Class::Inspector->loaded($class)) {
-                my $code = slurp $existing_remote_file;
+                my $code = slurp_file $existing_remote_file;
 
                 $code =~ s/(?<=package $remote_class)/Temporary/g;
 
@@ -623,16 +673,61 @@ 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 {