From c8f1e66f718d922c4633786de3434dfb72fc9a6e Mon Sep 17 00:00:00 2001
From: Michael Moravec <mail@majkl578.cz>
Date: Tue, 26 Dec 2017 20:04:02 +0100
Subject: [PATCH] Add more new sniffs

---
 .../Sniffs/Spacing/ControlStructureSniff.php  | 117 ------------
 lib/Doctrine/Sniffs/Spacing/EnsureSpaces.php  |   4 +-
 .../Sniffs/Spacing/SpaceOnNotSniff.php        |  28 ---
 lib/Doctrine/ruleset.xml                      | 171 ++++++++++++++++--
 tests/expected_report.txt                     |   6 +-
 tests/fixed/not_spacing.php                   |   8 +-
 6 files changed, 169 insertions(+), 165 deletions(-)
 delete mode 100644 lib/Doctrine/Sniffs/Spacing/ControlStructureSniff.php
 delete mode 100644 lib/Doctrine/Sniffs/Spacing/SpaceOnNotSniff.php

diff --git a/lib/Doctrine/Sniffs/Spacing/ControlStructureSniff.php b/lib/Doctrine/Sniffs/Spacing/ControlStructureSniff.php
deleted file mode 100644
index 4752679b..00000000
--- a/lib/Doctrine/Sniffs/Spacing/ControlStructureSniff.php
+++ /dev/null
@@ -1,117 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Doctrine\Sniffs\Spacing;
-
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Sniffs\Sniff;
-
-/**
- * Small modification on PSR2 sniff to allow a space before the NOT operator
- *
- * @see \PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ControlStructureSpacingSniff
- */
-final class ControlStructureSniff implements Sniff
-{
-    private const OPENER_NAME    = 'parenthesis_opener';
-    private const OPENER_MESSAGE = 'Expected no spaces after opening bracket; %s found';
-    private const CLOSER_NAME    = 'parenthesis_closer';
-    private const CLOSER_MESSAGE = 'Expected no spaces before closing bracket; %s found';
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return [
-            \T_IF,
-            \T_WHILE,
-            \T_FOREACH,
-            \T_FOR,
-            \T_SWITCH,
-            \T_DO,
-            \T_ELSE,
-            \T_ELSEIF,
-            \T_TRY,
-            \T_CATCH,
-        ];
-    }
-
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        if ( ! isset($tokens[$stackPtr][self::OPENER_NAME], $tokens[$stackPtr][self::CLOSER_NAME])) {
-            return;
-        }
-
-        $openerPosition = $tokens[$stackPtr][self::OPENER_NAME];
-        $closerPosition = $tokens[$stackPtr][self::CLOSER_NAME];
-
-        $this->validateParenthesisOpener($phpcsFile, $tokens, $stackPtr, $openerPosition);
-        $this->validateParenthesisCloser($phpcsFile, $tokens, $stackPtr, $openerPosition, $closerPosition);
-    }
-
-    private function validateParenthesisOpener(File $file, array $tokens, int $position, int $openerPosition) : void
-    {
-        $nextTokenPosition = $openerPosition + 1;
-        $nextToken         = $tokens[$nextTokenPosition];
-
-        if ($nextToken['code'] !== T_WHITESPACE || $tokens[$nextTokenPosition + 1]['code'] === T_BOOLEAN_NOT) {
-            return;
-        }
-
-        $spaces = $nextToken['length'];
-
-        if (\strpos($nextToken['content'], $file->eolChar) !== false) {
-            $spaces = 'newline';
-        }
-
-        $file->recordMetric($position, 'Spaces after control structure open parenthesis', $spaces);
-
-        if ($spaces === 0) {
-            return;
-        }
-
-        if ( ! $file->addFixableError(self::OPENER_MESSAGE, $nextTokenPosition, 'AfterOpenBrace', [$spaces])) {
-            return;
-        }
-
-        $file->fixer->replaceToken($nextTokenPosition, '');
-    }
-
-    private function validateParenthesisCloser(
-        File $file,
-        array $tokens,
-        int $position,
-        int $openerPosition,
-        int $closerPosition
-    ) : void {
-        if ($tokens[$openerPosition]['line'] !== $tokens[$closerPosition]['line']) {
-            return;
-        }
-
-        $previousTokenPosition = $closerPosition - 1;
-        $previousToken         = $tokens[$previousTokenPosition];
-        $spaces                = 0;
-
-        if ($previousToken['code'] === T_WHITESPACE) {
-            $spaces = $previousToken['length'];
-        }
-
-        $file->recordMetric($position, 'Spaces before control structure close parenthesis', $spaces);
-
-        if ($spaces === 0) {
-            return;
-        }
-
-        if ( ! $file->addFixableError(self::CLOSER_MESSAGE, $previousTokenPosition, 'BeforeCloseBrace', [$spaces])) {
-            return;
-        }
-
-        $file->fixer->replaceToken($previousTokenPosition, '');
-    }
-}
diff --git a/lib/Doctrine/Sniffs/Spacing/EnsureSpaces.php b/lib/Doctrine/Sniffs/Spacing/EnsureSpaces.php
index 4fc524e2..36ec2b41 100644
--- a/lib/Doctrine/Sniffs/Spacing/EnsureSpaces.php
+++ b/lib/Doctrine/Sniffs/Spacing/EnsureSpaces.php
@@ -16,7 +16,7 @@ protected function ensureSpaceBefore(File $file, array $tokens, int $position, s
             return;
         }
 
