Merge pull request #2255 from WordPress/feature/core-add-oo-declarati…

…on-check

Core: add new sniff to check formatting of OO declaration statement

Tests/RulesetCheck/class-ruleset-test.inc

@@ -110,5 +110,4 @@ class Ruleset_Test {
 		end:
 		echo 'This is a goto - it needs to be here to prevent parse errors';
 	}
-
 }

WordPress-Core/ruleset.xml

@@ -778,6 +778,18 @@
 	<!-- Class opening braces should be on the same line as the statement. -->
 	<rule ref="Generic.Classes.OpeningBraceSameLine"/>
 
+	<!-- Implied via examples: one space after keywords in class declaration, class declaration on one line,
+		 close brace on line by itself and no blank lines between OO structure body and close brace. -->
+	<rule ref="PSR2.Classes.ClassDeclaration"/>
+	<rule ref="PSR2.Classes.ClassDeclaration.OpenBraceNewLine">
+		<!-- WP expects open brace on same line as class keyword. -->
+		<severity>0</severity>
+	</rule>
+	<rule ref="PSR2.Classes.ClassDeclaration.OpenBraceWrongLine">
+		<!-- WP expects open brace on same line as class keyword. -->
+		<severity>0</severity>
+	</rule>
+
 	<!-- References to self in a class should be lower-case and not have extraneous spaces,
 		 per implicit conventions in the core codebase; the NotUsed code refers to using the
 		 fully-qualified class name instead of self, for which there are instances in core. -->

WordPress/AbstractArrayAssignmentRestrictionsSniff.php

@@ -240,5 +240,4 @@ public function process_token( $stackPtr ) {
 	 *                       with custom error message passed to ->process().
 	 */
 	abstract public function callback( $key, $val, $line, $group );
-
 }

WordPress/AbstractFunctionRestrictionsSniff.php

@@ -356,5 +356,4 @@ protected function prepare_name_for_regex( $function_name ) {
 
 		return $function_name;
 	}
-
 }

WordPress/Helpers/IsUnitTestTrait.php

@@ -178,5 +178,4 @@ protected function is_test_class( File $phpcsFile, $stackPtr ) {
 
 		return false;
 	}
-
 }

WordPress/Sniffs/Arrays/ArrayDeclarationSpacingSniff.php

@@ -466,5 +466,4 @@ protected function process_multi_line_array( $stackPtr, $opener, $closer ) {
 			$end_of_last_item = $end_of_this_item;
 		}
 	}
-
 }

WordPress/Sniffs/Arrays/ArrayIndentationSniff.php

@@ -545,5 +545,4 @@ protected function fix_alignment_error( $ptr, $new_indent ) {
 			$this->phpcsFile->fixer->replaceToken( ( $ptr - 1 ), $new_indent );
 		}
 	}
-
 }

WordPress/Sniffs/Arrays/ArrayKeySpacingRestrictionsSniff.php

@@ -173,5 +173,4 @@ public function process_token( $stackPtr ) {
 			}
 		}
 	}
-
 }

WordPress/Sniffs/Arrays/CommaAfterArrayItemSniff.php

@@ -309,5 +309,4 @@ public function process_token( $stackPtr ) {
 			}
 		}
 	}
-
 }

WordPress/Sniffs/Arrays/MultipleStatementAlignmentSniff.php

@@ -580,5 +580,4 @@ protected function validate_align_multiline_items() {
 		// Reset to the default if an invalid value was received.
 		$this->alignMultilineItems = 'always';
 	}
-
 }

WordPress/Sniffs/CodeAnalysis/EscapedNotTranslatedSniff.php

@@ -87,5 +87,4 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 			$data
 		);
 	}
-
 }

WordPress/Sniffs/DB/DirectDatabaseQuerySniff.php

@@ -297,5 +297,4 @@ protected function mergeFunctionLists() {
 			$this->addedCustomFunctions['cachedelete'] = $this->customCacheDeleteFunctions;
 		}
 	}
-
 }

WordPress/Sniffs/DB/PreparedSQLPlaceholdersSniff.php

@@ -654,5 +654,4 @@ protected function analyse_implode( $implode_token ) {
 
 		return (bool) preg_match( '`^(["\'])%[dfFs]\1$`', $array_fill_params[3]['raw'] );
 	}
