Merge pull request #140 from openeuropa/tighten-coding-standards

openeuropa · Jul 1, 2020 · e7cc2fa · e7cc2fa
2 parents 4d1884e + c951e51
commit e7cc2fa
Show file tree

Hide file tree

Showing 43 changed files with 320 additions and 179 deletions.
diff --git a/composer.json b/composer.json
@@ -16,7 +16,8 @@
     },
     "require-dev": {
         "openeuropa/code-review": "~1.0.0-beta3",
-        "phpunit/phpunit": "~6.0||~7.0"
+        "phpunit/phpunit": "~6.0||~7.0",
+        "slevomat/coding-standard": "~6.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/grumphp.yml.dist b/grumphp.yml.dist
@@ -1,6 +1,7 @@
 imports:
   - { resource: vendor/openeuropa/code-review/dist/library-conventions.yml }
 parameters:
+  tasks.phpcs.standard: phpcs.xml
   tasks.phpcs.ignore_patterns:
     - vendor/
     - loadTasks.php

diff --git a/phpcs-ruleset.xml b/phpcs-ruleset.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+<!-- PHP_CodeSniffer ruleset for TaskRunner. -->
+<!-- See http://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
+<ruleset name="TaskRunner">
+    <description>TaskRunner coding standard</description>
+
+    <!-- Include the Slevomat sniffs. -->
+    <rule ref="./vendor/squizlabs/php_codesniffer/src/Standards/PSR12" />
+    <config name="installed_paths" value="../../slevomat/coding-standard"/>
+
+    <!-- Exclude unsupported file types. -->
+    <exclude-pattern>*.gif</exclude-pattern>
+    <exclude-pattern>*.less</exclude-pattern>
+    <exclude-pattern>*.png</exclude-pattern>
+
+    <!-- Minified files don't have to comply with coding standards. -->
+    <exclude-pattern>*.min.css</exclude-pattern>
+    <exclude-pattern>*.min.js</exclude-pattern>
+
+    <!-- Require classes to be documented using docblock comments. -->
+    <rule ref="PEAR.Commenting.ClassComment.Missing"/>
+    <rule ref="PEAR.Commenting.ClassComment.WrongStyle"/>
+    <rule ref="Squiz.CSS.EmptyClassDefinition"/>
+
+    <!-- Require the strict types declaration in every PHP file. -->
+    <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
+        <properties>
+            <property name="newlinesCountBetweenOpenTagAndDeclare" value="2"/>
+            <property name="spacesCountAroundEqualsSign" value="0"/>
+        </properties>
+    </rule>
+
+    <!-- Detect unused use statements. -->
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses"/>
+
+    <!-- Require nullable types to be preceded by the nullability symbol. -->
+    <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
+
+    <!-- Forbid obsolete annotations which are superseded by annotations and version control. -->
+    <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
+        <properties>
+            <property name="forbiddenAnnotations" type="array">
+                <element value="@author"/>
+                <element value="@created"/>
+                <element value="@copyright"/>
+                <element value="@license"/>
+                <element value="@package"/>
+                <element value="@version"/>
+            </property>
+        </properties>
+    </rule>
+
+    <!-- Forbid unhelpful documentation auto-generated by IDEs. -->
+    <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
+        <properties>
+            <property name="forbiddenCommentPatterns" type="array">
+                <element value="/^Class [a-zA-z]*\.?$/"/>
+                <element value="/^Interface [a-zA-z]*\.?$/"/>
+            </property>
+        </properties>
+    </rule>
+
+    <!-- Enforce correct formatting of type hints for return types. -->
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
+
+    <!-- Use statements should be ordered alphabetically. -->
+    <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
+        <properties>
+            <property name="caseSensitive" value="true"/>
+        </properties>
+    </rule>
+
+    <!-- The concatenation operator should be surrounded with a space. -->
+    <rule ref="Squiz.Strings.ConcatenationSpacing">
+        <properties>
+            <property name="spacing" value="1"/>
+            <property name="ignoreNewlines" value="true"/>
+        </properties>
+    </rule>
+</ruleset>
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="task-runner">
+  <description>PHP CodeSniffer configuration for TaskRunner.</description>
+  <rule ref="phpcs-ruleset.xml"/>
+  <file>src</file>
+  <file>tests</file>
+</ruleset>
diff --git a/src/Commands/AbstractCommands.php b/src/Commands/AbstractCommands.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 use Consolidation\AnnotatedCommand\AnnotationData;
@@ -15,9 +17,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 
 /**
- * Class AbstractCommands
- *
- * @package OpenEuropa\TaskRunner\Commands
+ * Base class for commands.
  */
 abstract class AbstractCommands implements BuilderAwareInterface, IOAwareInterface, ConfigAwareInterface
 {
@@ -34,7 +34,7 @@ abstract class AbstractCommands implements BuilderAwareInterface, IOAwareInterfa
      */
     public function getConfigurationFile()
     {
-        return __DIR__.'/../../config/commands/base.yml';
+        return __DIR__ . '/../../config/commands/base.yml';
     }
 
     /**
@@ -115,7 +115,7 @@ public function initializeValuelessOptions(InputInterface $input, AnnotationData
      */
     protected function getBin($name)
     {
-        $filename = $this->getConfig()->get('runner.bin_dir').'/'.$name;
+        $filename = $this->getConfig()->get('runner.bin_dir') . '/' . $name;
         if (!file_exists($filename) && !$this->isSimulating()) {
             throw new TaskException($this, "Executable '{$filename}' not found.");
         }

diff --git a/src/Commands/AbstractDrupalCommands.php b/src/Commands/AbstractDrupalCommands.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 use Consolidation\AnnotatedCommand\CommandData;
@@ -12,7 +14,7 @@
 use Symfony\Component\Yaml\Yaml;
 
 /**
- * Class DrupalCommands.
+ * Base class for Drupal commands.
  */
 abstract class AbstractDrupalCommands extends AbstractCommands implements FilesystemAwareInterface
 {
@@ -37,7 +39,7 @@ public function getDrupal()
      */
     public function getConfigurationFile()
     {
-        return __DIR__.'/../../config/commands/drupal.yml';
+        return __DIR__ . '/../../config/commands/drupal.yml';
     }
 
     /**
@@ -94,10 +96,11 @@ public function validateSiteInstall(CommandData $commandData)
         ]);
 
         // Check if required files/folders exist and they are writable.
-        $requiredFiles = [$siteDirectory, $siteDirectory.'/settings.php'];
+        $requiredFiles = [$siteDirectory, $siteDirectory . '/settings.php'];
         foreach ($requiredFiles as $requiredFile) {
             if (file_exists($requiredFile) && !is_writable($requiredFile)) {
-                throw new \Exception(sprintf('The file/folder %s must be writable for installation to continue.', $requiredFile));
+                $message = 'The file/folder %s must be writable for installation to continue.';
+                throw new \Exception(sprintf($message, $requiredFile));
             }
         }
     }
@@ -162,15 +165,16 @@ public function siteInstall(array $options = [
     ])
     {
         if ($options['database-type']) {
-            $this->io()->warning("Option 'database-type' is deprecated and it will be removed in 1.0.0. Use 'database-scheme' instead.");
+            $message = "'database-type' is deprecated and will be removed in 1.0.0. Use 'database-scheme' instead.";
+            $this->io()->warning($message);
             $options['database-scheme'] = $options['database-type'];
         }
         if ($options['config-dir']) {
             $this->io()->warning("The 'config-dir' option is deprecated. Use 'existing-config' instead.");
             $options['existing-config'] = true;
         }
 
-        $drush = $this->getConfig()->get('runner.bin_dir').'/drush';
+        $drush = $this->getConfig()->get('runner.bin_dir') . '/drush';
         $task = $this->taskDrush($drush)
             ->root($options['root'])
             ->siteName($options['site-name'])
@@ -312,8 +316,9 @@ public function drushSetup(array $options = [
         $yaml = Yaml::dump($config->get('drupal.drush'));
 
         return $this->collectionBuilder()->addTaskList([
-            $this->taskWriteConfiguration($options['root'].'/sites/default/drushrc.php', $config)->setConfigKey('drupal.drush'),
-            $this->taskWriteToFile($options['config-dir'].'/drush.yml')->text($yaml),
+            $this->taskWriteConfiguration($options['root'] . '/sites/default/drushrc.php', $config)
+                ->setConfigKey('drupal.drush'),
+            $this->taskWriteToFile($options['config-dir'] . '/drush.yml')->text($yaml),
         ]);
     }
 
@@ -358,9 +363,10 @@ public function settingsSetup(array $options = [
         'skip-permissions-setup' => false,
     ])
     {
-        $settings_default_path = $options['root'] . '/sites/' . $options['sites-subdir'] . '/default.settings.php';
-        $settings_path = $options['root'] . '/sites/' . $options['sites-subdir'] . '/settings.php';
-        $settings_override_path = $options['root'] . '/sites/' . $options['sites-subdir'] . '/' . $options['settings-override-file'];
+        $base_path = $options['root'] . '/sites/' . $options['sites-subdir'] . '/';
+        $settings_default_path = $base_path . 'default.settings.php';
+        $settings_path = $base_path . 'settings.php';
+        $settings_override_path = $base_path . $options['settings-override-file'];
 
         // Save the filename of the override file in a single variable to use it
         // in the heredoc variable $custom_config hereunder.

diff --git a/src/Commands/ChangelogCommands.php b/src/Commands/ChangelogCommands.php
@@ -1,15 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 use OpenEuropa\TaskRunner\Contract\ComposerAwareInterface;
 use OpenEuropa\TaskRunner\Traits\ComposerAwareTrait;
 use Symfony\Component\Console\Input\InputOption;
 
 /**
- * Class ChangelogCommands
- *
- * @package OpenEuropa\TaskRunner\Commands
+ * Command for generating a changelog.
  */
 class ChangelogCommands extends AbstractCommands implements ComposerAwareInterface
 {
@@ -20,7 +20,7 @@ class ChangelogCommands extends AbstractCommands implements ComposerAwareInterfa
      */
     public function getConfigurationFile()
     {
-        return __DIR__.'/../../config/commands/changelog.yml';
+        return __DIR__ . '/../../config/commands/changelog.yml';
     }
 
     /**

diff --git a/src/Commands/Drupal7Commands.php b/src/Commands/Drupal7Commands.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 /**

diff --git a/src/Commands/Drupal8Commands.php b/src/Commands/Drupal8Commands.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 /**

diff --git a/src/Commands/DrupalCommands.php b/src/Commands/DrupalCommands.php
@@ -1,15 +1,8 @@
 <?php
 
-namespace OpenEuropa\TaskRunner\Commands;
+declare(strict_types=1);
 
-use Consolidation\AnnotatedCommand\CommandData;
-use NuvoleWeb\Robo\Task as NuvoleWebTasks;
-use OpenEuropa\TaskRunner\Contract\FilesystemAwareInterface;
-use OpenEuropa\TaskRunner\Tasks as TaskRunnerTasks;
-use OpenEuropa\TaskRunner\Traits as TaskRunnerTraits;
-use Symfony\Component\Console\Event\ConsoleCommandEvent;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Yaml\Yaml;
+namespace OpenEuropa\TaskRunner\Commands;
 
 /**
  * Base class for commands that interact with a Drupal installation.

diff --git a/src/Commands/DynamicCommands.php b/src/Commands/DynamicCommands.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 use OpenEuropa\TaskRunner\Tasks as TaskRunnerTasks;

diff --git a/src/Commands/ReleaseCommands.php b/src/Commands/ReleaseCommands.php
@@ -1,13 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Commands;
 
 use Gitonomy\Git\Reference\Branch;
-use OpenEuropa\TaskRunner\Contract\ComposerAwareInterface;
-use OpenEuropa\TaskRunner\Contract\RepositoryAwareInterface;
-use OpenEuropa\TaskRunner\Contract\TimeAwareInterface;
-use OpenEuropa\TaskRunner\Traits\ComposerAwareTrait;
+use OpenEuropa\TaskRunner\Contract\ComposerAwareInterface as ComposerAware;
+use OpenEuropa\TaskRunner\Contract\RepositoryAwareInterface as RepositoryAware;
+use OpenEuropa\TaskRunner\Contract\TimeAwareInterface as TimeAware;
 use OpenEuropa\TaskRunner\Tasks as TaskRunnerTasks;
+use OpenEuropa\TaskRunner\Traits\ComposerAwareTrait;
 use OpenEuropa\TaskRunner\Traits\RepositoryAwareTrait;
 use OpenEuropa\TaskRunner\Traits\TimeAwareTrait;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
@@ -16,7 +18,7 @@
 /**
  * Project release commands.
  */
-class ReleaseCommands extends AbstractCommands implements ComposerAwareInterface, RepositoryAwareInterface, TimeAwareInterface
+class ReleaseCommands extends AbstractCommands implements ComposerAware, RepositoryAware, TimeAware
 {
     use ComposerAwareTrait;
     use RepositoryAwareTrait;
@@ -139,9 +141,10 @@ private function getVersionString()
         $tag = end($tags);
 
         // Resolve local branch name for current HEAD.
-        $branches = array_filter($repository->getReferences()->getBranches(), function (Branch $branch) use ($revision) {
+        $filter = function (Branch $branch) use ($revision) {
             return $branch->isLocal() && $branch->getRevision() === $revision;
-        });
+        };
+        $branches = array_filter($repository->getReferences()->getBranches(), $filter);
         $branch = reset($branches);
 
         // Make sure we always have a version string, i.e. when in detached state.

diff --git a/src/Contract/ComposerAwareInterface.php b/src/Contract/ComposerAwareInterface.php
@@ -1,13 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Contract;
 
 use OpenEuropa\TaskRunner\Services\Composer;
 
 /**
- * Interface ComposerAwareInterface
- *
- * @package OpenEuropa\TaskRunner\Contract
+ * Interface for classes that interact with the composer manifest.
  */
 interface ComposerAwareInterface
 {

diff --git a/src/Contract/ConfigProviderInterface.php b/src/Contract/ConfigProviderInterface.php
@@ -4,7 +4,6 @@
 
 namespace OpenEuropa\TaskRunner\Contract;
 
-use OpenEuropa\TaskRunner\Traits\ConfigFromFilesTrait;
 use Robo\Config\Config;
 
 /**
@@ -31,7 +30,7 @@ interface ConfigProviderInterface
      *
      * @var string
      */
-    const DEFAULT_CONFIG_LOCATION = 'openeuropa/taskrunner/runner.yml';
+    public const DEFAULT_CONFIG_LOCATION = 'openeuropa/taskrunner/runner.yml';
 
     /**
      * Adds or overrides configuration.

diff --git a/src/Contract/FilesystemAwareInterface.php b/src/Contract/FilesystemAwareInterface.php
@@ -1,11 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OpenEuropa\TaskRunner\Contract;
 
 /**
- * Interface FilesystemAwareTrait
- *
- * @package OpenEuropa\TaskRunner\Contract
+ * Interface for classes that have to interact with the filesystem.
  */
 interface FilesystemAwareInterface
 {