Upgrade PHP version in workflow configurations

The PHP version used in the GitHub workflow configurations for coding standards, static analysis, and continuous integration has been updated. The previous version was 8.1 and it has been upgraded to 8.3. Likewise, the 'old_stable' and 'current_stable

.github/workflows/coding-standards.yml

@@ -0,0 +1,12 @@
+name: Coding Standards
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  cs:
+    uses: ray-di/.github/.github/workflows/coding-standards.yml@v1
+    with:
+      php_version: 8.3

.github/workflows/continuous-integration.yml

@@ -9,5 +9,5 @@ jobs:
   ci:
     uses: ray-di/.github/.github/workflows/continuous-integration.yml@v1
     with:
-      old_stable: '["8.0", "8.1"]'
-      current_stable: 8.2
+      old_stable: '["8.1", "8.2"]'
+      current_stable: 8.3

.github/workflows/static-analysis.yml

@@ -0,0 +1,13 @@
+name: Static Analysis
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  sa:
+    uses: ray-di/.github/.github/workflows/static-analysis.yml@v1
+    with:
+      php_version: 8.3
+      has_crc_config: true

.github/workflows/update-copyright-years-in-license-file.yml

@@ -1,4 +1,4 @@
-name: Update copyright year(s) in license file
+name: Update copyright year in license file
 
 on:
   workflow_dispatch:

.gitignore

@@ -3,3 +3,4 @@
 /composer.lock
 /.php_cs.cache
 /.phpunit.result.cache
+/.phpcs-cache

composer-require-checker.json

@@ -0,0 +1,18 @@
+{
+  "symbol-whitelist" : [
+    "Mobile_Detect"
+  ],
+  "php-core-extensions" : [
+    "Core",
+    "date",
+    "json",
+    "hash",
+    "pcre",
+    "Phar",
+    "Reflection",
+    "SPL",
+    "random",
+    "standard"
+  ],
+  "scan-files" : []
+}

composer.json

