Merge pull request #438 from jhedstrom/338-coding-standards

Enforce coding standards
jhedstrom · Dec 6, 2017 · ff385ab · ff385ab
2 parents ca50162 + d72c88c
commit ff385ab
Show file tree

Hide file tree

Showing 65 changed files with 2,113 additions and 1,840 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -83,6 +83,8 @@ before_script:
 
 script:
   - vendor/bin/parallel-lint src spec features fixtures
+  - vendor/bin/phpcs --standard=./phpcs-ruleset.xml -p
+  - vendor/bin/phpcs --standard=./phpcs-drupal-ruleset.xml -p
   - vendor/bin/phpspec run -f pretty --no-interaction
   - vendor/bin/behat -fprogress --strict
   - vendor/bin/behat -fprogress --profile=drupal${DRUPAL_VERSION} --strict

diff --git a/composer.json b/composer.json
@@ -27,7 +27,8 @@
     "phpspec/phpspec": "~2.0",
     "phpunit/phpunit": "3.7.*",
     "behat/mink-zombie-driver": "^1.2",
-    "jakub-onderka/php-parallel-lint": "^0.9.2"
+    "jakub-onderka/php-parallel-lint": "^0.9.2",
+    "drupal/coder": "^8.2"
   },
   "autoload": {
     "psr-0": {

diff --git a/fixtures/drupal6/modules/behat_test/behat_test.install b/fixtures/drupal6/modules/behat_test/behat_test.install
@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * @file
+ * Install hooks for the behat_test module.
+ */
+
 /**
  * Implements hook_install().
  */

diff --git a/fixtures/drupal6/modules/behat_test/behat_test.module b/fixtures/drupal6/modules/behat_test/behat_test.module
@@ -1 +1,6 @@
 <?php
+
+/**
+ * @file
+ * Intentionally empty file.
+ */
diff --git a/fixtures/drupal7/modules/behat_test/behat_test.features.field_base.inc b/fixtures/drupal7/modules/behat_test/behat_test.features.field_base.inc
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file
  * behat_test.features.field_base.inc
@@ -10,7 +11,7 @@
 function behat_test_field_default_field_bases() {
   $field_bases = array();
 
-  // Exported field_base: 'body'
+  // Exported field_base: 'body'.
   $field_bases['body'] = array(
     'active' => 1,
     'cardinality' => 1,
@@ -39,7 +40,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'text_with_summary',
   );
 
-  // Exported field_base: 'field_post_address'
+  // Exported field_base: 'field_post_address'.
   $field_bases['field_post_address'] = array(
     'active' => 1,
     'cardinality' => 2,
@@ -54,7 +55,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'addressfield',
   );
 
-  // Exported field_base: 'field_post_date'
+  // Exported field_base: 'field_post_date'.
   $field_bases['field_post_date'] = array(
     'active' => 1,
     'cardinality' => 1,
@@ -84,7 +85,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'datetime',
   );
 
-  // Exported field_base: 'field_post_dates'
+  // Exported field_base: 'field_post_dates'.
   $field_bases['field_post_dates'] = array(
     'active' => 1,
     'cardinality' => 1,
@@ -114,7 +115,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'datetime',
   );
 
-  // Exported field_base: 'field_post_links'
+  // Exported field_base: 'field_post_links'.
   $field_bases['field_post_links'] = array(
     'active' => 1,
     'cardinality' => -1,
@@ -144,7 +145,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'link_field',
   );
 
-  // Exported field_base: 'field_post_reference'
+  // Exported field_base: 'field_post_reference'.
   $field_bases['field_post_reference'] = array(
     'active' => 1,
     'cardinality' => -1,
@@ -175,7 +176,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'entityreference',
   );
 
-  // Exported field_base: 'field_post_select'
+  // Exported field_base: 'field_post_select'.
   $field_bases['field_post_select'] = array(
     'active' => 1,
     'cardinality' => -1,
@@ -202,7 +203,7 @@ function behat_test_field_default_field_bases() {
     'type' => 'list_text',
   );
 
-  // Exported field_base: 'field_tags'
+  // Exported field_base: 'field_tags'.
   $field_bases['field_tags'] = array(
     'active' => 1,
     'cardinality' => -1,

diff --git a/fixtures/drupal7/modules/behat_test/behat_test.features.field_instance.inc b/fixtures/drupal7/modules/behat_test/behat_test.features.field_instance.inc
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file
  * behat_test.features.field_instance.inc
@@ -10,7 +11,7 @@
 function behat_test_field_default_field_instances() {
   $field_instances = array();
 
-  // Exported field_instance: 'node-post-body'
+  // Exported field_instance: 'node-post-body'.
   $field_instances['node-post-body'] = array(
     'bundle' => 'post',
     'default_value' => NULL,
@@ -54,7 +55,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'node-post-field_post_address'
+  // Exported field_instance: 'node-post-field_post_address'.
   $field_instances['node-post-field_post_address'] = array(
     'bundle' => 'post',
     'default_value' => NULL,
@@ -109,7 +110,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'node-post-field_post_date'
+  // Exported field_instance: 'node-post-field_post_date'.
   $field_instances['node-post-field_post_date'] = array(
     'bundle' => 'post',
     'deleted' => 0,
@@ -162,7 +163,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'node-post-field_post_dates'
+  // Exported field_instance: 'node-post-field_post_dates'.
   $field_instances['node-post-field_post_dates'] = array(
     'bundle' => 'post',
     'deleted' => 0,
@@ -215,7 +216,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'node-post-field_post_links'
+  // Exported field_instance: 'node-post-field_post_links'.
   $field_instances['node-post-field_post_links'] = array(
     'bundle' => 'post',
     'default_value' => NULL,
@@ -272,7 +273,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'node-post-field_post_reference'
+  // Exported field_instance: 'node-post-field_post_reference'.
   $field_instances['node-post-field_post_reference'] = array(
     'bundle' => 'post',
     'default_value' => NULL,
@@ -311,7 +312,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'node-post-field_post_select'
+  // Exported field_instance: 'node-post-field_post_select'.
   $field_instances['node-post-field_post_select'] = array(
     'bundle' => 'post',
     'default_value' => NULL,
@@ -348,7 +349,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'user-user-field_post_address'
+  // Exported field_instance: 'user-user-field_post_address'.
   $field_instances['user-user-field_post_address'] = array(
     'bundle' => 'user',
     'default_value' => NULL,
@@ -397,7 +398,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'user-user-field_post_reference'
+  // Exported field_instance: 'user-user-field_post_reference'.
   $field_instances['user-user-field_post_reference'] = array(
     'bundle' => 'user',
     'default_value' => NULL,
@@ -430,7 +431,7 @@ function behat_test_field_default_field_instances() {
     ),
   );
 
-  // Exported field_instance: 'user-user-field_tags'
+  // Exported field_instance: 'user-user-field_tags'.
   $field_instances['user-user-field_tags'] = array(
     'bundle' => 'user',
     'default_value' => NULL,

diff --git a/fixtures/drupal7/modules/behat_test/behat_test.features.inc b/fixtures/drupal7/modules/behat_test/behat_test.features.inc
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file
  * behat_test.features.inc

diff --git a/fixtures/drupal7/modules/behat_test/behat_test.features.taxonomy.inc b/fixtures/drupal7/modules/behat_test/behat_test.features.taxonomy.inc
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file
  * behat_test.features.taxonomy.inc

diff --git a/fixtures/drupal7/modules/behat_test/behat_test.features.user_permission.inc b/fixtures/drupal7/modules/behat_test/behat_test.features.user_permission.inc
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file
  * behat_test.features.user_permission.inc

diff --git a/fixtures/drupal7/modules/behat_test/behat_test.module b/fixtures/drupal7/modules/behat_test/behat_test.module
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file
  * Code for the Behat test feature.

diff --git a/fixtures/drupal8/modules/behat_test/behat_test.info.yml b/fixtures/drupal8/modules/behat_test/behat_test.info.yml
@@ -2,8 +2,6 @@ name: Behat test
 type: module
 description: 'Test feature exposing basic configuration for Behat Drupal extension test.'
 package: Test
-version: '8.x-1.x-dev'
 core: '8.x'
-project: 'behat_test'
 dependencies:
   - language
diff --git a/fixtures/drupal8/modules/behat_test/behat_test.install b/fixtures/drupal8/modules/behat_test/behat_test.install
@@ -1,20 +1,25 @@
 <?php
 
 /**
- * Implements hook_install()
+ * @file
+ * Install hooks for the behat_test module.
+ */
+
+/**
+ * Implements hook_install().
  */
 function behat_test_install() {
   $storage = \Drupal::service('behat_test.config.storage.install');
 
   // Override Standard profile's user settings with our own.
-  $config_names = array(
+  $config_names = [
     'core.entity_form_mode.user.register',
     'core.entity_form_display.user.user.default',
     'core.entity_view_display.user.user.default',
     'core.entity_view_display.user.user.compact',
     'core.entity_view_mode.user.compact',
     'core.entity_view_mode.user.full',
-  );
+  ];
 
   foreach ($config_names as $config_name) {
     $data = $storage->read($config_name);

diff --git a/fixtures/drupal8/modules/behat_test/behat_test.services.yml b/fixtures/drupal8/modules/behat_test/behat_test.services.yml
@@ -2,4 +2,3 @@ services:
   behat_test.config.storage.install:
     class: Drupal\behat_test\Config\BehatTestExtensionInstallStorage
     arguments: ['@config.storage', 'config/install']
-
diff --git a/fixtures/drupal8/modules/behat_test/src/Config/BehatTestExtensionInstallStorage.php b/fixtures/drupal8/modules/behat_test/src/Config/BehatTestExtensionInstallStorage.php
@@ -1,16 +1,14 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\behat_test\Config\BehatTestExtensionInstallStorage
- */
-
 namespace Drupal\behat_test\Config;
 
 use Drupal\Core\Config\ExtensionInstallStorage;
 use Drupal\Core\Config\StorageInterface;
 use Drupal\Core\Extension\ExtensionDiscovery;
 
+/**
+ * Finds module folders.
+ */
 class BehatTestExtensionInstallStorage extends ExtensionInstallStorage {
 
   /**
@@ -29,7 +27,7 @@ protected function getAllFolders() {
     if (!isset($this->folders)) {
       $listing = new ExtensionDiscovery(\Drupal::root());
       $modules = $listing->scan('module');
-      $this->folders = $this->getComponentNames(array('behat_test' => $modules['behat_test']));
+      $this->folders = $this->getComponentNames(['behat_test' => $modules['behat_test']]);
     }
     return $this->folders;
   }

diff --git a/...ures/drupal8/modules/behat_test/src/Plugin/Field/FieldFormatter/AddressFieldFormatter.php b/...ures/drupal8/modules/behat_test/src/Plugin/Field/FieldFormatter/AddressFieldFormatter.php
@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains Drupal\behat_test\Plugin\Field\FieldFormatter\AddressFieldFormatter.
- */
-
 namespace Drupal\behat_test\Plugin\Field\FieldFormatter;
 
 use Drupal\Core\Field\FieldDefinitionInterface;
@@ -31,7 +26,7 @@ class AddressFieldFormatter extends FormatterBase implements ContainerFactoryPlu
   /**
    * The country manager.
    *
-   * @var \Drupal\Core\Locale\CountryManagerInterface;
+   * @var \Drupal\Core\Locale\CountryManagerInterface
    */
   protected $countryManager;
 

diff --git a/fixtures/drupal8/modules/behat_test/src/Plugin/Field/FieldType/AddressFieldItem.php b/fixtures/drupal8/modules/behat_test/src/Plugin/Field/FieldType/AddressFieldItem.php
@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\behat_test\Plugin\Field\FieldType\AddressFieldItem.
- */
-
 namespace Drupal\behat_test\Plugin\Field\FieldType;
 
 use Drupal\Core\Field\FieldItemBase;

diff --git a/fixtures/drupal8/modules/behat_test/src/Plugin/Field/FieldWidget/AddressFieldWidget.php b/fixtures/drupal8/modules/behat_test/src/Plugin/Field/FieldWidget/AddressFieldWidget.php
@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\behat_test\Plugin\field\widget\AddressFieldWidget.
- */
-
 namespace Drupal\behat_test\Plugin\Field\FieldWidget;
 
 use Drupal\Core\Field\FieldItemListInterface;

diff --git a/phpcs-drupal-ruleset.xml b/phpcs-drupal-ruleset.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<!-- PHP_CodeSniffer standard -->
+<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
+<ruleset name="drupal/drupal-extension-fixtures">
+    <description>Drupal Behat Extension coding standards for packaged Drupal code</description>
+
+    <file>./fixtures</file>
+
+    <exclude-pattern>^/doc/*</exclude-pattern>
+    <exclude-pattern>^/drupal/*</exclude-pattern>
+    <exclude-pattern>^/drush/*</exclude-pattern>
+    <exclude-pattern>^/reports/*</exclude-pattern>
+    <exclude-pattern>^/spec/*</exclude-pattern>
+    <exclude-pattern>^/vendor/*</exclude-pattern>
+    <exclude-pattern>^/README.md</exclude-pattern>
+
+    <rule ref="./vendor/drupal/coder/coder_sniffer/Drupal"></rule>
+
+</ruleset>
diff --git a/phpcs-ruleset.xml b/phpcs-ruleset.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<!-- PHP_CodeSniffer standard -->
+<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
+<ruleset name="drupal/drupal-extension">
+    <description>Drupal Behat Extension coding standards</description>
+
+    <file>./src</file>
+
+    <exclude-pattern>^/doc/*</exclude-pattern>
+    <exclude-pattern>^/drupal/*</exclude-pattern>
+    <exclude-pattern>^/drush/*</exclude-pattern>
+    <exclude-pattern>^/fixtures/*</exclude-pattern>
+    <exclude-pattern>^/reports/*</exclude-pattern>
+    <exclude-pattern>^/spec/*</exclude-pattern>
+    <exclude-pattern>^/vendor/*</exclude-pattern>
+    <exclude-pattern>^/README.md</exclude-pattern>
+
+    <rule ref="PSR2">
+        <!-- @todo Fix long line length issues -->
+        <exclude name="Generic.Files.LineLength.TooLong" />
+    </rule>
+
+</ruleset>