refactor: remove configuration from API Platform bundle, will try to …

…reuse standard API Platform extra properties. (#45)
rekalogika · Apr 9, 2024 · cc8ed7a · cc8ed7a
1 parent 3d9288e
commit cc8ed7a
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 77 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+# 0.8.2
+
+* refactor: remove configuration from API Platform bundle, will try to reuse
+  standard API Platform extra properties.
+
 # 0.8.1
 
 * feat: add `PagerFactoryInterface` for API Platform

diff --git a/packages/rekapager-api-platform/config/services.php b/packages/rekapager-api-platform/config/services.php
@@ -22,14 +22,6 @@
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
-    $parameters = $containerConfigurator->parameters();
-
-    $parameters
-        ->set(
-            'rekalogika.rekapager.api_platform.enable_orm_support_by_default',
-            false
-        );
-
     $services = $containerConfigurator->services();
 
     $services
@@ -65,7 +57,6 @@
         ->args([
             '$pagerFactory' => service(PagerFactoryInterface::class),
             '$pagination' => service('api_platform.pagination'),
-            '$enabledByDefault' => '%rekalogika.rekapager.api_platform.enable_orm_support_by_default%',
         ])
         ->tag('api_platform.doctrine.orm.query_extension.collection', [
             'priority' => -48,

diff --git a/packages/rekapager-api-platform/src/DependencyInjection/Configuration.php b/packages/rekapager-api-platform/src/DependencyInjection/Configuration.php
diff --git a/...ekapager-api-platform/src/DependencyInjection/RekalogikaRekapagerApiPlatformExtension.php b/...ekapager-api-platform/src/DependencyInjection/RekalogikaRekapagerApiPlatformExtension.php
@@ -23,11 +23,6 @@ class RekalogikaRekapagerApiPlatformExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container)
     {
-        // load configuration
-
-        $configuration = new Configuration();
-        $config = $this->processConfiguration($configuration, $configs);
-
         // load our services
 
         $loader = new PhpFileLoader(
@@ -47,16 +42,5 @@ public function load(array $configs, ContainerBuilder $container)
         // load services from symfony-bridge package
 
         RekapagerSymfonyBridge::loadServices($container);
-
-        // process config
-        $enableOrmSupportByDefault = $config['enable_orm_support_by_default'] ?? false;
-        if (!\is_bool($enableOrmSupportByDefault)) {
-            throw new \InvalidArgumentException('The "enable_orm_support_by_default" option must be a boolean.');
-        }
-
-        $container->setParameter(
-            'rekalogika.rekapager.api_platform.enable_orm_support_by_default',
-            $enableOrmSupportByDefault
-        );
     }
 }
diff --git a/packages/rekapager-api-platform/src/Implementation/RekapagerExtension.php b/packages/rekapager-api-platform/src/Implementation/RekapagerExtension.php
@@ -41,7 +41,6 @@ final class RekapagerExtension implements QueryResultCollectionExtensionInterfac
     public function __construct(
         private readonly PagerFactory $pagerFactory,
         private readonly Pagination $pagination,
-        private readonly bool $enabledByDefault,
     ) {
     }
 
@@ -67,12 +66,8 @@ public function supportsResult(
     ): bool {
         /** @psalm-suppress InternalMethod */
         $extraProperties = $operation?->getExtraProperties() ?? [];
-        /** @var bool|null */
-        $isEnabled = $extraProperties['rekapager_orm_enabled'] ?? null;
-
-        if (!\is_bool($isEnabled) && $isEnabled === null) {
-            $isEnabled = $this->enabledByDefault;
-        }
+        /** @var bool */
+        $isEnabled = $extraProperties['rekapager_orm_enabled'] ?? false;
 
         if ($isEnabled === false) {
             return false;

diff --git a/psalm.xml b/psalm.xml
@@ -54,19 +54,16 @@
         <UndefinedInterfaceMethod>
             <errorLevel type="suppress">
                 <file name="packages/rekapager-bundle/src/DependencyInjection/Configuration.php" />
-                <file name="packages/rekapager-api-platform/src/DependencyInjection/Configuration.php" />
             </errorLevel>
         </UndefinedInterfaceMethod>
         <MixedMethodCall>
             <errorLevel type="suppress">
                 <file name="packages/rekapager-bundle/src/DependencyInjection/Configuration.php" />
-                <file name="packages/rekapager-api-platform/src/DependencyInjection/Configuration.php" />
             </errorLevel>
         </MixedMethodCall>
         <PossiblyNullReference>
             <errorLevel type="suppress">
                 <file name="packages/rekapager-bundle/src/DependencyInjection/Configuration.php" />
-                <file name="packages/rekapager-api-platform/src/DependencyInjection/Configuration.php" />
             </errorLevel>
         </PossiblyNullReference>
         <InternalClass>

diff --git a/tests/config/packages/api_platform.yaml b/tests/config/packages/api_platform.yaml
@@ -18,6 +18,7 @@ api_platform:
         extra_properties:
             standard_put: true
             rfc_7807_compliant_errors: true
+            rekapager_orm_enabled: true
         normalization_context:
             skip_null_values: false
     event_listeners_backward_compatibility_layer: false

diff --git a/tests/config/packages/rekalogika_rekapager_api_platform.yaml b/tests/config/packages/rekalogika_rekapager_api_platform.yaml
diff --git a/tests/src/App/Entity/Post.php b/tests/src/App/Entity/Post.php
@@ -26,7 +26,7 @@
 #[ORM\Index(fields: ['date'])]
 #[ORM\Index(fields: ['title'])]
 #[ORM\Index(fields: ['setName'])]
-#[ApiResource(extraProperties: ['rekapager_orm_enabled' => true])]
+#[ApiResource]
 #[ApiResource(
     operations: [
         new GetCollection(