Naming convention for interfaces (#155)

Interfaces now have an `Interface` suffix as per https://www.php-fig.org/bylaws/psr-naming-conventions/
Spomky-Labs · Apr 4, 2024 · 2ecc4e3 · 2ecc4e3
1 parent 0e5285b
commit 2ecc4e3
Show file tree

Hide file tree

Showing 49 changed files with 200 additions and 128 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -71,7 +71,7 @@ parameters:
 			path: src/Command/CreateIconsCommand.php
 
 		-
-			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessor\\:\\:process\\(\\) expects string, string\\|false given\\.$#"
+			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessorInterface\\:\\:process\\(\\) expects string, string\\|false given\\.$#"
 			count: 1
 			path: src/Command/CreateIconsCommand.php
 
@@ -91,7 +91,7 @@ parameters:
 			path: src/Command/CreateIconsCommand.php
 
 		-
-			message: "#^Parameter \\#4 \\$format of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessor\\:\\:process\\(\\) expects string\\|null, mixed given\\.$#"
+			message: "#^Parameter \\#4 \\$format of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessorInterface\\:\\:process\\(\\) expects string\\|null, mixed given\\.$#"
 			count: 1
 			path: src/Command/CreateIconsCommand.php
 
@@ -111,12 +111,12 @@ parameters:
 			path: src/Command/CreateScreenshotCommand.php
 
 		-
-			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessor\\:\\:getSizes\\(\\) expects string, string\\|false given\\.$#"
+			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessorInterface\\:\\:getSizes\\(\\) expects string, string\\|false given\\.$#"
 			count: 1
 			path: src/Command/CreateScreenshotCommand.php
 
 		-
-			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessor\\:\\:process\\(\\) expects string, string\\|false given\\.$#"
+			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessorInterface\\:\\:process\\(\\) expects string, string\\|false given\\.$#"
 			count: 1
 			path: src/Command/CreateScreenshotCommand.php
 
@@ -136,7 +136,7 @@ parameters:
 			path: src/Command/CreateScreenshotCommand.php
 
 		-
-			message: "#^Parameter \\#4 \\$format of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessor\\:\\:process\\(\\) expects string\\|null, mixed given\\.$#"
+			message: "#^Parameter \\#4 \\$format of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessorInterface\\:\\:process\\(\\) expects string\\|null, mixed given\\.$#"
 			count: 1
 			path: src/Command/CreateScreenshotCommand.php
 
@@ -501,7 +501,7 @@ parameters:
 			path: src/Normalizer/ScreenshotNormalizer.php
 
 		-
-			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessor\\:\\:getSizes\\(\\) expects string, string\\|false given\\.$#"
+			message: "#^Parameter \\#1 \\$image of method SpomkyLabs\\\\PwaBundle\\\\ImageProcessor\\\\ImageProcessorInterface\\:\\:getSizes\\(\\) expects string, string\\|false given\\.$#"
 			count: 1
 			path: src/Normalizer/ScreenshotNormalizer.php
 

diff --git a/src/CachingStrategy/AssetCache.php b/src/CachingStrategy/AssetCache.php
@@ -18,7 +18,7 @@
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
 
-final readonly class AssetCache implements HasCacheStrategies
+final readonly class AssetCache implements HasCacheStrategiesInterface
 {
     private int $jsonOptions;
 
@@ -53,7 +53,7 @@ public function getCacheStrategies(): array
         $strategy = WorkboxCacheStrategy::create(
             $this->workbox->enabled && $this->workbox->assetCache->enabled,
             true,
-            CacheStrategy::STRATEGY_CACHE_FIRST,
+            CacheStrategyInterface::STRATEGY_CACHE_FIRST,
             sprintf("({url}) => url.pathname.startsWith('%s')", $this->assetPublicPrefix),
         )
             ->withName($this->workbox->assetCache->cacheName)

diff --git a/src/CachingStrategy/BackgroundSync.php b/src/CachingStrategy/BackgroundSync.php
@@ -6,16 +6,16 @@
 
 use SpomkyLabs\PwaBundle\Dto\ServiceWorker;
 use SpomkyLabs\PwaBundle\Dto\Workbox;
-use SpomkyLabs\PwaBundle\MatchCallbackHandler\MatchCallbackHandler;
+use SpomkyLabs\PwaBundle\MatchCallbackHandler\MatchCallbackHandlerInterface;
 use SpomkyLabs\PwaBundle\WorkboxPlugin\BackgroundSyncPlugin;
 use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
 
-final readonly class BackgroundSync implements HasCacheStrategies
+final readonly class BackgroundSync implements HasCacheStrategiesInterface
 {
     private Workbox $workbox;
 
     /**
-     * @param iterable<MatchCallbackHandler> $matchCallbackHandlers
+     * @param iterable<MatchCallbackHandlerInterface> $matchCallbackHandlers
      */
     public function __construct(
         ServiceWorker $serviceWorker,
@@ -26,7 +26,7 @@ public function __construct(
     }
 
     /**
-     * @return array<CacheStrategy>
+     * @return array<CacheStrategyInterface>
      */
     public function getCacheStrategies(): array
     {
@@ -35,7 +35,7 @@ public function getCacheStrategies(): array
             $strategies[] = WorkboxCacheStrategy::create(
                 $this->workbox->enabled,
                 true,
-                CacheStrategy::STRATEGY_NETWORK_ONLY,
+                CacheStrategyInterface::STRATEGY_NETWORK_ONLY,
                 $this->prepareMatchCallback($sync->matchCallback)
             )
                 ->withName('Background Sync')

diff --git a/src/CachingStrategy/CacheStrategy.php b/src/CachingStrategy/CacheStrategy.php
@@ -4,31 +4,9 @@
 
 namespace SpomkyLabs\PwaBundle\CachingStrategy;
 
-interface CacheStrategy
+/**
+ * @deprecated since 1.2.0, will be removed in 2.0.0. Use CacheStrategyInterface instead.
+ */
+interface CacheStrategy extends CacheStrategyInterface
 {
-    public const STRATEGY_CACHE_FIRST = 'CacheFirst';
-
-    public const STRATEGY_CACHE_ONLY = 'CacheOnly';
-
-    public const STRATEGY_NETWORK_FIRST = 'NetworkFirst';
-
-    public const STRATEGY_NETWORK_ONLY = 'NetworkOnly';
-
-    public const STRATEGY_STALE_WHILE_REVALIDATE = 'StaleWhileRevalidate';
-
-    public const STRATEGIES = [
-        self::STRATEGY_CACHE_FIRST,
-        self::STRATEGY_CACHE_ONLY,
-        self::STRATEGY_NETWORK_FIRST,
-        self::STRATEGY_NETWORK_ONLY,
-        self::STRATEGY_STALE_WHILE_REVALIDATE,
-    ];
-
-    public function getName(): ?string;
-
-    public function isEnabled(): bool;
-
-    public function needsWorkbox(): bool;
-
-    public function render(string $cacheObjectName, bool $debug = false): string;
 }
diff --git a/src/CachingStrategy/CacheStrategyInterface.php b/src/CachingStrategy/CacheStrategyInterface.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SpomkyLabs\PwaBundle\CachingStrategy;
+
+interface CacheStrategyInterface
+{
+    public const STRATEGY_CACHE_FIRST = 'CacheFirst';
+
+    public const STRATEGY_CACHE_ONLY = 'CacheOnly';
+
+    public const STRATEGY_NETWORK_FIRST = 'NetworkFirst';
+
+    public const STRATEGY_NETWORK_ONLY = 'NetworkOnly';
+
+    public const STRATEGY_STALE_WHILE_REVALIDATE = 'StaleWhileRevalidate';
+
+    public const STRATEGIES = [
+        self::STRATEGY_CACHE_FIRST,
+        self::STRATEGY_CACHE_ONLY,
+        self::STRATEGY_NETWORK_FIRST,
+        self::STRATEGY_NETWORK_ONLY,
+        self::STRATEGY_STALE_WHILE_REVALIDATE,
+    ];
+
+    public function getName(): ?string;
+
+    public function isEnabled(): bool;
+
+    public function needsWorkbox(): bool;
+
+    public function render(string $cacheObjectName, bool $debug = false): string;
+}
diff --git a/src/CachingStrategy/FontCache.php b/src/CachingStrategy/FontCache.php
@@ -18,7 +18,7 @@
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
 
-final readonly class FontCache implements HasCacheStrategies
+final readonly class FontCache implements HasCacheStrategiesInterface
 {
     private int $jsonOptions;
 
@@ -49,7 +49,7 @@ public function getCacheStrategies(): array
         $strategy = WorkboxCacheStrategy::create(
             $this->workbox->enabled && $this->workbox->fontCache->enabled,
             true,
-            CacheStrategy::STRATEGY_CACHE_FIRST,
+            CacheStrategyInterface::STRATEGY_CACHE_FIRST,
             "({request}) => request.destination === 'font'"
         )
             ->withName($this->workbox->fontCache->cacheName ?? 'fonts')

diff --git a/src/CachingStrategy/GoogleFontCache.php b/src/CachingStrategy/GoogleFontCache.php
@@ -9,7 +9,7 @@
 use SpomkyLabs\PwaBundle\WorkboxPlugin\CacheableResponsePlugin;
 use SpomkyLabs\PwaBundle\WorkboxPlugin\ExpirationPlugin;
 
-final readonly class GoogleFontCache implements HasCacheStrategies
+final readonly class GoogleFontCache implements HasCacheStrategiesInterface
 {
     private Workbox $workbox;
 
@@ -30,14 +30,14 @@ public function getCacheStrategies(): array
             WorkboxCacheStrategy::create(
                 $this->workbox->enabled && $this->workbox->googleFontCache->enabled,
                 true,
-                CacheStrategy::STRATEGY_STALE_WHILE_REVALIDATE,
+                CacheStrategyInterface::STRATEGY_STALE_WHILE_REVALIDATE,
                 "({url}) => url.origin === 'https://fonts.googleapis.com'",
             )
                 ->withName($prefix . 'google-fonts-stylesheets'),
             WorkboxCacheStrategy::create(
                 $this->workbox->enabled && $this->workbox->googleFontCache->enabled,
                 true,
-                CacheStrategy::STRATEGY_CACHE_FIRST,
+                CacheStrategyInterface::STRATEGY_CACHE_FIRST,
                 "({url}) => url.origin === 'https://fonts.gstatic.com'"
             )
                 ->withName($prefix . 'google-fonts-webfonts')

diff --git a/src/CachingStrategy/HasCacheStrategies.php b/src/CachingStrategy/HasCacheStrategies.php
@@ -4,10 +4,9 @@
 
 namespace SpomkyLabs\PwaBundle\CachingStrategy;
 
-interface HasCacheStrategies
+/**
+ * @deprecated since 1.2.0, will be removed in 2.0.0. Use HasCacheStrategiesInterface instead.
+ */
+interface HasCacheStrategies extends HasCacheStrategiesInterface
 {
-    /**
-     * @return array<CacheStrategy>
-     */
-    public function getCacheStrategies(): array;
 }
diff --git a/src/CachingStrategy/HasCacheStrategiesInterface.php b/src/CachingStrategy/HasCacheStrategiesInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SpomkyLabs\PwaBundle\CachingStrategy;
+
+interface HasCacheStrategiesInterface
+{
+    /**
+     * @return array<CacheStrategyInterface>
+     */
+    public function getCacheStrategies(): array;
+}
diff --git a/src/CachingStrategy/ImageCache.php b/src/CachingStrategy/ImageCache.php
@@ -9,7 +9,7 @@
 use Symfony\Component\AssetMapper\Path\PublicAssetsPathResolverInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 
-final readonly class ImageCache implements HasCacheStrategies
+final readonly class ImageCache implements HasCacheStrategiesInterface
 {
     private string $assetPublicPrefix;
 
@@ -30,7 +30,7 @@ public function getCacheStrategies(): array
             WorkboxCacheStrategy::create(
                 $this->workbox->enabled && $this->workbox->imageCache->enabled,
                 true,
-                CacheStrategy::STRATEGY_CACHE_FIRST,
+                CacheStrategyInterface::STRATEGY_CACHE_FIRST,
                 sprintf(
                     "({request, url}) => (request.destination === 'image' && !url.pathname.startsWith('%s'))",
                     $this->assetPublicPrefix

diff --git a/src/CachingStrategy/ManifestCache.php b/src/CachingStrategy/ManifestCache.php
@@ -8,7 +8,7 @@
 use SpomkyLabs\PwaBundle\Dto\Workbox;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 
-final readonly class ManifestCache implements HasCacheStrategies
+final readonly class ManifestCache implements HasCacheStrategiesInterface
 {
     private string $manifestPublicUrl;
 
@@ -29,7 +29,7 @@ public function getCacheStrategies(): array
             WorkboxCacheStrategy::create(
                 $this->workbox->enabled && $this->workbox->cacheManifest,
                 true,
-                CacheStrategy::STRATEGY_STALE_WHILE_REVALIDATE,
+                CacheStrategyInterface::STRATEGY_STALE_WHILE_REVALIDATE,
                 sprintf("({url}) => '%s' === url.pathname", $this->manifestPublicUrl),
             )
                 ->withName('manifest'),

diff --git a/src/CachingStrategy/ResourceCaches.php b/src/CachingStrategy/ResourceCaches.php
@@ -6,7 +6,7 @@
 
 use SpomkyLabs\PwaBundle\Dto\ServiceWorker;
 use SpomkyLabs\PwaBundle\Dto\Workbox;
-use SpomkyLabs\PwaBundle\MatchCallbackHandler\MatchCallbackHandler;
+use SpomkyLabs\PwaBundle\MatchCallbackHandler\MatchCallbackHandlerInterface;
 use SpomkyLabs\PwaBundle\WorkboxPlugin\BroadcastUpdatePlugin;
 use SpomkyLabs\PwaBundle\WorkboxPlugin\CacheableResponsePlugin;
 use SpomkyLabs\PwaBundle\WorkboxPlugin\ExpirationPlugin;
@@ -21,14 +21,14 @@
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
 
-final readonly class ResourceCaches implements HasCacheStrategies
+final readonly class ResourceCaches implements HasCacheStrategiesInterface
 {
     private int $jsonOptions;
 
     private Workbox $workbox;
 
     /**
-     * @param iterable<MatchCallbackHandler> $matchCallbackHandlers
+     * @param iterable<MatchCallbackHandlerInterface> $matchCallbackHandlers
      */
     public function __construct(
         ServiceWorker $serviceWorker,
@@ -63,10 +63,10 @@ public function getCacheStrategies(): array
                     $resourceCache->cacheableResponseHeaders
                 ),
             ];
-            if ($resourceCache->broadcast === true && $resourceCache->strategy === CacheStrategy::STRATEGY_STALE_WHILE_REVALIDATE) {
+            if ($resourceCache->broadcast === true && $resourceCache->strategy === CacheStrategyInterface::STRATEGY_STALE_WHILE_REVALIDATE) {
                 $plugins[] = BroadcastUpdatePlugin::create($resourceCache->broadcastHeaders);
             }
-            if ($resourceCache->rangeRequests === true && $resourceCache->strategy !== CacheStrategy::STRATEGY_NETWORK_ONLY) {
+            if ($resourceCache->rangeRequests === true && $resourceCache->strategy !== CacheStrategyInterface::STRATEGY_NETWORK_ONLY) {
                 $plugins[] = RangeRequestsPlugin::create();
             }
             if ($resourceCache->maxEntries !== null || $resourceCache->maxAgeInSeconds() !== null) {

diff --git a/src/CachingStrategy/WorkboxCacheStrategy.php b/src/CachingStrategy/WorkboxCacheStrategy.php
@@ -4,21 +4,21 @@
 
 namespace SpomkyLabs\PwaBundle\CachingStrategy;
 
-use SpomkyLabs\PwaBundle\WorkboxPlugin\CachePlugin;
+use SpomkyLabs\PwaBundle\WorkboxPlugin\CachePluginInterface;
 use function in_array;
 use const JSON_PRETTY_PRINT;
 use const JSON_THROW_ON_ERROR;
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
 
-final class WorkboxCacheStrategy implements CacheStrategy
+final class WorkboxCacheStrategy implements CacheStrategyInterface
 {
     private null|string $name = null;
 
     private null|string $method = null;
 
     /**
-     * @var array<CachePlugin>
+     * @var array<CachePluginInterface>
      */
     private array $plugins = [];
 
@@ -63,7 +63,7 @@ public function withMethod(string $method): static
         return $this;
     }
 
-    public function withPlugin(CachePlugin $plugin, CachePlugin ...$plugins): static
+    public function withPlugin(CachePluginInterface $plugin, CachePluginInterface ...$plugins): static
     {
         $this->plugins = array_merge([$plugin], $plugins);
         return $this;
@@ -122,7 +122,7 @@ public function render(string $cacheObjectName, bool $debug = false): string
             $cacheName = sprintf("cacheName: '%s',", $this->getName() ?? $cacheObjectName);
         }
         $plugins = sprintf('[%s]', implode(', ', array_map(
-            fn (CachePlugin $plugin) => $plugin->render($jsonOptions),
+            fn (CachePluginInterface $plugin) => $plugin->render($jsonOptions),
             $this->plugins
         )));
         $method = $this->method !== null ? ",'{$this->method}'" : '';
@@ -191,7 +191,7 @@ public function getMethod(): ?string
     }
 
     /**
-     * @return array<CachePlugin>
+     * @return array<CachePluginInterface>
      */
     public function getPlugins(): array
     {

diff --git a/src/Command/CreateIconsCommand.php b/src/Command/CreateIconsCommand.php
@@ -4,7 +4,7 @@
 
 namespace SpomkyLabs\PwaBundle\Command;
 
-use SpomkyLabs\PwaBundle\ImageProcessor\ImageProcessor;
+use SpomkyLabs\PwaBundle\ImageProcessor\ImageProcessorInterface;
 use Symfony\Component\AssetMapper\AssetMapperInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -28,7 +28,7 @@ public function __construct(
         private readonly Filesystem $filesystem,
         #[Autowire('%kernel.project_dir%')]
         private readonly string $projectDir,
-        private readonly null|ImageProcessor $imageProcessor,
+        private readonly null|ImageProcessorInterface $imageProcessor,
     ) {
         parent::__construct();
     }