feat: override

jguittard · jguittard · commit d0abc7705d01 · 2025-05-07T01:34:46.000+02:00
Signed-off-by: Julien Guittard &lt;julien.guittard@me.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,58 @@
+on:
+  - push
+
+name: Continuous Integration
+jobs:
+  tests:
+    name: Run tests
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          coverage: xdebug
+          tools: composer:v2
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: echo "{cache_dir}={$(composer config cache-files-dir)}" >> $GITHUB_OUTPUT
+
+      - name: Cache PHP dependencies
+        uses: actions/cache@v4
+        id: vendor-cache
+        with:
+          path: vendor
+          key: ${{ runner.os }}-build-${{ hashFiles('**/composer.lock') }}
+
+      - name: Install Composer dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        uses: php-actions/composer@v6
+        with:
+          php_version: 8.4
+          version: 2
+          args: --ignore-platform-reqs
+        env:
+          ACTION_PHP_VERSION: 8.4
+
+      - name: Run code styling with phpcs
+        run: ./vendor/bin/phpcs
+
+      - name: Run header check with docheader
+        run: ./vendor/bin/docheader check src/ test/
+
+      - name: Run static code analysis with psalm
+        run: ./vendor/bin/psalm --config=psalm.xml
+
+#      - name: Run unit tests with phpunit
+#        run: ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+
+#      - name: Run coverage
+#        env:
+#          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#        run: ./vendor/bin/php-coveralls --coverage_clover=build/logs/clover.xml -v
diff --git a/src/Command/ConvertCommand.php b/src/Command/ConvertCommand.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Command;
 
+use Override;
 use Phayne\UAParser\Util\Converter;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -31,6 +32,7 @@ public function __construct(private readonly string $resourceDirectory, private
         parent::__construct('ua-parser:convert');
     }
 
+    #[Override]
     protected function configure(): void
     {
         $this
@@ -51,6 +53,7 @@ protected function configure(): void
         ;
     }
 
+    #[Override]
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $file = $input->getArgument('file');
diff --git a/src/Command/FetchCommand.php b/src/Command/FetchCommand.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Command;
 
+use Override;
 use Phayne\UAParser\Util\Fetcher;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -33,6 +34,7 @@ public function __construct(private readonly string $defaultYamlFile)
         parent::__construct('ua-parser:fetch');
     }
 
+    #[Override]
     protected function configure(): void
     {
         $this
@@ -47,6 +49,7 @@ protected function configure(): void
         ;
     }
 
+    #[Override]
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $file = $input->getArgument('file');
diff --git a/src/Command/LogfileCommand.php b/src/Command/LogfileCommand.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Command;
 
+use Override;
 use Phayne\UAParser\Exception\InvalidArgumentException;
 use Phayne\UAParser\Exception\ReaderException;
 use Phayne\UAParser\Parser;
@@ -46,6 +47,7 @@
  */
 class LogfileCommand extends Command
 {
+    #[Override]
     protected function configure(): void
     {
         $this
@@ -84,6 +86,7 @@ protected function configure(): void
             );
     }
 
