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

[DowngradePhp80] Add DowngradeArrayFilterNullableCallbackRector #1593

Merged
merged 21 commits into from
Dec 30, 2021
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions config/set/downgrade-php80.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Rector\DowngradePhp80\Rector\ClassMethod\DowngradeTrailingCommasInParamUseRector;
use Rector\DowngradePhp80\Rector\Expression\DowngradeMatchToSwitchRector;
use Rector\DowngradePhp80\Rector\Expression\DowngradeThrowExprRector;
use Rector\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector;
use Rector\DowngradePhp80\Rector\FuncCall\DowngradeStrContainsRector;
use Rector\DowngradePhp80\Rector\FuncCall\DowngradeStrEndsWithRector;
use Rector\DowngradePhp80\Rector\FuncCall\DowngradeStrStartsWithRector;
Expand Down Expand Up @@ -78,4 +79,5 @@
$services->set(DowngradeRecursiveDirectoryIteratorHasChildrenRector::class);
$services->set(DowngradeReflectionPropertyGetDefaultValueRector::class);
$services->set(DowngradeReflectionClassGetConstantsFilterRector::class);
$services->set(DowngradeArrayFilterNullableCallbackRector::class);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector;

use Iterator;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
use Symplify\SmartFileSystem\SmartFileInfo;

final class DowngradeArrayFilterNullableCallbackRectorTest extends AbstractRectorTestCase
{
/**
* @dataProvider provideData()
* @requires PHP 8.0
*/
public function test(SmartFileInfo $fileInfo): void
{
$this->doTestFileInfo($fileInfo);
}

/**
* @return Iterator<SmartFileInfo>
*/
public function provideData(): Iterator
{
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
{
return __DIR__ . '/config/configured_rule.php';
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class MayBeNullFromParam
{
public function run(array $data, $callback = null)
{
var_dump(array_filter($data, $callback));
}
}

?>
-----
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class MayBeNullFromParam
{
public function run(array $data, $callback = null)
{
var_dump(array_filter($data, $callback === null ? fn($v, $k): bool => !empty($v) : $callback, $callback === null ? ARRAY_FILTER_USE_BOTH : 0));
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class MayBeNullFromParamHasConstant
{
public function run(array $data, $callback = null)
{
var_dump(array_filter($data, $callback, ARRAY_FILTER_USE_KEY));
}
}

?>
-----
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class MayBeNullFromParamHasConstant
{
public function run(array $data, $callback = null)
{
var_dump(array_filter($data, $callback === null ? fn($v, $k): bool => !empty($v) : $callback, $callback === null ? ARRAY_FILTER_USE_BOTH : ARRAY_FILTER_USE_KEY));
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class NullSecondArg
{
public function run(array $data)
{
array_filter($data, null);
}
}

?>
-----
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class NullSecondArg
{
public function run(array $data)
{
array_filter($data);
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class SkipCallbackSecondArg
{
public function run(array $data)
{
array_filter($data, fn ($v, $k) => ! empty ($v), ARRAY_FILTER_USE_BOTH);
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class SkipNamedArg
{
public function run(array $data)
{
array_filter(array: $data, callback: null);
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class SkipNoSecondArg
{
public function run(array $data)
{
array_filter($data);
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class SkipNotArrayFilter
{
public function run()
{
strlen('test');
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\Fixture;

class SkipStringFunctionNameSecondArg
{
public function run(array $data)
{
$result = array_filter($data, 'strlen' );
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

declare(strict_types=1);

use Rector\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();
$services->set(DowngradeArrayFilterNullableCallbackRector::class);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
<?php

declare(strict_types=1);

namespace Rector\DowngradePhp80\Rector\FuncCall;

use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\ArrowFunction;
use PhpParser\Node\Expr\BinaryOp\Identical;
use PhpParser\Node\Expr\BooleanNot;
use PhpParser\Node\Expr\ConstFetch;
use PhpParser\Node\Expr\Empty_;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\Ternary;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Param;
use PHPStan\Type\MixedType;
use Rector\Core\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @changelog https://www.php.net/manual/en/function.array-filter.php#refsect1-function.array-filter-changelog
*
* @see \Rector\Tests\DowngradePhp80\Rector\FuncCall\DowngradeArrayFilterNullableCallbackRector\DowngradeArrayFilterNullableCallbackRectorTest
*/
final class DowngradeArrayFilterNullableCallbackRector extends AbstractRector
{
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Unset nullable callback on array_filter',
[
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
public function run($callback = null)
{
$data = [[]];
var_dump(array_filter($data, null));
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeClass
{
public function run($callback = null)
{
$data = [[]];
var_dump(array_filter($data));
}
}
CODE_SAMPLE
),
]
);
}

/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [FuncCall::class];
}

/**
* @param FuncCall $node
*/
public function refactor(Node $node): FuncCall|Ternary|null
{
$args = $node->getArgs();

if (! $this->isName($node, 'array_filter')) {
return null;
}

if ($this->hasNamedArg($args)) {
return null;
}

if (! isset($args[1])) {
return null;
}

// direct null check ConstFetch
if ($args[1]->value instanceof ConstFetch && $this->valueResolver->isNull($args[1]->value)) {
$args = [$args[0]];
$node->args = $args;
return $node;
}

$type = $this->nodeTypeResolver->getType($args[1]->value);
if (! $type instanceof MixedType) {
return null;
}

$node->args[1] = new Arg($this->createNewArgFirstTernary($args));
$node->args[2] = new Arg($this->createNewArgSecondTernary($args));

return $node;
}

/**
* @param Arg[] $args
*/
private function createNewArgFirstTernary(array $args): Ternary
{
$identical = new Identical($args[1]->value, $this->nodeFactory->createNull());
$vVariable = new Variable('v');
$arrowFunction = new ArrowFunction([
'expr' => new BooleanNot(new Empty_($vVariable)),
]);
$arrowFunction->params = [new Param($vVariable), new Param(new Variable('k'))];
$arrowFunction->returnType = new Identifier('bool');

return new Ternary($identical, $arrowFunction, $args[1]->value);
}

/**
* @param Arg[] $args
*/
private function createNewArgSecondTernary(array $args): Ternary
{
$identical = new Identical($args[1]->value, $this->nodeFactory->createNull());
$constFetch = new ConstFetch(new Name('ARRAY_FILTER_USE_BOTH'));

return new Ternary(
$identical,
$constFetch,
isset($args[2]) ? $args[2]->value : new ConstFetch(new Name('0'))
);
}

/**
* @param Arg[] $args
*/
private function hasNamedArg(array $args): bool
{
foreach ($args as $arg) {
if ($arg->name instanceof Identifier) {
return true;
}
}

return false;
}
}