feat: TYPO3 v12 compatibility (#85)

* chore: prepare for TYPO3_v12 * chore: prepare for TYPO3_v12 - update github actions * chore: prepare for TYPO3_v12 - update github actions - fix typo * chore: prepare for TYPO3_v12 - update github actions - fix path to phpunit * chore: v12 only * chore: v12 only, code-style * chore: code-style * docs: readme, year update * docs: more badges * chore: ecs config * chore: minor adjustment * chore: PHP 8.4 experimental * Revert "chore: PHP 8.4 experimental" This reverts commit 4ab6a71. * chore: fix javascript include * chore: cleanup the code --------- Co-authored-by: thomas.layh <[email protected]> Co-authored-by: Jürgen Kußmann <[email protected]>
AOEpeople · Jul 16, 2024 · 7ec19f2 · 7ec19f2
1 parent 102d561
commit 7ec19f2
Show file tree

Hide file tree

Showing 50 changed files with 176 additions and 387 deletions.
diff --git a/.code-quality/ecs.php b/.code-quality/ecs.php
@@ -2,14 +2,11 @@
 
 declare(strict_types=1);
 
-use PhpCsFixer\Fixer\FunctionNotation\FunctionTypehintSpaceFixer;
 use PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer;
 use PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer;
-use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
 use Rector\Naming\Rector\ClassMethod\RenameParamToMatchTypeRector;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
-use Symplify\CodingStandard\Fixer\LineLength\DocBlockLineLengthFixer;
 use Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Option;
@@ -36,17 +33,9 @@
     )
     ->withSkip([
         NotOperatorWithSuccessorSpaceFixer::class => null,
-        DocBlockLineLengthFixer::class => null,
         ArrayListItemNewlineFixer::class => null,
         ArrayOpenerAndCloserNewlineFixer::class => null,
-        FunctionTypehintSpaceFixer::class => [
-            __DIR__ . '/../Tests/Unit/TYPO3/AdditionalResponseHeadersTest.php',
-            __DIR__ . '/../Classes/TYPO3/Hooks/ClearCacheMenuHook.php',
-            __DIR__ . '/../Classes/TYPO3/Configuration/ExtensionConfiguration.php',
-        ],
-        DeclareStrictTypesFixer::class => null,
         GeneralPhpdocAnnotationRemoveFixer::class => null,
         RenameParamToMatchTypeRector::class => null,
-
     ])
     ->withSpacing(OPTION::INDENTATION_SPACES, "\n");
diff --git a/.code-quality/ecs_old.php b/.code-quality/ecs_old.php
diff --git a/.code-quality/phpstan-baseline.neon b/.code-quality/phpstan-baseline.neon
@@ -28,26 +28,6 @@ parameters:
 				message: "#^Method Aoe\\\\Restler\\\\System\\\\Restler\\\\RestlerExtended\\:\\:postCall\\(\\) has no return type specified\\.$#"
 				count: 1
 				path: ../Classes/System/Restler/RestlerExtended.php
-			-
-				message: "#^Dead catch \\- Error is never thrown in the try block\\.$#"
-				count: 1
-				path: ../Classes/System/Restler/Builder.php
-			-
-				message: "#^Anonymous variable in a `\\$request\\-\\>getAttribute\\('site'\\)\\-\\>\\.\\.\\.\\(\\)` method call can lead to false dead methods\\. Make sure the variable type is known$#"
-				count: 1
-				path: ../Classes/System/Dispatcher.php
-			-
-				message: "#^Anonymous variable in a `\\$request\\-\\>getAttribute\\('site'\\)\\-\\>getBase\\(\\)\\-\\>\\.\\.\\.\\(\\)` method call can lead to false dead methods\\. Make sure the variable type is known$#"
-				count: 1
-				path: ../Classes/System/Dispatcher.php
-			-
-				message: "#^Anonymous variable in a `\\$this\\-\\>request\\-\\>getAttribute\\('site'\\)\\-\\>\\.\\.\\.\\(\\)` method call can lead to false dead methods\\. Make sure the variable type is known$#"
-				count: 1
-				path: ../Classes/System/Restler/RestlerExtended.php
-			-
-				message: "#^Anonymous variable in a `\\$this\\-\\>request\\-\\>getAttribute\\('site'\\)\\-\\>getBase\\(\\)\\-\\>\\.\\.\\.\\(\\)` method call can lead to false dead methods\\. Make sure the variable type is known$#"
-				count: 1
-				path: ../Classes/System/Restler/RestlerExtended.php
 			-
 				message: "#^Method Aoe\\\\Restler\\\\System\\\\RestApi\\\\RestApiRequest\\:\\:composeHeaders\\(\\) has no return type specified\\.$#"
 				count: 1
