Fixed CS errors. Added cs-check, cs-fix and test scripts

othercorey · othercorey · commit c890c4c3df56 · 2020-04-10T16:37:21.000-05:00
diff --git a/composer.json b/composer.json
@@ -51,6 +51,16 @@
     "suggest": {
         "ext-pdo_sqlite": "DebugKit needs to store panel data in a database. SQLite is simple and easy to use."
     },
-    "prefer-stable": true,
-    "minimum-stability": "dev"
+    "scripts": {
+        "cs-check": [
+          "phpcs --colors --parallel=16 -p src/ tests/"
+        ],
+        "cs-fix": [
+          "phpcbf --colors --parallel=16 -p src/ tests/"
+        ],
+        "test": [
+          "phpunit"
+        ]
+    },
+    "prefer-stable": true
 }
diff --git a/src/Cache/Engine/DebugEngine.php b/src/Cache/Engine/DebugEngine.php
@@ -11,7 +11,6 @@
  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
- *
  */
 namespace DebugKit\Cache\Engine;
 
@@ -143,7 +142,7 @@ protected function log(string $operation, float $duration, ?string $key = null):
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function set($key, $value, $ttl = null): bool
     {
@@ -158,7 +157,7 @@ public function set($key, $value, $ttl = null): bool
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function setMultiple($data, $ttl = null): bool
     {
@@ -173,7 +172,7 @@ public function setMultiple($data, $ttl = null): bool
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function get($key, $default = null)
     {
@@ -192,7 +191,7 @@ public function get($key, $default = null)
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function getMultiple($keys, $default = null): iterable
     {
@@ -207,7 +206,7 @@ public function getMultiple($keys, $default = null): iterable
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function increment(string $key, int $offset = 1)
     {
@@ -222,7 +221,7 @@ public function increment(string $key, int $offset = 1)
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function decrement(string $key, int $offset = 1)
     {
@@ -237,7 +236,7 @@ public function decrement(string $key, int $offset = 1)
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function delete($key): bool
     {
@@ -252,7 +251,7 @@ public function delete($key): bool
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function deleteMultiple($data): bool
     {
@@ -267,7 +266,7 @@ public function deleteMultiple($data): bool
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function clear(): bool
     {
@@ -282,7 +281,7 @@ public function clear(): bool
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function groups(): array
     {
@@ -316,7 +315,7 @@ public function setConfig($key, $value = null, $merge = true)
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function clearGroup(string $group): bool
     {
diff --git a/src/Controller/ComposerController.php b/src/Controller/ComposerController.php
@@ -26,7 +26,7 @@
 class ComposerController extends DebugKitController
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function initialize(): void
     {
diff --git a/src/DebugInclude.php b/src/DebugInclude.php
@@ -19,7 +19,6 @@
 
 /**
  * Contains methods for Providing list of files.
- *
  */
 class DebugInclude
 {
diff --git a/src/DebugMemory.php b/src/DebugMemory.php
@@ -19,7 +19,6 @@
 
 /**
  * Contains methods for Profiling memory usage.
- *
  */
 class DebugMemory
 {
diff --git a/src/DebugTimer.php b/src/DebugTimer.php
@@ -19,7 +19,6 @@
 
 /**
  * Contains methods for Profiling and creating timers.
- *
  */
 class DebugTimer
 {
diff --git a/src/Log/Engine/DebugKitLog.php b/src/Log/Engine/DebugKitLog.php
@@ -18,7 +18,6 @@
 
 /**
  * A CakeLog listener which saves having to munge files or other configured loggers.
- *
  */
 class DebugKitLog extends BaseLog
 {
diff --git a/src/Mailer/SentMailResult.php b/src/Mailer/SentMailResult.php
@@ -16,7 +16,6 @@
 
 /**
  * Represents the result of an already sent email
- *
  */
 class SentMailResult extends AbstractResult
 {
diff --git a/src/Panel/CachePanel.php b/src/Panel/CachePanel.php
@@ -11,7 +11,6 @@
  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
- *
  */
 namespace DebugKit\Panel;
 
diff --git a/src/Panel/DeprecationsPanel.php b/src/Panel/DeprecationsPanel.php
@@ -21,7 +21,6 @@
 
 /**
  * Provides a list of deprecated methods for the current request
- *
  */
 class DeprecationsPanel extends DebugPanel
 {
diff --git a/src/Panel/EnvironmentPanel.php b/src/Panel/EnvironmentPanel.php
@@ -11,7 +11,6 @@
  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
- *
  */
 namespace DebugKit\Panel;
 
@@ -21,7 +20,6 @@
 
 /**
  * Provides information about your PHP and CakePHP environment to assist with debugging.
- *
  */
 class EnvironmentPanel extends DebugPanel
 {
diff --git a/src/Panel/HistoryPanel.php b/src/Panel/HistoryPanel.php
@@ -19,7 +19,6 @@
 
 /**
  * Provides debug information on previous requests.
- *
  */
 class HistoryPanel extends DebugPanel
 {
diff --git a/src/Panel/IncludePanel.php b/src/Panel/IncludePanel.php
@@ -21,7 +21,6 @@
 
 /**
  * Provides a list of included files for the current request
- *
  */
 class IncludePanel extends DebugPanel
 {
diff --git a/src/Panel/LogPanel.php b/src/Panel/LogPanel.php
@@ -19,7 +19,6 @@
 
 /**
  * Log Panel - Reads log entries made this request.
- *
  */
 class LogPanel extends DebugPanel
 {
diff --git a/src/Panel/PackagesPanel.php b/src/Panel/PackagesPanel.php
@@ -20,7 +20,6 @@
 
 /**
  * Packages Panel - Reads all installed packages in the project.
- *
  */
 class PackagesPanel extends DebugPanel
 {
diff --git a/src/Panel/RequestPanel.php b/src/Panel/RequestPanel.php
@@ -19,7 +19,6 @@
 
 /**
  * Provides debug information on the Current request params.
- *
  */
 class RequestPanel extends DebugPanel
 {
diff --git a/src/Panel/RoutesPanel.php b/src/Panel/RoutesPanel.php
@@ -11,7 +11,6 @@
  * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
  * @license       http://www.opensource.org/licenses/mit-license.php MIT License
- *
  */
 namespace DebugKit\Panel;
 
diff --git a/src/Panel/SqlLogPanel.php b/src/Panel/SqlLogPanel.php
@@ -24,7 +24,6 @@
 
 /**
  * Provides debug information on the SQL logs and provides links to an ajax explain interface.
- *
  */
 class SqlLogPanel extends DebugPanel
 {
diff --git a/src/Panel/VariablesPanel.php b/src/Panel/VariablesPanel.php
@@ -31,15 +31,13 @@
 
 /**
  * Provides debug information on the View variables.
- *
  */
 class VariablesPanel extends DebugPanel
 {
     /**
      * Extracts nested validation errors
      *
      * @param \Cake\Datasource\EntityInterface $entity Entity to extract
-     *
      * @return array
      */
     protected function _getErrors(EntityInterface $entity)
@@ -68,7 +66,6 @@ protected function _getErrors(EntityInterface $entity)
      *
      * @param callable $walker The walker to apply on the debug info array.
      * @param object $item The item whose debug info to retrieve.
-     *
      * @return array|string
      */
     protected function _walkDebugInfo(callable $walker, $item)
diff --git a/tests/TestCase/DebugIncludeTest.php b/tests/TestCase/DebugIncludeTest.php
@@ -19,7 +19,6 @@
 
 /**
  * Class DebugInclude test
- *
  */
 class DebugIncludeTest extends TestCase
 {
diff --git a/tests/TestCase/DebugMemoryTest.php b/tests/TestCase/DebugMemoryTest.php
@@ -19,7 +19,6 @@
 
 /**
  * Class DebugMemoryTest
- *
  */
 class DebugMemoryTest extends TestCase
 {
diff --git a/tests/TestCase/Panel/DeprecationsPanelTest.php b/tests/TestCase/Panel/DeprecationsPanelTest.php
@@ -20,7 +20,6 @@
 
 /**
  * Class DeprecationsPanelTest
- *
  */
 class DeprecationsPanelTest extends TestCase
 {
@@ -67,12 +66,12 @@ public function testShutdown()
         $error = $data['plugins']['DebugKit'][0];
         $this->assertStringContainsString('Something going away', $error['message']);
         $this->assertEquals('DebugKit/tests/TestCase/Panel/DeprecationsPanelTest.php', $error['niceFile']);
-        $this->assertEquals(47, $error['line']);
+        $this->assertEquals(46, $error['line']);
 
         $error = $data['plugins']['DebugKit'][2];
         $this->assertStringContainsString('Raw error', $error['message']);
         $this->assertEquals('DebugKit/tests/TestCase/Panel/DeprecationsPanelTest.php', $error['niceFile']);
-        $this->assertEquals(49, $error['line']);
+        $this->assertEquals(48, $error['line']);
     }
 
     public function testSummary()
diff --git a/tests/TestCase/Panel/EnvironmentPanelTest.php b/tests/TestCase/Panel/EnvironmentPanelTest.php
@@ -20,7 +20,6 @@
 
 /**
  * Class EnvironmentPanelTest
- *
  */
 class EnvironmentPanelTest extends TestCase
 {
diff --git a/tests/TestCase/Panel/IncludePanelTest.php b/tests/TestCase/Panel/IncludePanelTest.php
@@ -20,7 +20,6 @@
 
 /**
  * Class IncludePanelTest
- *
  */
 class IncludePanelTest extends TestCase
 {
diff --git a/tests/TestCase/Panel/LogPanelTest.php b/tests/TestCase/Panel/LogPanelTest.php
@@ -21,7 +21,6 @@
 
 /**
  * Class LogPanelTest
- *
  */
 class LogPanelTest extends TestCase
 {
diff --git a/tests/TestCase/Panel/PackagesPanelTest.php b/tests/TestCase/Panel/PackagesPanelTest.php
@@ -20,7 +20,6 @@
 
 /**
  * Class PackagesPanelTest
- *
  */
 class PackagesPanelTest extends TestCase
 {
@@ -42,6 +41,7 @@ public function setUp(): void
 
     /**
      * Packages view variables provider
+     *
      * @return array
      */
     public function packagesProvider()
diff --git a/tests/TestCase/Panel/RoutesPanelTest.php b/tests/TestCase/Panel/RoutesPanelTest.php
@@ -21,7 +21,6 @@
 
 /**
  * Class RoutesPanelTest
- *
  */
 class RoutesPanelTest extends TestCase
 {
diff --git a/tests/TestCase/Panel/VariablesPanelTest.php b/tests/TestCase/Panel/VariablesPanelTest.php
@@ -23,7 +23,6 @@
 
 /**
  * Class VariablesPanelTest
- *
  */
 class VariablesPanelTest extends TestCase
 {
diff --git a/tests/test_app/Form/TestForm.php b/tests/test_app/Form/TestForm.php
@@ -9,6 +9,7 @@
 
 /**
  * Class TestForm
+ *
  * @package DebugKit\TestApp\Form
  */
 class TestForm extends Form
diff --git a/tests/test_app/Plugin/DebugkitTestPlugin/Panel/PluginTestPanel.php b/tests/test_app/Plugin/DebugkitTestPlugin/Panel/PluginTestPanel.php
@@ -22,7 +22,6 @@
 
 /**
  * Class PluginTestPanel
- *
  */
 
 class PluginTestPanel extends DebugPanel

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`	`* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)`
`12`	`12`	`* @link http://cakephp.org CakePHP(tm) Project`
`13`	`13`	`* @license http://www.opensource.org/licenses/mit-license.php MIT License`
`14`		`- *`
`15`	`14`	`*/`
`16`	`15`	`namespace DebugKit\Cache\Engine;`
`17`	`16`
`@@ -143,7 +142,7 @@ protected function log(string $operation, float $duration, ?string $key = null):`
`143`	`142`	`}`
`144`	`143`
`145`	`144`	`/**`
`146`		`- * {@inheritDoc}`
	`145`	`+ * @inheritDoc`
`147`	`146`	`*/`
`148`	`147`	`public function set($key, $value, $ttl = null): bool`
`149`	`148`	`{`
`@@ -158,7 +157,7 @@ public function set($key, $value, $ttl = null): bool`
`158`	`157`	`}`
`159`	`158`
`160`	`159`	`/**`
`161`		`- * {@inheritDoc}`
	`160`	`+ * @inheritDoc`
`162`	`161`	`*/`
`163`	`162`	`public function setMultiple($data, $ttl = null): bool`
`164`	`163`	`{`
`@@ -173,7 +172,7 @@ public function setMultiple($data, $ttl = null): bool`
`173`	`172`	`}`
`174`	`173`
`175`	`174`	`/**`
`176`		`- * {@inheritDoc}`
	`175`	`+ * @inheritDoc`
`177`	`176`	`*/`
`178`	`177`	`public function get($key, $default = null)`
`179`	`178`	`{`
`@@ -192,7 +191,7 @@ public function get($key, $default = null)`
`192`	`191`	`}`
`193`	`192`
`194`	`193`	`/**`
`195`		`- * {@inheritDoc}`
	`194`	`+ * @inheritDoc`
`196`	`195`	`*/`
`197`	`196`	`public function getMultiple($keys, $default = null): iterable`
`198`	`197`	`{`
`@@ -207,7 +206,7 @@ public function getMultiple($keys, $default = null): iterable`
`207`	`206`	`}`
`208`	`207`
`209`	`208`	`/**`
`210`		`- * {@inheritDoc}`
	`209`	`+ * @inheritDoc`
`211`	`210`	`*/`
`212`	`211`	`public function increment(string $key, int $offset = 1)`
`213`	`212`	`{`
`@@ -222,7 +221,7 @@ public function increment(string $key, int $offset = 1)`
`222`	`221`	`}`
`223`	`222`
`224`	`223`	`/**`
`225`		`- * {@inheritDoc}`
	`224`	`+ * @inheritDoc`
`226`	`225`	`*/`
`227`	`226`	`public function decrement(string $key, int $offset = 1)`
`228`	`227`	`{`
`@@ -237,7 +236,7 @@ public function decrement(string $key, int $offset = 1)`
`237`	`236`	`}`
`238`	`237`
`239`	`238`	`/**`
`240`		`- * {@inheritDoc}`
	`239`	`+ * @inheritDoc`
`241`	`240`	`*/`
`242`	`241`	`public function delete($key): bool`
`243`	`242`	`{`
`@@ -252,7 +251,7 @@ public function delete($key): bool`
`252`	`251`	`}`
`253`	`252`
`254`	`253`	`/**`
`255`		`- * {@inheritDoc}`
	`254`	`+ * @inheritDoc`
`256`	`255`	`*/`
`257`	`256`	`public function deleteMultiple($data): bool`
`258`	`257`	`{`
`@@ -267,7 +266,7 @@ public function deleteMultiple($data): bool`
`267`	`266`	`}`
`268`	`267`
`269`	`268`	`/**`
`270`		`- * {@inheritDoc}`
	`269`	`+ * @inheritDoc`
`271`	`270`	`*/`
`272`	`271`	`public function clear(): bool`
`273`	`272`	`{`
`@@ -282,7 +281,7 @@ public function clear(): bool`
`282`	`281`	`}`
`283`	`282`
`284`	`283`	`/**`
`285`		`- * {@inheritDoc}`
	`284`	`+ * @inheritDoc`
`286`	`285`	`*/`
`287`	`286`	`public function groups(): array`
`288`	`287`	`{`
`@@ -316,7 +315,7 @@ public function setConfig($key, $value = null, $merge = true)`
`316`	`315`	`}`
`317`	`316`
`318`	`317`	`/**`
`319`		`- * {@inheritDoc}`
	`318`	`+ * @inheritDoc`
`320`	`319`	`*/`
`321`	`320`	`public function clearGroup(string $group): bool`
`322`	`321`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`class ComposerController extends DebugKitController`
`27`	`27`	`{`
`28`	`28`	`/**`
`29`		`- * {@inheritDoc}`
	`29`	`+ * @inheritDoc`
`30`	`30`	`*/`
`31`	`31`	`public function initialize(): void`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* Contains methods for Providing list of files.`
`22`		`- *`
`23`	`22`	`*/`
`24`	`23`	`class DebugInclude`
`25`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* A CakeLog listener which saves having to munge files or other configured loggers.`
`21`		`- *`
`22`	`21`	`*/`
`23`	`22`	`class DebugKitLog extends BaseLog`
`24`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* Represents the result of an already sent email`
`19`		`- *`
`20`	`19`	`*/`
`21`	`20`	`class SentMailResult extends AbstractResult`
`22`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,6 @@`
`21`	`21`
`22`	`22`	`/**`
`23`	`23`	`* Provides a list of deprecated methods for the current request`
`24`		`- *`
`25`	`24`	`*/`
`26`	`25`	`class DeprecationsPanel extends DebugPanel`
`27`	`26`	`{`