Switch coding standard for MO4 files to MO4

Author: mmoll

.github/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Contributing
 
 If you contribute code, please make sure it conforms to the
-[PHPCS coding standard](https://github.com/squizlabs/PHP_CodeSniffer/blob/master/phpcs.xml.dist)
+MO4 coding standard
 and that the unit tests still pass.
 Whenever possible, add an auto fixer for coding standard violations. 
 

.travis.yml

@@ -42,7 +42,7 @@ script:
   - diff -B phpcs.xml.dist <(xmllint --format phpcs.xml.dist)
   - vendor/bin/phpcs -s --standard=MO4 integrationtests/testfile.php # Check, if all the sniffs work with the current dependencies
   - vendor/bin/phpunit # Run tests
-  - vendor/bin/phpcs # Stylecheck against PHPCS's ruleset
+  - vendor/bin/phpcs # Stylecheck against MO4
   - vendor/bin/phpstan analyse --no-progress # Run PHPStan
   - vendor/bin/psalm --show-info=false # run psalm
   - if [ "${DEPENDENCIES}" = "highest" ]; then vendor/bin/phan; fi; # Run phan

MO4/Library/PregLibrary.php

@@ -1,11 +1,15 @@
 <?php
+
 /**
  * This file is part of the mo4-coding-standard (phpcs standard)
  *
  * @author  Michael Moll <mmoll@mmoll.at>
+ *
  * @license http://spdx.org/licenses/MIT MIT License
+ *
  * @link    https://github.com/mayflower/mo4-coding-standard
  */
+
 declare(strict_types=1);
 
 namespace MO4\Library;
@@ -14,8 +18,6 @@
 
 class PregLibrary
 {
-
-
     /**
      * Split string by a regular expression
      *
@@ -31,23 +33,21 @@ class PregLibrary
      *                        PREG_SPLIT_OFFSET_CAPTURE: If this flag is set, for every occurring match the appendant
      *                        string offset will also be returned.
      *
-     * @return string[]|array[]
+     * @return array<string>|array<array>
      *
      * @throws RuntimeException
      *
      * @psalm-suppress ArgumentTypeCoercion
      */
-    public static function mo4_preg_split($pattern, $subject, $limit=-1, $flags=0): array
+    public static function MO4PregSplit(string $pattern, string $subject, int $limit = -1, int $flags = 0): array
     {
         $pregSplitResult = \preg_split($pattern, $subject, $limit, $flags);
-        // @phan-suppress-next-line PhanTypeComparisonFromArray
-        if ($pregSplitResult === false) {
+
+        // @phan-suppress-next-line PhanTypeComparisonToArray
+        if (false === $pregSplitResult) {
             throw new RuntimeException('Unexpected Error in MO4 Coding Standard.');
         }
 
         return $pregSplitResult;
-
-    }//end mo4_preg_split()
-
-
-}//end class
+    }
+}

MO4/Sniffs/Arrays/ArrayDoubleArrowAlignmentSniff.php

@@ -4,9 +4,12 @@
  * This file is part of the mo4-coding-standard (phpcs standard)
  *
  * @author  Xaver Loppenstedt <xaver@loppenstedt.de>
+ *
  * @license http://spdx.org/licenses/MIT MIT License
+ *
  * @link    https://github.com/mayflower/mo4-coding-standard
  */
+
 declare(strict_types=1);
 
 namespace MO4\Sniffs\Arrays;
@@ -21,41 +24,43 @@
  * '=>' must be aligned in arrays, and the key and the '=>' must be in the same line
  *
  * @author    Xaver Loppenstedt <xaver@loppenstedt.de>
+ *
  * @copyright 2013 Xaver Loppenstedt, some rights reserved.
+ *
  * @license   http://spdx.org/licenses/MIT MIT License