@@ -64,3 +44,11 @@ parameters:
 				message: "#^Comparison operation \"\\>\" between int\\<1, max\\> and 0 is always true\\.$#"
 				count: 1
 				path: ../Classes/System/Restler/Format/HalJsonFormat.php
+			-
+				message: "#^Interface (.*) has only single implementer. Consider using the class directly as there is no point in using the interface.$#"
+				count: 1
+				path: ../Classes/System/Restler/ConfigurationInterface.php
+			-
+				message: "#^Unable to resolve the template type T in call to method static method (.*)$#"
+				count: 2
+				path: ../Classes/System/Restler/Builder.php
diff --git a/.code-quality/phpstan.neon b/.code-quality/phpstan.neon
@@ -8,9 +8,10 @@ parameters:
     paths:
         - "../Classes/"
 
+    ignoreErrors:
+        - identifier: missingType.iterableValue
+
     inferPrivatePropertyTypeFromConstructor: true
-    checkMissingIterableValueType: false
-    checkGenericClassInNonGenericObjectType: false
     checkAlwaysTrueCheckTypeFunctionCall: false
     checkAlwaysTrueStrictComparison: false
 

diff --git a/.code-quality/rector-8_0.php b/.code-quality/rector-8_0.php
diff --git a/.code-quality/rector.php b/.code-quality/rector.php
@@ -5,12 +5,10 @@
 use Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector;
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector;
-use Rector\EarlyReturn\Rector\If_\ChangeAndIfToEarlyReturnRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertEqualsToSameRector;
 use Rector\Set\ValueObject\SetList;
 use Rector\PHPUnit\Set\PHPUnitSetList;
-use Rector\Privatization\Rector\Class_\FinalizeClassesWithoutChildrenRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictSetUpRector;
 
