Merge pull request #23 from CodeLieutenant/chore/change-encryptor-to-encrypter

CodeLieutenant · web-flow · commit 53d912cfe50d · 2024-03-05T11:28:53.000+01:00
chore: rename *Encryptor to *Encrypter per Laravel convention **BREAKING**
diff --git a/benchmarks/DecryptionBench.php b/benchmarks/DecryptionBench.php
@@ -4,15 +4,15 @@
 
 namespace CodeLieutenant\LaravelCrypto\Benchmarks;
 
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use Illuminate\Encryption\Encrypter;
 
 class DecryptionBench
 {
     private Encrypter $laravelEncrypter;
-    private XChaCha20Poly1305Encryptor $xchacha;
-    private AesGcm256Encryptor $aes256gcm;
+    private XChaCha20Poly1305Encrypter $xchacha;
+    private AesGcm256Encrypter $aes256gcm;
     private string $xChaChaData;
     private string $aes256GcmData;
     private string $laravelData;
@@ -21,8 +21,8 @@ public function __construct()
     {
         $key = base64_decode(file_get_contents(__DIR__.'/key'));
         $this->laravelEncrypter = new Encrypter($key, 'AES-256-CBC');
-        $this->xchacha = new XChaCha20Poly1305Encryptor($key);
-        $this->aes256gcm = new AesGcm256Encryptor($key);
+        $this->xchacha = new XChaCha20Poly1305Encrypter($key);
+        $this->aes256gcm = new AesGcm256Encrypter($key);
         $this->xChaChaData = file_get_contents(__DIR__.'/encrypted-xchacha');
         $this->laravelData = file_get_contents(__DIR__.'/encrypted-laravel');
         $this->aes256GcmData = file_get_contents(__DIR__.'/encrypted-aes256gcm');
diff --git a/benchmarks/EncryptionBench.php b/benchmarks/EncryptionBench.php
@@ -6,8 +6,8 @@
 use CodeLieutenant\LaravelCrypto\Encoder\IgbinaryEncoder;
 use CodeLieutenant\LaravelCrypto\Encoder\JsonEncoder;
 use CodeLieutenant\LaravelCrypto\Encoder\PhpEncoder;
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use CodeLieutenant\LaravelCrypto\Support\Random;
 use Generator;
 use Illuminate\Encryption\Encrypter;
@@ -62,7 +62,7 @@ public function providerChaCha20Crypto(): Generator
             foreach ($encoders as $encoderName => $encoder) {
                 yield 'ChaCha20-' . $encoderName . '-' . $dataName => [
                     'data' => $dataValue,
-                    'encrypter' => new XChaCha20Poly1305Encryptor(new KeyLoader(Random::bytes(32)), $logger, $encoder),
+                    'encrypter' => new XChaCha20Poly1305Encrypter(new KeyLoader(Random::bytes(32)), $logger, $encoder),
                 ];
             }
         }
@@ -91,7 +91,7 @@ public function providerAESGCMCrypto(): Generator
             foreach ($encoders as $encoderName => $encoder) {
                 yield 'ChaCha20-' . $encoderName . '-' . $dataName => [
                     'data' => $dataValue,
-                    'encrypter' => new AesGcm256Encryptor(new KeyLoader(Random::bytes(32)), $logger, $encoder),
+                    'encrypter' => new AesGcm256Encrypter(new KeyLoader(Random::bytes(32)), $logger, $encoder),
                 ];
             }
         }
diff --git a/src/Encryption/AesGcm256Encrypter.php b/src/Encryption/AesGcm256Encrypter.php
@@ -17,7 +17,7 @@
 use Illuminate\Contracts\Encryption\StringEncrypter;
 use Psr\Log\LoggerInterface;
 
