Merge pull request #21 from awesomemotive/issue/2-no-empty-line-before-break

Remove requirement for a new line before break statement inside the switch.

Author: kagg-design

WPForms/Sniffs/BaseSniff.php

@@ -151,6 +151,30 @@ protected function getFirstArgument( $phpcsFile, $stackPtr ) {
 		);
 	}
 
+	/**
+	 * Check whether the token is break in switch statement.
+	 *
+	 * @since 1.0.4
+	 *
+	 * @param File  $phpcsFile The PHP_CodeSniffer file where the token was found.
+	 * @param array $token     First token on the next line.
+	 *
+	 * @return bool
+	 */
+	protected function isBreakInSwitch( $phpcsFile, $token ) {
+
+		$tokens = $phpcsFile->getTokens();
+
+		if ( $token['code'] !== T_BREAK ) {
+			return false;
+		}
+
+		return (
+			isset( $token['scope_condition'] ) &&
+			in_array( $tokens[ $token['scope_condition'] ]['code'], [ T_CASE, T_DEFAULT ], true )
+		);
+	}
+
 	/**
 	 * Get fully qualified class name.
 	 *

WPForms/Sniffs/Formatting/EmptyLineAfterAssigmentVariablesSniff.php

@@ -62,7 +62,10 @@ public function process( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		if ( in_array( $nextLineTokens[0]['code'], $this->getAllowedTokensAfterAssigment(), true ) ) {
+		if (
+			$this->isBreakInSwitch( $phpcsFile, $nextLineTokens[0] ) ||
+			in_array( $nextLineTokens[0]['code'], $this->getAllowedTokensAfterAssigment(), true )
+		) {
 			return;
 		}
 

WPForms/Sniffs/Formatting/SwitchSniff.php

@@ -52,7 +52,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 			$this->processCase( $phpcsFile, $stackPtr );
 		}
 
-		if ( $tokens[ $stackPtr ]['code'] === T_BREAK ) {
+		if ( $this->isBreakInSwitch( $phpcsFile, $tokens[ $stackPtr ] ) ) {
 			$this->processBreak( $phpcsFile, $stackPtr );
 		}
 	}
@@ -70,6 +70,10 @@ private function processSwitch( File $phpcsFile, $stackPtr ) {
 		$tokens   = $phpcsFile->getTokens();
 		$previous = $phpcsFile->findPrevious( T_WHITESPACE, $stackPtr - 1, null, true );
 
+		if ( $previous === false ) {
+			return;
+		}
+
 		if ( $tokens[ $stackPtr ]['line'] - $tokens[ $previous ]['line'] === 1 ) {
 			$this->addEmptyLineError( $phpcsFile, $stackPtr );
 		}
@@ -82,7 +86,7 @@ private function processSwitch( File $phpcsFile, $stackPtr ) {
 
 		$next = $phpcsFile->findNext( T_WHITESPACE, $tokens[ $stackPtr ]['scope_closer'] + 1, null, true );
 
-		if ( $tokens[ $next ]['code'] === T_CLOSE_CURLY_BRACKET ) {
+		if ( $next === false || ( $tokens[ $next ]['code'] === T_CLOSE_CURLY_BRACKET ) ) {
 			return;
 		}
 
@@ -156,8 +160,8 @@ private function processBreak( File $phpcsFile, $stackPtr ) {
 
 		$previousStatement = $phpcsFile->findFirstOnLine( [ T_CASE, T_DEFAULT ], $previous );
 
-		if ( empty( $previousStatement ) && $tokens[ $stackPtr ]['line'] - $tokens[ $previous ]['line'] !== 2 ) {
-			$this->addEmptyLineError( $phpcsFile, $stackPtr );
+		if ( empty( $previousStatement ) && $tokens[ $stackPtr ]['line'] - $tokens[ $previous ]['line'] !== 1 ) {
+			$this->removeEmptyLineError( $phpcsFile, $stackPtr );
 		}
 	}
 

WPForms/Tests/TestFiles/Formatting/EmptyLineAfterAssigmentVariables.php

@@ -137,3 +137,34 @@ function invalid2() {
 		unset( $types[ $key ] );
 	}
 }
+
+// Good example.
+switch ( $foo ) {
+	case 'foo':
+		$bar = 1;
+		break;
+
+	case 'bar':
+		echo 1;
+		break;
+
+	case 'baz':
+		$bar = 3;
+		break;
+
+	case 'krya':
+	default:
+		$bar = 4;
+		break;
+}
+
+// Good example.
+foreach ( $rays as $ray ) {
+	if ( $ray === 1 ) {
+		$a = 2;
+
+		break;
+	}
+
+	$c = 3;
+}

WPForms/Tests/TestFiles/Formatting/Switch.php

@@ -9,13 +9,11 @@ public function example( $args ) {
 		switch ( $args ) {
 			case 'a':
 				example( $args );
-
 				break;
 
 			case 'b':
 			case 'c':
 				$value = 2;
-
 				break;
 
 			case 'd':
@@ -31,13 +29,11 @@ public function example_2( $args ) {
 		switch ( $args ) {
 			case 'a':
 				example( $args );
-
 				break;
 
 			case 'b':
 			case 'c':
 				$value = 2;
-
 				break;
 
 			default:
@@ -65,11 +61,13 @@ public function example( $args ) {
 
 			case 'a':
 				example( $args );
+
 				break;
 			case 'b':
 
 			case 'c':
 				$value = 2;
+
 				break;
 
 			default:
@@ -83,10 +81,12 @@ public function example_2( $args ) {
 		switch ( $args ) {
 			case 'a':
 				example( $args );
+
 				break;
 			case 'b':
 			case 'c':
 				$value = 2;
+
 				break;
 			default:
 				$value = 3;

WPForms/Tests/Tests/Formatting/SwitchTest.php

@@ -21,7 +21,7 @@ public function testProcess() {
 
 		$phpcsFile = $this->process( new SwitchSniff() );
 
-		$this->fileHasErrors( $phpcsFile, 'AddEmptyLineBefore', [ 64, 68, 69, 73, 86, 87, 90, 91, 94 ] );
-		$this->fileHasErrors( $phpcsFile, 'RemoveEmptyLineBefore', [ 66, 71, 78 ] );
+		$this->fileHasErrors( $phpcsFile, 'AddEmptyLineBefore', [ 60, 66, 86, 91, 94 ] );
+		$this->fileHasErrors( $phpcsFile, 'RemoveEmptyLineBefore', [ 62, 65, 68, 71, 76, 85, 90 ] );
 	}
 }