Merge branch 'master' into 4.x

Author: jrfnl

src/Standards/Squiz/Sniffs/Commenting/BlockCommentSniff.php

@@ -66,7 +66,7 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        // If this is a function/class/interface doc block comment, skip it.
+        // If this is a function/class/interface/enum/property/const doc block comment, skip it.
         // We are only interested in inline doc block comments.
         if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) {
             $nextToken = $stackPtr;
@@ -80,16 +80,14 @@ public function process(File $phpcsFile, $stackPtr)
                 break;
             } while (true);
 
-            $ignore = [
+            $ignore  = Tokens::SCOPE_MODIFIERS;
+            $ignore += [
                 T_CLASS     => true,
                 T_INTERFACE => true,
                 T_TRAIT     => true,
                 T_ENUM      => true,
                 T_FUNCTION  => true,
-                T_PUBLIC    => true,
-                T_PRIVATE   => true,
                 T_FINAL     => true,
-                T_PROTECTED => true,
                 T_STATIC    => true,
                 T_ABSTRACT  => true,
                 T_CONST     => true,

src/Standards/Squiz/Sniffs/Commenting/DocCommentAlignmentSniff.php

@@ -42,17 +42,16 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
-        // We are only interested in function/class/interface doc block comments.
+        // We are only interested in function/class/interface/enum/property/const doc block comments.
         $nextToken = $phpcsFile->findNext(Tokens::EMPTY_TOKENS, ($stackPtr + 1), null, true);
-        $ignore    = [
+
+        $ignore  = Tokens::SCOPE_MODIFIERS;
+        $ignore += [
             T_CLASS     => true,
             T_INTERFACE => true,
             T_ENUM      => true,
             T_ENUM_CASE => true,
             T_FUNCTION  => true,
-            T_PUBLIC    => true,
-            T_PRIVATE   => true,
-            T_PROTECTED => true,
             T_STATIC    => true,
             T_ABSTRACT  => true,
             T_FINAL     => true,

src/Standards/Squiz/Sniffs/Functions/FunctionDeclarationArgumentSpacingSniff.php

@@ -334,6 +334,40 @@ public function processBracket($phpcsFile, $openBracket)
                 }//end if
             }//end if
 
+            if (isset($param['set_visibility_token']) === true && $param['set_visibility_token'] !== false) {
+                $visibilityToken      = $param['set_visibility_token'];
+                $afterVisibilityToken = $phpcsFile->findNext(T_WHITESPACE, ($visibilityToken + 1), $param['token'], true);
+
+                $spacesAfter = 0;
+                if ($afterVisibilityToken !== false
+                    && $tokens[$visibilityToken]['line'] !== $tokens[$afterVisibilityToken]['line']
+                ) {
+                    $spacesAfter = 'newline';
+                } else if ($tokens[($visibilityToken + 1)]['code'] === T_WHITESPACE) {
+                    $spacesAfter = $tokens[($visibilityToken + 1)]['length'];
+                }
+
+                if ($spacesAfter !== 1) {
+                    $error = 'Expected 1 space after set-visibility modifier "%s"; %s found';
+                    $data  = [
+                        $tokens[$visibilityToken]['content'],
+                        $spacesAfter,
+                    ];
+
+                    $fix = $phpcsFile->addFixableError($error, $visibilityToken, 'SpacingAfterSetVisbility', $data);
+                    if ($fix === true) {
+                        $phpcsFile->fixer->beginChangeset();
+                        $phpcsFile->fixer->addContent($visibilityToken, ' ');
+
+                        for ($i = ($visibilityToken + 1); $tokens[$i]['code'] === T_WHITESPACE; $i++) {
+                            $phpcsFile->fixer->replaceToken($i, '');
+                        }
+
+                        $phpcsFile->fixer->endChangeset();
+                    }
+                }//end if
+            }//end if
+
             if (isset($param['readonly_token']) === true) {
                 $readonlyToken      = $param['readonly_token'];
                 $afterReadonlyToken = $phpcsFile->findNext(T_WHITESPACE, ($readonlyToken + 1), $param['token'], true);

src/Standards/Squiz/Sniffs/Scope/MemberVarScopeSniff.php

@@ -51,9 +51,15 @@ protected function processMemberVar(File $phpcsFile, $stackPtr)
         }
 
         $tokens = $phpcsFile->getTokens();
-        $error  = 'Scope modifier not specified for member variable "%s"';
-        $data   = [$tokens[$stackPtr]['content']];
-        $phpcsFile->addError($error, $stackPtr, 'Missing', $data);
+        if ($properties['set_scope'] === false) {
+            $error = 'Scope modifier not specified for member variable "%s"';
+            $data  = [$tokens[$stackPtr]['content']];
+            $phpcsFile->addError($error, $stackPtr, 'Missing', $data);
+        } else {
+            $error = 'Read scope modifier not specified for member variable "%s"';
+            $data  = [$tokens[$stackPtr]['content']];
+            $phpcsFile->addError($error, $stackPtr, 'AsymReadMissing', $data);
+        }
 
     }//end processMemberVar()
 

src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc

@@ -314,3 +314,20 @@ class FinalProperties {
      */
     final int $prop = 1;
 }
+
+class AsymVisibility {
+    /**
+     * Comment should be ignored.
+     */
+    public(set) int $prop = 1;
+
+    /**
+     * Comment should be ignored.
+     */
+    protected(set) int $prop = 1;
+
+    /**
+     * Comment should be ignored.
+     */
+    private(set) int $prop = 1;
+}

src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc.fixed

@@ -316,3 +316,20 @@ class FinalProperties {
      */
     final int $prop = 1;
 }
+
+class AsymVisibility {
+    /**
+     * Comment should be ignored.
+     */
+    public(set) int $prop = 1;
+
+    /**
+     * Comment should be ignored.
+     */
+    protected(set) int $prop = 1;
+
+    /**
+     * Comment should be ignored.
+     */
+    private(set) int $prop = 1;
+}

src/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.inc

@@ -114,3 +114,20 @@ final class FinalClassWithFinalProp
       */
     final $property = 10;
 }
