Roughs in a simple ReturnTrailingNewlineSniff

Author: donatj

src/Corpus/Sniffs/General/ReturnTrailingNewlineSniff.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Corpus\Sniffs\General;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ReturnTrailingNewlineSniff implements Sniff {
+
+	public const CODE_RETURN_HAS_TRAILING_NEWLINE = 'ReturnHasTrailingNewline';
+
+	/**
+	 * @inheritDoc
+	 */
+	public function register() {
+		return [ T_RETURN ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function process( File $phpcsFile, $stackPtr ) {
+		$tokens = $phpcsFile->getTokens();
+
+		$eosPtr  = $phpcsFile->findEndOfStatement($stackPtr);
+		$nextPtr = $phpcsFile->findNext(T_WHITESPACE, $eosPtr + 1, null, true);
+		if( !$nextPtr ) {
+			return;
+		}
+
+		if( $tokens[$nextPtr]['code'] !== T_CLOSE_CURLY_BRACKET ) {
+			return;
+		}
+
+		if( $tokens[$nextPtr]['line'] <= $tokens[$eosPtr]['line'] + 1 ) {
+			return;
+		}
+
+		$fix = $phpcsFile->addFixableError(
+			'There must be no blank lines between return and the following curly brace',
+			$stackPtr,
+			self::CODE_RETURN_HAS_TRAILING_NEWLINE
+		);
+		if( $fix ) {
+			$phpcsFile->fixer->beginChangeset();
+			for( $removePtr = $eosPtr + 1; $removePtr <= $nextPtr; $removePtr++ ) {
+				if( $tokens[$removePtr + 1]['line'] === $tokens[$nextPtr]['line'] ) {
+					break;
+				}
+
+				$phpcsFile->fixer->replaceToken($removePtr, '');
+			}
+
+			$phpcsFile->fixer->endChangeset();
+		}
+	}
+
+}

test/Corpus/Sniffs/General/ReturnTrailingNewline.data/examples.fixed.php

@@ -0,0 +1,36 @@
+<?php
+
+function foo() {
+
+	return;
+}
+
+function bar() {
+	return 1;
+}
+
+
+class Foo {
+
+	function foo() {
+		if(true) {
+			return;
+		}
+
+	}
+
+	function bar() {
+		return 1;
+	}
+
+
+}
+
+function baz() {
+	return 1;
+
+	// This is fine
+}
+
+// nothing after this, ignore
+return;

test/Corpus/Sniffs/General/ReturnTrailingNewline.data/examples.php

@@ -0,0 +1,40 @@
+<?php
+
+function foo() {
+
+	return;
+
+}
+
+function bar() {
+	return 1;
+
+}
+
+
+class Foo {
+
+	function foo() {
+		if(true) {
+			return;
+
+		}
+
+	}
+
+	function bar() {
+		return 1;
+
+	}
+
+
+}
+
+function baz() {
+	return 1;
+
+	// This is fine
+}
+
+// nothing after this, ignore
+return;

test/Corpus/Sniffs/General/ReturnTrailingNewline.data/rootreturn.php

@@ -0,0 +1,6 @@
+<?php
+
+// Returning from the root shouldn't do anything
+
+return [];
+

test/Corpus/Sniffs/General/ReturnTrailingNewlineSniffTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Corpus\Sniffs\General;
+
+use SlevomatCodingStandard\Sniffs\TestCase;
+
+class ReturnTrailingNewlineSniffTest extends TestCase {
+
+	public function testErrors() : void {
+		$report = self::checkFile(__DIR__ . '/ReturnTrailingNewline.data/examples.php');
+		$this->assertSame(4, $report->getErrorCount());
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testRootReturn() : void{
+		$report = self::checkFile(__DIR__ . '/ReturnTrailingNewline.data/rootreturn.php');
+		$this->assertSame(0, $report->getErrorCount());
+	}
+
+}