Test

.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.json

@@ -19,6 +19,7 @@
         }
     },
     "require-dev": {
+        "phpstan/phpstan": "^2.1",
         "phpunit/phpunit": "^11.5"
     }
 }

source/AlnumVigenereCipher.php

@@ -8,39 +8,77 @@
  * This file is the main class for alpha-numric mode vigenere cipher algortithm
  *
  * @author Fahmi Auliya Tsani <amixcustomlinux@gmail.com>
- * @version 0.1
+ * @version 1.1
  */
-
 class AlnumVigenereCipher extends VigenereCipherBlueprint
 {
+    public function __construct(
+        public string $data,
+        public string $key,
+        public string $process = 'encrypt'
+    ) {
+        $this->process = $process;
+        $this->tabulaRecta = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+
+        if ($process == ProcessType::ENCRYPT->value) {
+            $this->plainText = $data;
+            $this->key = $this->generateKey($key);
+
+            if ($this->isValid()) {
+                $this->encrypt();
+            }
+        } else {
+            $this->cipherText = $data;
+            $this->key = $this->generateKey($key);
+
+            if ($this->isValid()) {
+                $this->decrypt();
+            }
+        }
+    }
+
     /**
-     * Default list of acceptable character to be used in vigenere cipher algorithm
-     * This list cointains alpha-numeric characters including the capitalized
-     *
-     * @var string
+     * @inheritdoc
      */
-    public $tabulaRecta = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+    public function isValidKey(string $pattern): bool
+    {
+        return preg_match($pattern, $this->key) == 1;
+    }
 
+    /**
+     * @inheritdoc
+     */
+    public function isValidPlainText(string $pattern): bool
+    {
+        return preg_match($pattern, $this->plainText) == 1;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isValidCipherText(string $pattern): bool
+    {
+        return preg_match($pattern, $this->cipherText) == 1;
+    }
+
+    /**
+     * @inheritdoc
+     */
     public function isValid(): bool
     {
         try {
             $pattern = '/^[a-zA-Z0-9]*$/';
-            $isValid = preg_match($pattern, $this->key);
 
-            if (! $isValid) {
+            if (! $this->isValidKey($pattern)) {
                 throw new InvalidAlnumException('Key');
             }
 
             if ($this->process == ProcessType::ENCRYPT->value) {
-                $isValid = preg_match($pattern, $this->plainText) && $isValid;
-
-                if (! $isValid) {
+                if (! $this->isValidPlainText($pattern)) {
                     throw new InvalidAlnumException('Plain text');
                 }
             } else {
-                $isValid = preg_match($pattern, $this->cipherText) && $isValid;
-
-                if (! $isValid) {
+                if (! $this->isValidCipherText($pattern)) {
                     throw new InvalidAlnumException('Cipher text');
                 }
             }
@@ -50,6 +88,7 @@ public function isValid(): bool
             return false;
         }
 
+        $this->setIsValid(true);
         return true;
     }
 }

source/BasicVigenereCipher.php

@@ -8,36 +8,78 @@
  * This file is the main class for basic vigenere cipher algortithm
  *
  * @author Fahmi Auliya Tsani <amixcustomlinux@gmail.com>
- * @version 0.2
+ * @version 1.1
  */
-
+#[\AllowDynamicProperties]
 class BasicVigenereCipher extends VigenereCipherBlueprint
 {
+    public function __construct(
+        public string $data,
+        public string $key,
+        public string $process = 'encrypt'
+    ) {
+        $this->process = $process;
+        $this->tabulaRecta = 'abcdefghijklmnopqrstuvwxyz';
+
+        if ($process == ProcessType::ENCRYPT->value) {
+            $this->plainText = $data;
+            $this->key = $this->generateKey($key);
+
+            if ($this->isValid()) {
+                $this->encrypt();
+            }
+        } else {
+            $this->cipherText = $data;
+            $this->key = $this->generateKey($key);
+
+            if ($this->isValid()) {
+                $this->decrypt();
+            }
+        }
+    }
+
     /**
      * @inheritdoc
      */
-    public $tabulaRecta = 'abcdefghijklmnopqrstuvwxyz';
+    public function isValidKey(string $pattern): bool
+    {
+        return preg_match($pattern, $this->key) == 1;
+    }
 
+    /**
+     * @inheritdoc
+     */
+    public function isValidPlainText(string $pattern): bool
+    {
+        return preg_match($pattern, $this->plainText) == 1;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isValidCipherText(string $pattern): bool
+    {
+        return preg_match($pattern, $this->cipherText) == 1;
+    }
+
+    /**
+     * @inheritdoc
+     */
     public function isValid(): bool
     {
         try {
             $pattern = '/^[a-z]*$/';
-            $isValid = preg_match($pattern, $this->key);
 
-            if (! $isValid) {
+            if (! $this->isValidKey($pattern)) {
                 throw new InvalidBasicException('Key');
             }
 
             if ($this->process == ProcessType::ENCRYPT->value) {
-                $isValid = preg_match($pattern, $this->plainText) && $isValid;
-
-                if (! $isValid) {
+                if (! $this->isValidPlainText($pattern)) {
                     throw new InvalidBasicException('Plain text');
                 }
             } else {
-                $isValid = preg_match($pattern, $this->cipherText) && $isValid;
-
-                if (! $isValid) {
+                if (! $this->isValidCipherText($pattern)) {
                     throw new InvalidBasicException('Cipher text');
                 }
             }
@@ -47,6 +89,8 @@ public function isValid(): bool
             return false;
         }
 
+        $this->setIsValid(true);
+
         return true;
     }
 }

source/VigenereCipher.php

@@ -1,6 +1,7 @@
 <?php
 namespace amculin\cryptography\classic;
 
+use amculin\cryptography\classic\VigenereCipherBlueprint;
 use amculin\cryptography\classic\enums\ProcessType;
 use amculin\cryptography\classic\enums\VigenereMode;
 
@@ -9,33 +10,36 @@ class VigenereCipher
     public static function getClassName(string $mode): string
     {
         $path = 'amculin\cryptography\classic\\';
+        $className = 'BasicVigenereCipher';
 
-        if ($mode == VigenereMode::BASIC->value) {
-            return $path . 'BasicVigenereCipher';
-        } elseif ($mode == VigenereMode::ALPHA_NUMERIC->value) {
-            return $path . 'AlnumVigenereCipher';
+        if ($mode == VigenereMode::ALPHA_NUMERIC->value) {
+            $className = 'AlnumVigenereCipher';
         }
+
+        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);
 
         $processName = ProcessType::ENCRYPT->value;
 
-        $encrypt = new $className($processName, $data, $key);
+        /** @var VigenereCipherBlueprint $encrypt */
+        $encrypt = new $className($data, $key, $processName);
 
-        return $encrypt->getCipherText();
+        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);
 
         $processName = ProcessType::DECRYPT->value;
 
-        $decrypt = new $className($processName, $data, $key);
+        /** @var VigenereCipherBlueprint $decrypt */
+        $decrypt = new $className($data, $key, $processName);
 
-        return $decrypt->getPlainText();
+        return $decrypt->plainText;
     }
 }