+
+class AsymVisibility {
+    /**
+    * Stars should be aligned.
+   */
+    public(set) int $prop = 1;
+
+    /**
+      * Stars should be aligned.
+       */
+    protected(set) int $prop = 1;
+
+    /**
+     * Stars should be aligned.
+     */
+    private(set) int $prop = 1;
+}

src/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.inc.fixed

@@ -114,3 +114,20 @@ final class FinalClassWithFinalProp
      */
     final $property = 10;
 }
+
+class AsymVisibility {
+    /**
+     * Stars should be aligned.
+     */
+    public(set) int $prop = 1;
+
+    /**
+     * Stars should be aligned.
+     */
+    protected(set) int $prop = 1;
+
+    /**
+     * Stars should be aligned.
+     */
+    private(set) int $prop = 1;
+}

src/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.php

@@ -57,6 +57,10 @@ public function getErrorList()
             112 => 1,
             113 => 1,
             114 => 1,
+            120 => 1,
+            121 => 1,
+            125 => 1,
+            126 => 1,
         ];
 
     }//end getErrorList()

src/Standards/Squiz/Tests/Commenting/VariableCommentUnitTest.inc

@@ -517,3 +517,20 @@ class StandaloneFQNNullTrueFalseTypes
      */
     private \FALSE $variableName = false;
 }
+
+class AsymVisibility {
+    /**
+     * @var integer
+     */
+    public(set) int $hasDocblockA;
+
+    /**
+     * @var integer
+     */
+    public protected(set) int $hasDocblockB;
+
+    /**
+     * @var integer
+     */
+    private(set) protected int $hasDocblockC;
+}