Merge pull request #52 from VincentLanglet/improve

✨ Minor improvements

Author: VincentLanglet

SymfonyCustom/Sniffs/Namespaces/NamespaceDeclarationSniff.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace SymfonyCustom\Sniffs\Namespaces;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Ensure there is a blank line before namespace.
+ * PSR2 checks only for blank line after namespace.
+ */
+class NamespaceDeclarationSniff implements Sniff
+{
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return [T_NAMESPACE];
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param File $phpcsFile The file being scanned.
+     * @param int  $stackPtr  The position of the current token in the stack passed in $tokens.
+     *
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        for ($i = $stackPtr - 1; $i > 0; $i--) {
+            if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
+                continue;
+            }
+
+            break;
+        }
+
+        // The $i var now points to the last token on the line before the
+        // namespace declaration, which must be a blank line.
+        $previous = $phpcsFile->findPrevious(T_WHITESPACE, $i, null, true);
+        if (false === $previous) {
+            return;
+        }
+
+        $diff = ($tokens[$i]['line'] - $tokens[$previous]['line']);
+        if (1 === $diff) {
+            return;
+        }
+
+        if ($diff < 0) {
+            $diff = 0;
+        }
+
+        $error = 'There must be one blank line before the namespace declaration';
+        $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'BlankLineBefore');
+
+        if (true === $fix) {
+            if (0 === $diff) {
+                $phpcsFile->fixer->addNewlineBefore($stackPtr);
+            } else {
+                $phpcsFile->fixer->beginChangeset();
+                for ($x = $stackPtr - 1; $x > $previous; $x--) {
+                    if ($tokens[$x]['line'] === $tokens[$previous]['line']) {
+                        break;
+                    }
+
+                    $phpcsFile->fixer->replaceToken($x, '');
+                }
+
+                $phpcsFile->fixer->addNewlineBefore($stackPtr);
+                $phpcsFile->fixer->endChangeset();
+            }
+        }
+    }
+}

SymfonyCustom/Sniffs/Namespaces/UnusedUseSniff.php

@@ -109,8 +109,13 @@ public function process(File $phpcsFile, $stackPtr)
                     true
                 );
 
-                // If a backslash is used before the class name then this is some other use statement.
-                if (T_USE !== $tokens[$beforeUsage]['code'] && T_NS_SEPARATOR !== $tokens[$beforeUsage]['code']) {
+                if (!in_array($tokens[$beforeUsage]['code'], [
+                    T_USE,
+                    // If a backslash is used before the class name then this is some other use statement.
+                    T_NS_SEPARATOR,
+                    // If an object operator is used before the class name then is a class property.
+                    T_OBJECT_OPERATOR,
+                ])) {
                     return;
                 }
 

SymfonyCustom/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Util\Tokens;
 
 /**
- * Checks that there is no white space before a closing bracket, for ")" and "}".
+ * Checks that there is no white space before a closing bracket, for ")", "}", and array bracket.
  * Square Brackets are handled by Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
  */
 class CloseBracketSpacingSniff implements Sniff

SymfonyCustom/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php

@@ -6,7 +6,7 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 
 /**
- * Checks that there is no white space after an opening bracket, for "(" and "{".
+ * Checks that there is no white space after an opening bracket, for "(", "{", and array bracket.
  * Square Brackets are handled by Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
  */
 class OpenBracketSpacingSniff implements Sniff

SymfonyCustom/Tests/Namespaces/NamespaceDeclarationUnitTest.inc

@@ -0,0 +1,8 @@
+<?php
+namespace MyProject;
+
+namespace Foo;
+
+
+namespace Toto;
+;namespace FooBar;

SymfonyCustom/Tests/Namespaces/NamespaceDeclarationUnitTest.inc.fixed

@@ -0,0 +1,10 @@
+<?php
+
+namespace MyProject;
+
+namespace Foo;
+
+namespace Toto;
+;
+
+namespace FooBar;

SymfonyCustom/Tests/Namespaces/NamespaceDeclarationUnitTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace SymfonyCustom\Tests\Namespaces;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the UnusedUse sniff.
+ *
+ * @group SymfonyCustom
+ */
+class NamespaceDeclarationUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    public function getErrorList()
+    {
+        return [
+            2 => 1,
+            7 => 1,
+            8 => 1,
+        ];
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    public function getWarningList()
+    {
+        return [];
+    }
+}

SymfonyCustom/Tests/Namespaces/UnusedUseUnitTest.inc

@@ -13,6 +13,7 @@ use Client;
 use Clients;
 use PasClient;
 use Somewhere\Something;
+use Somewhere\SomethingElse;
 
 class Container
 {
@@ -28,7 +29,8 @@ class Container
     function test (Bar $bar): Something
     {
         /** @var Client|Clients[]|PasClient $client */
+        $client = [$this->somethingElse];
 
-        return;
+        return $client;
     }
 }

SymfonyCustom/Tests/Namespaces/UnusedUseUnitTest.inc.fixed

@@ -27,7 +27,8 @@ class Container
     function test (Bar $bar): Something
     {
         /** @var Client|Clients[]|PasClient $client */
+        $client = [$this->somethingElse];
 
-        return;
+        return $client;
     }
 }

