[TEST] Add PHPStan level 10, optimise Unit Test

Author: amculin

.github/workflows/build.yml

@@ -39,6 +39,9 @@ jobs:
 
       - name: Install dependencies
         run: composer install --prefer-dist
+      
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyse -l 10 source/ tests/
 
       - name: Run unit tests
         run: vendor/bin/phpunit --no-coverage tests/

composer.lock

@@ -10,6 +10,7 @@
  * @author Fahmi Auliya Tsani <[email protected]>
  * @version 1.1
  */
+#[\AllowDynamicProperties]
 class BasicVigenereCipher extends VigenereCipherBlueprint
 {
     public function __construct(

source/BasicVigenereCipher.php

@@ -19,7 +19,7 @@ public static function getClassName(string $mode): string
         return $path . $className;
     }
 
-    public static function encrypt(string $data, string $key, string $mode = 'basic'): string|null
+    public static function encrypt(string $data, string $key, string $mode = 'basic'): string
     {
         $className = self::getClassName($mode);
 
@@ -31,7 +31,7 @@ public static function encrypt(string $data, string $key, string $mode = 'basic'
         return $encrypt->cipherText;
     }
 
-    public static function decrypt(string $data, string $key, string $mode = 'basic'): string|null
+    public static function decrypt(string $data, string $key, string $mode = 'basic'): string
     {
         $className = self::getClassName($mode);
 

source/VigenereCipher.php

@@ -3,6 +3,7 @@
 
 use amculin\cryptography\classic\enums\ProcessType;
 
+#[\AllowDynamicProperties]
 abstract class VigenereCipherBlueprint
 {
     /**
@@ -25,7 +26,7 @@ abstract class VigenereCipherBlueprint
      *
      * @var string
      */
-    public string $plainText;
+    public string $plainText = '';
 
     /**
      * The key used to encrypt plain text/message
@@ -47,7 +48,7 @@ abstract class VigenereCipherBlueprint
      *
      * @var string
      */
-    public string $cipherText;
+    public string $cipherText = '';
 
     /**
      * Method to validate key, plainText, and cipherText
@@ -127,7 +128,7 @@ public function setProcess(string $process): void
      *
      * @return string
      */
-    public function getPlainText(): string|null
+    public function getPlainText(): string
     {
         return $this->plainText;
     }
@@ -171,7 +172,7 @@ public function setKey(string $key): void
      *
      * @return string
      */
-    public function getCipherText(): string|null
+    public function getCipherText(): string
     {
         return $this->cipherText;
     }

source/VigenereCipherBlueprint.php

@@ -15,14 +15,11 @@ public function testCanEncryptInBasicMode():void
         $data = 'encryptionprocess';
         $key = 'thekey';
 
-        $encrypted = VigenereCipher::encrypt($data, $key, VigenereMode::BASIC->value);
+        $encrypted = (string) VigenereCipher::encrypt($data, $key, VigenereMode::BASIC->value);
 
         $this->assertEquals(strlen($data), strlen($encrypted));
         $this->assertEquals('xugbcnmpsxtphjicw', $encrypted);
         $this->assertNotEquals($data, $encrypted);
-        $this->assertIsString($data);
-        $this->assertIsString($key);
-        $this->assertIsString($encrypted);
         $this->assertMatchesRegularExpression($allowedChars, $data);
         $this->assertMatchesRegularExpression($allowedChars, $key);
         $this->assertMatchesRegularExpression($allowedChars, $encrypted);
@@ -35,7 +32,7 @@ public function testCanNotEncryptInBasicModeWithInvalidKey():void
 
         $encrypted = VigenereCipher::encrypt($data, $key, VigenereMode::BASIC->value);
 
-        $this->assertNull($encrypted);
+        $this->assertEquals('', $encrypted);
     }
 
     public function testCanDecryptInBasicMode():void
@@ -44,14 +41,11 @@ public function testCanDecryptInBasicMode():void
         $data = 'xugbcnmpsxtphjicw';
         $key = 'thekey';
 
-        $decrypted = VigenereCipher::decrypt($data, $key, VigenereMode::BASIC->value);
+        $decrypted = (string) VigenereCipher::decrypt($data, $key, VigenereMode::BASIC->value);
 
         $this->assertEquals(strlen($data), strlen($decrypted));
         $this->assertEquals('encryptionprocess', $decrypted);
         $this->assertNotEquals($data, $decrypted);
-        $this->assertIsString($data);
-        $this->assertIsString($key);
-        $this->assertIsString($decrypted);
         $this->assertMatchesRegularExpression($allowedChars, $data);
         $this->assertMatchesRegularExpression($allowedChars, $key);
         $this->assertMatchesRegularExpression($allowedChars, $decrypted);
@@ -64,7 +58,7 @@ public function testCanNotDecryptInBasicModeWithInvalidKey():void
 
         $encrypted = VigenereCipher::decrypt($data, $key, VigenereMode::BASIC->value);
 
-        $this->assertNull($encrypted);
+        $this->assertEquals('', $encrypted);
     }
 
     public function testCanEncryptInAlphaNumericMode():void
@@ -78,9 +72,6 @@ public function testCanEncryptInAlphaNumericMode():void
         $this->assertEquals(strlen($data), strlen($encrypted));
         $this->assertEquals('Xu5B2NMpTxjPHJWCz', $encrypted);
         $this->assertNotEquals($data, $encrypted);
-        $this->assertIsString($data);
-        $this->assertIsString($key);
-        $this->assertIsString($encrypted);
         $this->assertMatchesRegularExpression($allowedChars, $data);
         $this->assertMatchesRegularExpression($allowedChars, $key);
         $this->assertMatchesRegularExpression($allowedChars, $encrypted);
@@ -93,7 +84,7 @@ public function testCanNotEncryptInAlphaNumericModeWithInvalidKey():void
 
         $encrypted = VigenereCipher::encrypt($data, $key, VigenereMode::ALPHA_NUMERIC->value);
 
-        $this->assertNull($encrypted);
+        $this->assertEquals('', $encrypted);
     }
 
     public function testCanDecryptWithAlphaNumericMode():void
@@ -107,9 +98,6 @@ public function testCanDecryptWithAlphaNumericMode():void
         $this->assertEquals(strlen($data), strlen($decrypted));
         $this->assertEquals('Encrypti0nProC3s5', $decrypted);
         $this->assertNotEquals($data, $decrypted);
-        $this->assertIsString($data);
-        $this->assertIsString($key);
-        $this->assertIsString($decrypted);
         $this->assertMatchesRegularExpression($allowedChars, $data);
         $this->assertMatchesRegularExpression($allowedChars, $key);
         $this->assertMatchesRegularExpression($allowedChars, $decrypted);
@@ -122,7 +110,7 @@ public function testCanNotDecryptInAlphaNumericModeWithInvalidKey():void
 
         $encrypted = VigenereCipher::decrypt($data, $key, VigenereMode::ALPHA_NUMERIC->value);
 
-        $this->assertNull($encrypted);
+        $this->assertEquals('', $encrypted);
     }
 
     public function testCanGetBasicVigenereClass(): void
@@ -132,7 +120,6 @@ public function testCanGetBasicVigenereClass(): void
 
         $className = VigenereCipher::getClassName($mode);
 
-        $this->assertIsString($className);
         $this->assertEquals($path . 'BasicVigenereCipher', $className);
     }
 
@@ -143,7 +130,6 @@ public function testCanGetAlphaNumericVigenereClass(): void
 
         $className = VigenereCipher::getClassName($mode);
 
-        $this->assertIsString($className);
         $this->assertEquals($path . 'AlnumVigenereCipher', $className);
     }
 }