Fixed wrongly returning error for valid descriptions

Author: svera

Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php

@@ -112,10 +112,11 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             if ($varParts[1]) {
                 return;
             }
-            $error = 'Short description duplicates class property name.';
-            $phpcsFile->addWarning($error, $isShortDescriptionAfterVar, 'AlreadyHaveMeaningFulNameVar');
+            $error = 'Short description must be before @var tag.';
+            $phpcsFile->addWarning($error, $isShortDescriptionAfterVar, 'ShortDescriptionAfterVar');
             return;
         }
+
         // Check if class has already have meaningful description before @var tag
         $isShortDescriptionPreviousVar = $phpcsFile->findPrevious(
             T_DOC_COMMENT_STRING,
@@ -125,23 +126,28 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             null,
             false
         );
-        if ($this->PHPDocFormattingValidator->providesMeaning(
-            $isShortDescriptionPreviousVar,
-            $commentStart,
-            $tokens
-        ) !== true) {
-            preg_match(
-                '`^((?:\|?(?:array\([^\)]*\)|[\\\\\[\]]+))*)( .*)?`i',
-                $tokens[($foundVar + 2)]['content'],
-                $varParts
-            );
-            if ($varParts[1]) {
-                return;
-            }
+
+        if (stripos($tokens[$isShortDescriptionPreviousVar]['content'], $tokens[$string]['content']) !== false) {
             $error = 'Short description duplicates class property name.';
-            $phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningFulNameVar');
+            $phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningfulNameVar');
             return;
         }
+        $re = '/
+                # Split camelCase "words". Two global alternatives. Either g1of2:
+                  (?<=[a-z])      # Position is after a lowercase,
+                  (?=[A-Z])       # and before an uppercase letter.
+                | (?<=[A-Z])      # Or g2of2; Position is after uppercase,
+                  (?=[A-Z][a-z])  # and before upper-then-lower case.
+                /x';
+        $varTagParts = preg_split($re, $tokens[$string]['content']);
+
+        foreach ($varTagParts as $part) {
+            if (stripos($tokens[$isShortDescriptionPreviousVar]['content'], $part) === false) {
+                return;
+            }
+        }
+        $error = 'Short description duplicates class property name.';
+        $phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningfulNameVar');
     }
 
     /**

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc

@@ -65,11 +65,25 @@ class Bar {
     private $variableName;
 
     /**
-     * Some more invalid description
+     * Some more invalid description with test which is the same name as the variable and is not allowed
      *
      * @var test
      */
     protected $test;
+
+    /**
+     * Formatted Correctly Protected Class Member
+     *
+     * @var correctlyFormattedProtectedClassMember
+     */
+    protected $correctlyFormattedProtectedClassMember;
+
+    /**
+     * anotherCorrectlyFormattedProtectedClassMember
+     *
+     * @var anotherCorrectlyFormattedProtectedClassMember
+     */
+    protected $anotherCorrectlyFormattedProtectedClassMember;
 }
 
 class correctlyFormattedClassMemberDocBlock
@@ -99,4 +113,11 @@ class correctlyFormattedClassMemberDocBlock
      *      \FooObject_TEST_C
      */
     private $testObject;
+
+    /**
+     * Fallback factory
+     *
+     * @var RulePool
+     */
+    protected $rulePool;
 }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.php

@@ -32,7 +32,9 @@ public function getWarningList()
             49 => 1,
             56 => 1,
             63 => 1,
-            68 => 1
+            68 => 1,
+            75 => 1,
+            82 => 1,
         ];
     }
 }