-
 }

WordPress/Sniffs/DB/PreparedSQLSniff.php

@@ -241,5 +241,4 @@ function ( $symbol ) {
 
 		return $this->end;
 	}
-
 }

WordPress/Sniffs/DB/RestrictedClassesSniff.php

@@ -56,5 +56,4 @@ public function getGroups() {
 
 		);
 	}
-
 }

WordPress/Sniffs/DB/RestrictedFunctionsSniff.php

@@ -62,5 +62,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/DB/SlowDBQuerySniff.php

@@ -58,5 +58,4 @@ public function getGroups() {
 	public function callback( $key, $val, $line, $group ) {
 		return true;
 	}
-
 }

WordPress/Sniffs/DateTime/RestrictedFunctionsSniff.php

@@ -58,5 +58,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/PHP/DevelopmentFunctionsSniff.php

@@ -62,5 +62,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/PHP/DiscouragedPHPFunctionsSniff.php

@@ -99,5 +99,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/PHP/DontExtractSniff.php

@@ -51,5 +51,4 @@ public function getGroups() {
 
 		);
 	}
-
 }

WordPress/Sniffs/PHP/POSIXFunctionsSniff.php

@@ -72,5 +72,4 @@ public function getGroups() {
 
 		);
 	}
-
 }

WordPress/Sniffs/PHP/RestrictedPHPFunctionsSniff.php

@@ -44,5 +44,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/PHP/TypeCastsSniff.php

@@ -89,5 +89,4 @@ public function process_token( $stackPtr ) {
 				break;
 		}
 	}
-
 }

WordPress/Sniffs/PHP/YodaConditionsSniff.php

@@ -123,5 +123,4 @@ public function process_token( $stackPtr ) {
 
 		$this->phpcsFile->addError( 'Use Yoda Condition checks, you must.', $stackPtr, 'NotYoda' );
 	}
-
 }

WordPress/Sniffs/Security/NonceVerificationSniff.php

@@ -324,5 +324,4 @@ protected function mergeFunctionLists() {
 			$this->addedCustomFunctions['unslashsanitize'] = $this->customUnslashingSanitizingFunctions;
 		}
 	}
-
 }

WordPress/Sniffs/Security/PluginMenuSlugSniff.php

@@ -124,5 +124,4 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 			}
 		}
 	}
-
 }

WordPress/Sniffs/Security/SafeRedirectSniff.php

@@ -44,5 +44,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/Security/ValidatedSanitizedInputSniff.php

@@ -231,5 +231,4 @@ protected function mergeFunctionLists() {
 			$this->addedCustomFunctions['unslashsanitize'] = $this->customUnslashingSanitizingFunctions;
 		}
 	}
-
 }

WordPress/Sniffs/WP/CapabilitiesSniff.php

@@ -477,5 +477,4 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 			)
 		);
 	}
-
 }

WordPress/Sniffs/WP/CapitalPDangitSniff.php

@@ -309,5 +309,4 @@ protected function retrieve_misspellings( $match_stack ) {
 
 		return $misspelled;
 	}
-
 }

WordPress/Sniffs/WP/CronIntervalSniff.php

@@ -318,5 +318,4 @@ public function confused( $stackPtr ) {
 			'ChangeDetected'
 		);
 	}
-
 }

WordPress/Sniffs/WP/DeprecatedClassesSniff.php

@@ -121,5 +121,4 @@ public function process_matched_token( $stackPtr, $group_name, $matched_content
 			$data
 		);
 	}
-
 }

WordPress/Sniffs/WP/DeprecatedFunctionsSniff.php

@@ -1550,5 +1550,4 @@ public function process_matched_token( $stackPtr, $group_name, $matched_content
 			$data
 		);
 	}
-
 }

WordPress/Sniffs/WP/DeprecatedParameterValuesSniff.php

@@ -288,5 +288,4 @@ protected function process_parameter( $matched_content, $parameter, $parameter_a
 			$data
 		);
 	}
-
 }

WordPress/Sniffs/WP/DiscouragedConstantsSniff.php

@@ -237,5 +237,4 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 			);
 		}
 	}
-
 }

WordPress/Sniffs/WP/DiscouragedFunctionsSniff.php

