Merge pull request #60 from cakephp/2.x-updates

Bump to PHP 8.1 and drop deprecated code.

Author: markstory

.editorconfig

@@ -12,3 +12,6 @@ trim_trailing_whitespace = true
 
 [*.yml]
 indent_size = 2
+
+[*.neon]
+indent_style = tab

.gitattributes

@@ -8,3 +8,5 @@
 phpunit.xml.dist export-ignore
 phpcs.xml.dist export-ignore
 .github export-ignore
+phpstan.neon export-ignore
+psalm.xml export-ignore

.github/workflows/ci.yml

@@ -8,78 +8,14 @@ on:
     branches:
       - '*'
 
-jobs:
-  testsuite-linux:
-    runs-on: ubuntu-18.04
-    strategy:
-      fail-fast: false
-      matrix:
-        php-version: ['5.6', '7.4', '8.0']
-        prefer-lowest: ['']
-        include:
-          - php-version: '5.6'
-            prefer-lowest: 'prefer-lowest'
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        coverage: none
-        php-version: ${{ matrix.php-version }}
-        extensions: mbstring, intl
-
-    - name: Get composer cache directory
-      id: composer-cache
-      run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-    - name: Get date part for cache key
-      id: key-date
-      run: echo "::set-output name=date::$(date +'%Y-%m')"
-
-    - name: Cache composer dependencies
-      uses: actions/cache@v1
-      with:
-        path: ${{ steps.composer-cache.outputs.dir }}
-        key: ${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}-${{ matrix.prefer-lowest }}
-
-    - name: Composer install
-      run: |
-        if ${{ matrix.prefer-lowest == 'prefer-lowest' }}; then
-          composer update --prefer-lowest --prefer-stable
-        else
-          composer install
-        fi
+permissions:
+  contents: read
 
-    - name: Run PHPUnit
-      run: |
-        if [[ ${{ matrix.php-version }} == '5.6' ]]; then
-          vendor/bin/phpunit tests/php56/
-        else
-          vendor/bin/phpunit
-        fi
+jobs:
+  testsuite:
+    uses: cakephp/.github/.github/workflows/testsuite-without-db.yml@5.x
+    secrets: inherit
 
   cs-stan:
-    name: Coding Standard & Static Analysis
-    runs-on: ubuntu-18.04
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: '7.4'
-        extensions: mbstring, intl
-        coverage: none
-        tools: psalm:~4.1.0, cs2pr
-
-    - name: Composer Install
-      run: composer install
-
-    - name: Run phpcs
-      run: vendor/bin/phpcs --report=checkstyle src/ tests/ | cs2pr
-
-    - name: Run psalm
-      run: psalm --output-format=github
+    uses: cakephp/.github/.github/workflows/cs-stan.yml@5.x
+    secrets: inherit

composer.json

@@ -10,13 +10,13 @@
         }
     ],
     "require": {
-        "php": ">=5.6.0",
+        "php": ">=8.1",
         "composer-plugin-api": "^1.0 || ^2.0"
     },
     "require-dev": {
-        "cakephp/cakephp-codesniffer": "^3.3",
+        "cakephp/cakephp-codesniffer": "5.x-dev",
         "composer/composer": "^2.0",
-        "phpunit/phpunit": "^5.7 || ^6.5 || ^8.5 || ^9.3"
+        "phpunit/phpunit": "^9.5.19"
     },
     "autoload": {
         "psr-4": {
@@ -25,15 +25,17 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Cake\\Test\\TestCase\\Composer\\": "tests/TestCase/",
-            "Cake\\Test\\TestCase\\Composer\\Php56\\": "tests/php56/TestCase/"
+            "Cake\\Test\\TestCase\\Composer\\": "tests/TestCase/"
         }
     },
     "extra": {
         "class": "Cake\\Composer\\Plugin"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     },
     "prefer-stable": true
 }

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+	level: 6
+	paths:
+		- src/

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="5"
+    errorLevel="2"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
@@ -12,4 +12,9 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+
+    <issueHandlers>
+        <MissingClosureReturnType errorLevel="info" />
+        <MissingClosureParamType errorLevel="info" />
+    </issueHandlers>
 </psalm>

src/Installer/PluginInstaller.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Cake\Composer;
 
 use Composer\Composer;
