new dev release
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / RelBuilder.pm
index 59a5638..4d5912a 100644 (file)
@@ -2,10 +2,11 @@ package DBIx::Class::Schema::Loader::RelBuilder;
 
 use strict;
 use warnings;
+use Class::C3;
 use Carp::Clan qw/^DBIx::Class/;
 use Lingua::EN::Inflect::Number ();
 
-our $VERSION = '0.04999_07';
+our $VERSION = '0.04999_14';
 
 =head1 NAME
 
@@ -75,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;
 }
 
 
@@ -121,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) = @_;
 
@@ -151,11 +175,35 @@ 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 $attrs;
+}
+
+sub _remote_relname {
+    my ($self, $remote_table, $cond) = @_;
+
+    my $remote_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 =~ s/_id$//;
+        $remote_relname = $self->_inflect_singular($col);
+    }
+    else {
+        $remote_relname = $self->_inflect_singular(lc $remote_table);
+    }
 
-       return $nullable ? { join_type => 'LEFT' } : ();
+    return $remote_relname;
 }
 
 sub generate_code {
@@ -193,18 +241,7 @@ sub generate_code {
         }
 
         my $local_relname;
-        my $remote_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 =~ s/_id$//;
-            $remote_relname = $self->_inflect_singular($col);
-        }
-        else {
-            $remote_relname = $self->_inflect_singular(lc $remote_table);
-        }
+        my $remote_relname = $self->_remote_relname($remote_table, \%cond);
 
         # If more than one rel between this pair of tables, use the local
         # col names to distinguish
@@ -244,6 +281,7 @@ sub generate_code {
               args => [ $local_relname,
                         $local_class,
                         \%rev_cond,
+                       $self->_relationship_attrs($remote_method),
               ],
             }
         );
@@ -252,4 +290,15 @@ sub generate_code {
     return $all_code;
 }
 
+=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;