@@ -53,5 +53,4 @@ public function getGroups() {
 			),
 		);
 	}
-
 }

WordPress/Sniffs/WP/GlobalVariablesOverrideSniff.php

@@ -435,5 +435,4 @@ protected function add_error( $stackPtr, $data = array() ) {
 			$data
 		);
 	}
-
 }

WordPress/Sniffs/WP/PostsPerPageSniff.php

@@ -74,5 +74,4 @@ public function callback( $key, $val, $line, $group ) {
 
 		return false;
 	}
-
 }

WordPress/Sniffs/WhiteSpace/CastStructureSpacingSniff.php

@@ -58,5 +58,4 @@ public function process_token( $stackPtr ) {
 			}
 		}
 	}
-
 }

WordPress/Sniffs/WhiteSpace/ControlStructureSpacingSniff.php

@@ -575,5 +575,4 @@ public function process_token( $stackPtr ) {
 			}
 		}
 	}
-
 }

WordPress/Sniffs/WhiteSpace/OperatorSpacingSniff.php

@@ -59,5 +59,4 @@ public function register() {
 
 		return $tokens;
 	}
-
 }

WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.php

@@ -111,5 +111,4 @@ public function getErrorList( $testFile = '' ) {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Arrays/ArrayIndentationUnitTest.php

@@ -161,5 +161,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Arrays/ArrayKeySpacingRestrictionsUnitTest.php

@@ -72,5 +72,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Arrays/CommaAfterArrayItemUnitTest.php

@@ -88,5 +88,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.php

@@ -170,5 +170,4 @@ public function getWarningList() {
 			570 => 1,
 		);
 	}
-
 }

WordPress/Tests/CodeAnalysis/EscapedNotTranslatedUnitTest.php

@@ -43,5 +43,4 @@ public function getWarningList() {
 			8 => 1,
 		);
 	}
-
 }

WordPress/Tests/DB/PreparedSQLPlaceholdersUnitTest.php

@@ -97,5 +97,4 @@ public function getWarningList() {
 			177 => 1,
 		);
 	}
-
 }

WordPress/Tests/DB/RestrictedClassesUnitTest.php

@@ -162,5 +162,4 @@ public function getErrorList( $testFile = '' ) {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/DB/RestrictedFunctionsUnitTest.php

@@ -125,5 +125,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/DB/SlowDBQueryUnitTest.php

@@ -48,5 +48,4 @@ public function getWarningList() {
 			19 => 2,
 		);
 	}
-
 }

WordPress/Tests/DateTime/RestrictedFunctionsUnitTest.php

@@ -42,5 +42,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Files/FileNameUnitTest.php

@@ -158,5 +158,4 @@ public function getErrorList( $testFile = '' ) {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/NamingConventions/PrefixAllGlobalsUnitTest.php

@@ -166,5 +166,4 @@ public function getWarningList( $testFile = 'PrefixAllGlobalsUnitTest.1.inc' ) {
 				return array();
 		}
 	}
-
 }

WordPress/Tests/NamingConventions/ValidVariableNameUnitTest.php

@@ -110,5 +110,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/PHP/DevelopmentFunctionsUnitTest.php

@@ -56,5 +56,4 @@ public function getWarningList() {
 			34 => 1,
 		);
 	}
-
 }

WordPress/Tests/PHP/DiscouragedPHPFunctionsUnitTest.php

@@ -64,5 +64,4 @@ public function getWarningList() {
 			39 => 1,
 		);
 	}
-
 }

WordPress/Tests/PHP/DontExtractUnitTest.php

@@ -43,5 +43,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/PHP/POSIXFunctionsUnitTest.php

@@ -48,5 +48,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/PHP/RestrictedPHPFunctionsUnitTest.php

@@ -41,5 +41,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/PHP/YodaConditionsUnitTest.php

@@ -60,5 +60,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Security/EscapeOutputUnitTest.php

@@ -106,5 +106,4 @@ public function getErrorList() {
 	public function getWarningList() {
 		return array();
 	}
-
 }

WordPress/Tests/Security/SafeRedirectUnitTest.php

@@ -41,5 +41,4 @@ public function getWarningList() {
 			3 => 1,
 		);
 	}
-
 }