Skip to content

Commit

Permalink
[DowngradePhp71] Add DowngradePhp71JsonConstRector (#1784)
Browse files Browse the repository at this point in the history
  • Loading branch information
samsonasik committed Feb 8, 2022
1 parent 78a42c7 commit 6aa48e1
Show file tree
Hide file tree
Showing 8 changed files with 199 additions and 0 deletions.
2 changes: 2 additions & 0 deletions config/set/downgrade-php71.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Rector\Core\ValueObject\PhpVersion;
use Rector\DowngradePhp71\Rector\Array_\SymmetricArrayDestructuringToListRector;
use Rector\DowngradePhp71\Rector\ClassConst\DowngradeClassConstantVisibilityRector;
use Rector\DowngradePhp71\Rector\ConstFetch\DowngradePhp71JsonConstRector;
use Rector\DowngradePhp71\Rector\FuncCall\DowngradeIsIterableRector;
use Rector\DowngradePhp71\Rector\FunctionLike\DowngradeIterablePseudoTypeDeclarationRector;
use Rector\DowngradePhp71\Rector\FunctionLike\DowngradeNullableTypeDeclarationRector;
Expand All @@ -31,4 +32,5 @@
$services->set(DowngradeIterablePseudoTypeDeclarationRector::class);
$services->set(DowngradeIsIterableRector::class);
$services->set(DowngradeClosureFromCallableRector::class);
$services->set(DowngradePhp71JsonConstRector::class);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\ConstFetch\DowngradePhp71JsonConstRector;

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

final class DowngradePhp71JsonConstRectorTest extends AbstractRectorTestCase
{
/**
* @dataProvider provideData()
*/
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,31 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\FuncCall\DowngradePhp71JsonConstRector\Fixture;

class Fixture
{
public function run()
{
$inDecoder = new Decoder($connection, true, 512, \JSON_UNESCAPED_LINE_TERMINATORS);
}
}

?>
-----
<?php

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\FuncCall\DowngradePhp71JsonConstRector\Fixture;

class Fixture
{
public function run()
{
$inDecoder = new Decoder($connection, true, 512, 0);
}
}

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

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\FuncCall\DowngradePhp71JsonConstRector\Fixture;

class InBitwise
{
public function run($argument)
{
$argument = json_encode($argument, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_LINE_TERMINATORS);
}
}

?>
-----
<?php

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\FuncCall\DowngradePhp71JsonConstRector\Fixture;

class InBitwise
{
public function run($argument)
{
$argument = json_encode($argument, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
}
}

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

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\FuncCall\DowngradePhp71JsonConstRector\Fixture;

class SkipBitwiseDifferentConstant
{
public function run($argument)
{
$argument = json_encode($argument, JSON_HEX_TAG | JSON_PRETTY_PRINT);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\DowngradePhp71\Rector\FuncCall\DowngradePhp71JsonConstRector\Fixture;

class SkipDifferentConstant
{
public function run()
{
json_encode($a, JSON_HEX_TAG);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

declare(strict_types=1);

use Rector\DowngradePhp71\Rector\ConstFetch\DowngradePhp71JsonConstRector;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

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

declare(strict_types=1);

namespace Rector\DowngradePhp71\Rector\ConstFetch;

use PhpParser\Node;
use PhpParser\Node\Expr\BinaryOp\BitwiseOr;
use PhpParser\Node\Expr\ConstFetch;
use Rector\Core\Rector\AbstractRector;
use Rector\DowngradePhp72\NodeManipulator\JsonConstCleaner;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @changelog https://www.php.net/manual/en/function.json-encode.php#refsect1-function.json-encode-changelog
*
* @see \Rector\Tests\DowngradePhp71\Rector\ConstFetch\DowngradePhp71JsonConstRector\DowngradePhp71JsonConstRectorTest
*/
final class DowngradePhp71JsonConstRector extends AbstractRector
{
/**
* @var string[]
*/
private const CONSTANTS = ['JSON_UNESCAPED_LINE_TERMINATORS'];

public function __construct(
private readonly JsonConstCleaner $jsonConstCleaner
) {
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Remove Json constant that available only in php 7.1',
[
new CodeSample(
<<<'CODE_SAMPLE'
json_encode($content, JSON_UNESCAPED_LINE_TERMINATORS);
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
json_encode($content, 0);
CODE_SAMPLE
),
]
);
}

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

/**
* @param ConstFetch|BitwiseOr $node
*/
public function refactor(Node $node): ?Node
{
return $this->jsonConstCleaner->clean($node, self::CONSTANTS);
}
}

0 comments on commit 6aa48e1

Please sign in to comment.