Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NoBlankLines*: fix removing lines consisting only of spaces #4109

Merged
merged 1 commit into from
Dec 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/AbstractLinesBeforeNamespaceFixer.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,12 @@ protected function fixLinesBeforeNamespace(Tokens $tokens, $index, $expectedMin,

return;
}
$newWhitespaceToken = new Token([T_WHITESPACE, str_repeat($lineEnding, $newlinesForWhitespaceToken)]);
if ($previous->isWhitespace()) {
// Fix the previous whitespace token
$tokens[$previousIndex] = $newWhitespaceToken;
$tokens[$previousIndex] = new Token([T_WHITESPACE, str_repeat($lineEnding, $newlinesForWhitespaceToken).substr($previous->getContent(), strrpos($previous->getContent(), "\n") + 1)]);
} else {
// Add a new whitespace token
$tokens->insertAt($index, $newWhitespaceToken);
$tokens->insertAt($index, new Token([T_WHITESPACE, str_repeat($lineEnding, $newlinesForWhitespaceToken)]));
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Utils;

/**
* @author Ceeram <ceeram@cakephp.org>
Expand Down Expand Up @@ -87,8 +86,7 @@ private function fixWhitespace(Tokens $tokens, $index)
// if there is more than one new line in the whitespace, then we need to fix it
if (substr_count($content, "\n") > 1) {
// the final bit of the whitespace must be the next statement's indentation
$lines = Utils::splitLines($content);
$tokens[$index] = new Token([T_WHITESPACE, $this->whitespacesConfig->getLineEnding().end($lines)]);
$tokens[$index] = new Token([T_WHITESPACE, $this->whitespacesConfig->getLineEnding().substr($content, strrpos($content, "\n") + 1)]);
}
}
}
4 changes: 1 addition & 3 deletions src/Fixer/Phpdoc/NoBlankLinesAfterPhpdocFixer.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Utils;

/**
* @author Graham Campbell <graham@alt-three.com>
Expand Down Expand Up @@ -107,8 +106,7 @@ private function fixWhitespace(Tokens $tokens, $index)
// if there is more than one new line in the whitespace, then we need to fix it
if (substr_count($content, "\n") > 1) {
// the final bit of the whitespace must be the next statement's indentation
$lines = Utils::splitLines($content);
$tokens[$index] = new Token([T_WHITESPACE, "\n".end($lines)]);
$tokens[$index] = new Token([T_WHITESPACE, substr($content, strrpos($content, "\n"))]);
}
}
}
1 change: 0 additions & 1 deletion tests/AutoReview/FixerFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,6 @@ public function provideFixersPriorityCases()
[$fixers['no_useless_return'], $fixers['blank_line_before_statement']],
[$fixers['no_useless_return'], $fixers['no_extra_blank_lines']],
[$fixers['no_useless_return'], $fixers['no_whitespace_in_blank_line']],
[$fixers['no_whitespace_in_blank_line'], $fixers['no_blank_lines_after_phpdoc']],
[$fixers['ordered_class_elements'], $fixers['class_attributes_separation']],
[$fixers['ordered_class_elements'], $fixers['method_separation']],
[$fixers['ordered_class_elements'], $fixers['no_blank_lines_after_class_opening']],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,40 @@ function firstMethod()
}',
];

// check if line with spaces is removed when next token is indented
$cases[] = [
'<?php
class Foo
{
function bar() {}
}
',
'<?php
class Foo
{
'.'
function bar() {}
}
',
];

// check if line with spaces is removed when next token is not indented
$cases[] = [
'<?php
class Foo
{
function bar() {}
}
',
'<?php
class Foo
{
'.'
function bar() {}
}
',
];

return $cases;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,28 @@ public function provideFixCases()
["<?php\nnamespace X;", "<?php\r\n\r\n\r\n\r\nnamespace X;"],
["<?php\r\nnamespace X;", "<?php\r\n\r\n\r\n\r\nnamespace X;", new WhitespacesFixerConfig(' ', "\r\n")],
["<?php\n\nnamespace\\Sub\\Foo::bar();"],
[
'<?php
// Foo
namespace Foo;
',
'<?php
// Foo
'.'
namespace Foo;
',
],
[
'<?php
// Foo
namespace Foo;
',
'<?php
// Foo
'.'
namespace Foo;
',
],
];
}

Expand Down
34 changes: 34 additions & 0 deletions tests/Fixer/Phpdoc/NoBlankLinesAfterPhpdocFixerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,40 @@ public function testLineBeforeDeclareIsNotBeRemoved()
$this->doTest($expected);
}

public function testLineWithSpacesIsRemovedWhenNextTokenIsIndented()
{
$this->doTest(
'<?php
/**
* PHPDoc with a line with space
*/
class Foo {}',
'<?php
/**
* PHPDoc with a line with space
*/
'.'
class Foo {}'
);
}

public function testLineWithSpacesIsRemovedWhenNextTokenIsNotIndented()
{
$this->doTest(
'<?php
/**
* PHPDoc with a line with space
*/
class Foo {}',
'<?php
/**
* PHPDoc with a line with space
*/
'.'
class Foo {}'
);
}

public function testFixesSimpleClass()
{
$expected = <<<'EOF'
Expand Down