Skip to content
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\CodeQuality\Rector\If_\ArrayExplicitBoolCompareRector;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;

final class ArrayExplicitBoolCompareRectorTest extends AbstractRectorTestCase
{
#[DataProvider('provideData')]
public function test(string $filePath): void
{
$this->doTestFile($filePath);
}

public static function provideData(): Iterator
{
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

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

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ArrayExplicitBoolCompareRector\Fixture;

final class ArrayCompare
{
Expand All @@ -20,7 +20,7 @@ final class ArrayCompare
-----
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ArrayExplicitBoolCompareRector\Fixture;

final class ArrayCompare
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ArrayExplicitBoolCompareRector\Fixture;

final class SkipNotVariableType
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\If_\ArrayExplicitBoolCompareRector;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
->withRules([ArrayExplicitBoolCompareRector::class]);
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class Nullable
{
Expand Down Expand Up @@ -30,7 +30,7 @@ final class Nullable
-----
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class Nullable
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class NullableInstanceToInstanceof
{
Expand All @@ -25,7 +25,7 @@ final class NullableInstanceToInstanceof
-----
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class NullableInstanceToInstanceof
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class SkipDocblockNullable
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class WithAssign
{
Expand All @@ -21,7 +21,7 @@ final class WithAssign
-----
<?php

namespace Rector\Tests\CodeQuality\Rector\If_\ExplicitBoolCompareRector\Fixture;
namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector\Fixture;

final class WithAssign
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;

final class ObjectExplicitBoolCompareRectorTest extends AbstractRectorTestCase
{
#[DataProvider('provideData')]
public function test(string $filePath): void
{
$this->doTestFile($filePath);
}

public static function provideData(): Iterator
{
return self::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,9 @@
<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\If_\ObjectExplicitBoolCompareRector;
use Rector\Config\RectorConfig;

return RectorConfig::configure()
->withRules([ObjectExplicitBoolCompareRector::class]);
129 changes: 129 additions & 0 deletions rules/CodeQuality/Rector/If_/ArrayExplicitBoolCompareRector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<?php

declare(strict_types=1);

namespace Rector\CodeQuality\Rector\If_;

use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\BinaryOp\Identical;
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
use PhpParser\Node\Expr\BooleanNot;
use PhpParser\Node\Expr\Cast\Bool_;
use PhpParser\Node\Expr\Ternary;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt\ElseIf_;
use PhpParser\Node\Stmt\If_;
use PHPStan\Type\MixedType;
use Rector\NodeTypeResolver\TypeAnalyzer\ArrayTypeAnalyzer;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @see \Rector\Tests\CodeQuality\Rector\If_\ArrayExplicitBoolCompareRector\ArrayExplicitBoolCompareRectorTest
*/
final class ArrayExplicitBoolCompareRector extends AbstractRector
{
public function __construct(
private readonly ArrayTypeAnalyzer $arrayTypeAnalyzer,
) {
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Make array if conditions more explicit', [
new CodeSample(
<<<'CODE_SAMPLE'
final class SomeController
{
public function run(array $items)
{
if (!$items) {
return 'no items';
}
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
final class SomeController
{
public function run(array $items)
{
if ($items === []) {
return 'no items';
}
}
}
CODE_SAMPLE
),
]);
}

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

/**
* @param If_|ElseIf_|Ternary $node
*/
public function refactor(Node $node): ?Node
{
// skip short ternary
if ($node instanceof Ternary && ! $node->if instanceof Expr) {
return null;
}

if ($node->cond instanceof BooleanNot) {
$conditionNode = $node->cond->expr;
$isNegated = true;
} else {
$conditionNode = $node->cond;
$isNegated = false;
}

if ($conditionNode instanceof Bool_) {
return null;
}

$conditionStaticType = $this->nodeTypeResolver->getNativeType($conditionNode);
if ($conditionStaticType instanceof MixedType || $conditionStaticType->isBoolean()->yes()) {
return null;
}

if (! $this->arrayTypeAnalyzer->isArrayType($conditionNode)) {
return null;
}

$binaryOp = $this->resolveArray($isNegated, $conditionNode);
if (! $binaryOp instanceof Expr) {
return null;
}

$node->cond = $binaryOp;

return $node;
}

private function resolveArray(bool $isNegated, Expr $expr): Identical|NotIdentical|null
{
if (! $expr instanceof Variable) {
return null;
}

$array = new Array_([]);

// compare === []
if ($isNegated) {
return new Identical($expr, $array);
}

return new NotIdentical($expr, $array);
}
}
Loading
Loading