Merge pull request #34 from acsiomatic/routing-condition-service

Tag DeviceDetector as routing condition service

Author: Renan de Lima

README.md

@@ -61,6 +61,11 @@ acsiomatic_device_detector:
     # Version truncation behavior, it may assume: major, minor, patch, build, or none
     # By default minor versions will be returned (e.g. X.Y)
     version_truncation: 'minor'
+
+    routing:
+
+        # If null, it will not tag DeviceDetector as routing condition service
+        condition_service_alias: 'device'
 ```
 
 ## Usage in controllers
@@ -94,6 +99,23 @@ The `DeviceDetector` service is assigned to the Twig templates as `device` varia
 {% endif %}
 ```
 
+## Usage in route condition
+
+The `DeviceDetector` is tagged as routing condition service.
+
+```php
+use DeviceDetector\DeviceDetector;
+
+class MyController
+{
+    #[Route('/page', condition: "service('device').isSmartphone()")]
+    public function index()
+    {
+        // this endpoint is available only for smartphone devices
+    }
+}
+```
+
 ## Parsing custom request
 
 You might want to parse other request than the current one.

phpstan.neon.dist

@@ -17,7 +17,10 @@ parameters:
                     variable_name: string|null
                 },
                 auto_parse: bool,
-                version_truncation: 'major'|'minor'|'patch'|'build'|'none'
+                version_truncation: 'major'|'minor'|'patch'|'build'|'none',
+                routing: array{
+                    condition_service_alias: string|null
+                }
             }
 '''
     tmpDir: var/phpstan

src/DependencyInjection/AcsiomaticDeviceDetectorExtension.php

@@ -66,7 +66,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->setupProxy($container, $config);
         $this->setupClientHintsFactory($container, $config);
         $this->setupDeviceDetectorFactory($container, $config);
-        $this->setupDeviceDetector($container);
+        $this->setupDeviceDetector($container, $config);
         $this->setupTwig($container, $config);
     }
 
@@ -127,16 +127,25 @@ private function setupDeviceDetectorFactory(ContainerBuilder $container, array $
             ]);
     }
 
-    private function setupDeviceDetector(ContainerBuilder $container): void
+    /**
+     * @param BundleConfigArray $config
+     */
+    private function setupDeviceDetector(ContainerBuilder $container, array $config): void
     {
-        $container
+        $definition = $container
             ->register(DeviceDetector::class, DeviceDetector::class)
             ->setPublic(false)
             ->setFactory([DeviceDetectorFactory::class, 'createDeviceDetectorFromRequestStack'])
             ->setArguments([
                 new Reference(DeviceDetectorFactoryInterface::class),
                 new Reference(RequestStack::class),
             ]);
+
+        if ($config['routing']['condition_service_alias'] !== null) {
+            $definition->addTag('routing.condition_service', [
+                'alias' => $config['routing']['condition_service_alias'],
+            ]);
+        }
     }
 
     /**

src/DependencyInjection/Configuration.php

@@ -51,6 +51,13 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->defaultValue('minor')
             ->end()
 
+            ->arrayNode('routing')
+            ->addDefaultsIfNotSet()
+            ->children()
+            ->scalarNode('condition_service_alias')->defaultValue('device')->end()
+            ->end()
+            ->end()
+
             ->end()
         ;
 

tests/RoutingConditionServiceTest.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Acsiomatic\DeviceDetectorBundle\Tests;
+
+use Acsiomatic\DeviceDetectorBundle\AcsiomaticDeviceDetectorBundle;
+use Acsiomatic\DeviceDetectorBundle\Tests\Util\Compiler\CallbackContainerPass;
+use Acsiomatic\DeviceDetectorBundle\Tests\Util\HttpKernel\Kernel;
+use DeviceDetector\DeviceDetector;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class RoutingConditionServiceTest extends TestCase
+{
+    public function testDeviceDetectorIsTaggedAsRoutingConditionService(): void
+    {
+        $kernel = new Kernel('test', true);
+        $kernel->appendBundle(new FrameworkBundle());
+        $kernel->appendBundle(new AcsiomaticDeviceDetectorBundle());
+        $kernel->appendExtensionConfiguration('framework', ['test' => true, 'secret' => '53CR37']);
+        $kernel->appendCompilerPass(
+            new CallbackContainerPass(
+                static function (ContainerBuilder $containerBuilder): void {
+                    self::assertTrue($containerBuilder->hasDefinition(DeviceDetector::class));
+
+                    $definition = $containerBuilder->getDefinition(DeviceDetector::class);
+
+                    self::assertTrue($definition->hasTag('routing.condition_service'));
+                    self::assertSame([['alias' => 'device']], $definition->getTag('routing.condition_service'));
+                }
+            )
+        );
+
+        $kernel->boot();
+    }
+
+    public function testHonorCustomAlias(): void
+    {
+        $kernel = new Kernel('test', true);
+        $kernel->appendBundle(new FrameworkBundle());
+        $kernel->appendBundle(new AcsiomaticDeviceDetectorBundle());
+        $kernel->appendExtensionConfiguration('framework', ['test' => true, 'secret' => '53CR37']);
+        $kernel->appendExtensionConfiguration('acsiomatic_device_detector', ['routing' => ['condition_service_alias' => 'custom']]);
+        $kernel->appendCompilerPass(
+            new CallbackContainerPass(
+                static function (ContainerBuilder $containerBuilder): void {
+                    self::assertTrue($containerBuilder->hasDefinition(DeviceDetector::class));
+
+                    $definition = $containerBuilder->getDefinition(DeviceDetector::class);
+
+                    self::assertTrue($definition->hasTag('routing.condition_service'));
+                    self::assertSame([['alias' => 'custom']], $definition->getTag('routing.condition_service'));
+                }
+            )
+        );
+
+        $kernel->boot();
+    }
+
+    public function testDisabling(): void
+    {
+        $kernel = new Kernel('test', true);
+        $kernel->appendBundle(new FrameworkBundle());
+        $kernel->appendBundle(new AcsiomaticDeviceDetectorBundle());
+        $kernel->appendExtensionConfiguration('framework', ['test' => true, 'secret' => '53CR37']);
+        $kernel->appendExtensionConfiguration('acsiomatic_device_detector', ['routing' => ['condition_service_alias' => null]]);
+        $kernel->appendCompilerPass(
+            new CallbackContainerPass(
+                static function (ContainerBuilder $containerBuilder): void {
+                    self::assertTrue($containerBuilder->hasDefinition(DeviceDetector::class));
+                    self::assertFalse($containerBuilder->getDefinition(DeviceDetector::class)->hasTag('routing.condition_service'));
+                }
+            )
+        );
+
+        $kernel->boot();
+    }
+}