Allow to set version truncation (#29)

README.md

@@ -57,6 +57,10 @@ acsiomatic_device_detector:
 
     # If true, DeviceDetector will trigger parser() when necessary
     auto_parse: true
+
+    # 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'
 ```
 
 ## Usage in controllers

phpstan.neon.dist

@@ -16,7 +16,8 @@ parameters:
                 twig: array{
                     variable_name: string|null
                 },
-                auto_parse: bool
+                auto_parse: bool,
+                version_truncation: 'major'|'minor'|'patch'|'build'|'none'
             }
 '''
     tmpDir: var/phpstan

rector.php

@@ -1,7 +1,6 @@
 <?php
 
 use Rector\Core\Configuration\Option;
-use Rector\Core\ValueObject\PhpVersion;
 use Rector\Set\ValueObject\LevelSetList;
 use Rector\Set\ValueObject\SetList;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

src/DependencyInjection/AcsiomaticDeviceDetectorExtension.php

@@ -11,6 +11,7 @@
 use Acsiomatic\DeviceDetectorBundle\Twig\TwigExtension;
 use DeviceDetector\DeviceDetector;
 use DeviceDetector\Parser\AbstractBotParser;
+use DeviceDetector\Parser\AbstractParser;
 use DeviceDetector\Parser\Client\AbstractClientParser;
 use DeviceDetector\Parser\Device\AbstractDeviceParser;
 use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
@@ -40,6 +41,17 @@ final class AcsiomaticDeviceDetectorExtension extends Extension
      */
     private const DEVICE_PARSER_TAG = 'acsiomatic.device_detector.device_parser';
 
+    /**
+     * @var array<string, int>
+     */
+    private const VERSION_TRUNCATION_MAP = [
+        'major' => AbstractParser::VERSION_TRUNCATION_MAJOR,
+        'minor' => AbstractParser::VERSION_TRUNCATION_MINOR,
+        'patch' => AbstractParser::VERSION_TRUNCATION_PATCH,
+        'build' => AbstractParser::VERSION_TRUNCATION_BUILD,
+        'none' => AbstractParser::VERSION_TRUNCATION_NONE,
+    ];
+
     /**
      * @param array<string, mixed> $configs
      */
@@ -105,6 +117,7 @@ private function setupDeviceDetectorFactory(ContainerBuilder $container, array $
             ->setArguments([
                 $config['bot']['skip_detection'],
                 $config['bot']['discard_information'],
+                self::VERSION_TRUNCATION_MAP[$config['version_truncation']],
                 new Reference(ClientHintsFactoryInterface::class),
                 $config['cache']['pool'] !== null ? new Reference($config['cache']['pool']) : null,
                 $config['auto_parse'] ? new Reference(DeviceDetectorProxyFactory::class) : null,

src/DependencyInjection/Configuration.php

@@ -46,7 +46,13 @@ public function getConfigTreeBuilder(): TreeBuilder
 
             ->booleanNode('auto_parse')->defaultTrue()->end()
 
-            ->end();
+            ->enumNode('version_truncation')
+            ->values(['major', 'minor', 'patch', 'build', 'none'])
+            ->defaultValue('minor')
+            ->end()
+
+            ->end()
+        ;
 
         return $builder;
     }

src/Factory/DeviceDetectorFactory.php

@@ -29,6 +29,11 @@ final class DeviceDetectorFactory implements DeviceDetectorFactoryInterface
      */
     private $discardBotInformation = false;
 
+    /**
+     * @var int
+     */
+    private $versionTruncation;
+
     /**
      * @var ClientHintsFactoryInterface
      */
@@ -67,6 +72,7 @@ final class DeviceDetectorFactory implements DeviceDetectorFactoryInterface
     public function __construct(
         bool $skipBotDetection,
         bool $discardBotInformation,
+        int $versionTruncation,
         ClientHintsFactoryInterface $clientHintsFactory,
         ?CacheItemPoolInterface $cache,
         ?DeviceDetectorProxyFactory $proxyFactory,
@@ -76,6 +82,7 @@ public function __construct(
     ) {
         $this->skipBotDetection = $skipBotDetection;
         $this->discardBotInformation = $discardBotInformation;
+        $this->versionTruncation = $versionTruncation;
         $this->clientHintsFactory = $clientHintsFactory;
         $this->cache = $cache;
         $this->proxyFactory = $proxyFactory;
@@ -93,6 +100,8 @@ public function createDeviceDetector(): DeviceDetector
         $detector->skipBotDetection($this->skipBotDetection);
         $detector->discardBotInformation($this->discardBotInformation);
 
+        AbstractDeviceParser::setVersionTruncation($this->versionTruncation);
+
         if ($this->cache !== null) {
             $detector->setCache(new PSR6Bridge($this->cache));
         }

tests/VersionTruncationTest.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Acsiomatic\DeviceDetectorBundle\Tests;
+
+use Acsiomatic\DeviceDetectorBundle\AcsiomaticDeviceDetectorBundle;
+use Acsiomatic\DeviceDetectorBundle\Contracts\DeviceDetectorFactoryInterface;
+use Acsiomatic\DeviceDetectorBundle\Tests\Util\Compiler\CompilerPassFactory;
+use Acsiomatic\DeviceDetectorBundle\Tests\Util\HttpKernel\Kernel;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+
+final class VersionTruncationTest extends TestCase
+{
+    /**
+     * @var string
+     */
+    private const USER_AGENT = 'Mozilla/5.0 (Linux; Android 4.2.2; ARCHOS 101 PLATINUM Build/JDQ39) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.114 Safari/537.36';
+
+    public function testDefaultsTargetsToMinor(): void
+    {
+        $kernel = new Kernel('test', true);
+        $kernel->appendBundle(new FrameworkBundle());
+        $kernel->appendBundle(new AcsiomaticDeviceDetectorBundle());
+        $kernel->appendExtensionConfiguration('framework', ['test' => true, 'secret' => '53CR37']);
+
+        $kernel->appendCompilerPass(
+            CompilerPassFactory::createPublicAlias(
+                'device_detector_factory.public',
+                DeviceDetectorFactoryInterface::class
+            )
+        );
+
+        $kernel->boot();
+
+        /** @var DeviceDetectorFactoryInterface $deviceDetectorFactory */
+        $deviceDetectorFactory = $kernel->getContainer()->get('device_detector_factory.public');
+        $deviceDetector = $deviceDetectorFactory->createDeviceDetector();
+
+        $deviceDetector->setUserAgent(self::USER_AGENT);
+        $deviceDetector->parse();
+
+        static::assertSame('4.2', $deviceDetector->getOs('version'));
+        static::assertSame('34.0', $deviceDetector->getClient('version'));
+    }
+
+    /**
+     * @dataProvider getVersionTruncationFixtures
+     */
+    public function testSetVersionTruncation(
+        string $userAgent,
+        string $truncation,
+        string $expectedOsVersion,
+        string $expectedClientVersion
+    ): 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', ['version_truncation' => $truncation]);
+
+        $kernel->appendCompilerPass(
+            CompilerPassFactory::createPublicAlias(
+                'device_detector_factory.public',
+                DeviceDetectorFactoryInterface::class
+            )
+        );
+
+        $kernel->boot();
+
+        /** @var DeviceDetectorFactoryInterface $deviceDetectorFactory */
+        $deviceDetectorFactory = $kernel->getContainer()->get('device_detector_factory.public');
+        $deviceDetector = $deviceDetectorFactory->createDeviceDetector();
+
+        $deviceDetector->setUserAgent($userAgent);
+        $deviceDetector->parse();
+
+        static::assertSame($expectedOsVersion, $deviceDetector->getOs('version'));
+        static::assertSame($expectedClientVersion, $deviceDetector->getClient('version'));
+    }
+
+    /**
+     * @return iterable<array{user_agent: string, truncation: string, os_version: string, client_version: string}>
+     */
+    public function getVersionTruncationFixtures(): iterable
+    {
+        yield 'none' => [
+            'user_agent' => self::USER_AGENT,
+            'truncation' => 'none',
+            'os_version' => '4.2.2',
+            'client_version' => '34.0.1847.114',
+        ];
+
+        yield 'build' => [
+            'user_agent' => self::USER_AGENT,
+            'truncation' => 'build',
+            'os_version' => '4.2.2',
+            'client_version' => '34.0.1847.114',
+        ];
+
+        yield 'patch' => [
+            'user_agent' => self::USER_AGENT,
+            'truncation' => 'patch',
+            'os_version' => '4.2.2',
+            'client_version' => '34.0.1847',
+        ];
+
+        yield 'minor' => [
+            'user_agent' => self::USER_AGENT,
+            'truncation' => 'minor',
+            'os_version' => '4.2',
+            'client_version' => '34.0',
+        ];
+
+        yield 'major' => [
+            'user_agent' => self::USER_AGENT,
+            'truncation' => 'major',
+            'os_version' => '4',
+            'client_version' => '34',
+        ];
+    }
+}