test: add fixture suite and expand architecture tests

Author: danielebarbaro

phpstan.neon.dist

@@ -6,5 +6,4 @@ parameters:
     paths:
         - src
         - config
-        - database
     tmpDir: build/phpstan

src/EmailFixer.php

@@ -19,18 +19,18 @@
 use PlinCode\LaravelEmailFixer\Locale\ItalianPreset;
 use PlinCode\LaravelEmailFixer\Support\FixReport;
 
-class EmailFixer
+final class EmailFixer
 {
     /** @var array<string, class-string<LocalePreset>> */
     private static array $presets = [
         'it' => ItalianPreset::class,
     ];
 
     /**
-     * @param FixerInterface[] $fixers
-     * @param array<string, string> $domainMap
-     * @param array<string, mixed> $garbageConfig
-     * @param (callable(string): bool)|null $validator
+     * @param  FixerInterface[]  $fixers
+     * @param  array<string, string>  $domainMap
+     * @param  array<string, mixed>  $garbageConfig
+     * @param  (callable(string): bool)|null  $validator
      */
     public function __construct(
         private array $fixers,
@@ -112,7 +112,7 @@ public function fixMany(array $emails): array
         return array_map(fn (string $email) => $this->diagnose($email), $emails);
     }
 
-    public function locale(string $locale): static
+    public function locale(string $locale): self
     {
         $presetClass = self::$presets[$locale] ?? null;
 
@@ -144,20 +144,20 @@ public function locale(string $locale): static
 
         array_splice($fixers, $insertIndex, 0, $preset->fixers());
 
-        return new static($fixers, $mergedMap, $this->garbageConfig, $this->validator);
+        return new self($fixers, $mergedMap, $this->garbageConfig, $this->validator);
     }
 
     /**
-     * @param array<string, string> $domainMap
-     * @param array<string, mixed> $garbageConfig
-     * @param (callable(string): bool)|null $validator
+     * @param  array<string, string>  $domainMap
+     * @param  array<string, mixed>  $garbageConfig
+     * @param  (callable(string): bool)|null  $validator
      */
     public static function defaults(
         array $domainMap = [],
         array $garbageConfig = [],
         ?callable $validator = null,
-    ): static {
-        return new static(
+    ): self {
+        return new self(
             fixers: self::defaultFixers($domainMap),
             domainMap: $domainMap,
             garbageConfig: $garbageConfig,

src/Fixers/CleanLocalPart.php

@@ -15,7 +15,7 @@ public function fix(string $email): string
 
         $local = rtrim(substr($email, 0, $atPos), '.');
 
-        return $local . substr($email, $atPos);
+        return $local.substr($email, $atPos);
     }
 
     public function name(): string

src/Fixers/CompleteDomain.php

@@ -4,7 +4,7 @@
 
 use PlinCode\LaravelEmailFixer\Contracts\DomainAwareFixer;
 
-class CompleteDomain implements DomainAwareFixer
+final class CompleteDomain implements DomainAwareFixer
 {
     /** @param array<string, string> $domainMap */
     public function __construct(private array $domainMap) {}
@@ -20,7 +20,7 @@ public function fix(string $email): string
         $domain = substr($email, $atPos + 1);
 
         if (isset($this->domainMap[$domain])) {
-            return $local . '@' . $this->domainMap[$domain];
+            return $local.'@'.$this->domainMap[$domain];
         }
 
         return $email;
@@ -33,6 +33,6 @@ public function name(): string
 
     public function withDomainMap(array $domainMap): static
     {
-        return new static($domainMap);
+        return new self($domainMap);
     }
 }

src/Fixers/FixDomainSeparator.php

@@ -4,7 +4,7 @@
 
 use PlinCode\LaravelEmailFixer\Contracts\DomainAwareFixer;
 
-class FixDomainSeparator implements DomainAwareFixer
+final class FixDomainSeparator implements DomainAwareFixer
 {
     /** @param array<string, string> $domainMap */
     public function __construct(private array $domainMap) {}
@@ -23,7 +23,7 @@ public function fix(string $email): string
         foreach ($this->domainMap as $fullDomain) {
             $normalizedKnown = str_replace(['.', '-'], '', strtolower($fullDomain));
             if ($normalized === $normalizedKnown) {
-                return $local . '@' . $fullDomain;
+                return $local.'@'.$fullDomain;
             }
         }
 
@@ -37,6 +37,6 @@ public function name(): string
 
     public function withDomainMap(array $domainMap): static
     {
-        return new static($domainMap);
+        return new self($domainMap);
     }
 }

src/Fixers/InsertMissingAt.php

@@ -4,7 +4,7 @@
 
 use PlinCode\LaravelEmailFixer\Contracts\DomainAwareFixer;
 
-class InsertMissingAt implements DomainAwareFixer
+final class InsertMissingAt implements DomainAwareFixer
 {
     /** @param array<string, string> $domainMap */
     public function __construct(private array $domainMap) {}
@@ -22,8 +22,8 @@ public function fix(string $email): string
         foreach ($fullDomains as $domain) {
             if (str_ends_with($email, $domain)) {
                 $local = substr($email, 0, -strlen($domain));
-                if ($local !== '' && $local !== false) {
-                    return $local . '@' . $domain;
+                if ($local !== '') {
+                    return $local.'@'.$domain;
                 }
             }
         }
@@ -35,8 +35,8 @@ public function fix(string $email): string
         foreach ($keys as $key) {
             if (str_ends_with($email, $key)) {
                 $local = substr($email, 0, -strlen($key));
-                if ($local !== '' && $local !== false) {
-                    return $local . '@' . $this->domainMap[$key];
+                if ($local !== '') {
+                    return $local.'@'.$this->domainMap[$key];
                 }
             }
         }
@@ -51,6 +51,6 @@ public function name(): string
 
     public function withDomainMap(array $domainMap): static
     {
-        return new static($domainMap);
+        return new self($domainMap);
     }
 }

src/Fixers/ItalianKeyboard.php

@@ -13,7 +13,7 @@ public function fix(string $email): string
             return $email;
         }
 
-        return mb_substr($email, 0, $pos) . '@' . mb_substr($email, $pos + 1);
+        return mb_substr($email, 0, $pos).'@'.mb_substr($email, $pos + 1);
     }
 
     public function name(): string

src/Rules/SanitizedEmail.php

@@ -30,7 +30,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
 
         $fixed = $fixer->fix($value);
 
-        request()?->merge([$attribute => $fixed]);
+        request()->merge([$attribute => $fixed]);
 
         $emailRule = $this->strict ? 'email:rfc' : 'email';
         $validator = validator([$attribute => $fixed], [$attribute => $emailRule]);

src/Support/FixReport.php

@@ -5,7 +5,7 @@
 class FixReport
 {
     /**
-     * @param string[] $appliedFixers
+     * @param  string[]  $appliedFixers
      */
     public function __construct(
         public readonly string $original,

tests/ArchTest.php

@@ -3,3 +3,27 @@
 arch('it will not use debugging functions')
     ->expect(['dd', 'dump', 'ray'])
     ->each->not->toBeUsed();
+
+arch('core classes do not depend on Laravel')
+    ->expect('PlinCode\LaravelEmailFixer\Contracts')
+    ->not->toUse('Illuminate');
+
+arch('fixers do not depend on Laravel')
+    ->expect('PlinCode\LaravelEmailFixer\Fixers')
+    ->not->toUse('Illuminate');
+
+arch('support classes do not depend on Laravel')
+    ->expect('PlinCode\LaravelEmailFixer\Support')
+    ->not->toUse('Illuminate');
+
+arch('locale presets do not depend on Laravel')
+    ->expect('PlinCode\LaravelEmailFixer\Locale')
+    ->not->toUse('Illuminate');
+
+arch('EmailFixer core does not depend on Laravel')
+    ->expect('PlinCode\LaravelEmailFixer\EmailFixer')
+    ->not->toUse('Illuminate');
+
+arch('all fixers implement FixerInterface')
+    ->expect('PlinCode\LaravelEmailFixer\Fixers')
+    ->toImplement('PlinCode\LaravelEmailFixer\Contracts\FixerInterface');