@@ -35,8 +33,6 @@
         PHPUnitSetList::PHPUNIT_CODE_QUALITY
     ])
     ->withSkip([
-        FinalizeClassesWithoutChildrenRector::class,
-        ChangeAndIfToEarlyReturnRector::class,
         TypedPropertyFromStrictSetUpRector::class,
         AddMethodCallBasedStrictParamTypeRector::class,
         FlipTypeControlToUseExclusiveTypeRector::class,

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,18 +1,6 @@
 name: Tests
 
-on:
-  push:
-    branches:
-      - '**'
-      - '!TYPO3_V10'
-      - '!TYPO3V8'
-      - '!TYPO3V9'
-  pull_request:
-    branches:
-      - '**'
-      - '!TYPO3_V10'
-      - '!TYPO3V8'
-      - '!TYPO3V9'
+on: [ push, pull_request ]
 
 jobs:
   build:
@@ -22,13 +10,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        typo3: [ ^11.5 ]
-        php: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
+        typo3: [ ^12.4 ]
+        php: [ '8.1', '8.2', '8.3' ]
         experimental: [false]
-        include:
-          - typo3: ^11.5
-            php: '8.1'
-            experimental: true
+
 
     continue-on-error: ${{ matrix.experimental }}
 
@@ -55,29 +40,29 @@ jobs:
       - name: Validate composer.json and composer.lock
         run: composer validate
 
-      - name: Install dependencies with nimut/typo3-complete:${{ matrix.typo3 }}
+      - name: Install dependencies with typo3/cms-core:${{ matrix.typo3 }}
         run: |
-          composer require --dev nimut/typo3-complete:${{ matrix.typo3 }} --no-progress
+          composer require --dev typo3/cms-core:${{ matrix.typo3 }} --no-progress
           git checkout composer.json
           ln -nfs .Build/vendor/typo3/cms/typo3 typo3
 
       - name: Lint PHP
         run: find . -name \*.php ! -path "./.Build/*" ! -path "./scripts/*" ! -path "./typo3_src/*" | parallel --gnu php -d display_errors=stderr -l {} > /dev/null \;
 
       - name: Unit Tests without coverage
-        if: matrix.typo3 != '^11.5' || matrix.php != '8.3'
+        if: matrix.typo3 != '^12.4' || matrix.php != '8.3'
         run: |
-          export "UNIT_XML"=.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml
+          export "UNIT_XML"=Tests/phpunit.xml
           .Build/bin/phpunit --colors -c $UNIT_XML Tests/Unit
 
       - name: Unit Tests with coverage
-        if: matrix.typo3 == '^11.5' && matrix.php == '8.3'
+        if: matrix.typo3 == '^12.4' && matrix.php == '8.3'
         run: |
-          export "UNIT_XML"=.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests-v10.xml 
+          export "UNIT_XML"=Tests/phpunit.xml
           .Build/bin/phpunit --coverage-filter Classes --coverage-clover=unittest-coverage.clover --colors -c $UNIT_XML Tests/Unit/
 
       - name: Upload coverage results to Scrutinizer
         uses: sudo-bot/action-scrutinizer@latest
-        if: matrix.typo3 == '^11.5' && matrix.php == '8.3'
+        if: matrix.typo3 == '^12.4' && matrix.php == '8.3'
         with:
           cli-args: "--format=php-clover .Build/reports/php_all_tests/coverage_clover.xml --revision=${{ github.event.pull_request.head.sha || github.sha }}"
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -1,6 +1,9 @@
 build:
     nodes:
         analysis:
+            image: default-bionic
+            environment:
+                php: 8.3.0
             tests:
                 override:
                     - php-scrutinizer-run

diff --git a/Classes/Configuration/ExtensionConfiguration.php b/Classes/Configuration/ExtensionConfiguration.php
@@ -5,7 +5,7 @@
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2021 AOE GmbH <[email protected]>
+ *  (c) 2024 AOE GmbH <[email protected]>
  *
  *  All rights reserved
  *

diff --git a/Classes/Controller/BeUserAuthenticationController.php b/Classes/Controller/BeUserAuthenticationController.php
@@ -5,7 +5,7 @@
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2021 AOE GmbH <[email protected]>
+ *  (c) 2024 AOE GmbH <[email protected]>
  *
  *  All rights reserved
  *
@@ -63,11 +63,9 @@ class BeUserAuthenticationController implements iAuthenticate
      */
     public $restler;
 
-    private Loader $typo3Loader;
-
-    public function __construct(Loader $typo3Loader)
-    {
-        $this->typo3Loader = $typo3Loader;
+    public function __construct(
+        private readonly Loader $typo3Loader
+    ) {
         $this->restler = Scope::get('Restler');
     }
 

diff --git a/Classes/Controller/ExplorerAuthenticationController.php b/Classes/Controller/ExplorerAuthenticationController.php
@@ -5,7 +5,7 @@
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2021 AOE GmbH <[email protected]>
+ *  (c) 2024 AOE GmbH <[email protected]>
  *
  *  All rights reserved
  *

diff --git a/Classes/Controller/FeUserAuthenticationController.php b/Classes/Controller/FeUserAuthenticationController.php
@@ -5,7 +5,7 @@
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2021 AOE GmbH <[email protected]>
+ *  (c) 2024 AOE GmbH <[email protected]>
  *
  *  All rights reserved
  *
@@ -89,11 +89,9 @@ class FeUserAuthenticationController implements iAuthenticate
      */
     public $restler;
 
-    private Loader $typo3Loader;
-
-    public function __construct(Loader $typo3Loader)
-    {
-        $this->typo3Loader = $typo3Loader;
+    public function __construct(
+        private readonly Loader $typo3Loader
+    ) {
         $this->restler = Scope::get('Restler');
     }
 

diff --git a/Classes/System/Dispatcher.php b/Classes/System/Dispatcher.php
@@ -5,7 +5,7 @@
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2015 AOE GmbH <[email protected]>
+ *  (c) 2024 AOE GmbH <[email protected]>
  *
  *  All rights reserved
  *
@@ -83,7 +83,15 @@ protected function extractSiteUrl(ServerRequestInterface $request): string
         }
 
         if ($siteBasePath) {
-            return '/' . rtrim(preg_replace('%^' . preg_quote($siteBasePath, '%') . '%', '', $request->getUri()->getPath()), '/');
+            return '/' . rtrim(
+                (string) preg_replace(
+                    '%^' . preg_quote((string) $siteBasePath, '%') . '%',
+                    '',
+                    $request->getUri()
+                        ->getPath()
+                ),
+                '/'
+            );
         }
 
         return $request->getUri()