Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Fix indentation of multiline function declarations

Browse Source 
[MAILPOET-3732]
This commit is contained in:
Pavel Dohnal
2021-09-17 10:29:00 +02:00
committed by Jan Lysý
parent cdda3480ca
commit 21839fc30b
200 changed files with 707 additions and 349 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/Subscribers/ImportExport/ImportExportFactory.php
View File

@ -96,7 +96,8 @@ class ImportExportFactory {
public function formatFieldsForSelect2(
$subscriberFields,
$subscriberCustomFields) {
$subscriberCustomFields
) {
$actions = ($this->action === 'import') ?
[
[

3
lib/Tasks/State.php
View File

@ -55,7 +55,8 @@ class State {
ScheduledTask::STATUS_SCHEDULED,
ScheduledTask::VIRTUAL_STATUS_RUNNING,
],
$limit = Scheduler::TASK_BATCH_SIZE) {
$limit = Scheduler::TASK_BATCH_SIZE
) {
$tasks = [];
foreach ($statuses as $status) {
$query = ScheduledTask::orderByDesc('id')

353
tasks/code_sniffer/MailPoet/Sniffs/ControlStructures/FunctionDeclarationSniff.php Normal file
View File

@ -0,0 +1,353 @@
<?php
/**
* Ensure multi-line function declarations are defined correctly.
* Copy from PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\FunctionDeclarationSniff
*
*/
namespace MailPoet\Sniffs;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Tokens;
class FunctionDeclarationSniff implements Sniff {
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [
'PHP',
'JS',
];
/**
* The number of spaces code should be indented.
*
* @var int
*/
public $indent = 2;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register() {
return [
T_FUNCTION,
T_CLOSURE,
];
}//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
*
* @return void
*/
public function process(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
if (isset($tokens[$stackPtr]['parenthesis_opener']) === false
|| isset($tokens[$stackPtr]['parenthesis_closer']) === false
|| $tokens[$stackPtr]['parenthesis_opener'] === null
|| $tokens[$stackPtr]['parenthesis_closer'] === null
) {
return;
}
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
if ($this->isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tokens) === true) {
$this->processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens);
} else {
$this->processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens);
}
}//end process()
/**
* Determine if this is a multi-line function declaration.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
* @param int $openBracket The position of the opening bracket
* in the stack passed in $tokens.
* @param array $tokens The stack of tokens that make up
* the file.
*
* @return bool
*/
public function isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tokens) {
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) {
return true;
}
return false;
}//end isMultiLineDeclaration()
/**
* Processes single-line declarations.
*
* Just uses the Generic BSD-Allman brace sniff.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
* @param array $tokens The stack of tokens that make up
* the file.
*
* @return void
*/
public function processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens) {
}//end processSingleLineDeclaration()
/**
* Processes multi-line declarations.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
* @param array $tokens The stack of tokens that make up
* the file.
*
* @return void
*/
public function processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens) {
$this->processArgumentList($phpcsFile, $stackPtr, $this->indent);
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
if ($use !== false) {
$open = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
$closeBracket = $tokens[$open]['parenthesis_closer'];
}
}
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
return;
}
// The opening brace needs to be one space away from the closing parenthesis.
$opener = $tokens[$stackPtr]['scope_opener'];
if ($tokens[$opener]['line'] !== $tokens[$closeBracket]['line']) {
$error = 'The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line';
$fix = $phpcsFile->addFixableError($error, $opener, 'NewlineBeforeOpenBrace');
if ($fix === true) {
$prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($opener - 1), $closeBracket, true);
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->addContent($prev, ' {');
// If the opener is on a line by itself, removing it will create
// an empty line, so just remove the entire line instead.
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($opener - 1), $closeBracket, true);
$next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true);
if ($tokens[$prev]['line'] < $tokens[$opener]['line']
&& $tokens[$next]['line'] > $tokens[$opener]['line']
) {
// Clear the whole line.
for ($i = ($prev + 1); $i < $next; $i++) {
if ($tokens[$i]['line'] === $tokens[$opener]['line']) {
$phpcsFile->fixer->replaceToken($i, '');
}
}
} else {
// Just remove the opener.
$phpcsFile->fixer->replaceToken($opener, '');
if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
$phpcsFile->fixer->replaceToken(($opener + 1), '');
}
}
$phpcsFile->fixer->endChangeset();
}//end if
} else {
$prev = $tokens[($opener - 1)];
if ($prev['code'] !== T_WHITESPACE) {
$length = 0;
} else {
$length = strlen($prev['content']);
}
if ($length !== 1) {
$error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found %s spaces';
$fix = $phpcsFile->addFixableError($error, ($opener - 1), 'SpaceBeforeOpenBrace', [$length]);
if ($fix === true) {
if ($length === 0) {
$phpcsFile->fixer->addContentBefore($opener, ' ');
} else {
$phpcsFile->fixer->replaceToken(($opener - 1), ' ');
}
}
return;
}//end if
}//end if
}//end processMultiLineDeclaration()
/**
* Processes multi-line argument list declarations.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
* @param int $indent The number of spaces code should be indented.
* @param string $type The type of the token the brackets
* belong to.
*
* @return void
*/
public function processArgumentList($phpcsFile, $stackPtr, $indent, $type='function') {
$tokens = $phpcsFile->getTokens();
// We need to work out how far indented the function
// declaration itself is, so we can work out how far to
// indent parameters.
$functionIndent = 0;
for ($i = ($stackPtr - 1); $i >= 0; $i--) {
if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
break;
}
}
// Move $i back to the line the function is or to 0.
$i++;
if ($tokens[$i]['code'] === T_WHITESPACE) {
$functionIndent = $tokens[$i]['length'];
}
// The closing parenthesis must be on a new line, even
// when checking abstract function definitions.
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
$prev = $phpcsFile->findPrevious(
T_WHITESPACE,
($closeBracket - 1),
null,
true
);
if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']
&& $tokens[$prev]['line'] === $tokens[$closeBracket]['line']
) {
$error = 'The closing parenthesis of a multi-line ' . $type . ' declaration must be on a new line';
$fix = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine');
if ($fix === true) {
$phpcsFile->fixer->addNewlineBefore($closeBracket);
}
}
// If this is a closure and is using a USE statement, the closing
// parenthesis we need to look at from now on is the closing parenthesis
// of the USE statement.
if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
$use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']);
if ($use !== false) {
$open = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1));
$closeBracket = $tokens[$open]['parenthesis_closer'];
$prev = $phpcsFile->findPrevious(
T_WHITESPACE,
($closeBracket - 1),
null,
true
);
if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']
&& $tokens[$prev]['line'] === $tokens[$closeBracket]['line']
) {
$error = 'The closing parenthesis of a multi-line use declaration must be on a new line';
$fix = $phpcsFile->addFixableError($error, $closeBracket, 'UseCloseBracketLine');
if ($fix === true) {
$phpcsFile->fixer->addNewlineBefore($closeBracket);
}
}
}//end if
}//end if
// Each line between the parenthesis should be indented 4 spaces.
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
$lastLine = $tokens[$openBracket]['line'];
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
if ($tokens[$i]['line'] !== $lastLine) {
if ($i === $tokens[$stackPtr]['parenthesis_closer']
|| ($tokens[$i]['code'] === T_WHITESPACE
&& (($i + 1) === $closeBracket
|| ($i + 1) === $tokens[$stackPtr]['parenthesis_closer']))
) {
// Closing braces need to be indented to the same level
// as the function.
$expectedIndent = $functionIndent;
} else {
$expectedIndent = ($functionIndent + $indent);
}
// We changed lines, so this should be a whitespace indent token.
if ($tokens[$i]['code'] !== T_WHITESPACE) {
$foundIndent = 0;
} else if ($tokens[$i]['line'] !== $tokens[($i + 1)]['line']) {
// This is an empty line, so don't check the indent.
$foundIndent = $expectedIndent;
$error = 'Blank lines are not allowed in a multi-line ' . $type . ' declaration';
$fix = $phpcsFile->addFixableError($error, $i, 'EmptyLine');
if ($fix === true) {
$phpcsFile->fixer->replaceToken($i, '');
}
} else {
$foundIndent = $tokens[$i]['length'];
}
if ($expectedIndent !== $foundIndent) {
$error = 'Multi-line ' . $type . ' declaration not indented correctly; expected %s spaces but found %s';
$data = [
$expectedIndent,
$foundIndent,
];
$fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data);
if ($fix === true) {
$spaces = str_repeat(' ', $expectedIndent);
if ($foundIndent === 0) {
$phpcsFile->fixer->addContentBefore($i, $spaces);
} else {
$phpcsFile->fixer->replaceToken($i, $spaces);
}
}
}
$lastLine = $tokens[$i]['line'];
}//end if
if ($tokens[$i]['code'] === T_ARRAY || $tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
// Skip arrays as they have their own indentation rules.
if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) {
$i = $tokens[$i]['bracket_closer'];
} else {
$i = $tokens[$i]['parenthesis_closer'];
}
$lastLine = $tokens[$i]['line'];
continue;
}
}//end for
}//end processArgumentList()
}//end class

2
tasks/code_sniffer/MailPoet/ruleset.xml
View File

@ -80,6 +80,8 @@
<property name="indent" value="2"/>
</properties>
</rule>
<!-- Enforce indentation on multiline function declarations -->
<rule ref="MailPoet.ControlStructures.FunctionDeclaration"/>
<!-- Spacing -->
<rule ref="Squiz.WhiteSpace.FunctionSpacing">

3
tests/integration/Newsletter/ShortcodesTest.php
View File

@ -106,7 +106,8 @@ class ShortcodesTest extends \MailPoetTest {
$result = $shortcodesObject->process($shortcode);
expect($result[0])->false();
add_filter('mailpoet_newsletter_shortcode', function(
$shortcode, $newsletter, $subscriber, $queue, $content, $arguments) {
$shortcode, $newsletter, $subscriber, $queue, $content, $arguments
) {
expect($arguments)->count(2);
expect($arguments['arg1'])->equals('val1');
expect($arguments['arg2'])->equals('val2');