-final class AesGcm256Encryptor implements Encrypter, KeyGeneration, StringEncrypter
+final class AesGcm256Encrypter implements Encrypter, KeyGeneration, StringEncrypter
 {
     use Crypto;
 
diff --git a/src/Encryption/XChaCha20Poly1305Encrypter.php b/src/Encryption/XChaCha20Poly1305Encrypter.php
@@ -17,7 +17,7 @@
 use Illuminate\Contracts\Encryption\StringEncrypter;
 use Psr\Log\LoggerInterface;
 
-final class XChaCha20Poly1305Encryptor implements Encrypter, KeyGeneration, StringEncrypter
+final class XChaCha20Poly1305Encrypter implements Encrypter, KeyGeneration, StringEncrypter
 {
     use Crypto;
 
diff --git a/src/Keys/Generators/AppKeyGenerator.php b/src/Keys/Generators/AppKeyGenerator.php
@@ -4,8 +4,8 @@
 
 namespace CodeLieutenant\LaravelCrypto\Keys\Generators;
 
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use CodeLieutenant\LaravelCrypto\Enums\Encryption;
 use CodeLieutenant\LaravelCrypto\Keys\EnvKeySaver;
 use Illuminate\Contracts\Config\Repository;
@@ -31,8 +31,8 @@ public function generate(?string $write): ?string
 
         $new = $this->formatKey(
             match (Encryption::tryFrom($cipher)) {
-                Encryption::SodiumAES256GCM => AesGcm256Encryptor::generateKey($cipher),
-                Encryption::SodiumXChaCha20Poly1305 => XChaCha20Poly1305Encryptor::generateKey($cipher),
+                Encryption::SodiumAES256GCM => AesGcm256Encrypter::generateKey($cipher),
+                Encryption::SodiumXChaCha20Poly1305 => XChaCha20Poly1305Encrypter::generateKey($cipher),
                 default => Encrypter::generateKey($cipher),
             }
         );
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -12,8 +12,8 @@
 use CodeLieutenant\LaravelCrypto\Encoder\JsonEncoder;
 use CodeLieutenant\LaravelCrypto\Encoder\MessagePackEncoder;
 use CodeLieutenant\LaravelCrypto\Encoder\PhpEncoder;
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use CodeLieutenant\LaravelCrypto\Enums\Encryption;
 use CodeLieutenant\LaravelCrypto\Hashing\Blake2b;
 use CodeLieutenant\LaravelCrypto\Hashing\HashingManager;
@@ -173,7 +173,7 @@ protected function getConfigPath(): string
 
     protected function registerEncrypter(): void
     {
-        foreach ([AesGcm256Encryptor::class, XChaCha20Poly1305Encryptor::class] as $encryptor) {
+        foreach ([AesGcm256Encrypter::class, XChaCha20Poly1305Encrypter::class] as $encryptor) {
             $this->app->singleton($encryptor);
             $this->app->when($encryptor)
                 ->needs(Loader::class)
@@ -190,8 +190,8 @@ protected function registerEncrypter(): void
             }
 
             return match ($enc) {
-                Encryption::SodiumAES256GCM => $app->make(AesGcm256Encryptor::class),
-                Encryption::SodiumXChaCha20Poly1305 => $app->make(XChaCha20Poly1305Encryptor::class),
+                Encryption::SodiumAES256GCM => $app->make(AesGcm256Encrypter::class),
+                Encryption::SodiumXChaCha20Poly1305 => $app->make(XChaCha20Poly1305Encrypter::class),
             };
         };
 
diff --git a/tests/Architecture/EncryptionTest.php b/tests/Architecture/EncryptionTest.php
@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 use CodeLieutenant\LaravelCrypto\Contracts\KeyGeneration;
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use CodeLieutenant\LaravelCrypto\Enums\Encryption;
 use CodeLieutenant\LaravelCrypto\Traits\Crypto;
 use Illuminate\Contracts\Encryption\Encrypter;
@@ -14,5 +14,5 @@
     ->expect('CodeLieutenant\LaravelCrypto\Encryption')
     ->toImplement([Encrypter::class, StringEncrypter::class])
     ->toBeClasses()
-    ->toHaveSuffix('Encryptor')
+    ->toHaveSuffix('Encrypter')
     ->toBeFinal();
diff --git a/tests/Feature/Encryption/AesGcm256EncryptorTest.php b/tests/Feature/Encryption/AesGcm256EncryptorTest.php
@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
 
 it('should encrypt/decrypt data', function (bool $serialize) {
-    $encryptor = new AesGcm256Encryptor(inMemoryKeyLoader());
+    $encryptor = new AesGcm256Encrypter(inMemoryKeyLoader());
     $data = $serialize ? ['data'] : 'hello world';
     $encrypted = $encryptor->encrypt($data, $serialize);
 
@@ -16,7 +16,7 @@
 })->with([true, false]);
 
 it('should encrypt/decrypt string', function () {
-    $encryptor = new AesGcm256Encryptor(inMemoryKeyLoader());
+    $encryptor = new AesGcm256Encrypter(inMemoryKeyLoader());
     $data = 'hello world';
     $encrypted = $encryptor->encryptString($data);
 
diff --git a/tests/Feature/Encryption/XChaCha20Poly1305EncryptorTest.php b/tests/Feature/Encryption/XChaCha20Poly1305EncryptorTest.php
@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 
 it('should encrypt/decrypt data', function (bool $serialize) {
-    $encryptor = new XChaCha20Poly1305Encryptor(inMemoryKeyLoader());
+    $encryptor = new XChaCha20Poly1305Encrypter(inMemoryKeyLoader());
     $data = $serialize ? ['data'] : 'hello world';
     $encrypted = $encryptor->encrypt($data, $serialize);
 
@@ -16,7 +16,7 @@
 })->with([true, false]);
 
 it('should encrypt/decrypt string', function () {
-    $encryptor = new XChaCha20Poly1305Encryptor(inMemoryKeyLoader());
+    $encryptor = new XChaCha20Poly1305Encrypter(inMemoryKeyLoader());
     $data = 'hello world';
     $encrypted = $encryptor->encryptString($data);
 
diff --git a/tests/Feature/ServiceProviderLoadingTest.php b/tests/Feature/ServiceProviderLoadingTest.php
@@ -2,8 +2,8 @@
 
 declare(strict_types=1);
 
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encryptor;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
+use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use CodeLieutenant\LaravelCrypto\Enums\Encryption;
 use Illuminate\Encryption\Encrypter;
 use Illuminate\Support\Facades\Config;
@@ -17,6 +17,6 @@
 })->with([
     ['AES-256-GCM', Encrypter::class],
     ['AES-256-CBC', Encrypter::class],
-    [Encryption::SodiumAES256GCM->value, AesGcm256Encryptor::class],
-    [Encryption::SodiumXChaCha20Poly1305->value, XChaCha20Poly1305Encryptor::class],
+    [Encryption::SodiumAES256GCM->value, AesGcm256Encrypter::class],
+    [Encryption::SodiumXChaCha20Poly1305->value, XChaCha20Poly1305Encrypter::class],
 ]);

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`use Illuminate\Contracts\Encryption\StringEncrypter;`
`18`	`18`	`use Psr\Log\LoggerInterface;`
`19`	`19`
`20`		`-final class AesGcm256Encryptor implements Encrypter, KeyGeneration, StringEncrypter`
	`20`	`+final class AesGcm256Encrypter implements Encrypter, KeyGeneration, StringEncrypter`
`21`	`21`	`{`
`22`	`22`	`use Crypto;`
`23`	`23`