Merge pull request #1635 from spryker/bugfix/cs

Fix CS using Spryker+Slevomat cs ruleset.

Author: dereuromark

.license

@@ -0,0 +1,7 @@
+/**
+ * This file is part of the Propel package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license MIT License
+ */

composer.json

@@ -27,6 +27,8 @@
         "psr/log": "^1.0"
     },
     "require-dev": {
+        "ext-pdo": "*",
+        "ext-json": "*",
         "monolog/monolog": "^1.3",
         "phpstan/phpstan": "^0.12.4",
         "phpunit/phpunit": "^7.5.15",
@@ -44,11 +46,10 @@
         "bin/propel"
     ],
     "scripts": {
-        "cs-check": "phpcs -p -s --standard=vendor/spryker/code-sniffer/Spryker/ruleset.xml src/",
-        "cs-fix": "phpcbf -p --standard=vendor/spryker/code-sniffer/Spryker/ruleset.xml src/",
-        "stan": [
-            "vendor/bin/phpstan analyze"
-        ]
+        "cs-check": "phpcs -p -s --standard=config/phpcs.xml src/",
+        "cs-fix": "phpcbf -p --standard=config/phpcs.xml src/",
+        "stan": "vendor/bin/phpstan analyze",
+        "stan-baseline": "vendor/bin/phpstan analyze --generate-baseline"
     },
     "extra": {
         "branch-alias": {

config/phpcs.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<ruleset name="Propel">
+    <description>
+        Propel Coding Standard.
+
+        Extends Spryker+Slevomatik Coding Standard.
+    </description>
+
+    <rule ref="vendor/spryker/code-sniffer/Spryker/ruleset.xml"/>
+
+    <exclude-pattern>*/templates/*</exclude-pattern>
+
+    <!-- exclude for now -->
+    <rule ref="Spryker.Commenting.FileDocBlock">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Spryker.ControlStructures.NoInlineAssignment">
+        <severity>0</severity>
+    </rule>
+    <rule ref="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison">
+        <severity>0</severity>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements">
+        <severity>0</severity>
+    </rule>
+
+    <rule ref="Spryker.Commenting.DocBlockReturnSelf">
+        <severity>0</severity>
+    </rule>
+
+</ruleset>

phpstan-baseline.neon

@@ -1,7 +1,7 @@
 includes:
     - phpstan-baseline.neon
 parameters:
-    level: 5
+    level: 6
     checkGenericClassInNonGenericObjectType: false
     checkMissingIterableValueType: false
     paths:
@@ -25,4 +25,3 @@ parameters:
         -
         	message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\TreeBuilder\\:\\:root\\(\\)\\.$#"
         	path: src/Propel/Common/Config/PropelConfiguration.php
-        - '#PHPDoc tag @throws with type .+FileLoaderLoadException|.+LoaderLoadException is not subtype of Throwable#'

phpstan.neon

@@ -13,8 +13,8 @@
 use Propel\Common\Config\Exception\InvalidArgumentException;
 use Propel\Common\Config\Exception\InvalidConfigurationException;
 use Propel\Common\Config\Loader\DelegatingLoader;
-use Symfony\Component\Finder\Finder;
 use Symfony\Component\Config\Definition\Processor;
+use Symfony\Component\Finder\Finder;
 
 /**
  * Class ConfigurationManager
@@ -25,7 +25,7 @@
  */
 class ConfigurationManager
 {
-    const CONFIG_FILE_NAME = 'propel';
+    public const CONFIG_FILE_NAME = 'propel';
 
     /**
      * Array of configuration values
@@ -37,8 +37,8 @@ class ConfigurationManager
     /**
      * Load and validate configuration values from a file.
      *
-     * @param string|null $filename  Configuration file name or directory in which resides the configuration file.
-     * @param array  $extraConf Array of configuration properties, to be merged with those loaded from file.
+     * @param string|null $filename Configuration file name or directory in which resides the configuration file.
+     * @param array $extraConf Array of configuration properties, to be merged with those loaded from file.
      *                          It's useful when passing configuration parameters from command line.
      */
     public function __construct($filename = null, $extraConf = [])
@@ -61,7 +61,8 @@ public function get()
      * Return a specific section of the configuration array.
      * It ca be useful to get, in example, only 'generator' values.
      *
-     * @param  string $section the section to be returned
+     * @param string $section the section to be returned
+     *
      * @return array|null
      */
     public function getSection($section)
@@ -81,9 +82,11 @@ public function getSection($section)
      * is expressed by:
      * <code>'database.adapter.mysql.tableType</code>
      *
-     * @param  string                                                   $name The name of property, expressed as a dot separated level hierarchy
+     * @param string $name The name of property, expressed as a dot separated level hierarchy
+     *
      * @throws \Propel\Common\Config\Exception\InvalidArgumentException
-     * @return mixed                                                    The configuration property
+     *
+     * @return mixed The configuration property
      */
     public function getConfigProperty($name)
     {
@@ -107,12 +110,13 @@ public function getConfigProperty($name)
      * Return an array of parameters relative to configured connections, for `runtime` or `generator` section.
      * It's useful for \Propel\Generator\Command\ConfigConvertCommand class
      *
-     * @param  string     $section `runtime` or `generator` section
+     * @param string $section `runtime` or `generator` section
+     *
      * @return array|null
      */
     public function getConnectionParametersArray($section = 'runtime')
     {
-        if (!in_array($section, ['runtime', 'generator'])) {
+        if (!in_array($section, ['runtime', 'generator'], true)) {
             return null;
         }
 
@@ -132,8 +136,9 @@ public function getConnectionParametersArray($section = 'runtime')
      * Only one configuration file is supposed to be found.
      * This method also looks for a '.dist' configuration file and loads it.
      *
-     * @param string|null $fileName  Configuration file name or directory in which resides the configuration file.
+     * @param string|null $fileName Configuration file name or directory in which resides the configuration file.
      * @param array|null $extraConf Array of configuration properties, to be merged with those loaded from file.
+     *
      * @return void
      */
     protected function load($fileName, $extraConf)
@@ -144,19 +149,19 @@ protected function load($fileName, $extraConf)
             $fileName = self::CONFIG_FILE_NAME;
         }
 
-        if (null === $extraConf) {
+        if ($extraConf === null) {
             $extraConf = [];
         }
 
-        if (static::CONFIG_FILE_NAME === $fileName) {
+        if ($fileName === static::CONFIG_FILE_NAME) {
             $files = $this->getFiles($dirs, $fileName);
             $distFiles = $this->getFiles($dirs, $fileName, true);
 
             $numFiles = count($files);
             $numDistFiles = count($distFiles);
 
             //allow to load only .dist file
-            if (0 === $numFiles && 1 === $numDistFiles) {
+            if ($numFiles === 0 && $numDistFiles === 1) {
                 $files = $distFiles;
                 $numFiles = 1;
             }
@@ -171,21 +176,22 @@ protected function load($fileName, $extraConf)
             $fileName = $file->getPathName();
         }
 
-        $this->config = array_replace_recursive($this->loadFile($fileName.'.dist'), $this->loadFile($fileName), $extraConf);
+        $this->config = array_replace_recursive($this->loadFile($fileName . '.dist'), $this->loadFile($fileName), $extraConf);
     }
 
     /**
      * Validate the configuration array via Propel\Common\Config\PropelConfiguration class
      * and add default values.
      *
-     * @param array $extraConf Extra configuration to merge before processing. It's useful when a child class overwrite
+     * @param array|null $extraConf Extra configuration to merge before processing. It's useful when a child class overwrite
      *                         the constructor to pass a built-in array of configuration, without load it from file. I.e.
      *                         Propel\Generator\Config\QuickGeneratorConfig class.
+     *
      * @return void
      */
     protected function process($extraConf = null)
     {
-        if (null === $extraConf && count($this->config) <= 0) {
+        if ($extraConf === null && count($this->config) <= 0) {
             return;
         }
 
@@ -205,9 +211,11 @@ protected function process($extraConf = null)
     /**
      * Return an array of configuration files in the $dirs directories
      *
-     * @param array  $dirs     The directories where to find the configuration files
+     * @param array $dirs The directories where to find the configuration files
      * @param string $fileName The name of the file
-     * @param bool   $dist     If search .dist files
+     * @param bool $dist If search .dist files
+     *
+     * @throws \Propel\Common\Config\Exception\InvalidArgumentException
      *
      * @return array
      */
@@ -216,7 +224,7 @@ private function getFiles($dirs, $fileName, $dist = false)
         $finder = new Finder();
         $fileName .= '.{php,inc,ini,properties,yaml,yml,xml,json}';
 
-        if (true === $dist) {
+        if ($dist === true) {
             $fileName .= '.dist';
         }
 
@@ -236,7 +244,6 @@ private function getFiles($dirs, $fileName, $dist = false)
      * @param string $fileName The configuration file
      *
      * @return array|mixed
-     * @throws \Symfony\Component\Config\Exception\LoaderLoadException|\Symfony\Component\Config\Exception\FileLoaderLoadException
      */
     private function loadFile($fileName)
     {
@@ -252,7 +259,8 @@ private function loadFile($fileName)
     /**
      * Return the directories where to find the configuration file.
      *
-     * @param  string|null $fileName
+     * @param string|null $fileName
+     *
      * @return array
      */
     private function getDirs($fileName)
@@ -268,11 +276,11 @@ private function getDirs($fileName)
         }
 
         $dirs[] = $currentDir;
-        if (is_dir($currentDir.'/conf')) {
-            $dirs[] = $currentDir.'/conf';
+        if (is_dir($currentDir . '/conf')) {
+            $dirs[] = $currentDir . '/conf';
         }
-        if (is_dir($currentDir.'/config')) {
-            $dirs[] = $currentDir.'/config';
+        if (is_dir($currentDir . '/config')) {
+            $dirs[] = $currentDir . '/config';
         }
 
         return $dirs;
@@ -296,6 +304,8 @@ private function cleanupSlaveConnections()
      * If not defined, set `runtime` and `generator` connections, based on `database.connections` property.
      * Check if runtime and generator connections are correctly defined.
      *
+     * @throws \Propel\Common\Config\Exception\InvalidConfigurationException
+     *
      * @return void
      */
     private function cleanupConnections()
@@ -314,14 +324,14 @@ private function cleanupConnections()
 
             foreach ($this->config[$section]['connections'] as $connection) {
                 if (!array_key_exists($connection, $this->config['database']['connections'])) {
-                    throw new InvalidConfigurationException("`$connection` isn't a valid configured connection (Section: propel.$section.connections). ".
-                        "Please, check your configured connections in `propel.database.connections` section of your configuration file.");
+                    throw new InvalidConfigurationException("`$connection` isn't a valid configured connection (Section: propel.$section.connections). " .
+                        'Please, check your configured connections in `propel.database.connections` section of your configuration file.');
                 }
             }
 
             if (!array_key_exists($defaultConnection = $this->config[$section]['defaultConnection'], $this->config['database']['connections'])) {
-                throw new InvalidConfigurationException("`$defaultConnection` isn't a valid configured connection (Section: propel.$section.defaultConnection). ".
-                    "Please, check your configured connections in `propel.database.connections` section of your configuration file.");
+                throw new InvalidConfigurationException("`$defaultConnection` isn't a valid configured connection (Section: propel.$section.defaultConnection). " .
+                    'Please, check your configured connections in `propel.database.connections` section of your configuration file.');
             }
         }
     }

src/Propel/Common/Config/ConfigurationManager.php

@@ -10,6 +10,8 @@
 
 namespace Propel\Common\Config\Exception;
 
-class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
+use InvalidArgumentException as CoreInvalidArgumentException;
+
+class InvalidArgumentException extends CoreInvalidArgumentException implements ExceptionInterface
 {
 }