mirror_php/rector
1
0
Fork 0
mirror of https://github.com/rectorphp/rector.git synced 2025-03-18 22:39:44 +01:00
Code Issues Projects Releases Wiki Activity

Updated Rector to commit 217026caf877c60eb7a7fd61b5b16d9a642f1662

Browse Source 
217026caf8 [Php84] Add AddEscapeArgumentRector (#6782)
This commit is contained in:
Tomas Votruba 2025-03-14 16:20:50 +00:00
parent e443ba3062
commit 7a39169380
6 changed files with 110 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
config/set/php84.php
View File

@ -4,8 +4,9 @@ declare (strict_types=1);
namespace RectorPrefix202503;
use Rector\Config\RectorConfig;
use Rector\Php84\Rector\FuncCall\AddEscapeArgumentRector;
use Rector\Php84\Rector\FuncCall\RoundingModeEnumRector;
use Rector\Php84\Rector\Param\ExplicitNullableParamTypeRector;
return static function (RectorConfig $rectorConfig) : void {
$rectorConfig->rules([ExplicitNullableParamTypeRector::class, RoundingModeEnumRector::class]);
$rectorConfig->rules([ExplicitNullableParamTypeRector::class, RoundingModeEnumRector::class, AddEscapeArgumentRector::class]);
};

99
rules/Php84/Rector/FuncCall/AddEscapeArgumentRector.php Normal file
View File

@ -0,0 +1,99 @@
<?php
declare (strict_types=1);
namespace Rector\Php84\Rector\FuncCall;
use PHPStan\Type\ObjectType;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Scalar\String_;
use Rector\Rector\AbstractRector;
use Rector\ValueObject\PhpVersionFeature;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\Php84\Rector\FuncCall\AddEscapeArgumentRector\AddEscapeArgumentRectorTest
*/
final class AddEscapeArgumentRector extends AbstractRector implements MinPhpVersionInterface
{
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Add escape argument on CSV function calls', [new CodeSample(<<<'CODE_SAMPLE'
str_getcsv($string, separator: ',', enclosure: '"');
CODE_SAMPLE
, <<<'CODE_SAMPLE'
str_getcsv($string, separator: ',', enclosure: '"', escape: '\\');
CODE_SAMPLE
)]);
}
public function getNodeTypes() : array
{
return [FuncCall::class, MethodCall::class];
}
/**
* @param FuncCall|MethodCall $node
* @return null|\PhpParser\Node\Expr\FuncCall|\PhpParser\Node\Expr\MethodCall
*/
public function refactor(Node $node)
{
if ($node->isFirstClassCallable()) {
return null;
}
if ($node instanceof FuncCall) {
if (!$this->isNames($node, ['fputcsv', 'fgetcsv', 'str_getcsv'])) {
return null;
}
if ($this->shouldSkipNamedArg($node)) {
return null;
}
$name = $this->getName($node);
if (\in_array($name, ['fputcsv', 'fgetcsv'], \true) && isset($node->getArgs()[4])) {
return null;
}
if ($name === 'str_getcsv' && isset($node->getArgs()[3])) {
return null;
}
$node->args[\count($node->getArgs())] = new Arg(new String_("\\"), \false, \false, [], new Identifier('escape'));
return $node;
}
if (!$this->isObjectType($node->var, new ObjectType('SplFileObject'))) {
return null;
}
$name = $this->getName($node->name);
if (!\in_array($name, ['setCsvControl', 'fputcsv', 'fgetcsv'], \true)) {
return null;
}
if ($this->shouldSkipNamedArg($node)) {
return null;
}
if (\in_array($name, ['setCsvControl', 'fgetcsv'], \true) && isset($node->getArgs()[2])) {
return null;
}
if ($name === 'fputcsv' && isset($node->getArgs()[3])) {
return null;
}
$node->args[\count($node->getArgs())] = new Arg(new String_("\\"), \false, \false, [], new Identifier('escape'));
return $node;
}
/**
* @param \PhpParser\Node\Expr\FuncCall|\PhpParser\Node\Expr\MethodCall $node
*/
private function shouldSkipNamedArg($node) : bool
{
foreach ($node->getArgs() as $arg) {
// already defined in named arg
if ($arg->name instanceof Identifier && $arg->name->toString() === 'escape') {
return \true;
}
}
return \false;
}
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::REQUIRED_ESCAPE_PARAMETER;
}
}

