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

Convert time() to Carbon::now()->timestamp #5901

Merged
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/datetime-to-carbon.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
declare(strict_types=1);

use Rector\Carbon\Rector\FuncCall\DateFuncCallToCarbonRector;
use Rector\Carbon\Rector\FuncCall\TimeFuncCallToCarbonRector;
use Rector\Carbon\Rector\MethodCall\DateTimeMethodCallToCarbonRector;
use Rector\Carbon\Rector\New_\DateTimeInstanceToCarbonRector;
use Rector\Config\RectorConfig;
Expand All @@ -12,5 +13,6 @@
DateFuncCallToCarbonRector::class,
DateTimeInstanceToCarbonRector::class,
DateTimeMethodCallToCarbonRector::class,
TimeFuncCallToCarbonRector::class,
]);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

namespace Rector\Tests\Carbon\Rector\FuncCall\TimeFuncCallToCarbonRector\Fixture;

class FirstClassCallable
{
public function run()
{
$time = time(...);
}
}

?>
-----
<?php

namespace Rector\Tests\Carbon\Rector\FuncCall\TimeFuncCallToCarbonRector\Fixture;

class FirstClassCallable
{
public function run()
{
$time = static fn() => \Carbon\Carbon::now()->timestamp;
}
}

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

namespace Rector\Tests\Carbon\Rector\FuncCall\DateFuncCallToCarbonRector\Fixture;

class SomeClass
{
public function run()
{
$time = time();
}
}

?>
-----
<?php

namespace Rector\Tests\Carbon\Rector\FuncCall\DateFuncCallToCarbonRector\Fixture;

class SomeClass
{
public function run()
{
$time = \Carbon\Carbon::now()->timestamp;
}
}

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

declare(strict_types=1);

namespace Rector\Tests\Carbon\Rector\FuncCall\TimeFuncCallToCarbonRector;

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

final class TimeFuncCallToCarbonRectorTest 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,10 @@
<?php

declare(strict_types=1);

use Rector\Carbon\Rector\FuncCall\TimeFuncCallToCarbonRector;
use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->rule(TimeFuncCallToCarbonRector::class);
};
4 changes: 2 additions & 2 deletions rules/Carbon/Rector/FuncCall/DateFuncCallToCarbonRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ final class DateFuncCallToCarbonRector extends AbstractRector
{
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Convert date() function call to Carbon::*()', [
return new RuleDefinition('Convert date() function call to Carbon::now()->format(*)', [
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
Expand All @@ -40,7 +40,7 @@ class SomeClass
{
public function run()
{
$date = \Carbon\Carbon::now()->format('Y-m-d')
$date = \Carbon\Carbon::now()->format('Y-m-d');
}
}
CODE_SAMPLE
Expand Down
86 changes: 86 additions & 0 deletions rules/Carbon/Rector/FuncCall/TimeFuncCallToCarbonRector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?php

declare(strict_types=1);

namespace Rector\Carbon\Rector\FuncCall;

use PhpParser\Node;
use PhpParser\Node\Expr\ArrowFunction;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Name\FullyQualified;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @see \Rector\Tests\Carbon\Rector\FuncCall\DateFuncCallToCarbonRector\DateFuncCallToCarbonRectorTest
*/
final class TimeFuncCallToCarbonRector extends AbstractRector
{
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Convert time() function call to Carbon::now()->timestamp', [
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
public function run()
{
$time = time();
}
}
CODE_SAMPLE

,
<<<'CODE_SAMPLE'
class SomeClass
{
public function run()
{
$time = \Carbon\Carbon::now()->timestamp;
}
}
CODE_SAMPLE
),
]);
}

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

/**
* @param FuncCall $node
*/
public function refactor(Node $node): ?Node
{
if (! $this->isName($node->name, 'time')) {
return null;
}

$firstClassCallable = $node->isFirstClassCallable();

if (!$firstClassCallable && count($node->getArgs()) !== 0) {
return null;
}

// create now and format()
$nowStaticCall = new StaticCall(new FullyQualified('Carbon\Carbon'), 'now');
$propertyFetch = new PropertyFetch($nowStaticCall, 'timestamp');

if ($firstClassCallable) {
return new ArrowFunction([
'static' => true,
'expr' => $propertyFetch,
]);
}

return $propertyFetch;
}
}