SymfonyCustom/Tests/Namespaces/UnusedUseUnitTest.php

@@ -23,6 +23,7 @@ public function getErrorList()
     {
         return [
             11 => 1,
+            16 => 1,
         ];
     }
 

SymfonyCustom/ruleset.xml

@@ -3,6 +3,9 @@
     <!-- See http://symfony.com/doc/current/contributing/code/standards.html -->
     <description>The SymfonyCustom coding standard.</description>
 
+    <arg name="extensions" value="php,inc"/>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+
     <!-- ************** -->
     <!-- ***  PSR2  *** -->
     <!-- ************** -->
@@ -60,12 +63,10 @@
     </rule>
 
     <!-- Added by VincentLanglet repo -->
-    <rule ref="Generic.PHP.ForbiddenFunctions"/>
-    <rule ref="Squiz.PHP.DiscouragedFunctions"/>
-    <rule ref="Squiz.Strings.DoubleQuoteUsage">
-        <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
-    </rule>
+    <!-- Whitespace -->
+    <rule ref="Squiz.WhiteSpace.CastSpacing"/>
     <rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace"/>
+    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
     <rule ref="Squiz.WhiteSpace.OperatorSpacing">
         <properties>
             <property name="ignoreNewlines" value="true"/>
@@ -77,9 +78,19 @@
         </properties>
     </rule>
     <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
+
+    <!-- Comment -->
+    <rule ref="Generic.Commenting.DocComment">
+        <exclude name="Generic.Commenting.DocComment.MissingShort"/>
+    </rule>
+    <rule ref="Squiz.Commenting.DocCommentAlignment"/>
+
+    <!-- Others -->
+    <rule ref="Generic.PHP.ForbiddenFunctions"/>
+    <rule ref="Squiz.PHP.DiscouragedFunctions"/>
     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <rule ref="Squiz.Strings.DoubleQuoteUsage">
+        <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
+    </rule>
     <rule ref="Generic.CodeAnalysis.EmptyPHPStatement"/>
-    <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
-    <rule ref="Squiz.WhiteSpace.CastSpacing"/>
-    <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing"/>
 </ruleset>

docs/standards.md

@@ -138,6 +138,15 @@ we do not respect this rule:
 </rule>
 ```
 
+- DocComment should start on a new line, end on a new line and be correctly indented
+
+```
+<rule ref="Generic.Commenting.DocComment">
+    <exclude name="Generic.Commenting.DocComment.MissingShort"/>
+</rule>
+<rule ref="Squiz.Commenting.DocCommentAlignment"/>
+```
+
 ### Custom
 - Some others checks are made about array (`=>` alignments and indentation)
 
@@ -193,3 +202,9 @@ we do not respect this rule:
 ```
 <rule ref="SymfonyCustom.WhiteSpace.DocCommentTagSpacing"/>
 ```
+
+- Add a single space before `namespace` declaration
+
+```
+<rule ref="SymfonyCustom.Namespaces.NamespaceDeclaration"/>
+```

docs/standards/symfony.md

@@ -182,7 +182,7 @@ Covered by `PSR1` completed by
 
 - Add PHPDoc blocks for all classes, methods, and functions
 
-We added exceptions for functions `setUp`, `tearDown` and `tests` with no `@param` or `@return`
+We added exceptions for functions with no `@param` or `@return`
 ```
 <rule ref="SymfonyCustom.Commenting.ClassComment"/>
 <rule ref="SymfonyCustom.Commenting.FunctionComment"/>