+    #[Override]
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if (!$input->getOption('log-file') && !$input->getOption('log-dir')) {
diff --git a/src/Command/ParserCommand.php b/src/Command/ParserCommand.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Command;
 
+use Override;
 use Phayne\UAParser\Parser;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -25,6 +26,7 @@
  */
 class ParserCommand extends Command
 {
+    #[Override]
     protected function configure(): void
     {
         $this
@@ -38,6 +40,7 @@ protected function configure(): void
         ;
     }
 
+    #[Override]
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $userAgent = $input->getArgument('user-agent');
diff --git a/src/Command/UpdateCommand.php b/src/Command/UpdateCommand.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Command;
 
+use Override;
 use Phayne\UAParser\Util\Converter;
 use Phayne\UAParser\Util\Fetcher;
 use Symfony\Component\Console\Command\Command;
@@ -31,6 +32,7 @@ public function __construct(private readonly string $resourceDirectory)
         parent::__construct('ua-parser:update');
     }
 
+    #[Override]
     protected function configure(): void
     {
         $this
@@ -45,6 +47,7 @@ protected function configure(): void
         ;
     }
 
+    #[Override]
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $fetcher = new Fetcher();
diff --git a/src/Result/AbstractClient.php b/src/Result/AbstractClient.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Result;
 
+use Override;
 use Stringable;
 
 /**
@@ -23,6 +24,7 @@ abstract class AbstractClient implements Stringable
 {
     abstract public function toString(): string;
 
+    #[Override]
     public function __toString(): string
     {
         return $this->toString();
diff --git a/src/Result/AbstractSoftware.php b/src/Result/AbstractSoftware.php
@@ -12,6 +12,8 @@
 
 namespace Phayne\UAParser\Result;
 
+use Override;
+
 /**
  * Class AbstractSoftware
  *
@@ -21,6 +23,7 @@ abstract class AbstractSoftware extends AbstractClient
 {
     public string $family = 'Other';
 
+    #[Override]
     public function toString(): string
     {
         return $this->family;
diff --git a/src/Result/AbstractVersionedSoftware.php b/src/Result/AbstractVersionedSoftware.php
@@ -12,6 +12,8 @@
 
 namespace Phayne\UAParser\Result;
 
+use Override;
+
 use function array_filter;
 use function implode;
 
@@ -24,6 +26,7 @@ abstract class AbstractVersionedSoftware extends AbstractSoftware
 {
     abstract public function toVersion(): string;
 
+    #[Override]
     public function toString(): string
     {
         return implode(' ', array_filter([$this->family, $this->toVersion()]));
diff --git a/src/Result/Client.php b/src/Result/Client.php
@@ -12,6 +12,8 @@
 
 namespace Phayne\UAParser\Result;
 
+use Override;
+
 /**
  * Class Client
  *
@@ -29,6 +31,7 @@ public function __construct(public string $originalUserAgent)
     {
     }
 
+    #[Override]
     public function toString(): string
     {
         return sprintf('%s / %s', $this->ua->toString(), $this->os->toString());
diff --git a/src/Result/OperatingSystem.php b/src/Result/OperatingSystem.php
@@ -12,6 +12,8 @@
 
 namespace Phayne\UAParser\Result;
 
+use Override;
+
 /**
  * Class OperatingSystem
  *
@@ -27,6 +29,7 @@ final class OperatingSystem extends AbstractVersionedSoftware
 
     public string | int | null $patchMinor = null;
 
+    #[Override]
     public function toVersion(): string
     {
         return $this->formatVersion($this->major, $this->minor, $this->patch, $this->patchMinor);
diff --git a/src/Result/UserAgent.php b/src/Result/UserAgent.php
@@ -12,6 +12,8 @@
 
 namespace Phayne\UAParser\Result;
 
+use Override;
+
 /**
  * Class UserAgent
  *
@@ -25,6 +27,7 @@ final class UserAgent extends AbstractVersionedSoftware
 
     public string | int | null $patch = null;
 
+    #[Override]
     public function toVersion(): string
     {
         return $this->formatVersion($this->major, $this->minor, $this->patch);
diff --git a/src/Util/Logfile/AbstractReader.php b/src/Util/Logfile/AbstractReader.php
@@ -12,6 +12,7 @@
 
 namespace Phayne\UAParser\Util\Logfile;
 
+use Override;
 use Phayne\UAParser\Exception\ReaderException;
 
 /**
@@ -45,13 +46,15 @@ private static function getReaders(): array
         return static::$readers;
     }
 
+    #[Override]
     public function test(string $line): bool
     {
         $matches = $this->match($line);
 
         return isset($matches['userAgentString']);
     }
 
+    #[Override]
     public function read(string $line): string
     {
         $matches = $this->match($line);
diff --git a/src/Util/Logfile/ApacheCommonLogFormatReader.php b/src/Util/Logfile/ApacheCommonLogFormatReader.php
@@ -12,13 +12,16 @@
 
 namespace Phayne\UAParser\Util\Logfile;
 
+use Override;
+
 /**
  * Class ApacheCommonLogFormatReader
  *
  * @package Phayne\UAParser\Util\Logfile
  */
 class ApacheCommonLogFormatReader extends AbstractReader
 {
+    #[Override]
     protected function getRegex(): string
     {
         return '@^

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`
`13`	`13`	`namespace Phayne\UAParser\Command;`
`14`	`14`
	`15`	`+use Override;`
`15`	`16`	`use Phayne\UAParser\Util\Converter;`
`16`	`17`	`use Symfony\Component\Console\Command\Command;`
`17`	`18`	`use Symfony\Component\Console\Input\InputArgument;`
`@@ -31,6 +32,7 @@ public function __construct(private readonly string $resourceDirectory, private`
`31`	`32`	`parent::__construct('ua-parser:convert');`
`32`	`33`	`}`
`33`	`34`
	`35`	`+ #[Override]`
`34`	`36`	`protected function configure(): void`
`35`	`37`	`{`
`36`	`38`	`$this`
`@@ -51,6 +53,7 @@ protected function configure(): void`
`51`	`53`	`;`
`52`	`54`	`}`
`53`	`55`
	`56`	`+ #[Override]`
`54`	`57`	`protected function execute(InputInterface $input, OutputInterface $output): int`
`55`	`58`	`{`
`56`	`59`	`$file = $input->getArgument('file');`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`
`13`	`13`	`namespace Phayne\UAParser\Result;`
`14`	`14`
	`15`	`+use Override;`
	`16`	`+`
`15`	`17`	`/**`
`16`	`18`	`* Class AbstractSoftware`
`17`	`19`	`*`
`@@ -21,6 +23,7 @@ abstract class AbstractSoftware extends AbstractClient`
`21`	`23`	`{`
`22`	`24`	`public string $family = 'Other';`
`23`	`25`
	`26`	`+ #[Override]`
`24`	`27`	`public function toString(): string`
`25`	`28`	`{`
`26`	`29`	`return $this->family;`