Merge pull request #1582 from WordPress-Coding-Standards/feature/remove-part-of-typecast-sniff

Core: Defer to upstream `Generic.PHP.LowerCaseType` sniff (PHPCS 3.3.0)

Author: GaryJones

WordPress-Core/ruleset.xml

@@ -248,6 +248,8 @@
 	<rule ref="Squiz.WhiteSpace.CastSpacing"/>
 	<rule ref="WordPress.WhiteSpace.CastStructureSpacing"/>
 	<rule ref="WordPress.PHP.TypeCasts"/>
+	<!-- N.B.: This sniff also checks the case of (parameter/return) type declarations, not just type casts. -->
+	<rule ref="Generic.PHP.LowerCaseType"/>
 
 	<!-- Covers rule: ... array items, only include a space around the index if it is a variable. -->
 	<rule ref="WordPress.Arrays.ArrayKeySpacingRestrictions"/>

WordPress/Sniffs/PHP/TypeCastsSniff.php

@@ -36,7 +36,10 @@ class TypeCastsSniff extends Sniff {
 	 * @return array
 	 */
 	public function register() {
-		return Tokens::$castTokens;
+		$targets = Tokens::$castTokens;
+		unset( $targets[ \T_ARRAY_CAST ], $targets[ \T_OBJECT_CAST ] );
+
+		return $targets;
 	}
 
 	/**
@@ -122,33 +125,6 @@ public function process_token( $stackPtr ) {
 				);
 				break;
 		}
-
-		/*
-		 * {@internal Once the minimum PHPCS version has gone up to PHPCS 3.3.0+, the lowercase
-		 * check below can be removed in favour of adding the `Generic.PHP.LowerCaseType` sniff
-		 * to the ruleset.
-		 * Note: the `register()` function also needs adjusting in that case to only register the
-		 * targetted type casts above and the metrics recording should probably be adjusted as well.
-		 * The above mentioned Generic sniff records metrics about the case of typecasts, so we
-		 * don't need to worry about those no longer being recorded. They will be, just slightly
-		 * differently.}}
-		 */
-		if ( $typecast_lc !== $typecast ) {
-			$data = array(
-				$typecast_lc,
-				$typecast,
-			);
-
-			$fix = $this->phpcsFile->addFixableError(
-				'PHP type casts must be lowercase; expected "%s" but found "%s"',
-				$stackPtr,
-				'NonLowercaseFound',
-				$data
-			);
-			if ( true === $fix ) {
-				$this->phpcsFile->fixer->replaceToken( $stackPtr, $typecast_lc );
-			}
-		}
 	}
 
 }

WordPress/Tests/PHP/TypeCastsUnitTest.inc

@@ -20,34 +20,6 @@ $a = (binary) $b; // Warning.
 $a = b"binary string"; // Warning.
 $a = b"binary $string"; // Warning.
 
-// Error: Mixed case.
-$a = (Bool) $b;
-$a = (Boolean) $b; // + wrong form.
-$a = (Int) $b;
-$a = (Integer) $b; // + wrong form.
-$a = (Float) $b;
-$a = (Double) $b; // + wrong form.
-$a = (Real) $b; // + wrong form.
-$a = (String) $b;
-$a = (Array) $b;
-$a = (Object) $b;
-$a = (Unset) $b; // + discouraged.
-$a = (Binary) $b; // + discouraged.
-
-// Error: Uppercase.
-$a = (BOOL) $b;
-$a = (BOOLEAN) $b; // + wrong form.
-$a = (INT) $b;
-$a = (INTEGER) $b; // + wrong form.
-$a = (FLOAT) $b;
-$a = (DOUBLE) $b; // + wrong form.
-$a = (REAL) $b; // + wrong form.
-$a = (STRING) $b;
-$a = (ARRAY) $b;
-$a = (OBJECT) $b;
-$a = (UNSET) $b; // + discouraged.
-$a = (BINARY) $b; // + discouraged.
-
 // Test recognition with whitespace within the cast.
 // OK.
 $a = (  bool  ) $b;

WordPress/Tests/PHP/TypeCastsUnitTest.inc.fixed

@@ -20,34 +20,6 @@ $a = (binary) $b; // Warning.
 $a = b"binary string"; // Warning.
 $a = b"binary $string"; // Warning.
 
-// Error: Mixed case.
-$a = (bool) $b;
-$a = (bool) $b; // + wrong form.
-$a = (int) $b;
-$a = (int) $b; // + wrong form.
-$a = (float) $b;
-$a = (float) $b; // + wrong form.
-$a = (float) $b; // + wrong form.
-$a = (string) $b;
-$a = (array) $b;
-$a = (object) $b;
-$a = (unset) $b; // + discouraged.
-$a = (binary) $b; // + discouraged.
-
-// Error: Uppercase.
-$a = (bool) $b;
-$a = (bool) $b; // + wrong form.
-$a = (int) $b;
-$a = (int) $b; // + wrong form.
-$a = (float) $b;
-$a = (float) $b; // + wrong form.
-$a = (float) $b; // + wrong form.
-$a = (string) $b;
-$a = (array) $b;
-$a = (object) $b;
-$a = (unset) $b; // + discouraged.
-$a = (binary) $b; // + discouraged.
-
 // Test recognition with whitespace within the cast.
 // OK.
 $a = (  bool  ) $b;

WordPress/Tests/PHP/TypeCastsUnitTest.php

@@ -32,34 +32,10 @@ public function getErrorList() {
 			13 => 1,
 			14 => 1,
 			15 => 1,
-			24 => 1,
-			25 => 2,
-			26 => 1,
-			27 => 2,
-			28 => 1,
-			29 => 2,
-			30 => 2,
-			31 => 1,
 			32 => 1,
 			33 => 1,
 			34 => 1,
 			35 => 1,
-			38 => 1,
-			39 => 2,
-			40 => 1,
-			41 => 2,
-			42 => 1,
-			43 => 2,
-			44 => 2,
-			45 => 1,
-			46 => 1,
-			47 => 1,
-			48 => 1,
-			49 => 1,
-			60 => 1,
-			61 => 1,
-			62 => 1,
-			63 => 1,
 		);
 	}
 
@@ -74,12 +50,8 @@ public function getWarningList() {
 			19 => 1,
 			20 => ( version_compare( PHPCSHelper::get_version(), '3.4.0', '<' ) === true ? 0 : 1 ),
 			21 => 1,
-			34 => 1,
-			35 => 1,
-			48 => 1,
-			49 => 1,
-			64 => 1,
-			65 => 1,
+			36 => 1,
+			37 => 1,
 		);
 	}
 }