Fold column_info() into columns_info()
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Relationship / HasOne.pm
index dc2e436..46e18e3 100644 (file)
-package DBIx::Class::Relationship::HasOne;
+package # hide from PAUSE
+    DBIx::Class::Relationship::HasOne;
 
 use strict;
 use warnings;
+use DBIx::Class::Carp;
+use Try::Tiny;
+use DBIx::Class::_Util 'dbic_internal_try';
+use namespace::clean;
+
+our %_pod_inherit_config =
+  (
+   class_map => { 'DBIx::Class::Relationship::HasOne' => 'DBIx::Class::Relationship' }
+  );
+
+sub might_have {
+  shift->_has_one('LEFT' => @_);
+}
 
 sub has_one {
-  my ($class, $acc_name, $f_class, $conds, $args) = @_;
-  eval "require $f_class";
-  # single key relationship
-  if (not defined $conds && not defined $args) {
-    my ($pri, $too_many) = keys %{ $f_class->_primaries };
-    my $acc_type = ($class->_columns->{$acc_name}) ? 'filter' : 'single';
-    $class->add_relationship($acc_name, $f_class,
-      { "foreign.${pri}" => "self.${acc_name}" },
-      { accessor => $acc_type }
-    );
-  }
-  # multiple key relationship
-  else {
-    my %f_primaries = %{ $f_class->_primaries };
-    my $conds_rel;
-    for (keys %$conds) {
-      $conds_rel->{"foreign.$_"} = "self.".$conds->{$_};
-      # primary key usage checks
-      if (exists $f_primaries{$_}) {
-        delete $f_primaries{$_};
+  shift->_has_one(undef() => @_);
+}
+
+sub _has_one {
+  my ($class, $join_type, $rel, $f_class, $cond, $attrs) = @_;
+  unless (ref $cond) {
+    my $pri = $class->result_source_instance->_single_pri_col_or_die;
+
+    my ($f_key,$guess,$f_rsrc);
+    if (defined $cond && length $cond) {
+      $f_key = $cond;
+      $guess = "caller specified foreign key '$f_key'";
+    }
+    else {
+      # at this point we need to load the foreigner, expensive or not
+      $class->ensure_class_loaded($f_class);
+
+      $f_rsrc = dbic_internal_try {
+        my $r = $f_class->result_source_instance;
+        die "There got to be some columns by now... (exception caught and rewritten by catch below)"
+          unless $r->columns;
+        $r;
       }
-      else
-      {
-        $class->throw("non primary key used in join condition: $_");
+      catch {
+        $class->throw_exception(
+          "Foreign class '$f_class' does not seem to be a Result class "
+        . "(or it simply did not load entirely due to a circular relation chain)"
+        );
+      };
+
+      if ($f_rsrc->has_column($rel)) {
+        $f_key = $rel;
+        $guess = "using given relationship name '$rel' as foreign key column name";
+      }
+      else {
+        $f_key = $f_rsrc->_single_pri_col_or_die;
+        $guess = "using primary key of foreign class for foreign key";
       }
     }
-    $class->throw("not all primary keys used in multi key relationship!") if keys %f_primaries;
-    $class->add_relationship($acc_name, $f_class,
-      $conds_rel,
-      { accessor => 'single' }
-    );
+
+# FIXME - this check needs to be moved to schema-composition time...
+#    # only perform checks if the far side was not preloaded above *AND*
+#    # appears to have been loaded by something else (has a rsrc_instance)
+#    if (! $f_rsrc and $f_rsrc = dbic_internal_try { $f_class->result_source_instance }) {
+#      $class->throw_exception(
+#        "No such column '$f_key' on foreign class ${f_class} ($guess)"
+#      ) if !$f_rsrc->has_column($f_key);
+#    }
+
+    $cond = { "foreign.${f_key}" => "self.${pri}" };
+  }
+  $class->_validate_has_one_condition($cond);
+
+  my $default_cascade = ref $cond eq 'CODE' ? 0 : 1;
+
+  $class->add_relationship($rel, $f_class,
+   $cond,
+   { accessor => 'single',
+     cascade_update => $default_cascade,
+     cascade_delete => $default_cascade,
+     is_depends_on => 0,
+     ($join_type ? ('join_type' => $join_type) : ()),
+     %{$attrs || {}} });
+  1;
+}
+
+sub _validate_has_one_condition {
+  my ($class, $cond )  = @_;
+
+  return if $ENV{DBIC_DONT_VALIDATE_RELS};
+  return unless 'HASH' eq ref $cond;
+  foreach my $foreign_id ( keys %$cond ) {
+    my $self_id = $cond->{$foreign_id};
+
+    # we can ignore a bad $self_id because add_relationship handles this
+    # exception
+    return unless $self_id =~ /^self\.(.*)$/;
+
+    my $key = $1;
+
+    my $column_info = $class->result_source->columns_info->{$key}
+      or $class->throw_exception(
+        "Defining rel on ${class} that includes '$key' "
+      . 'but no such column defined there yet'
+      );
+
+    carp(
+      "'might_have'/'has_one' must not be used on columns with is_nullable "
+    . "set to true ($class/$key). This almost certainly indicates an "
+    . "incorrect use of these relationship helpers instead of 'belongs_to'"
+    ) if $column_info->{is_nullable};
   }
-  return 1;
 }
 
 1;