@@ -15,22 +15,25 @@
   ],
   "require": {
     "php": "^8.0",
-    "bear/resource": "^1.15.2",
+    "bear/resource": "^1.20",
     "bear/sunday": "^1.2",
-    "bear/app-meta": "^1.1",
+    "bear/app-meta": "^1.8",
     "twig/twig": "^2.15.3 || ^v3.4.3",
-    "mobiledetect/mobiledetectlib": "^2.7",
+    "mobiledetect/mobiledetectlib": "^2.7 || ^3.74",
     "ray/di": "^2.7",
-    "doctrine/annotations": "^1.13.3"
+    "ray/aop": "^2.13",
+    "psr/log": "^3.0"
   },
   "require-dev": {
+    "doctrine/annotations": "^1.13.3 || ^2.0",
     "phpunit/phpunit": "^9.5.21",
     "squizlabs/php_codesniffer": "^3.7",
     "phpmd/phpmd": "^2.6",
     "rector/rector": "^0.15.3",
     "ray/rector-ray": "^1.0",
-    "doctrine/coding-standard": "^11.1",
-    "vimeo/psalm": "^5.4"
+    "doctrine/coding-standard": "^12.0",
+    "vimeo/psalm": "^5.4",
+    "phpstan/phpstan": "^1.10"
   },
   "autoload":{
     "psr-4":{
@@ -46,13 +49,12 @@
     }
   },
   "scripts": {
-    "test": ["@setup", "vendor/bin/phpunit"],
-    "test74": ["/usr/local/Cellar/[email protected]/7.4.14/bin/php vendor/bin/phpunit"],
-    "tests": ["@cs", "phpstan analyse -l max src tests -c phpstan.neon --no-progress", "@test"],
-    "coverage": ["php -dzend_extension=xdebug.so -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
-    "cs": ["php-cs-fixer fix -v --dry-run", "phpcs --standard=phpcs.xml src;"],
+    "test": ["phpunit"],
+    "tests": ["@cs", "@sa", "@test"],
+    "coverage": ["php -dzend_extension=xdebug.so -dxdebug.mode=coverage phpunit --coverage-text --coverage-html=build/coverage"],
+    "cs": ["phpcs --standard=phpcs.xml src"],
     "cs-fix": ["phpcbf src tests"],
-    "sa": "psalm"
+    "sa": ["psalm", "phpstan"]
   },
   "config": {
     "allow-plugins": {

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+  level: max
+  paths:
+    - src
+    - tests
+  excludePaths:
+    - */tests/tmp/*
+    - */tests/Fake/*
+  ignoreErrors:

phpunit.xml → phpunit.xml.dist

@@ -1,12 +1,12 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="tests/bootstrap.php">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php">
     <coverage processUncoveredFiles="true">
         <include>
             <directory suffix=".php">src</directory>
         </include>
     </coverage>    <testsuites>
         <testsuite name="TwigModule test suite">
-            <directory suffix="Test.php">tests</directory>
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
 </phpunit>

psalm.xml

@@ -5,6 +5,13 @@
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 >
+    <issueHandlers>
+        <UndefinedClass>
+            <errorLevel type="suppress">
+                <directory name="src/" />
+            </errorLevel>
+        </UndefinedClass>
+    </issueHandlers>
     <projectFiles>
         <directory name="src" />
         <ignoreFiles>

src/AppPathProvider.php

@@ -16,7 +16,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function get(): array
     {

src/ErrorPagerRenderer.php

@@ -12,6 +12,9 @@
 use Twig\Error\RuntimeError;
 use Twig\Error\SyntaxError;
 
+use function assert;
+use function is_array;
+
 class ErrorPagerRenderer implements RenderInterface
 {
     public function __construct(
@@ -28,6 +31,7 @@ public function __construct(
      */
     public function render(ResourceObject $ro): string
     {
+        assert(is_array($ro->body));
         $ro->view = $this->twig->render($this->errorPage, $ro->body);
 
         return $ro->view;

src/MobileTemplateFinder.php

@@ -4,32 +4,41 @@
 
 namespace Madapaja\TwigModule;
 
+use Detection\MobileDetect;
 use Madapaja\TwigModule\Annotation\TwigPaths;
 use Mobile_Detect;
+use Ray\Di\Di\Named;
 
+use function class_alias;
+use function class_exists;
 use function file_exists;
 use function sprintf;
 use function str_replace;
 
 class MobileTemplateFinder implements TemplateFinderInterface
 {
-    private TemplateFinder $templateFinder;
-
+    /** @param array<string> $paths */
     public function __construct(
-        private mixed $userAgent = '',
         #[TwigPaths]
-        private array $paths = [],
+        private array $paths,
+        #[Named('original')]
+        private TemplateFinderInterface $templateFinder,
     ) {
-        $this->templateFinder = new TemplateFinder();
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function __invoke(string $name): string
     {
+        if (! class_exists(MobileDetect::class)) {
+            // @codeCoverageIgnoreStart
+            class_alias(Mobile_Detect::class, MobileDetect::class); // @phpstan-ignore-line
+            // @codeCoverageIgnoreEnd
+        }
+
+        $detect = new MobileDetect();
         $templatePath = ($this->templateFinder)($name);
-        $detect = new Mobile_Detect(null, $this->userAgent);
         $isMobile = $detect->isMobile() && ! $detect->isTablet();
         if ($isMobile) {
             $mobilePath = str_replace(TwigRenderer::EXT, '.mobile.twig', $templatePath);

src/MobileTwigModule.php

@@ -9,10 +9,11 @@
 class MobileTwigModule extends AbstractModule
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     protected function configure()
     {
         $this->bind(TemplateFinderInterface::class)->to(MobileTemplateFinder::class);
+        $this->bind(TemplateFinderInterface::class)->annotatedWith('original')->to(TemplateFinder::class);
     }
 }

src/OptionProvider.php

@@ -24,7 +24,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function get()
     {

src/TemplateFinder.php

@@ -4,19 +4,22 @@
 
 namespace Madapaja\TwigModule;
 
+use function assert;
+use function is_int;
 use function str_replace;
 use function strpos;
 use function substr;
 
 class TemplateFinder implements TemplateFinderInterface
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
-    public function __invoke(string $resourceFilePath): string
+    public function __invoke(string $name): string
     {
-        $pos = strpos($resourceFilePath, '/Resource/');
-        $relativePath = substr($resourceFilePath, $pos + 10);
+        $pos = strpos($name, '/Resource/');
+        assert(is_int($pos));
+        $relativePath = substr($name, $pos + 10);
 
         return str_replace('.php', TwigRenderer::EXT, $relativePath);
     }

src/TwigErrorHandler.php

@@ -26,7 +26,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function handle(Throwable $e, Request $request)
     {
@@ -56,7 +56,7 @@ public function handle(Throwable $e, Request $request)
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function transfer()
     {

src/TwigErrorPage.php

@@ -11,8 +11,10 @@
 
 class TwigErrorPage extends ResourceObject
 {
-    /** @var array */
+    /** @var array<string, string> */
     public $headers = ['content-type' => 'text/html; charset=utf-8'];
+
+    /** @var RenderInterface */
     protected $renderer;
 
     public function __sleep()
@@ -23,12 +25,14 @@ public function __sleep()
     /**
      * @Inject
      * @Named("error_page")
+     * {@inheritDoc}
      */
     #[Inject]
-
     #[Named('error_page')]
-    public function setRenderer(RenderInterface $renderer): void
+    public function setRenderer(RenderInterface $renderer)
     {
         $this->renderer = $renderer;
+
+        return $this;
     }
 }