upload 0.05003
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / RelBuilder.pm
index a2b587d..b802c8c 100644 (file)
@@ -6,7 +6,7 @@ use Class::C3;
 use Carp::Clan qw/^DBIx::Class/;
 use Lingua::EN::Inflect::Number ();
 
-our $VERSION = '0.04999_07';
+our $VERSION = '0.05003';
 
 =head1 NAME
 
@@ -76,17 +76,23 @@ arguments, like so:
 =cut
 
 sub new {
-    my ( $class, $schema, $inflect_pl, $inflect_singular ) = @_;
+
+    my ( $class, $schema, $inflect_pl, $inflect_singular, $rel_attrs ) = @_;
 
     my $self = {
         schema => $schema,
         inflect_plural => $inflect_pl,
         inflect_singular => $inflect_singular,
+        relationship_attrs => $rel_attrs,
     };
 
-    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";
+    }
 
-    $self;
+    return bless $self => $class;
 }
 
 
@@ -122,6 +128,23 @@ sub _inflect_singular {
     return Lingua::EN::Inflect::Number::to_S($relname);
 }
 
+# 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
+sub _relationship_attrs {
+    my ( $self, $reltype ) = @_;
+    my $r = $self->{relationship_attrs};
+    return unless $r && ( $r->{all} || $r->{$reltype} );
+
+    my %composite = %{ $r->{all} || {} };
+    if( my $specific = $r->{$reltype} ) {
+       while( my ($k,$v) = each %$specific ) {
+           $composite{$k} = $v;
+       }
+    }
+    return \%composite;
+}
+
 sub _array_eq {
     my ($a, $b) = @_;
 
@@ -152,11 +175,17 @@ sub _uniq_fk_rel {
 sub _remote_attrs {
        my ($self, $local_moniker, $local_cols) = @_;
 
-       # If the referring column is nullable, make 'belongs_to' an outer join:
+       # get our base set of attrs from _relationship_attrs, if present
+       my $attrs = $self->_relationship_attrs('belongs_to') || {};
+
+       # If the 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;
+       $attrs->{join_type} = 'LEFT'
+           if $nullable && !defined $attrs->{join_type};
 
-       return $nullable ? { join_type => 'LEFT' } : ();
+       return $attrs;
 }
 
 sub _remote_relname {
@@ -218,10 +247,14 @@ sub generate_code {
         # col names to distinguish
         if($counters{$remote_moniker} > 1) {
             my $colnames = q{_} . join(q{_}, @$local_cols);
-            $local_relname = $self->_inflect_plural(
-                lc($local_table) . $colnames
-            );
             $remote_relname .= $colnames if keys %cond > 1;
+
+            my $is_singular =
+              ($self->_uniq_fk_rel($local_moniker, 'dummy', $local_cols, $uniqs))[0] ne 'has_many';
+
+            $local_relname = $self->_multi_rel_local_relname(
+                $remote_class, $local_table, $local_cols, $is_singular
+            );
         } else {
             $local_relname = $self->_inflect_plural(lc $local_table);
         }
@@ -252,6 +285,7 @@ sub generate_code {
               args => [ $local_relname,
                         $local_class,
                         \%rev_cond,
+                       $self->_relationship_attrs($remote_method),
               ],
             }
         );
@@ -260,4 +294,35 @@ sub generate_code {
     return $all_code;
 }
 
+sub _multi_rel_local_relname {
+    my ($self, $remote_class, $local_table, $local_cols, $is_singular) = @_;
+
+    my $inflect = $is_singular ? '_inflect_singular' : '_inflect_plural';
+    $inflect    = $self->can($inflect);
+
+    my $colnames = q{_} . join(q{_}, @$local_cols);
+    my $old_relname = #< TODO: remove me after 0.05003 release
+    my $local_relname = lc($local_table) . $colnames;
+    my $stripped_id = $local_relname =~ s/_id$//; #< strip off any trailing _id
+    $local_relname = $self->$inflect( $local_relname );
+
+    # TODO: remove me after 0.05003 release
+    $old_relname = $self->$inflect( $old_relname );
+    warn __PACKAGE__." $VERSION: warning, stripping trailing _id from ${remote_class} relation '$old_relname', renaming to '$local_relname'.  This behavior is new as of 0.05003.\n"
+        if $stripped_id;
+
+    return $local_relname;
+}
+
+=head1 AUTHOR
+
+See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
+
+=head1 LICENSE
+
+This library is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
 1;