From cc1e182eb9b218625b0d7e31952717f5d294c426 Mon Sep 17 00:00:00 2001
From: Peter Fox <peter.fox@peterfox.me>
Date: Sat, 26 Oct 2024 14:43:48 +0100
Subject: [PATCH] Adds the EnvVariableToEnvHelperRector rule (#264)

Co-authored-by: Geni Jaho <jahogeni@gmail.com>
---
 docs/rector_rules_overview.md                 | 15 ++++-
 .../EnvVariableToEnvHelperRector.php          | 55 +++++++++++++++++++
 .../EnvVariableToEnvHelperRectorTest.php      | 31 +++++++++++
 .../Fixture/fixture.php.inc                   | 15 +++++
 .../skip_dim_fetch_without_dim.php.inc        |  7 +++
 .../Fixture/skip_non_env_variable.php.inc     |  7 +++
 .../config/configured_rule.php                | 12 ++++
 7 files changed, 141 insertions(+), 1 deletion(-)
 create mode 100644 src/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector.php
 create mode 100644 tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/EnvVariableToEnvHelperRectorTest.php
 create mode 100644 tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/fixture.php.inc
 create mode 100644 tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_dim_fetch_without_dim.php.inc
 create mode 100644 tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_non_env_variable.php.inc
 create mode 100644 tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/config/configured_rule.php

diff --git a/docs/rector_rules_overview.md b/docs/rector_rules_overview.md
index f8efff26..6b6b90f3 100644
--- a/docs/rector_rules_overview.md
+++ b/docs/rector_rules_overview.md
@@ -1,4 +1,4 @@
-# 69 Rules Overview
+# 70 Rules Overview
 
 ## AbortIfRector
 
@@ -578,6 +578,19 @@ Replace use of the unsafe `empty()` function with Laravel's safer `blank()` & `f
 
 <br>
 
+## EnvVariableToEnvHelperRector
+
+Change env variable to env static call
+
+- class: [`RectorLaravel\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector`](../src/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector.php)
+
+```diff
+-$_ENV['APP_NAME'];
++\Illuminate\Support\Env::get('APP_NAME');
+```
+
+<br>
+
 ## FactoryApplyingStatesRector
 
 Call the state methods directly instead of specify the name of state.
diff --git a/src/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector.php b/src/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector.php
new file mode 100644
index 00000000..295d8c02
--- /dev/null
+++ b/src/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector.php
@@ -0,0 +1,55 @@
+<?php
+
+namespace RectorLaravel\Rector\ArrayDimFetch;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\ArrayDimFetch;
+use PhpParser\Node\Expr\StaticCall;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \RectorLaravel\Tests\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector\EnvVariableToEnvHelperRectorTest
+ */
+class EnvVariableToEnvHelperRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change env variable to env static call',
+            [new CodeSample(
+                <<<'CODE_SAMPLE'
+$_ENV['APP_NAME'];
+CODE_SAMPLE,
+                <<<'CODE_SAMPLE'
+\Illuminate\Support\Env::get('APP_NAME');
+CODE_SAMPLE
+            )]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [ArrayDimFetch::class];
+    }
+
+    /**
+     * @param  ArrayDimFetch  $node
+     */
+    public function refactor(Node $node): ?StaticCall
+    {
+        if (! $this->isName($node->var, '_ENV')) {
+            return null;
+        }
+
+        if ($node->dim === null) {
+            return null;
+        }
+
+        return $this->nodeFactory->createStaticCall('Illuminate\Support\Env', 'get', [
+            new Arg($node->dim),
+        ]);
+    }
+}
diff --git a/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/EnvVariableToEnvHelperRectorTest.php b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/EnvVariableToEnvHelperRectorTest.php
new file mode 100644
index 00000000..8fcba10b
--- /dev/null
+++ b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/EnvVariableToEnvHelperRectorTest.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Tests\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class EnvVariableToEnvHelperRectorTest extends AbstractRectorTestCase
+{
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    /**
+     * @test
+     */
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/fixture.php.inc b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/fixture.php.inc
new file mode 100644
index 00000000..4419b33c
--- /dev/null
+++ b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/fixture.php.inc
@@ -0,0 +1,15 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector\Fixture;
+
+$_ENV['APP_NAME'];
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector\Fixture;
+
+\Illuminate\Support\Env::get('APP_NAME');
+
+?>
diff --git a/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_dim_fetch_without_dim.php.inc b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_dim_fetch_without_dim.php.inc
new file mode 100644
index 00000000..8665ff49
--- /dev/null
+++ b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_dim_fetch_without_dim.php.inc
@@ -0,0 +1,7 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector\Fixture;
+
+$_ENV[];
+
+?>
diff --git a/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_non_env_variable.php.inc b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_non_env_variable.php.inc
new file mode 100644
index 00000000..455a2c71
--- /dev/null
+++ b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/Fixture/skip_non_env_variable.php.inc
@@ -0,0 +1,7 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector\Fixture;
+
+$_ENVV['APP_NAME'];
+
+?>
diff --git a/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/config/configured_rule.php b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/config/configured_rule.php
new file mode 100644
index 00000000..fe9203e0
--- /dev/null
+++ b/tests/Rector/ArrayDimFetch/EnvVariableToEnvHelperRector/config/configured_rule.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use RectorLaravel\Rector\ArrayDimFetch\EnvVariableToEnvHelperRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
+
+    $rectorConfig->rule(EnvVariableToEnvHelperRector::class);
+};