-        if ( ! $file->addFixableError($message, $position, 'before', ['before', $spacing])) {
+        if (! $file->addFixableError($message, $position, 'before', ['before', $spacing])) {
             return;
         }
 
@@ -36,7 +36,7 @@ protected function ensureSpaceAfter(File $file, array $tokens, int $position, st
             return;
         }
 
-        if ( ! $file->addFixableError($message, $position, 'after', ['after', $spacing])) {
+        if (! $file->addFixableError($message, $position, 'after', ['after', $spacing])) {
             return;
         }
 
diff --git a/lib/Doctrine/Sniffs/Spacing/SpaceOnNotSniff.php b/lib/Doctrine/Sniffs/Spacing/SpaceOnNotSniff.php
deleted file mode 100644
index 92116ac9..00000000
--- a/lib/Doctrine/Sniffs/Spacing/SpaceOnNotSniff.php
+++ /dev/null
@@ -1,28 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Doctrine\Sniffs\Spacing;
-
-use PHP_CodeSniffer\Sniffs\Sniff;
-use PHP_CodeSniffer\Files\File;
-
-final class SpaceOnNotSniff implements Sniff
-{
-    use EnsureSpaces;
-
-    private const MESSAGE = 'There must be a single space %s a NOT operator; %d found';
-
-    public function register()
-    {
-        return [\T_BOOLEAN_NOT];
-    }
-
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        $this->ensureSpaceBefore($phpcsFile, $tokens, $stackPtr, self::MESSAGE);
-        $this->ensureSpaceAfter($phpcsFile, $tokens, $stackPtr, self::MESSAGE);
-    }
-}
diff --git a/lib/Doctrine/ruleset.xml b/lib/Doctrine/ruleset.xml
index 9c17cde6..81286720 100644
--- a/lib/Doctrine/ruleset.xml
+++ b/lib/Doctrine/ruleset.xml
@@ -3,26 +3,143 @@
     <description>The Doctrine coding standard.</description>
 
     <!-- Import PSR-2 coding standard (base) -->
-    <rule ref="PSR2">
-        <!-- Using \Doctrine\Sniffs\Spacing\ControlStructureSniff instead -->
-        <exclude name="PSR2.ControlStructures.ControlStructureSpacing"/>
-    </rule>
+    <rule ref="PSR2"/>
 
-    <!-- Disallow else if in favour elseif -->
-    <rule ref="PSR2.ControlStructures.ElseIfDeclaration.NotAllowed">
-        <type>error</type>
+    <!-- Forbid `array(...)` -->
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <!-- Forbid duplicate classes -->
+    <rule ref="Generic.Classes.DuplicateClassName"/>
+    <!-- Forbid empty statements -->
+    <rule ref="Generic.CodeAnalysis.EmptyStatement">
+        <!-- But allow empty catch -->
+        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCATCH"/>
     </rule>
-
+    <!-- Forbid final methods in final classes -->
+    <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
+    <!-- Forbid useless empty method overrides -->
+    <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
+    <!-- Forbid inline control structures, i.e. `if ($foo) bar();` -->
+    <rule ref="Generic.ControlStructures.InlineControlStructure"/>
+    <!-- Forbid inline HTML in PHP code -->
+    <rule ref="Generic.Files.InlineHTML"/>
     <!-- Align corresponding assignment statement tokens -->
     <rule ref="Generic.Formatting.MultipleStatementAlignment">
         <properties>
             <property name="error" value="true"/>
         </properties>
     </rule>
-
     <!-- Force whitespace after a type cast -->
-    <rule ref="Generic.Formatting.SpaceAfterCast" />
-
+    <rule ref="Generic.Formatting.SpaceAfterCast"/>
+    <!-- Force whitespace after `!` -->
+    <rule ref="Generic.Formatting.SpaceAfterNot"/>
+    <!-- Forbid PHP 4 constructors -->
+    <rule ref="Generic.NamingConventions.ConstructorName"/>
+    <!-- Forbid any content before opening tag -->
+    <rule ref="Generic.PHP.CharacterBeforePHPOpeningTag"/>
+    <!-- Forbid deprecated functions -->
+    <rule ref="Generic.PHP.DeprecatedFunctions"/>
+    <!-- Forbid alias functions, i.e. `sizeof()`, `delete()` -->
+    <rule ref="Generic.PHP.ForbiddenFunctions"/>
+    <!-- Forbid useless inline string concatenation -->
+    <rule ref="Generic.Strings.UnnecessaryStringConcat">
+        <!-- But multiline is useful for readability -->
+        <properties>
+            <property name="allowMultiline" value="true"/>
+        </properties>
+    </rule>
+    <!-- Force scope changes to increase indentation -->
+    <rule ref="Generic.WhiteSpace.ScopeIndent"/>
+    <!-- Require EOL at EOF -->
+    <rule ref="Generic.Files.EndFileNewline"/>
+    <!-- Forbid multiple classes per file -->
+    <rule ref="Generic.Files.OneClassPerFile"/>
+    <!-- Forbid multiple interfaces per file -->
+    <rule ref="Generic.Files.OneInterfacePerFile"/>
+    <!-- Forbid multiple traits per file -->
+    <rule ref="Generic.Files.OneTraitPerFile"/>
+    <!-- Forbid backtick operator -->
+    <rule ref="Generic.PHP.BacktickOperator"/>
+    <!-- Forbid short open tag -->
+    <rule ref="Generic.PHP.DisallowShortOpenTag"/>
+    <!-- Forbid `php_sapi_name()` function -->
+    <rule ref="Generic.PHP.SAPIUsage"/>
+    <!-- Forbid comments starting with # -->
+    <rule ref="PEAR.Commenting.InlineComment"/>
+    <!-- Disallow else if in favour elseif -->
+    <rule ref="PSR2.ControlStructures.ElseIfDeclaration.NotAllowed">
+        <type>error</type>
+    </rule>
+    <!-- Forbid spaces around square brackets -->
+    <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
+    <!-- Force array declaration structure -->
+    <rule ref="Squiz.Arrays.ArrayDeclaration">
+        <!-- Disable arrow alignment -->
+        <exclude name="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned"/>
+        <!-- Uses indentation of only single space -->
+        <exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned"/>
+        <!-- Allow multiple values on a single line -->
+        <exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed"/>
+        <!-- Disable alignment of braces -->
+        <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned"/>
+        <!-- Disable alignment of values with opening brace -->
+        <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned"/>
+    </rule>
+    <!-- Forbid class being in a file with different name -->
+    <rule ref="Squiz.Classes.ClassFileName"/>
+    <!-- Force `self::` for self-reference, force lower-case self, forbid spaces around `::` -->
+    <rule ref="Squiz.Classes.SelfMemberReference"/>
+    <!-- Force phpDoc alignment -->
+    <rule ref="Squiz.Commenting.DocCommentAlignment">
+        <!-- Allow extra spaces after star, i.e. for indented annotations -->
+        <exclude name="Squiz.Commenting.DocCommentAlignment.SpaceAfterStar"/>
+    </rule>
+    <!-- Force rules for function phpDoc -->
+    <rule ref="Squiz.Commenting.FunctionComment">
+        <!-- Allow `@throws` without description -->
+        <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows"/>
+        <!-- Does not work properly with PHP 7 / short-named types -->
+        <exclude name="Squiz.Commenting.FunctionComment.IncorrectParamVarName"/>
+        <!-- Does not support collections, i.e. `string[]` -->
+        <exclude name="Squiz.Commenting.FunctionComment.IncorrectTypeHint"/>
+        <!-- Forces incorrect types -->
+        <exclude name="Squiz.Commenting.FunctionComment.InvalidReturn"/>
+        <!-- Breaks with compound return types, i.e. `string|null` -->
+        <exclude name="Squiz.Commenting.FunctionComment.InvalidReturnNotVoid"/>
+        <!-- Breaks when all params are not documented -->
+        <exclude name="Squiz.Commenting.FunctionComment.InvalidTypeHint"/>
+        <!-- Doc comment is not required for every method -->
+        <exclude name="Squiz.Commenting.FunctionComment.Missing"/>
+        <!-- Do not require comments for `@param` -->
+        <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment"/>
+        <!-- Do not require `@param` for all parameters -->
+        <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/>
+        <!-- Do not require `@return` for void methods -->
+        <exclude name="Squiz.Commenting.FunctionComment.MissingReturn"/>
+        <!-- Comments don't have to be sentences -->
+        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop"/>
+        <!-- Comments don't have to be sentences -->
+        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentNotCapital"/>
+        <!-- Breaks when all params are not documented -->
+        <exclude name="Squiz.Commenting.FunctionComment.ParamNameNoMatch"/>
+        <!-- Doesn't respect inheritance -->
+        <exclude name="Squiz.Commenting.FunctionComment.ScalarTypeHintMissing"/>
+        <!-- Doesn't work with self as typehint -->
+        <exclude name="Squiz.Commenting.FunctionComment.TypeHintMissing"/>
+    </rule>
+    <!-- Forbid global functions -->
+    <rule ref="Squiz.Functions.GlobalFunction"/>
+    <!-- Forbid `AND` and `OR`, require `&&` and `||` -->
+    <rule ref="Squiz.Operators.ValidLogicalOperators"/>
+    <!-- Forbid `global` -->
+    <rule ref="Squiz.PHP.GlobalKeyword"/>
+    <!-- Forbid functions inside functions -->
+    <rule ref="Squiz.PHP.InnerFunctions"/>
+    <!-- Require PHP function calls in lowercase -->
+    <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
+    <!-- Forbid dead code -->
+    <rule ref="Squiz.PHP.NonExecutableCode"/>
+    <!-- Forbid `$this` inside static function -->
+    <rule ref="Squiz.Scope.StaticThisUsage"/>
     <!-- Force whitespace before and after concatenation -->
     <rule ref="Squiz.Strings.ConcatenationSpacing">
         <properties>
@@ -30,4 +147,36 @@
             <property name="ignoreNewlines" value="true"/>
         </properties>
     </rule>
+    <!-- Forbid strings in `"` unless necessary -->
+    <rule ref="Squiz.Strings.DoubleQuoteUsage"/>
+    <rule ref="Squiz.Strings.DoubleQuoteUsage.ContainsVar">
+        <message>Variable "%s" not allowed in double quoted string; use sprintf() or concatenation instead</message>
+    </rule>
+    <!-- Forbid braces around string in `echo` -->
+    <rule ref="Squiz.Strings.EchoedStrings"/>
+    <!-- Forbid spaces in type casts -->
+    <rule ref="Squiz.WhiteSpace.CastSpacing"/>
+    <!-- Forbid blank line after function opening brace -->
+    <rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace"/>
+    <!-- Require space after language constructs -->
+    <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
+    <!-- Require space around logical operators -->
+    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
+    <!-- Forbid spaces around `->` operator -->
+    <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing">
+        <properties>
+            <property name="ignoreNewlines" value="true"/>
+        </properties>
+    </rule>
+    <!-- Forbid superfluous whitespaces -->
+    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
+        <properties>
+            <!-- turned on by PSR2 -> turning back off -->
+            <property name="ignoreBlankLines" value="false"/>
+        </properties>
+    </rule>
+    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines">
+        <!-- turned off by PSR2 -> turning back on -->
+        <severity>5</severity>
+    </rule>
 </ruleset>
diff --git a/tests/expected_report.txt b/tests/expected_report.txt
index 0b74045c..b4104987 100644
--- a/tests/expected_report.txt
+++ b/tests/expected_report.txt
@@ -3,12 +3,12 @@ PHP CODE SNIFFER REPORT SUMMARY
 ----------------------------------------------------------------------
 FILE                                                  ERRORS  WARNINGS
 ----------------------------------------------------------------------
-tests/input/concatenation_spacing.php                 19      0
+tests/input/concatenation_spacing.php                 24      0
 tests/input/not_spacing.php                           7       0
 tests/input/return_type_on_closures.php               21      0
-tests/input/return_type_on_methods.php                16      0
+tests/input/return_type_on_methods.php                17      0
 ----------------------------------------------------------------------
-A TOTAL OF 63 ERRORS AND 0 WARNINGS WERE FOUND IN 4 FILES
+A TOTAL OF 69 ERRORS AND 0 WARNINGS WERE FOUND IN 4 FILES
 ----------------------------------------------------------------------
 PHPCBF CAN FIX 63 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
 ----------------------------------------------------------------------
diff --git a/tests/fixed/not_spacing.php b/tests/fixed/not_spacing.php
index 990e44e3..4c274bed 100644
--- a/tests/fixed/not_spacing.php
+++ b/tests/fixed/not_spacing.php
@@ -2,18 +2,18 @@
 
 $test = 1;
 
-if ( ! $test > 0) {
+if (! $test > 0) {
     echo 1;
-} elseif ( ! $test === 0) {
+} elseif (! $test === 0) {
     echo 0;
 } else {
     echo -1;
 }
 
-while ( ! true) {
+while (! true) {
     echo 1;
 }
 
 do {
     echo 1;
-} while ( ! true);
+} while (! true);