mirror of https://github.com/rectorphp/rector.git
119 lines
3.7 KiB
PHP
119 lines
3.7 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\CodingStyle\Rector\String_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Scalar\String_;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\Rector\AbstractRector;
|
|
use Rector\Util\StringUtils;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector\SymplifyQuoteEscapeRectorTest
|
|
*/
|
|
final class SymplifyQuoteEscapeRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @var string
|
|
* @see https://regex101.com/r/qEkCe9/2
|
|
*/
|
|
private const ESCAPED_CHAR_REGEX = '#\\\\|\\$|\\n|\\t#sim';
|
|
/**
|
|
* @var string
|
|
* @see https://alvinalexander.com/php/how-to-remove-non-printable-characters-in-string-regex/
|
|
* @see https://regex101.com/r/lGUhRb/1
|
|
*/
|
|
private const HAS_NON_PRINTABLE_CHARS = '#[\\x00-\\x1F\\x80-\\xFF]#';
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $hasChanged = \false;
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Prefer quote that are not inside the string', [new CodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
$name = "\" Tom";
|
|
$name = '\' Sara';
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
$name = '" Tom';
|
|
$name = "' Sara";
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [String_::class];
|
|
}
|
|
/**
|
|
* @param String_ $node
|
|
*/
|
|
public function refactor(Node $node) : ?String_
|
|
{
|
|
$this->hasChanged = \false;
|
|
if (StringUtils::isMatch($node->value, self::HAS_NON_PRINTABLE_CHARS)) {
|
|
return null;
|
|
}
|
|
$doubleQuoteCount = \substr_count($node->value, '"');
|
|
$singleQuoteCount = \substr_count($node->value, "'");
|
|
$kind = $node->getAttribute(AttributeKey::KIND);
|
|
if ($kind === String_::KIND_SINGLE_QUOTED) {
|
|
$this->processSingleQuoted($node, $doubleQuoteCount, $singleQuoteCount);
|
|
}
|
|
$quoteKind = $node->getAttribute(AttributeKey::KIND);
|
|
if ($quoteKind === String_::KIND_DOUBLE_QUOTED) {
|
|
$this->processDoubleQuoted($node, $singleQuoteCount, $doubleQuoteCount);
|
|
}
|
|
if (!$this->hasChanged) {
|
|
return null;
|
|
}
|
|
return $node;
|
|
}
|
|
private function processSingleQuoted(String_ $string, int $doubleQuoteCount, int $singleQuoteCount) : void
|
|
{
|
|
if ($doubleQuoteCount === 0 && $singleQuoteCount > 0) {
|
|
// contains chars that will be newly escaped
|
|
if ($this->isMatchEscapedChars($string->value)) {
|
|
return;
|
|
}
|
|
$string->setAttribute(AttributeKey::KIND, String_::KIND_DOUBLE_QUOTED);
|
|
// invoke override
|
|
$string->setAttribute(AttributeKey::ORIGINAL_NODE, null);
|
|
$this->hasChanged = \true;
|
|
}
|
|
}
|
|
private function processDoubleQuoted(String_ $string, int $singleQuoteCount, int $doubleQuoteCount) : void
|
|
{
|
|
if ($singleQuoteCount === 0 && $doubleQuoteCount > 0) {
|
|
// contains chars that will be newly escaped
|
|
if ($this->isMatchEscapedChars($string->value)) {
|
|
return;
|
|
}
|
|
$string->setAttribute(AttributeKey::KIND, String_::KIND_SINGLE_QUOTED);
|
|
// invoke override
|
|
$string->setAttribute(AttributeKey::ORIGINAL_NODE, null);
|
|
$this->hasChanged = \true;
|
|
}
|
|
}
|
|
private function isMatchEscapedChars(string $string) : bool
|
|
{
|
|
return StringUtils::isMatch($string, self::ESCAPED_CHAR_REGEX);
|
|
}
|
|
}
|