Merge pull request #42 from Blaspsoft/fix/empty-string-check

fix: check() should not throw on empty strings (#29)

Author: deemonic

src/BlaspService.php

@@ -246,15 +246,19 @@ public function allLanguages(): self
     }
 
     /**
-     * @param string $string
+     * @param string|null $string
      * @return $this
-     * @throws Exception
      */
-    public function check(string $string): self
+    public function check(?string $string): self
     {
         if (empty($string)) {
-
-            throw new Exception('No string to check');
+            $this->sourceString = $string ?? '';
+            $this->cleanString = $string ?? '';
+            $this->hasProfanity = false;
+            $this->profanitiesCount = 0;
+            $this->uniqueProfanitiesFound = [];
+            $this->uniqueProfanitiesMap = [];
+            return $this;
         }
 
         $this->sourceString = $string;

src/Facades/Blasp.php

@@ -6,7 +6,7 @@
 use Blaspsoft\Blasp\BlaspService;
 
 /**
- * @method static \Blaspsoft\Blasp\BlaspService check(string $string)
+ * @method static \Blaspsoft\Blasp\BlaspService check(?string $string)
  * @method static \Blaspsoft\Blasp\BlaspService configure(?array $profanities = null, ?array $falsePositives = null)
  * @method static \Blaspsoft\Blasp\BlaspService language(string $language)
  * @method static \Blaspsoft\Blasp\BlaspService english()
@@ -117,10 +117,10 @@ public static function maskWith(string $character): BlaspService
     /**
      * Check text for profanity (backwards compatible)
      *
-     * @param string $string
+     * @param string|null $string
      * @return \Blaspsoft\Blasp\BlaspService
      */
-    public static function check(string $string): BlaspService
+    public static function check(?string $string): BlaspService
     {
         return static::getFacadeRoot()->check($string);
     }

tests/EmptyInputTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Blaspsoft\Blasp\Tests;
+
+use Blaspsoft\Blasp\BlaspService;
+
+class EmptyInputTest extends TestCase
+{
+    protected $blaspService;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->blaspService = new BlaspService();
+    }
+
+    public function test_empty_string_returns_no_profanity()
+    {
+        $result = $this->blaspService->check('');
+
+        $this->assertFalse($result->hasProfanity());
+        $this->assertEquals(0, $result->getProfanitiesCount());
+        $this->assertEmpty($result->getUniqueProfanitiesFound());
+    }
+
+    public function test_empty_string_returns_empty_source_and_clean_strings()
+    {
+        $result = $this->blaspService->check('');
+
+        $this->assertEquals('', $result->getSourceString());
+        $this->assertEquals('', $result->getCleanString());
+    }
+
+    public function test_null_returns_no_profanity()
+    {
+        $result = $this->blaspService->check(null);
+
+        $this->assertFalse($result->hasProfanity());
+        $this->assertEquals('', $result->getSourceString());
+        $this->assertEquals('', $result->getCleanString());
+    }
+
+    public function test_profanity_still_detected_after_empty_check()
+    {
+        $this->blaspService->check('');
+        $result = $this->blaspService->check('shit');
+
+        $this->assertTrue($result->hasProfanity());
+    }
+}