Merge pull request #2191 from WordPress/feature/`validfunctionname-ph…

…pcsutils-and-modern-php

WordPress/Sniffs/NamingConventions/ValidFunctionNameSniff.php

@@ -11,6 +11,7 @@
 
 use PHPCSUtils\BackCompat\BCTokens;
 use PHPCSUtils\Utils\FunctionDeclarations;
+use PHPCSUtils\Utils\NamingConventions;
 use PHPCSUtils\Utils\ObjectDeclarations;
 use PHPCSUtils\Utils\Scopes;
 use WordPressCS\WordPress\Helpers\DeprecationHelper;
@@ -127,7 +128,7 @@ protected function process_function_declaration( $stackPtr, $functionName ) {
 	 *
 	 * @since 0.1.0
 	 * @since 3.0.0 Renamed from `processTokenWithinScope()` to `process_method_declaration()`.
-	 *              Method signature has been changed as well as this method no longer overloads
+	 *              Method signature has been changed as well, as this method no longer overloads
 	 *              a method from the PEAR sniff which was previously the sniff parent.
 	 *
 	 * @param int    $stackPtr   The position where this token was found.
@@ -142,19 +143,16 @@ protected function process_method_declaration( $stackPtr, $methodName, $currScop
 			$className = '[Anonymous Class]';
 		} else {
 			$className = ObjectDeclarations::getName( $this->phpcsFile, $currScope );
-		}
 
-		$methodNameLc = strtolower( $methodName );
-		$classNameLc  = strtolower( $className );
+			// PHP4 constructors are allowed to break our rules.
+			if ( NamingConventions::isEqual( $methodName, $className ) === true ) {
+				return;
+			}
 
-		// PHP4 constructors are allowed to break our rules.
-		if ( $methodNameLc === $classNameLc ) {
-			return;
-		}
-
-		// PHP4 destructors are allowed to break our rules.
-		if ( '_' . $classNameLc === $methodNameLc ) {
-			return;
+			// PHP4 destructors are allowed to break our rules.
+			if ( NamingConventions::isEqual( $methodName, '_' . $className ) === true ) {
+				return;
+			}
 		}
 
 		// PHP magic methods are exempt from our rules.
@@ -178,7 +176,7 @@ protected function process_method_declaration( $stackPtr, $methodName, $currScop
 		}
 
 		// Check for all lowercase.
-		if ( $methodNameLc !== $methodName ) {
+		if ( strtolower( $methodName ) !== $methodName ) {
 			$error     = 'Method name "%s" in class %s is not in snake case format, try "%s"';
 			$errorData = array(
 				$methodName,
@@ -188,5 +186,4 @@ protected function process_method_declaration( $stackPtr, $methodName, $currScop
 			$this->phpcsFile->addError( $error, $stackPtr, 'MethodNameInvalid', $errorData );
 		}
 	}
-
 }

WordPress/Tests/NamingConventions/ValidFunctionNameUnitTest.inc

@@ -184,3 +184,40 @@ class UnderScoreHandling {
 	public function Multiple_______Underscores() {} // Bad, replacement suggestion should be: multiple_______underscores.
 	public function Trailing_Underscores___() {}// Bad, replacement suggestion should be: trailing_underscores___.
 }
+
+// Safeguard that functions with a name only consisting of underscores are always ignored.
+function __() {}
+
+class OnlyUnderscores {
+	public function _____() {}
+}
+
+// Class vs function name PHP case-sensitivity quirks.
+class FooBÃÈ {
+	function FooBÃÈ() {} // OK, same case.
+	function fOOBÃÈ() {} // OK, same case for the non-ascii chars.
+	function FooBãè() {} // Bad - not PHP 4-type constructor, non ascii chars not in same case - POC: https://3v4l.org/YOc2R.
+}
+
+// Safeguard that methods in enums are correctly handled by the sniff.
+enum Suit {
+	case Hearts;
+	case Diamonds;
+
+	public function color(): string {} // OK.
+	public function __changeColor(): string {} // Bad
+
+	public function &getShape(): string // Bad.
+	{
+		return "Rectangle";
+	}
+
+	// These are the only three magic methods allowed in enums.
+	public function __call( $a, $b ) {} // Ok.
+	public static function __callStatic( $a, $b ) {} // Ok.
+	public function __invoke() {} // Ok.
+}
+
+// Live coding/parse error.
+// This has to be the last test in the file.
+function

WordPress/Tests/NamingConventions/ValidFunctionNameUnitTest.php

@@ -50,6 +50,9 @@ public function getErrorList() {
 			183 => 1,
 			184 => 1,
 			185 => 1,
+			199 => 1,
+			208 => 2,
+			210 => 1,
 		);
 	}
 
@@ -61,5 +64,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }