Merge pull request #1017 from cakephp/5.next-upwards-merge

merge 5.x => 5.next

Author: markstory

.phive/phars.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="1.10.22" installed="1.10.22" location="./tools/phpstan" copy="false"/>
-  <phar name="psalm" version="5.13.1" installed="5.13.1" location="./tools/psalm" copy="false"/>
+  <phar name="phpstan" version="1.11.9" installed="1.11.9" location="./tools/phpstan" copy="false"/>
+  <phar name="psalm" version="5.25.0" installed="5.25.0" location="./tools/psalm" copy="false"/>
 </phive>

README.md

@@ -24,10 +24,10 @@ For details and older versions see [version map](https://github.com/cakephp/debu
 
 * Install the plugin with [Composer](https://getcomposer.org/) from your CakePHP Project's ROOT directory (where the **composer.json** file is located)
 ```sh
-php composer.phar require --dev cakephp/debug_kit:"^4.0"
+php composer.phar require --dev cakephp/debug_kit:"^5.0"
 ```
 
-* [Load the plugin](https://book.cakephp.org/4/en/plugins.html#loading-a-plugin)
+* [Load the plugin](https://book.cakephp.org/5/en/plugins.html#loading-a-plugin)
 ```php
 // src/Application.php
 $this->addPlugin('DebugKit');
@@ -45,6 +45,8 @@ working correctly. Some common problems are:
 2. Your hostname needs to be added to the `DebugKit.safeTld`. If your local
    domain isn't a known development environment name, DebugKit will disable
    itself to protect a potentially non-development environment.
+3. If you are using the [Authorization Plugin](https://github.com/cakephp/authorization)
+   you need to set `DebugKit.ignoreAuthorization` to `true` in your config.
 
 ## Reporting Issues
 
@@ -63,3 +65,7 @@ requests](https://help.github.com/articles/using-pull-requests) or open
 
 Documentation for DebugKit can be found in the
 [CakePHP documentation](https://book.cakephp.org/debugkit/5/en/index.html).
+
+## Panels
+Panels by other plugins:
+- `L10n` by [Setup plugin](https://github.com/dereuromark/cakephp-setup) to show current localization for Date, DateTime, Time objects/values.

composer.json

@@ -1,10 +1,14 @@
 {
     "name": "cakephp/debug_kit",
     "description": "CakePHP Debug Kit",
-    "type": "cakephp-plugin",
-    "keywords": ["cakephp", "debug", "kit", "dev"],
-    "homepage": "https://github.com/cakephp/debug_kit",
     "license": "MIT",
+    "type": "cakephp-plugin",
+    "keywords": [
+        "cakephp",
+        "debug",
+        "kit",
+        "dev"
+    ],
     "authors": [
         {
             "name": "Mark Story",
@@ -16,13 +20,15 @@
             "homepage": "https://github.com/cakephp/debug_kit/graphs/contributors"
         }
     ],
+    "homepage": "https://github.com/cakephp/debug_kit",
     "support": {
         "issues": "https://github.com/cakephp/debug_kit/issues",
         "forum": "https://stackoverflow.com/tags/cakephp",
         "irc": "irc://irc.freenode.org/cakephp",
         "source": "https://github.com/cakephp/debug_kit"
     },
     "require": {
+        "php": ">=8.1",
         "cakephp/cakephp": "dev-5.next as 5.1.0",
         "composer/composer": "^2.0",
         "doctrine/sql-formatter": "^1.1.3"
@@ -32,6 +38,9 @@
         "cakephp/cakephp-codesniffer": "^5.0",
         "phpunit/phpunit": "^10.5.5 || ^11.1.3"
     },
+    "suggest": {
+        "ext-pdo_sqlite": "DebugKit needs to store panel data in a database. SQLite is simple and easy to use."
+    },
     "autoload": {
         "psr-4": {
             "DebugKit\\": "src/"
@@ -40,33 +49,30 @@
     "autoload-dev": {
         "psr-4": {
             "Cake\\Test\\": "vendor/cakephp/cakephp/tests/",
-            "DebugKit\\Test\\": "tests/",
             "DebugKit\\TestApp\\": "tests/test_app/",
+            "DebugKit\\Test\\": "tests/",
             "DebugkitTestPlugin\\": "tests/test_app/Plugin/DebugkitTestPlugin/src/"
         }
     },
-    "suggest": {
-        "ext-pdo_sqlite": "DebugKit needs to store panel data in a database. SQLite is simple and easy to use."
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     },
     "scripts": {
         "cs-check": "phpcs --colors --parallel=16 -p src/ tests/",
         "cs-fix": "phpcbf --colors --parallel=16 -p src/ tests/",
         "phpstan": "tools/phpstan analyse",
         "psalm": "tools/psalm --show-info=false",
+        "psalm-baseline": "tools/psalm  --set-baseline=psalm-baseline.xml",
         "stan": [
             "@phpstan",
             "@psalm"
         ],
         "stan-baseline": "tools/phpstan --generate-baseline",
-        "psalm-baseline": "tools/psalm  --set-baseline=psalm-baseline.xml",
         "stan-setup": "phive install",
         "test": "phpunit"
     },
-    "config": {
-        "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
-        }
-    },
     "minimum-stability": "dev",
     "prefer-stable": true
 }

docs/en/index.rst

@@ -64,6 +64,12 @@ Configuration
 
 * ``DebugKit.ignoreAuthorization`` - Set to true to ignore Cake Authorization plugin for DebugKit requests. Disabled by default.
 
+* ``DebugKit.maxDepth`` - Defines how many levels of nested data should be shown in general for debug output. Default is 5.
+  WARNING: Increasing the max depth level can lead to an out of memory error.::
+
+    // Show more levels
+    Configure::write('DebugKit.maxDepth', 8);
+
 * ``DebugKit.variablesPanelMaxDepth`` - Defines how many levels of nested data should be shown in the variables tab. Default is 5.
   WARNING: Increasing the max depth level can lead to an out of memory error.::
 

phpstan-baseline.neon

@@ -1,20 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Call to function file_get_contents\\(\\) on a separate line has no effect\\.$#"
-			count: 1
-			path: src/Command/BenchmarkCommand.php
-
-		-
-			message: "#^Comparison operation \"\\<\" between int\\<0, max\\> and 10\\|100\\|array\\<int, string\\>\\|bool\\|string\\|null results in an error\\.$#"
-			count: 1
-			path: src/Command/BenchmarkCommand.php
-
-		-
-			message: "#^Comparison operation \"\\<\\=\" between 10\\|100\\|array\\<int, string\\>\\|string\\|true and 1 results in an error\\.$#"
-			count: 1
-			path: src/Command/BenchmarkCommand.php
-
 		-
 			message: "#^Method DebugKit\\\\Mailer\\\\Transport\\\\DebugKitTransport\\:\\:send\\(\\) should return array\\{headers\\: string, message\\: string\\} but returns array\\{headers\\: non\\-empty\\-array\\<string, string\\>, message\\: array\\{text\\: string, html\\: string\\}\\}\\.$#"
 			count: 1

phpstan.neon

@@ -3,10 +3,12 @@ includes:
 
 parameters:
 	level: 6
-	checkMissingIterableValueType: false
-	checkGenericClassInNonGenericObjectType: false
 	treatPhpDocTypesAsCertain: false
 	bootstrapFiles:
 		- tests/bootstrap.php
 	paths:
 		- src/
+	ignoreErrors:
+			- identifier: missingType.generics
+			- identifier: missingType.iterableValue
+

phpunit.xml.dist

@@ -4,7 +4,7 @@
          processIsolation="false"
          stopOnFailure="false"
          cacheDirectory=".phpunit.cache"
-         bootstrap="./tests/bootstrap.php"
+         bootstrap="tests/bootstrap.php"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd"
 >
     <testsuites>

psalm-baseline.xml

@@ -1,45 +1,101 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.13.1@086b94371304750d1c673315321a55d15fc59015">
-  <file src="src/Command/BenchmarkCommand.php">
-    <PossiblyInvalidArgument>
-      <code><![CDATA[$options['t'] - array_sum($times)]]></code>
-    </PossiblyInvalidArgument>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[$options['t']]]></code>
-      <code>array_sum($times)</code>
-    </PossiblyInvalidOperand>
+<files psalm-version="5.20.0@3f284e96c9d9be6fe6b15c79416e1d1903dcfef4">
+  <file src="src/Cache/Engine/DebugEngine.php">
+    <RiskyTruthyFalsyComparison>
+      <code>$key</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
+  <file src="src/Controller/MailPreviewController.php">
+    <RiskyTruthyFalsyComparison>
+      <code><![CDATA[$this->findPart($email, $partType)]]></code>
+    </RiskyTruthyFalsyComparison>
+  </file>
+  <file src="src/Database/Log/DebugLog.php">
+    <InternalMethod>
+      <code>jsonSerialize</code>
+    </InternalMethod>
   </file>
   <file src="src/DebugInclude.php">
     <PossiblyNullArrayOffset>
       <code><![CDATA[$this->_composerPaths]]></code>
       <code><![CDATA[$this->_pluginPaths]]></code>
     </PossiblyNullArrayOffset>
   </file>
+  <file src="src/DebugMemory.php">
+    <RiskyTruthyFalsyComparison>
+      <code>!$message</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
   <file src="src/DebugSql.php">
     <InternalMethod>
       <code>bindings</code>
     </InternalMethod>
+    <RiskyTruthyFalsyComparison>
+      <code>$file</code>
+      <code>$file</code>
+      <code>$file</code>
+      <code>$line</code>
+      <code>$line</code>
+    </RiskyTruthyFalsyComparison>
   </file>
   <file src="src/DebugTimer.php">
     <PossiblyNullArrayOffset>
       <code>self::$_timers</code>
     </PossiblyNullArrayOffset>
+    <RiskyTruthyFalsyComparison>
+      <code>!$message</code>
+      <code>!$name</code>
+      <code>!$name</code>
+    </RiskyTruthyFalsyComparison>
   </file>
   <file src="src/Mailer/MailPreview.php">
     <PossiblyFalseOperand>
       <code>$pos</code>
     </PossiblyFalseOperand>
   </file>
+  <file src="src/Mailer/PreviewResult.php">
+    <RiskyTruthyFalsyComparison>
+      <code><![CDATA[!$mailer->viewBuilder()->getTemplate()]]></code>
+    </RiskyTruthyFalsyComparison>
+  </file>
   <file src="src/Mailer/Transport/DebugKitTransport.php">
     <InvalidReturnStatement>
       <code>$result</code>
     </InvalidReturnStatement>
     <MoreSpecificReturnType>
       <code>array</code>
     </MoreSpecificReturnType>
-    <PropertyTypeCoercion>
-      <code>new $className($config)</code>
-    </PropertyTypeCoercion>
+    <NullArgument>
+      <code><![CDATA[$this->emailLog]]></code>
+    </NullArgument>
+  </file>
+  <file src="src/Model/Table/LazyTableTrait.php">
+    <RiskyTruthyFalsyComparison>
+      <code><![CDATA[strpos($e->getMessage(), 'unable to open')]]></code>
+    </RiskyTruthyFalsyComparison>
+  </file>
+  <file src="src/Panel/DeprecationsPanel.php">
+    <RiskyTruthyFalsyComparison>
+      <code>$pluginName</code>
+      <code>$vendorName</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
+  <file src="src/Panel/EnvironmentPanel.php">
+    <RiskyTruthyFalsyComparison>
+      <code>$pluginName</code>
+      <code>$vendorName</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
+  <file src="src/Panel/IncludePanel.php">
+    <RiskyTruthyFalsyComparison>
+      <code>$pluginName</code>
+      <code>$vendorName</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
+  <file src="src/Panel/LogPanel.php">
+    <RiskyTruthyFalsyComparison>
+      <code><![CDATA[Log::getConfig('debug_kit_log_panel')]]></code>
+    </RiskyTruthyFalsyComparison>
   </file>
   <file src="src/Panel/PanelRegistry.php">
     <LessSpecificImplementedReturnType>
@@ -62,6 +118,12 @@
       <code>genericInstances</code>
     </UndefinedInterfaceMethod>
   </file>
+  <file src="src/ToolbarService.php">
+    <RiskyTruthyFalsyComparison>
+      <code><![CDATA[!$GLOBALS['FORCE_DEBUGKIT_TOOLBAR']]]></code>
+      <code>$enabled</code>
+    </RiskyTruthyFalsyComparison>
+  </file>
   <file src="src/View/Helper/ToolbarHelper.php">
     <InternalClass>
       <code>new HtmlFormatter()</code>

src/Command/BenchmarkCommand.php

@@ -50,14 +50,21 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
         $this->io = $io;
         /** @var string $url */
         $url = $args->getArgumentAt(0);
-        $defaults = ['t' => 100, 'n' => 10];
-        $options = array_merge($defaults, $args->getOptions());
         $times = [];
 
         $io->out(Text::insert('-> Testing :url', compact('url')));
         $io->out('');
-        for ($i = 0; $i < $options['n']; $i++) {
-            if (floor($options['t'] - array_sum($times)) <= 0 || $options['n'] <= 1) {
+        $count = 10;
+        if ($args->hasOption('n')) {
+            $count = (float)$args->getOption('n');
+        }
+        $timeout = 100;
+        if ($args->hasOption('t')) {
+            $timeout = (float)$args->getOption('t');
+        }
+
+        for ($i = 0; $i < $count; $i++) {
+            if (floor($timeout - array_sum($times)) <= 0 || $count <= 1) {
                 break;
             }
 

src/Controller/ComposerController.php

@@ -85,7 +85,7 @@ private function executeComposerCommand(ArrayInput $input): BufferedOutput
         putenv('COMPOSER_HOME=' . $bin);
         putenv('COMPOSER_CACHE_DIR=' . CACHE);
 
-        $dir = getcwd();
+        $dir = (string)getcwd();
         chdir(ROOT);
         $timeLimit = ini_get('max_execution_time');
         set_time_limit(300);