Improve handling of the stroustrup coding style

Author: MasterOdin

SubmittyStandard/Sniffs/ControlStructures/DoWhileSniff.php

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * Verifies that control statements conform to their coding standards.
+ *
+ * @author    Matthew Peveler
+ */
+
+declare(strict_types=1);
+
+namespace SubmittyStandard\Sniffs\ControlStructures;
+
+use PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ControlSignatureSniff;
+
+class DoWhileSniff extends ControlSignatureSniff {
+    public function register() {
+        return [
+            T_WHILE
+        ];
+    }
+}

SubmittyStandard/Sniffs/ControlStructures/StroustrupStructureSniff.php

@@ -10,31 +10,14 @@
 
 namespace SubmittyStandard\Sniffs\ControlStructures;
 
-use PHP_CodeSniffer\Sniffs\AbstractPatternSniff;
+use PHPCSExtra\Universal\Sniffs\ControlStructures\IfElseDeclarationSniff;
 
-class StroustrupStructureSniff extends AbstractPatternSniff {
-    // phpcs:disable SubmittyStandard.NamingConventions.ValidVariableName.MemberNotSnakeCase
-    /**
-     * If true, comments will be ignored if they are found in the code.
-     *
-     * @var boolean
-     */
-    public $ignoreComments = true;
-    // phpcs: enable
-
-    protected function getPatterns() {
+class StroustrupStructureSniff extends IfElseDeclarationSniff {
+    public function register() {
         return [
-            'do {EOL...} while (...);EOL',
-            'while (...) {EOL',
-            'for (...) {EOL',
-            'if (...) {EOL',
-            'foreach (...) {EOL',
-            '}EOLelse if (...) {EOL',
-            '}EOLelseif (...) {EOL',
-            '}EOLelse {EOL',
-            'do {EOL',
-            'try {EOL',
-            '}EOLcatch (...) {EOL'
+            \T_ELSE,
+            \T_ELSEIF,
+            \T_CATCH
         ];
     }
 }

SubmittyStandard/Tests/ControlStructures/DoWhileUnitTest.inc

@@ -0,0 +1,9 @@
+<?php
+
+do {
+} while (true);
+
+// do-while is special
+do {
+}
+while(true);

SubmittyStandard/Tests/ControlStructures/DoWhileUnitTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace SubmittyStandard\Tests\ControlStructures;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class DoWhileUnitTest extends AbstractSniffUnitTest {
+    public function getErrorList() {
+        return [
+            8 => 1,
+            9 => 1
+        ];
+    }
+
+    public function getWarningList() {
+        return [];
+    }
+}

SubmittyStandard/Tests/ControlStructures/StroustrupStructureUnitTest.inc

@@ -13,14 +13,6 @@ elseif (false) {
 else {
 }
 
-do {
-} while (true);
-
-// do-while is special
-do {
-}
-while(true);
-
 try {
 } catch ($exc) {
 }
@@ -34,10 +26,3 @@ try
 {
 } catch (exc) {
 }
-
-try
-{
-}
-catch (exc)
-{
-}

SubmittyStandard/Tests/ControlStructures/StroustrupStructureUnitTest.php

@@ -10,12 +10,8 @@ public function getErrorList() {
             4 => 1,
             5 => 1,
             6 => 1,
-            20 => 1,
-            25 => 1,
-            33 => 1,
-            35 => 1,
-            38 => 1,
-            41 => 1
+            17 => 1,
+            27 => 1
         ];
     }
 

composer.json

@@ -6,7 +6,9 @@
     "require": {
         "php": ">=7.1",
         "squizlabs/php_codesniffer": "^3.5.4",
-        "slevomat/coding-standard": "^6.1"
+        "slevomat/coding-standard": "^6.1",
+        "phpcsstandards/phpcsutils": "dev-develop",
+        "phpcsstandards/phpcsextra": "dev-develop"
     },
     "require-dev": {
         "pcov/clobber": "^2.0",