Must confirm delete all in query builder

With the query builder it is easy to delete all entries in a
table by forgetting the "where" restriction - now there is
a mandatory confirmDeleteAll call if no where restriction is
defined, to make deleting all entries explicit.

Author: iquito

src/Builder/DeleteEntries.php

@@ -2,7 +2,9 @@
 
 namespace Squirrel\Queries\Builder;
 
+use Squirrel\Queries\DBDebug;
 use Squirrel\Queries\DBInterface;
+use Squirrel\Queries\Exception\DBInvalidOptionException;
 
 /**
  * Delete query builder as a fluent object - build query and execute it
@@ -24,6 +26,11 @@ class DeleteEntries
      */
     private $where = [];
 
+    /**
+     * @var bool We need to confirmation before we delete all entries
+     */
+    private $deleteAll = false;
+
     public function __construct(DBInterface $db)
     {
         $this->db = $db;
@@ -41,12 +48,18 @@ public function where(array $whereClauses): self
         return $this;
     }
 
+    public function confirmDeleteAll(): self
+    {
+        $this->deleteAll = true;
+        return $this;
+    }
+
     /**
      * Write changes to database
      */
     public function write(): void
     {
-        $this->db->delete($this->table, $this->where);
+        $this->writeAndReturnAffectedNumber();
     }
 
     /**
@@ -56,6 +69,23 @@ public function write(): void
      */
     public function writeAndReturnAffectedNumber(): int
     {
+        $this->accidentalDeleteAllCheck();
+
         return $this->db->delete($this->table, $this->where);
     }
+
+    /**
+     * Make sure there is no accidental "delete everything" because WHERE restrictions were forgotten
+     */
+    private function accidentalDeleteAllCheck()
+    {
+        // Make sure there is no accidental "delete everything"
+        if (\count($this->where) === 0 && $this->deleteAll !== true) {
+            throw DBDebug::createException(
+                DBInvalidOptionException::class,
+                [self::class],
+                'No restricting "where" arguments defined for DELETE'
+            );
+        }
+    }
 }

tests/Builder/DeleteEntriesTest.php

@@ -4,6 +4,7 @@
 
 use Squirrel\Queries\Builder\DeleteEntries;
 use Squirrel\Queries\DBInterface;
+use Squirrel\Queries\Exception\DBInvalidOptionException;
 
 class DeleteEntriesTest extends \PHPUnit\Framework\TestCase
 {
@@ -29,7 +30,9 @@ public function testNoDataGetEntries()
             ->with('', [])
             ->andReturn($expectedResult);
 
-        $deleteBuilder->write();
+        $deleteBuilder
+            ->confirmDeleteAll()
+            ->write();
 
         $this->assertTrue(true);
     }
@@ -46,7 +49,9 @@ public function testNoDataGetEntriesWithAffected()
             ->with('', [])
             ->andReturn($expectedResult);
 
-        $results = $deleteBuilder->writeAndReturnAffectedNumber();
+        $results = $deleteBuilder
+            ->confirmDeleteAll()
+            ->writeAndReturnAffectedNumber();
 
         $this->assertSame($expectedResult, $results);
     }
@@ -76,4 +81,21 @@ public function testGetEntries()
 
         $this->assertSame($expectedResult, $results);
     }
+
+    public function testNoWhereNoConfirmation()
+    {
+        $this->expectException(DBInvalidOptionException::class);
+
+        $deleteBuilder = new DeleteEntries($this->db);
+
+        $expectedResult = 33;
+
+        $this->db
+            ->shouldReceive('delete')
+            ->once()
+            ->with('', [])
+            ->andReturn($expectedResult);
+
+        $deleteBuilder->write();
+    }
 }