@@ -7,6 +9,7 @@
 use Composer\Package\PackageInterface;
 use Composer\Plugin\PluginInterface;
 use Composer\Script\Event;
+use DirectoryIterator;
 use RuntimeException;
 
 class Plugin implements PluginInterface, EventSubscriberInterface
@@ -51,7 +54,7 @@ public static function getSubscribedEvents()
      * @param \Composer\Script\Event $event Composer's event object.
      * @return void
      */
-    public function postAutoloadDump(Event $event)
+    public function postAutoloadDump(Event $event): void
     {
         $composer = $event->getComposer();
         $config = $composer->getConfig();
@@ -78,16 +81,16 @@ public function postAutoloadDump(Event $event)
      * Add all composer packages of type `cakephp-plugin`, and all plugins located
      * in the plugins directory to a plugin-name indexed array of paths.
      *
-     * @param \Composer\Package\PackageInterface[] $packages Array of \Composer\Package\PackageInterface objects.
-     * @param array $pluginDirs The path to the plugins dir.
+     * @param array<\Composer\Package\PackageInterface> $packages Array of \Composer\Package\PackageInterface objects.
+     * @param array<string> $pluginDirs The path to the plugins dir.
      * @param string $vendorDir The path to the vendor dir.
-     * @return array Plugin name indexed paths to plugins.
+     * @return array<string, string> Plugin name indexed paths to plugins.
      */
     public function findPlugins(
         array $packages,
         array $pluginDirs = ['plugins'],
-        $vendorDir = 'vendor'
-    ) {
+        string $vendorDir = 'vendor'
+    ): array {
         $plugins = [];
 
         foreach ($packages as $package) {
@@ -103,7 +106,7 @@ public function findPlugins(
         foreach ($pluginDirs as $path) {
             $path = $this->getFullPath($path, $vendorDir);
             if (is_dir($path)) {
-                $dir = new \DirectoryIterator($path);
+                $dir = new DirectoryIterator($path);
                 foreach ($dir as $info) {
                     if (!$info->isDir() || $info->isDot()) {
                         continue;
@@ -131,7 +134,7 @@ public function findPlugins(
      * @param string $vendorDir The path to the vendor dir.
      * @return string
      */
-    public function getFullPath($path, $vendorDir)
+    public function getFullPath(string $path, string $vendorDir): string
     {
         if (preg_match('{^(?:/|[a-z]:|[a-z0-9.]+://)}i', $path)) {
             return rtrim($path, '/');
@@ -148,11 +151,11 @@ public function getFullPath($path, $vendorDir)
      * Rewrite the config file with a complete list of plugins.
      *
      * @param string $configFile The path to the config file.
-     * @param array $plugins Array of plugins.
+     * @param array<string, string> $plugins Array of plugins.
      * @param string|null $root The root directory. Defaults to a value generated from `$configFile`.
      * @return void
      */
-    public function writeConfigFile($configFile, array $plugins, $root = null)
+    public function writeConfigFile(string $configFile, array $plugins, ?string $root = null): void
     {
         $root = $root ?: dirname(dirname($configFile));
 
@@ -212,7 +215,7 @@ public function writeConfigFile($configFile, array $plugins, $root = null)
      * @param string $vendorDir Path to composer-vendor dir.
      * @return string Absolute file path.
      */
-    public function getConfigFilePath($vendorDir)
+    public function getConfigFilePath(string $vendorDir): string
     {
         return $vendorDir . DIRECTORY_SEPARATOR . 'cakephp-plugins.php';
     }
@@ -224,10 +227,11 @@ public function getConfigFilePath($vendorDir)
      * @return string The package's primary namespace.
      * @throws \RuntimeException When the package's primary namespace cannot be determined.
      */
-    public function getPrimaryNamespace(PackageInterface $package)
+    public function getPrimaryNamespace(PackageInterface $package): string
     {
         $primaryNs = null;
         $autoLoad = $package->getAutoload();
+        /** @var array<string, string> $pathMap */
         foreach ($autoLoad as $type => $pathMap) {
             if ($type !== 'psr-4') {
                 continue;
@@ -265,6 +269,6 @@ public function getPrimaryNamespace(PackageInterface $package)
             );
         }
 
-        return trim((string)$primaryNs, '\\');
+        return trim($primaryNs, '\\');
     }
 }