Add missing deprecation warnings on m2m set_*, tighten up code
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Relationship / ManyToMany.pm
index a99f7d5..c5f4570 100644 (file)
@@ -3,8 +3,17 @@ package # hide from PAUSE
 
 use strict;
 use warnings;
-use warnings::register;
-use Sub::Name ();
+
+use DBIx::Class::Carp;
+use Sub::Name 'subname';
+use Scalar::Util 'blessed';
+use DBIx::Class::_Util 'fail_on_internal_wantarray';
+use namespace::clean;
+
+our %_pod_inherit_config =
+  (
+   class_map => { 'DBIx::Class::Relationship::ManyToMany' => 'DBIx::Class::Relationship' }
+  );
 
 sub many_to_many {
   my ($class, $meth, $rel, $f_rel, $rel_attrs) = @_;
@@ -28,16 +37,20 @@ sub many_to_many {
 
     for ($add_meth, $remove_meth, $set_meth, $rs_meth) {
       if ( $class->can ($_) ) {
-        warnings::warnif(<<"EOW")
+        carp (<<"EOW") unless $ENV{DBIC_OVERWRITE_HELPER_METHODS_OK};
+
 ***************************************************************************
-The many-to-many relationship $meth is trying to create a utility method called
-$_. This will overwrite the existing method on $class. You almost certainly
-want to rename your method or the many-to-many relationship, as your method
-will not be callable (it will use the one from the relationship instead.)
+The many-to-many relationship '$meth' is trying to create a utility method
+called $_.
+This will completely overwrite one such already existing method on class
+$class.
 
-To disable this warning add the following to $class
+You almost certainly want to rename your method or the many-to-many
+relationship, as the functionality of the original method will not be
+accessible anymore.
 
-  no warnings 'DBIx::Class::Relationship::ManyToMany';
+To disable this warning set to a true value the environment variable
+DBIC_OVERWRITE_HELPER_METHODS_OK
 
 ***************************************************************************
 EOW
@@ -47,79 +60,109 @@ EOW
     $rel_attrs->{alias} ||= $f_rel;
 
     my $rs_meth_name = join '::', $class, $rs_meth;
-    *$rs_meth_name = Sub::Name::subname $rs_meth_name, sub {
+    *$rs_meth_name = subname $rs_meth_name, sub {
       my $self = shift;
       my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {};
-      my @args = ($f_rel, @_ > 0 ? @_ : undef, { %{$rel_attrs||{}}, %$attrs });
       my $rs = $self->search_related($rel)->search_related(
         $f_rel, @_ > 0 ? @_ : undef, { %{$rel_attrs||{}}, %$attrs }
       );
-         return $rs;
+      return $rs;
     };
 
     my $meth_name = join '::', $class, $meth;
-    *$meth_name = Sub::Name::subname $meth_name, sub {
-               my $self = shift;
-               my $rs = $self->$rs_meth( @_ );
-               return (wantarray ? $rs->all : $rs);
-       };
+    *$meth_name = subname $meth_name, sub {
+      DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_WANTARRAY and my $sog = fail_on_internal_wantarray;
+      my $self = shift;
+      my $rs = $self->$rs_meth( @_ );
+      return (wantarray ? $rs->all : $rs);
+    };
 
     my $add_meth_name = join '::', $class, $add_meth;
-    *$add_meth_name = Sub::Name::subname $add_meth_name, sub {
+    *$add_meth_name = subname $add_meth_name, sub {
       my $self = shift;
-      @_ > 0 or $self->throw_exception(
+      @_ or $self->throw_exception(
         "${add_meth} needs an object or hashref"
       );
-      my $source = $self->result_source;
-      my $schema = $source->schema;
-      my $rel_source_name = $source->relationship_info($rel)->{source};
-      my $rel_source = $schema->resultset($rel_source_name)->result_source;
-      my $f_rel_source_name = $rel_source->relationship_info($f_rel)->{source};
-      my $f_rel_rs = $schema->resultset($f_rel_source_name)->search({}, $rel_attrs||{});
-
-      my $obj;
-      if (ref $_[0]) {
-        if (ref $_[0] eq 'HASH') {
-          $obj = $f_rel_rs->create($_[0]);
-        } else {
-          $obj = $_[0];
-        }
-      } else {
-        $obj = $f_rel_rs->create({@_});
-      }
 
-      my $link_vals = @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {};
-      my $link = $self->search_related($rel)->new_result($link_vals);
-      $link->set_from_related($f_rel, $obj);
+      my $link = $self->new_related( $rel,
+        ( @_ > 1 && ref $_[-1] eq 'HASH' )
+          ? pop
+          : {}
+      );
+
+      my $far_obj = defined blessed $_[0]
+        ? $_[0]
+        : $self->result_source
+                ->related_source( $rel )
+                 ->related_source( $f_rel )
+                  ->resultset->search_rs( {}, $rel_attrs||{} )
+                   ->find_or_create( ref $_[0] eq 'HASH' ? $_[0] : {@_} )
+      ;
+
+      $link->set_from_related($f_rel, $far_obj);
+
       $link->insert();
-         return $obj;
+
+      return $far_obj;
     };
 
     my $set_meth_name = join '::', $class, $set_meth;
-    *$set_meth_name = Sub::Name::subname $set_meth_name, sub {
+    *$set_meth_name = subname $set_meth_name, sub {
+
       my $self = shift;
-      @_ > 0 or $self->throw_exception(
-        "{$set_meth} needs a list of objects or hashrefs"
+
+      my $set_to = ( ref $_[0] eq 'ARRAY' )
+        ? ( shift @_ )
+        : do {
+          carp_unique(
+            "Calling '$set_meth' with a list of items to link to is deprecated, use an arrayref instead"
+          );
+
+          # gobble up everything from @_ into a new arrayref
+          [ splice @_ ]
+        }
+      ;
+
+      # make sure folks are not invoking a bizarre mix of deprecated and curent syntax
+      $self->throw_exception(
+        "'$set_meth' expects an arrayref of objects or hashrefs to link to, and an optional hashref of link data"
+      ) if (
+        @_ > 1
+          or
+        ( @_ and ref $_[0] ne 'HASH' )
       );
-      my @to_set = (ref($_[0]) eq 'ARRAY' ? @{ $_[0] } : @_);
-      $self->search_related($rel, {})->delete;
-      $self->$add_meth($_, ref($_[1]) ? $_[1] : {}) for (@to_set);
+
+      my $guard = $self->result_source->schema->storage->txn_scope_guard;
+
+      # if there is a where clause in the attributes, ensure we only delete
+      # rows that are within the where restriction
+
+      if ($rel_attrs && $rel_attrs->{where}) {
+        $self->search_related( $rel, $rel_attrs->{where},{join => $f_rel})->delete;
+      } else {
+        $self->search_related( $rel, {} )->delete;
+      }
+      # add in the set rel objects
+      $self->$add_meth(
+        $_,
+        @_, # at this point @_ is either empty or contains a lone link-data hash
+      ) for @$set_to;
+
+      $guard->commit;
     };
 
     my $remove_meth_name = join '::', $class, $remove_meth;
-    *$remove_meth_name = Sub::Name::subname $remove_meth_name, sub {
-      my $self = shift;
-      @_ > 0 && ref $_[0] ne 'HASH'
-        or $self->throw_exception("${remove_meth} needs an object");
-      my $obj = shift;
-      my $rel_source = $self->search_related($rel)->result_source;
-      my $cond = $rel_source->relationship_info($f_rel)->{cond};
-      my $link_cond = $rel_source->resolve_condition(
-        $cond, $obj, $f_rel
-      );
-      $self->search_related($rel, $link_cond)->delete;
-    };
+    *$remove_meth_name = subname $remove_meth_name, sub {
+      my ($self, $obj) = @_;
+
+      $self->throw_exception("${remove_meth} needs an object")
+        unless blessed ($obj);
 
+      $self->search_related_rs($rel)->search_rs(
+        $obj->ident_condition( $f_rel ),
+        { join => $f_rel },
+      )->delete;
+    };
   }
 }