Merge pull request #4 from AntonTyutin/operations-results

Mixin methods return boolean results.

Author: cornernote

README.md

@@ -47,6 +47,11 @@ public function behaviors() {
 }
 ```
 
+then you can use explicitly `$model->softDelete()`, `$model->hardDelete()`
+and `$model->unDelete()` (for softly deleted models). Each of these methods return
+boolean result. Also `$model->softDelete()` calls indirectly from `$model->delete()`,
+which always returns `false`.
+
 In your ActiveQuery class:
 
 ```php

src/SoftDeleteBehavior.php

@@ -75,7 +75,7 @@ public function softDelete()
         $attribute = $this->attribute;
         $this->owner->$attribute = $this->getValue(null);
         // save record
-        $this->owner->save(false, [$attribute]);
+        return $this->owner->save(false, [$attribute]);
     }
 
     /**
@@ -87,7 +87,7 @@ public function unDelete()
         $attribute = $this->attribute;
         $this->owner->$attribute = null;
         // save record
-        $this->owner->save(false, [$attribute]);
+        return $this->owner->save(false, [$attribute]);
     }
 
     /**
@@ -99,7 +99,7 @@ public function hardDelete()
         $model = $this->owner;
         $this->detach();
         // delete as normal
-        $model->delete();
+        return 0 !== $model->delete();
     }
 
     /**
@@ -117,4 +117,4 @@ protected function getValue($event)
         }
     }
 
-}
+}

tests/unit/SoftDeleteTest.php

@@ -10,7 +10,6 @@
 
 use tests\models\PostA;
 use tests\models\PostB;
-use Yii;
 
 /**
  * SoftDeleteTest
@@ -25,7 +24,21 @@ public function testSoftDeletePostA()
     {
         /** @var PostA $post */
         $post = PostA::findOne(2);
-        $post->delete();
+        // delete() must return `false`, because we can't prevent real deletion and return `true` at the same time
+        $this->assertFalse($post->delete(), 'Result of `delete()` expected to be `false`');
+        $this->assertNotNull($post->deleted_at);
+        $post = PostA::findOne(2);
+        $this->assertNotNull($post->deleted_at);
+    }
+
+    /**
+     * Explicit Soft Delete PostA
+     */
+    public function testExplicitSoftDeletePostA()
+    {
+        /** @var PostA $post */
+        $post = PostA::findOne(2);
+        $this->assertTrue($post->softDelete(), 'Result of `softDelete()` expected to be `true`');
         $this->assertNotNull($post->deleted_at);
         $post = PostA::findOne(2);
         $this->assertNotNull($post->deleted_at);
@@ -38,11 +51,12 @@ public function testUnDeletePostA()
     {
         /** @var PostA $post */
         $post = PostA::findOne(2);
-        $post->delete();
+        // delete() must return `false`, because we can't prevent real deletion and return `true` at the same time
+        $this->assertFalse($post->delete(), 'Result of `delete()` expected to be `false`');
         $this->assertNotNull($post->deleted_at);
         $post = PostA::findOne(2);
         $this->assertNotNull($post->deleted_at);
-        $post->unDelete();
+        $this->assertTrue($post->unDelete(), 'Result of `unDelete()` expected to be `true`');
         $this->assertNull($post->deleted_at);
         $post = PostA::findOne(2);
         $this->assertNull($post->deleted_at);
@@ -55,7 +69,7 @@ public function testHardDeletePostA()
     {
         /** @var PostA $post */
         $post = PostA::findOne(2);
-        $post->hardDelete();
+        $this->assertTrue($post->hardDelete(), 'Result of `hardDelete()` expected to be `true`');
         $post = PostA::findOne(2);
         $this->assertNull($post);
     }
@@ -67,7 +81,8 @@ public function testSoftDeletePostB()
     {
         /** @var PostB $post */
         $post = PostB::findOne(2);
-        $post->delete();
+        // delete() must return `false`, because we can't prevent real deletion and return `true` at the same time
+        $this->assertFalse($post->delete(), 'Result of `delete()` expected to be `false`');
         $this->assertNotNull($post->deleted_at);
         $post = PostB::findOne(2);
         $this->assertNotNull($post->deleted_at);
@@ -80,11 +95,12 @@ public function testUnDeletePostB()
     {
         /** @var PostB $post */
         $post = PostB::findOne(2);
-        $post->delete();
+        // delete() must return `false`, because we can't prevent real deletion and return `true` at the same time
+        $this->assertFalse($post->delete(), 'Result of `delete()` expected to be `false`');
         $this->assertNotNull($post->deleted_at);
         $post = PostB::findOne(2);
         $this->assertNotNull($post->deleted_at);
-        $post->unDelete();
+        $this->assertTrue($post->unDelete(), 'Result of `unDelete()` expected to be `true`');
         $this->assertNull($post->deleted_at);
         $post = PostB::findOne(2);
         $this->assertNull($post->deleted_at);
@@ -97,9 +113,8 @@ public function testHardDeletePostB()
     {
         /** @var PostB $post */
         $post = PostB::findOne(2);
-        $post->hardDelete();
+        $this->assertTrue($post->hardDelete(), 'Result of `hardDelete()` expected to be `true`');
         $post = PostB::findOne(2);
         $this->assertNull($post);
     }
-
-}
+}