Skip to content
/ rector-src Public

[Php80] Fix end slash regex on AttributeValueResolver #6579

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.

Sign up for GitHub

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

Merged
samsonasik merged 10 commits into from
Dec 13, 2024
Merged

[Php80] Fix end slash regex on AttributeValueResolver #6579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
035c313
Fix end slash regex on AttributeValueResolver
samsonasik Dec 13, 2024
9bc2a53
update regex url
samsonasik Dec 13, 2024
10abeaf
use NewLineSplitter for explode new line
samsonasik Dec 13, 2024
6b53b18
add test
samsonasik Dec 13, 2024
e11b5de
add test
samsonasik Dec 13, 2024
b1b7665
also add test for with new line without other text
samsonasik Dec 13, 2024
577aa5e
fix left over empty comment
samsonasik Dec 13, 2024
b99a960
clean up
samsonasik Dec 13, 2024
313a2b0
clean up
samsonasik Dec 13, 2024
06b2f42
fix
samsonasik Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions ...tationToAttributeRector/Fixture/Behat/backslash_with_newline_without_another_text.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWitNewlineWithoutAnotherText
{
/**
* @Then then :value should \
*
*
*
*/
public function someStep(): void
{
}
}

?>
-----
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWitNewlineWithoutAnotherText
{
#[\Behat\Step\Then('then :value should \\')]
public function someStep(): void
{
}
}

?>
36 changes: 36 additions & 0 deletions ...ctor/Fixture/Behat/backslash_with_newline_without_another_text_with_other_comment.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWitNewlineWithoutAnotherTextWithOtherComment
{
// some comment
/**
* @Then then :value should \
*
*
*
*/
// some comment 2
public function someStep(): void
{
}
}

?>
-----
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWitNewlineWithoutAnotherTextWithOtherComment
{
// some comment
// some comment 2
#[\Behat\Step\Then('then :value should \\')]
public function someStep(): void
{
}
}

?>
34 changes: 34 additions & 0 deletions ...tor/Fixture/Behat/backslash_with_newline_without_another_text_with_other_comment2.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWitNewlineWithoutAnotherTextWithOtherComment2
{
// some comment
/**
* @Then then :value should \
*
*
*
*/
public function someStep(): void
{
}
}

?>
-----
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWitNewlineWithoutAnotherTextWithOtherComment2
{
// some comment
#[\Behat\Step\Then('then :value should \\')]
public function someStep(): void
{
}
}

?>
29 changes: 29 additions & 0 deletions ...Rector/Class_/AnnotationToAttributeRector/Fixture/Behat/backslash_without_newline.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWithoutNewline
{
/**
* @Then then :value should \
*/
public function someStep(): void
{
}
}

?>
-----
<?php

namespace Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\Fixture\Behat;

final class BackslashWithoutNewline
{
#[\Behat\Step\Then('then :value should \\')]
public function someStep(): void
{
}
}

?>
22 changes: 22 additions & 0 deletions rules/Php80/Rector/Class_/AnnotationToAttributeRector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\Exception\Configuration\InvalidConfigurationException;
use Rector\Naming\Naming\UseImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
use Rector\Php80\NodeFactory\AttrGroupsFactory;
use Rector\Php80\NodeManipulator\AttributeGroupNamedArgumentManipulator;
Expand Down Expand Up @@ -152,12 +153,33 @@ public function refactor(Node $node): ?Node
// 3. Reprint docblock
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);

// 4. Left over comment removal
$this->cleanLeftOverComment($node);

$this->attributeGroupNamedArgumentManipulator->decorate($attributeGroups);
$node->attrGroups = array_merge($node->attrGroups, $attributeGroups);

return $node;
}

private function cleanLeftOverComment(Node $node): void
{
$comments = $node->getComments();

if ($comments === []) {
return;
}

foreach ($comments as $key => $comment) {
if ($comment->getText() === '') {
unset($comments[$key]);
continue;
}
}

$node->setAttribute(AttributeKey::COMMENTS, array_values($comments));
}

/**
* @param mixed[] $configuration
*/
Expand Down
7 changes: 4 additions & 3 deletions rules/Php80/Rector/Class_/AttributeValueResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use Rector\Php80\ValueObject\AnnotationToAttribute;
use Rector\Php80\ValueObject\AttributeValueAndDocComment;
use Rector\Util\NewLineSplitter;

final class AttributeValueResolver
{
/**
* @var string
* @see https://regex101.com/r/CL9ktz/1
* @see https://regex101.com/r/CL9ktz/4
*/
private const END_SLASH_REGEX = '#\\\\\r?$#';
private const END_SLASH_REGEX = '#\\\\$#';

public function resolve(
AnnotationToAttribute $annotationToAttribute,
Expand All @@ -31,7 +32,7 @@ public function resolve(
// special case for newline
if (str_contains($docValue, "\n")) {
$keepJoining = true;
$docValueLines = explode("\n", $docValue);
$docValueLines = NewLineSplitter::split($docValue);

$joinDocValue = '';

Expand Down
Loading