Fixed wrongly returning error for valid descriptions

Author: svera

Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php

@@ -143,9 +143,16 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             return;
         };
         $propertyName = trim($tokens[$propertyNamePosition]['content'], '$');
+
+        if (strtolower($tokens[$isShortDescriptionPreviousVar]['content']) === strtolower($propertyName)) {
+            $error = 'Short description duplicates class property name.';
+            $phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningfulNameVar');
+            return;
+        }
+
         $propertyNameParts = array_filter(preg_split('/(?=[A-Z])/', $propertyName));
 
-        if (stripos($tokens[$isShortDescriptionPreviousVar]['content'], implode('', $propertyNameParts)) !== false) {
+        if (strtolower($tokens[$isShortDescriptionPreviousVar]['content']) === strtolower(implode(' ', $propertyNameParts))) {
             $error = 'Short description duplicates class property name.';
             $phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningfulNameVar');
         }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc

@@ -65,14 +65,7 @@ class Bar {
     private $variableName;
 
     /**
-     * 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
+     * Correctly Formatted Protected Class Member
      *
      * @var correctlyFormattedProtectedClassMember
      */
@@ -120,4 +113,11 @@ class correctlyFormattedClassMemberDocBlock
      * @var RulePool
      */
     protected $rulePool;
+
+    /**
+     * A description that includes test which is the same name as the variable is allowed
+     *
+     * @var test
+     */
+    protected $test;
 }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.php

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