2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
2019-01-03 13:03:10 +00:00
|
|
|
|
|
|
|
namespace Rector\CodeQuality\Rector\Concat;
|
|
|
|
|
2019-10-30 13:36:31 +00:00
|
|
|
use Nette\Utils\Strings;
|
2019-01-03 13:03:10 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Expr\BinaryOp\Concat;
|
|
|
|
use PhpParser\Node\Scalar\String_;
|
2020-02-06 21:48:18 +00:00
|
|
|
use Rector\Core\Rector\AbstractRector;
|
2020-08-28 16:08:25 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2019-01-03 13:03:10 +00:00
|
|
|
|
2019-09-03 09:11:45 +00:00
|
|
|
/**
|
|
|
|
* @see \Rector\CodeQuality\Tests\Rector\Concat\JoinStringConcatRector\JoinStringConcatRectorTest
|
|
|
|
*/
|
2019-01-03 13:03:10 +00:00
|
|
|
final class JoinStringConcatRector extends AbstractRector
|
|
|
|
{
|
2019-10-30 13:36:31 +00:00
|
|
|
/**
|
|
|
|
* @var int
|
|
|
|
*/
|
2020-07-19 13:30:10 +00:00
|
|
|
private const LINE_BREAK_POINT = 100;
|
2019-10-30 13:36:31 +00:00
|
|
|
|
2020-08-29 09:03:40 +00:00
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
private $nodeReplacementIsRestricted = false;
|
|
|
|
|
2020-11-16 17:50:38 +00:00
|
|
|
public function getRuleDefinition(): RuleDefinition
|
2019-01-03 13:03:10 +00:00
|
|
|
{
|
2020-11-16 17:50:38 +00:00
|
|
|
return new RuleDefinition(
|
2021-01-05 20:06:16 +00:00
|
|
|
'Joins concat of 2 strings, unless the length is too long',
|
2020-11-16 17:50:38 +00:00
|
|
|
[
|
|
|
|
new CodeSample(
|
|
|
|
<<<'CODE_SAMPLE'
|
2019-01-03 13:03:10 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
public function run()
|
|
|
|
{
|
|
|
|
$name = 'Hi' . ' Tom';
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2020-11-16 17:50:38 +00:00
|
|
|
,
|
|
|
|
<<<'CODE_SAMPLE'
|
2019-01-03 13:03:10 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
public function run()
|
|
|
|
{
|
|
|
|
$name = 'Hi Tom';
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2020-11-16 17:50:38 +00:00
|
|
|
),
|
|
|
|
|
|
|
|
]);
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
public function getNodeTypes(): array
|
|
|
|
{
|
|
|
|
return [Concat::class];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Concat $node
|
|
|
|
*/
|
|
|
|
public function refactor(Node $node): ?Node
|
|
|
|
{
|
2020-08-28 16:08:25 +00:00
|
|
|
$this->nodeReplacementIsRestricted = false;
|
|
|
|
|
|
|
|
if (! $this->isTopMostConcatNode($node)) {
|
|
|
|
return null;
|
|
|
|
}
|
2020-07-19 13:30:10 +00:00
|
|
|
|
|
|
|
$joinedNode = $this->joinConcatIfStrings($node);
|
|
|
|
if (! $joinedNode instanceof String_) {
|
2019-10-30 13:36:31 +00:00
|
|
|
return null;
|
|
|
|
}
|
2020-07-19 13:30:10 +00:00
|
|
|
|
2020-08-28 16:08:25 +00:00
|
|
|
if ($this->nodeReplacementIsRestricted) {
|
|
|
|
return null;
|
2020-07-19 13:30:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return $joinedNode;
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
|
2020-08-29 14:20:27 +00:00
|
|
|
private function isTopMostConcatNode(Concat $concat): bool
|
|
|
|
{
|
2021-01-06 21:10:51 +00:00
|
|
|
$parent = $concat->getAttribute(AttributeKey::PARENT_NODE);
|
|
|
|
return ! $parent instanceof Concat;
|
2020-08-29 14:20:27 +00:00
|
|
|
}
|
|
|
|
|
2019-01-03 13:03:10 +00:00
|
|
|
/**
|
|
|
|
* @return Concat|String_
|
|
|
|
*/
|
2020-08-28 16:08:25 +00:00
|
|
|
private function joinConcatIfStrings(Concat $node): Node
|
2019-01-03 13:03:10 +00:00
|
|
|
{
|
2020-08-28 16:08:25 +00:00
|
|
|
$concat = clone $node;
|
|
|
|
|
2019-02-22 17:25:31 +00:00
|
|
|
if ($concat->left instanceof Concat) {
|
|
|
|
$concat->left = $this->joinConcatIfStrings($concat->left);
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
|
2019-02-22 17:25:31 +00:00
|
|
|
if ($concat->right instanceof Concat) {
|
|
|
|
$concat->right = $this->joinConcatIfStrings($concat->right);
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
|
2019-02-22 17:25:31 +00:00
|
|
|
if (! $concat->left instanceof String_) {
|
2020-08-28 16:08:25 +00:00
|
|
|
return $node;
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
|
2019-02-22 17:25:31 +00:00
|
|
|
if (! $concat->right instanceof String_) {
|
2020-08-28 16:08:25 +00:00
|
|
|
return $node;
|
|
|
|
}
|
|
|
|
|
2021-01-06 21:10:51 +00:00
|
|
|
$leftValue = $concat->left->value;
|
|
|
|
$rightValue = $concat->right->value;
|
|
|
|
|
|
|
|
if ($leftValue === "\n") {
|
|
|
|
$this->nodeReplacementIsRestricted = true;
|
|
|
|
return $node;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($rightValue === "\n") {
|
|
|
|
$this->nodeReplacementIsRestricted = true;
|
|
|
|
return $node;
|
|
|
|
}
|
|
|
|
|
|
|
|
$resultString = new String_($leftValue . $rightValue);
|
2020-08-29 14:20:27 +00:00
|
|
|
if (Strings::length($resultString->value) >= self::LINE_BREAK_POINT) {
|
2020-08-28 16:08:25 +00:00
|
|
|
$this->nodeReplacementIsRestricted = true;
|
|
|
|
return $node;
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
|
2020-08-29 14:20:27 +00:00
|
|
|
return $resultString;
|
2019-01-03 13:03:10 +00:00
|
|
|
}
|
|
|
|
}
|