4
src/Application/VersionResolver.php
View File

@ -19,12 +19,12 @@ final class VersionResolver
* @api
* @var string
*/
public const PACKAGE_VERSION = '61cb7b5042ebca12c18e1f2df22ecf3ba9d26bdb';
public const PACKAGE_VERSION = '217026caf877c60eb7a7fd61b5b16d9a642f1662';
/**
* @api
* @var string
*/
public const RELEASE_DATE = '2025-03-12 22:12:48';
public const RELEASE_DATE = '2025-03-14 23:18:19';
/**
* @var int
*/

5
src/ValueObject/PhpVersionFeature.php
View File

@ -560,6 +560,11 @@ final class PhpVersionFeature
* @var int
*/
public const ROUNDING_MODES = \Rector\ValueObject\PhpVersion::PHP_84;
/**
* @see https://php.watch/versions/8.4/csv-functions-escape-parameter
* @var int
*/
public const REQUIRED_ESCAPE_PARAMETER = \Rector\ValueObject\PhpVersion::PHP_84;
/**
* @see https://www.php.net/manual/en/migration83.deprecated.php#migration83.deprecated.ldap
* @var int

1
vendor/composer/autoload_classmap.php vendored
View File

@ -2044,6 +2044,7 @@ return array(
'Rector\\Php83\\Rector\\ClassMethod\\AddOverrideAttributeToOverriddenMethodsRector' => $baseDir . '/rules/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector.php',
'Rector\\Php83\\Rector\\FuncCall\\CombineHostPortLdapUriRector' => $baseDir . '/rules/Php83/Rector/FuncCall/CombineHostPortLdapUriRector.php',
'Rector\\Php83\\Rector\\FuncCall\\RemoveGetClassGetParentClassNoArgsRector' => $baseDir . '/rules/Php83/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector.php',
'Rector\\Php84\\Rector\\FuncCall\\AddEscapeArgumentRector' => $baseDir . '/rules/Php84/Rector/FuncCall/AddEscapeArgumentRector.php',
'Rector\\Php84\\Rector\\FuncCall\\RoundingModeEnumRector' => $baseDir . '/rules/Php84/Rector/FuncCall/RoundingModeEnumRector.php',
'Rector\\Php84\\Rector\\Param\\ExplicitNullableParamTypeRector' => $baseDir . '/rules/Php84/Rector/Param/ExplicitNullableParamTypeRector.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper' => $baseDir . '/src/PhpAttribute/AnnotationToAttributeMapper.php',

1
vendor/composer/autoload_static.php vendored
View File

@ -2263,6 +2263,7 @@ class ComposerStaticInit82c6a73a31b80aa1be38da0fc895c7e2
'Rector\\Php83\\Rector\\ClassMethod\\AddOverrideAttributeToOverriddenMethodsRector' => __DIR__ . '/../..' . '/rules/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector.php',
'Rector\\Php83\\Rector\\FuncCall\\CombineHostPortLdapUriRector' => __DIR__ . '/../..' . '/rules/Php83/Rector/FuncCall/CombineHostPortLdapUriRector.php',
'Rector\\Php83\\Rector\\FuncCall\\RemoveGetClassGetParentClassNoArgsRector' => __DIR__ . '/../..' . '/rules/Php83/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector.php',
'Rector\\Php84\\Rector\\FuncCall\\AddEscapeArgumentRector' => __DIR__ . '/../..' . '/rules/Php84/Rector/FuncCall/AddEscapeArgumentRector.php',
'Rector\\Php84\\Rector\\FuncCall\\RoundingModeEnumRector' => __DIR__ . '/../..' . '/rules/Php84/Rector/FuncCall/RoundingModeEnumRector.php',
'Rector\\Php84\\Rector\\Param\\ExplicitNullableParamTypeRector' => __DIR__ . '/../..' . '/rules/Php84/Rector/Param/ExplicitNullableParamTypeRector.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper' => __DIR__ . '/../..' . '/src/PhpAttribute/AnnotationToAttributeMapper.php',