+ *
  * @link      https://github.com/mayflower/mo4-coding-standard
  */
 class ArrayDoubleArrowAlignmentSniff implements Sniff
 {
-
     /**
      * Define all types of arrays.
      *
      * @var array
      */
-    protected  $arrayTokens = [
+    protected $arrayTokens = [
         // @phan-suppress-next-line PhanUndeclaredConstant
         T_OPEN_SHORT_ARRAY,
         T_ARRAY,
     ];
 
-
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
      * @return array<int, int>
+     *
      * @see    Tokens.php
      */
     public function register(): array
     {
         return $this->arrayTokens;
-
-    }//end register()
-
+    }
 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
+     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint
+     *
      * @param File $phpcsFile The file being scanned.
      * @param int  $stackPtr  The position of the current token in
      *                        the stack passed in $tokens.
@@ -69,7 +74,7 @@ public function process(File $phpcsFile, $stackPtr): void
         $tokens  = $phpcsFile->getTokens();
         $current = $tokens[$stackPtr];
 
-        if ($current['code'] === T_ARRAY) {
+        if (T_ARRAY === $current['code']) {
             $start = $current['parenthesis_opener'];
             $end   = $current['parenthesis_closer'];
         } else {
@@ -93,82 +98,82 @@ public function process(File $phpcsFile, $stackPtr): void
             $previous = $tokens[($i - 1)];
 
             // Skip nested arrays.
-            if (\in_array($current['code'], $this->arrayTokens, true) === true) {
-                if ($current['code'] === T_ARRAY) {
-                    $i = ($current['parenthesis_closer'] + 1);
-                } else {
-                    $i = ($current['bracket_closer'] + 1);
-                }
+            if (true === \in_array($current['code'], $this->arrayTokens, true)) {
+                $i = T_ARRAY === $current['code'] ? ($current['parenthesis_closer'] + 1) : ($current['bracket_closer'] + 1);
 
                 continue;
             }
 
             // Skip closures in array.
-            if ($current['code'] === T_CLOSURE) {
+            if (T_CLOSURE === $current['code']) {
                 $i = ($current['scope_closer'] + 1);
+
                 continue;
             }
 
             $i = (int) $i;
 
-            if ($current['code'] === T_DOUBLE_ARROW) {
-                $assignments[] = $i;
-                $column        = $previous['column'];
-                $line          = $current['line'];
-
-                if ($lastLine === $line) {
-                    $previousComma = $this->getPreviousComma($phpcsFile, $i, $start);
-
-                    $msg = 'only one "=>" assignments per line is allowed in a multi line array';
-
-                    if ($previousComma !== false) {
-                        $fixable = $phpcsFile->addFixableError($msg, $i, 'OneAssignmentPerLine');
-
-                        if ($fixable === true) {
-                            $phpcsFile->fixer->beginChangeset();
-                            $phpcsFile->fixer->addNewline((int) $previousComma);
-                            $phpcsFile->fixer->endChangeset();
-                        }
-                    } else {
-                        // Remove current and previous '=>' from array for further processing.
-                        \array_pop($assignments);
-                        \array_pop($assignments);
-                        $phpcsFile->addError($msg, $i, 'OneAssignmentPerLine');
-                    }
-                }
+            if (T_DOUBLE_ARROW !== $current['code']) {
+                continue;
+            }
 
-                $hasKeyInLine = false;
+            $assignments[] = $i;
+            $column        = $previous['column'];
+            $line          = $current['line'];
 
-                $j = ($i - 1);
-                while (($j >= 0) && ($tokens[$j]['line'] === $current['line'])) {
-                    if (\in_array($tokens[$j]['code'], PHP_CodeSniffer_Tokens::$emptyTokens, true) === false) {
-                        $hasKeyInLine = true;
-                    }
+            if ($lastLine === $line) {
+                $previousComma = $this->getPreviousComma($phpcsFile, $i, $start);
 
-                    $j--;
-                }
+                $msg = 'only one "=>" assignments per line is allowed in a multi line array';
 
-                if ($hasKeyInLine === false) {
-                    $fixable = $phpcsFile->addFixableError(
-                        'in arrays, keys and "=>" must be on the same line',
-                        $i,
-                        'KeyAndValueNotOnSameLine'
-                    );
+                if (false !== $previousComma) {
+                    $fixable = $phpcsFile->addFixableError($msg, $i, 'OneAssignmentPerLine');
 
-                    if ($fixable === true) {
+                    if (true === $fixable) {
                         $phpcsFile->fixer->beginChangeset();
-                        $phpcsFile->fixer->replaceToken($j, '');
+                        $phpcsFile->fixer->addNewline((int) $previousComma);
                         $phpcsFile->fixer->endChangeset();
                     }
+                } else {
+                    // Remove current and previous '=>' from array for further processing.
+                    \array_pop($assignments);
+                    \array_pop($assignments);
+                    $phpcsFile->addError($msg, $i, 'OneAssignmentPerLine');
                 }
+            }
+
+            $hasKeyInLine = false;
 
-                if ($column > $keyEndColumn) {
-                    $keyEndColumn = $column;
+            $j = ($i - 1);
+
+            while (($j >= 0) && ($tokens[$j]['line'] === $current['line'])) {
+                if (false === \in_array($tokens[$j]['code'], PHP_CodeSniffer_Tokens::$emptyTokens, true)) {
+                    $hasKeyInLine = true;
+                }
+
+                $j--;
+            }
+
+            if (false === $hasKeyInLine) {
+                $fixable = $phpcsFile->addFixableError(
+                    'in arrays, keys and "=>" must be on the same line',
+                    $i,
+                    'KeyAndValueNotOnSameLine'
+                );
+
+                if (true === $fixable) {
+                    $phpcsFile->fixer->beginChangeset();
+                    $phpcsFile->fixer->replaceToken($j, '');
+                    $phpcsFile->fixer->endChangeset();
                 }
+            }
 
-                $lastLine = $line;
-            }//end if
-        }//end for
+            if ($column > $keyEndColumn) {
+                $keyEndColumn = $column;
+            }
+
+            $lastLine = $line;
+        }
 
         $doubleArrowStartColumn = ($keyEndColumn + 1);
 
@@ -179,26 +184,28 @@ public function process(File $phpcsFile, $stackPtr): void
             $beforeArrowPtr = ($ptr - 1);
             $currentIndent  = \strlen($tokens[$beforeArrowPtr]['content']);
             $correctIndent  = ($currentIndent - $column + $doubleArrowStartColumn);
-            if ($column !== $doubleArrowStartColumn) {
-                $fixable = $phpcsFile->addFixableError("each \"=>\" assignments must be aligned; current indentation before \"=>\" are $currentIndent space(s), must be $correctIndent space(s)", $ptr, 'AssignmentsNotAligned');
 
-                if ($fixable === false) {
-                    continue;
-                }
+            if ($column === $doubleArrowStartColumn) {
+                continue;
+            }
 
-                $phpcsFile->fixer->beginChangeset();
-                if ($tokens[$beforeArrowPtr]['code'] === T_WHITESPACE) {
-                    $phpcsFile->fixer->replaceToken($beforeArrowPtr, \str_repeat(' ', $correctIndent));
-                } else {
-                    $phpcsFile->fixer->addContent($beforeArrowPtr, \str_repeat(' ', $correctIndent));
-                }
+            $fixable = $phpcsFile->addFixableError("each \"=>\" assignments must be aligned; current indentation before \"=>\" are {$currentIndent} space(s), must be {$correctIndent} space(s)", $ptr, 'AssignmentsNotAligned');
 
-                $phpcsFile->fixer->endChangeset();
+            if (false === $fixable) {
+                continue;
             }
-        }//end foreach
 
-    }//end process()
+            $phpcsFile->fixer->beginChangeset();
 
+            if (T_WHITESPACE === $tokens[$beforeArrowPtr]['code']) {
+                $phpcsFile->fixer->replaceToken($beforeArrowPtr, \str_repeat(' ', $correctIndent));
+            } else {
+                $phpcsFile->fixer->addContent($beforeArrowPtr, \str_repeat(' ', $correctIndent));
+            }
+
+            $phpcsFile->fixer->endChangeset();
+        }
+    }
 
     /**
      * Find previous comma in array.
@@ -210,28 +217,27 @@ public function process(File $phpcsFile, $stackPtr): void
      *
      * @return bool|int
      */
-    private function getPreviousComma(File $phpcsFile, $stackPtr, $start)
+    private function getPreviousComma(File $phpcsFile, int $stackPtr, int $start)
     {
         $previousComma = false;
         $tokens        = $phpcsFile->getTokens();
 
         $ptr = $phpcsFile->findPrevious([T_COMMA, T_CLOSE_SHORT_ARRAY], $stackPtr, $start);
-        while ($ptr !== false) {
-            if ($tokens[$ptr]['code'] === T_COMMA) {
+
+        while (false !== $ptr) {
+            if (T_COMMA === $tokens[$ptr]['code']) {
                 $previousComma = $ptr;
+
                 break;
             }
 
-            if ($tokens[$ptr]['code'] === T_CLOSE_SHORT_ARRAY) {
+            if (T_CLOSE_SHORT_ARRAY === $tokens[$ptr]['code']) {
                 $ptr = $tokens[$ptr]['bracket_opener'];
             }
 
             $ptr = $phpcsFile->findPrevious([T_COMMA, T_CLOSE_SHORT_ARRAY], ($ptr - 1), $start);
         }
 
         return $previousComma;
-
-    }//end getPreviousComma()
-
-
-}//end class
+    }
+}