qa: apply CS rules

Applies CS rules, and ensures psalm tests pass following changes. Signed-off-by: Matthew Weier O'Phinney <[email protected]>
laminas-api-tools · Jun 7, 2021 · a9da9c5 · a9da9c5
1 parent 3a0f6f8
commit a9da9c5
Show file tree

Hide file tree

Showing 18 changed files with 224 additions and 276 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+/.phpcs-cache
 /.phpunit.result.cache
 /clover.xml
 /coveralls-upload.json

diff --git a/config/module.config.php b/config/module.config.php
@@ -2,8 +2,6 @@
 
 /**
  * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
  */
 
 namespace Laminas\ApiTools\Configuration;
@@ -19,13 +17,13 @@
         // manipulated by the ConfigWriter should use ::class notation
         // 'class_name_scalars' => true,
     ],
-    'service_manager' => [
+    'service_manager'         => [
         // Legacy Zend Framework aliases
-        'aliases' => [
-            \ZF\Configuration\ConfigResource::class => ConfigResource::class,
+        'aliases'   => [
+            \ZF\Configuration\ConfigResource::class        => ConfigResource::class,
             \ZF\Configuration\ConfigResourceFactory::class => ConfigResourceFactory::class,
-            \ZF\Configuration\ConfigWriter::class => ConfigWriter::class,
-            \ZF\Configuration\ModuleUtils::class => ModuleUtils::class,
+            \ZF\Configuration\ConfigWriter::class          => ConfigWriter::class,
+            \ZF\Configuration\ModuleUtils::class           => ModuleUtils::class,
         ],
         'factories' => [
             ConfigResource::class        => Factory\ConfigResourceFactory::class,

diff --git a/src/ConfigResource.php b/src/ConfigResource.php
@@ -1,23 +1,29 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration;
 
 use Laminas\Config\Writer\WriterInterface as ConfigWriter;
 use Laminas\Stdlib\ArrayUtils;
 use stdClass;
 use Traversable;
 
+use function array_key_exists;
+use function array_merge;
+use function array_shift;
+use function explode;
+use function file_exists;
+use function function_exists;
+use function get_class;
+use function gettype;
+use function ini_get;
+use function is_array;
+use function is_object;
+use function opcache_invalidate;
+use function sprintf;
+
 class ConfigResource
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $config;
 
     /**
@@ -34,15 +40,12 @@ class ConfigResource
      */
     protected $opcacheEnabled = false;
 
-    /**
-     * @var ConfigWriter
-     */
+    /** @var ConfigWriter */
     protected $writer;
 
     /**
      * @param array $config
      * @param string $fileName
-     * @param ConfigWriter $writer
      */
     public function __construct(array $config, $fileName, ConfigWriter $writer)
     {
@@ -202,7 +205,8 @@ public function replaceKey($keys, $value, array $config)
 
         // If key does not exist, or the current value is not an associative
         // array, create nested set and return
-        if (! isset($config[$key])
+        if (
+            ! isset($config[$key])
             || ! ArrayUtils::isHashTable($config[$key])
         ) {
             $config[$key] = $this->replaceKey($keys, $value, []);
@@ -262,9 +266,9 @@ public function traverseArray(array $array, $currentKey = '')
     {
         $flattened = [];
         foreach ($array as $key => $value) {
-            $targetKey = ('' === $currentKey) ? $key : $currentKey . '.' . $key;
+            $targetKey = '' === $currentKey ? $key : $currentKey . '.' . $key;
             if (is_array($value)) {
-                $value = $this->traverseArray($value, $targetKey);
+                $value     = $this->traverseArray($value, $targetKey);
                 $flattened = array_merge($flattened, $value);
                 continue;
             }
@@ -291,7 +295,7 @@ public function createNestedKeyValuePair(&$patchValues, $key, $value)
             throw new Exception\InvalidArgumentException(sprintf(
                 '%s expects the $patchValues argument to be an array; received %s',
                 __METHOD__,
-                (is_object($patchValues) ? get_class($patchValues) : gettype($patchValues))
+                is_object($patchValues) ? get_class($patchValues) : gettype($patchValues)
             ));
         }
 
@@ -312,7 +316,7 @@ protected function extractAndSet(array $keys, $value, &$array): void
             if (! isset($array[$key]) || ! is_array($array[$key])) {
                 $array[$key] = [];
             }
-            $reference   = &$array[$key];
+            $reference = &$array[$key];
             $this->extractAndSet($keys, $value, $reference);
             return;
         }

diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Exception;
 
 interface ExceptionInterface

diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Exception;
 
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface

diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Exception;
 
 class RuntimeException extends \RuntimeException implements ExceptionInterface

diff --git a/src/Factory/ConfigResourceFactory.php b/src/Factory/ConfigResourceFactory.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Factory;
 
 use Interop\Container\ContainerInterface;
@@ -16,14 +10,14 @@ class ConfigResourceFactory
 {
     /**
      * Default configuration file to use.
-     * @param string
+     *
+     * @var string
      */
     private $defaultConfigFile = 'config/autoload/development.php';
 
     /**
      * Create and return a ConfigResource.
      *
-     * @param ContainerInterface $container
      * @return ConfigResource
      */
     public function __invoke(ContainerInterface $container)
@@ -40,7 +34,6 @@ public function __invoke(ContainerInterface $container)
     /**
      * Fetch configuration from the container, if possible.
      *
-     * @param ContainerInterface $container
      * @return array
      */
     private function fetchConfig(ContainerInterface $container)

diff --git a/src/Factory/ConfigWriterFactory.php b/src/Factory/ConfigWriterFactory.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Factory;
 
 use Interop\Container\ContainerInterface;
@@ -16,7 +10,6 @@ class ConfigWriterFactory
     /**
      * Create and return a PhpArray config writer.
      *
-     * @param ContainerInterface $container
      * @return PhpArray
      */
     public function __invoke(ContainerInterface $container)
@@ -37,7 +30,6 @@ public function __invoke(ContainerInterface $container)
     /**
      * Discover the $key flag from configuration, if present.
      *
-     * @param ContainerInterface $container
      * @param string $key
      * @return bool
      */

diff --git a/src/Factory/ModuleUtilsFactory.php b/src/Factory/ModuleUtilsFactory.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Factory;
 
 use Interop\Container\ContainerInterface;
@@ -14,7 +8,6 @@
 class ModuleUtilsFactory
 {
     /**
-     * @param ContainerInterface $container
      * @return ModuleUtils
      */
     public function __invoke(ContainerInterface $container)

diff --git a/src/Factory/ResourceFactoryFactory.php b/src/Factory/ResourceFactoryFactory.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration\Factory;
 
 use Interop\Container\ContainerInterface;
@@ -16,7 +10,6 @@
 class ResourceFactoryFactory
 {
     /**
-     * @param ContainerInterface $container
      * @return ResourceFactory
      */
     public function __invoke(ContainerInterface $container)

diff --git a/src/Module.php b/src/Module.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration;
 
 /**

diff --git a/src/ModuleUtils.php b/src/ModuleUtils.php
@@ -1,31 +1,31 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools-configuration for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools-configuration/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools-configuration/blob/master/LICENSE.md New BSD License
- */
-
 namespace Laminas\ApiTools\Configuration;
 
 use Laminas\ModuleManager\ModuleManager;
 use ReflectionObject;
 
+use function array_key_exists;
+use function dirname;
+use function file_exists;
+use function in_array;
+use function is_dir;
+use function preg_match;
+use function sprintf;
+use function str_replace;
+use function strtoupper;
+use function substr;
+
+use const PHP_OS;
+
 class ModuleUtils
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $modules = [];
 
-    /**
-     * @var array
-     */
+    /** @var array */
     protected $moduleData = [];
 
-    /**
-     * @param  ModuleManager $modules
-     */
     public function __construct(ModuleManager $modules)
     {
         $this->modules = $modules->getLoadedModules();
@@ -36,8 +36,8 @@ public function __construct(ModuleManager $modules)
      *
      * @param  string $moduleName
      * @return string
-     * @throws Exception\InvalidArgumentException if module does not exist
-     * @throws Exception\RuntimeException if unable to locate module path
+     * @throws Exception\InvalidArgumentException If module does not exist.
+     * @throws Exception\RuntimeException If unable to locate module path.
      */
     public function getModulePath($moduleName)
     {
@@ -57,8 +57,8 @@ public function getModulePath($moduleName)
      *
      * @param  string $moduleName
      * @return string
-     * @throws Exception\InvalidArgumentException if module does not exist
-     * @throws Exception\RuntimeException if unable to locate config path
+     * @throws Exception\InvalidArgumentException If module does not exist.
+     * @throws Exception\RuntimeException If unable to locate config path.
      */
     public function getModuleConfigPath($moduleName)
     {
@@ -76,7 +76,7 @@ public function getModuleConfigPath($moduleName)
     /**
      * Validate that the module actually exists
      *
-     * @throws Exception\InvalidArgumentException if the module does not exist
+     * @throws Exception\InvalidArgumentException If the module does not exist.
      */
     protected function validateModule(string $moduleName): void
     {
@@ -93,8 +93,8 @@ protected function validateModule(string $moduleName): void
      */
     protected function deriveModuleData(string $moduleName): void
     {
-        $configPath = $this->deriveModuleConfig($moduleName);
-        $modulePath = dirname(dirname($configPath));
+        $configPath                    = $this->deriveModuleConfig($moduleName);
+        $modulePath                    = dirname(dirname($configPath));
         $this->moduleData[$moduleName] = [
             'config' => $configPath,
             'path'   => $modulePath,
@@ -104,7 +104,7 @@ protected function deriveModuleData(string $moduleName): void
     /**
      * Determines the location of the module configuration file
      *
-     * @throws Exception\RuntimeException if unable to find the configuration file
+     * @throws Exception\RuntimeException If unable to find the configuration file.
      */
     protected function deriveModuleConfig(string $moduleName): string
     {
@@ -147,7 +147,8 @@ protected function recurseTree(string $path)
             return $path . '/config/module.config.php';
         }
 
-        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN'
+        if (
+            strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN'
             && (in_array($path, ['.', '/', '\\\\', '\\'])
                 || preg_match('#[a-z]:(\\\\|/{1,2})$#i', $path))
         ) {