mirror_php/rector
1
0
Fork 0
mirror of https://github.com/rectorphp/rector.git synced 2025-03-24 09:19:47 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1823 from rectorphp/json-nette-utils

Browse Source 
[Nette] Add JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector
This commit is contained in:
Tomáš Votruba 2019-08-07 18:17:36 +02:00 committed by GitHub
commit 0fb70a97b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 208 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
config/set/nette/nette-utils-code-quality.yaml
View File

@ -6,13 +6,10 @@ services:
unlink: ['Nette\Utils\FileSystem', 'delete']
rmdir: ['Nette\Utils\FileSystem', 'delete']
# json
json_decode: ['Nette\Utils\Json', 'decode']
json_encode: ['Nette\Utils\Json', 'encode']
# strings
Rector\Nette\Rector\NotIdentical\StrposToStringsContainsRector: ~
Rector\Nette\Rector\FuncCall\SubstrStrlenFunctionToNetteUtilsStringsRector: ~
Rector\Nette\Rector\Identical\StartsWithFunctionToNetteUtilsStringsRector: ~
Rector\Nette\Rector\Identical\EndsWithFunctionToNetteUtilsStringsRector: ~
Rector\Nette\Rector\FuncCall\PregFunctionToNetteUtilsStringsRector: ~
Rector\Nette\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector: ~

124
packages/Nette/src/Rector/FuncCall/JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector.php Normal file
View File

@ -0,0 +1,124 @@
<?php declare(strict_types=1);
namespace Rector\Nette\Rector\FuncCall;
use PhpParser\Node;
use PhpParser\Node\Expr\FuncCall;
use Rector\Rector\AbstractRector;
use Rector\RectorDefinition\CodeSample;
use Rector\RectorDefinition\RectorDefinition;
/**
* @see @sponsor Thanks https://spaceflow.io/ for sponsoring this rule - visit them on https://github.com/SpaceFlow-app
*
* @see \Rector\Nette\Tests\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRectorTest
*/
final class JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector extends AbstractRector
{
public function getDefinition(): RectorDefinition
{
return new RectorDefinition(
'Changes json_encode()/json_decode() to safer and more verbose Nette\Utils\Json::encode()/decode() calls',
[
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
public function decodeJson(string $jsonString)
{
$stdClass = json_decode($jsonString);
$array = json_decode($jsonString, true);
$array = json_decode($jsonString, false);
}
public function encodeJson(array $data)
{
$jsonString = json_encode($data);
$prettyJsonString = json_encode($data, JSON_PRETTY_PRINT);
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeClass
{
public function decodeJson(string $jsonString)
{
$stdClass = \Nette\Utils\Json::decode($jsonString);
$array = \Nette\Utils\Json::decode($jsonString, \Nette\Utils\Json::FORCE_ARRAY);
$array = \Nette\Utils\Json::decode($jsonString);
}
public function encodeJson(array $data)
{
$jsonString = \Nette\Utils\Json::encode($data);
$prettyJsonString = \Nette\Utils\Json::encode($data, \Nette\Utils\Json::PRETTY);
}
}
CODE_SAMPLE
),
]
);
}
/**
* @return string[]
*/
public function getNodeTypes(): array
{
return [FuncCall::class];
}
/**
* @param FuncCall $node
*/
public function refactor(Node $node): ?Node
{
if ($this->isName($node, 'json_encode')) {
return $this->refactorJsonEncode($node);
}
if ($this->isName($node, 'json_decode')) {
return $this->refactorJsonDecode($node);
}
return null;
}
private function refactorJsonEncode(Node\Expr\FuncCall $funcCall): Node\Expr\StaticCall
{
$args = $funcCall->args;
if (isset($args[1])) {
$secondArgumentValue = $args[1]->value;
if ($this->isName($secondArgumentValue, 'JSON_PRETTY_PRINT')) {
$prettyClassConstant = $this->createClassConstant('Nette\Utils\Json', 'PRETTY');
$args[1] = new Node\Arg($prettyClassConstant);
}
}
return $this->createStaticCall('Nette\Utils\Json', 'encode', $args);
}
private function refactorJsonDecode(Node\Expr\FuncCall $funcCall): Node\Expr\StaticCall
{
$args = $funcCall->args;
if (isset($args[1])) {
$secondArgumentValue = $args[1]->value;
if ($this->isFalse($secondArgumentValue)) {
unset($args[1]);
} elseif ($this->isTrue($secondArgumentValue)) {
$forceArrayClassConstant = $this->createClassConstant('Nette\Utils\Json', 'FORCE_ARRAY');
$args[1] = new Node\Arg($forceArrayClassConstant);
}
}
return $this->createStaticCall('Nette\Utils\Json', 'decode', $args);
}
}

33
packages/Nette/tests/Rector/FuncCall/JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector/Fixture/json_decode.php.inc Normal file
View File

@ -0,0 +1,33 @@
<?php
namespace Rector\Nette\Tests\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector\Fixture;
class JsonDecode
{
public function decodeJson(string $jsonString)
{
$stdClass = json_decode($jsonString);
$array = json_decode($jsonString, true);
$array = json_decode($jsonString, false);
}
}
?>
-----
<?php
namespace Rector\Nette\Tests\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector\Fixture;
class JsonDecode
{
public function decodeJson(string $jsonString)
{
$stdClass = \Nette\Utils\Json::decode($jsonString);
$array = \Nette\Utils\Json::decode($jsonString, \Nette\Utils\Json::FORCE_ARRAY);
$array = \Nette\Utils\Json::decode($jsonString);
}
}
?>

31
packages/Nette/tests/Rector/FuncCall/JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector/Fixture/json_encode.php.inc Normal file
View File

@ -0,0 +1,31 @@
<?php
namespace Rector\Nette\Tests\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector\Fixture;
class JsonEncode
{
public function encodeJson(array $data)
{
$jsonString = json_encode($data);
$prettyJsonString = json_encode($data, JSON_PRETTY_PRINT);
}
}
?>
-----
<?php
namespace Rector\Nette\Tests\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector\Fixture;
class JsonEncode
{
public function encodeJson(array $data)
{
$jsonString = \Nette\Utils\Json::encode($data);
$prettyJsonString = \Nette\Utils\Json::encode($data, \Nette\Utils\Json::PRETTY);
}
}
?>

19
packages/Nette/tests/Rector/FuncCall/JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector/JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRectorTest.php Normal file
View File

@ -0,0 +1,19 @@
<?php declare(strict_types=1);
namespace Rector\Nette\Tests\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector;
use Rector\Nette\Rector\FuncCall\JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
final class JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRectorTest extends AbstractRectorTestCase
{
public function test(): void
{
$this->doTestFiles([__DIR__ . '/Fixture/json_decode.php.inc', __DIR__ . '/Fixture/json_encode.php.inc']);
}
protected function getRectorClass(): string
{
return JsonDecodeEncodeToNetteUtilsJsonDecodeEncodeRector::class;
}
}