feat: setup command configure helper autoloading

Author: kenjis

src/Commands/Setup.php

@@ -8,6 +8,7 @@
 use CodeIgniter\Commands\Database\Migrate;
 use CodeIgniter\Shield\Commands\Setup\ContentReplacer;
 use CodeIgniter\Test\Filters\CITestStreamFilter;
+use Config\Autoload as AutoloadConfig;
 use Config\Email as EmailConfig;
 use Config\Services;
 
@@ -78,7 +79,7 @@ private function publishConfig(): void
         $this->publishConfigAuthGroups();
         $this->publishConfigAuthToken();
 
-        $this->setupHelper();
+        $this->setAutoloadHelpers();
         $this->setupRoutes();
 
         $this->setSecurityCSRF();
@@ -236,24 +237,61 @@ private function replace(string $file, array $replaces): bool
         return false;
     }
 
-    private function setupHelper(): void
+    private function setAutoloadHelpers(): void
     {
-        $file  = 'Controllers/BaseController.php';
-        $check = '$this->helpers = array_merge($this->helpers, [\'setting\']);';
+        $file = 'Config/Autoload.php';
+
+        $path      = $this->distPath . $file;
+        $cleanPath = clean_path($path);
+
+        if (! is_file($path)) {
+            $this->error("  Not found file '{$cleanPath}'.");
+
+            return;
+        }
+
+        $config     = new AutoloadConfig();
+        $helpers    = $config->helpers;
+        $newHelpers = array_unique(array_merge($helpers, ['auth', 'setting']));
+
+        $pattern = '/^    public \$helpers = \[.*\];/mu';
+        $replace = '    public $helpers = [\'' . implode("', '", $newHelpers) . '\'];';
+        $content = file_get_contents($path);
+        $output  = preg_replace($pattern, $replace, $content);
+
+        // check if the content is updated
+        if ($output === $content) {
+            $this->write(CLI::color('  Autoload Setup: ', 'green') . 'Everything is fine.');
+
+            return;
+        }
+
+        if (write_file($path, $output)) {
+            $this->write(CLI::color('  Updated: ', 'green') . $cleanPath);
+
+            $this->removeHelperLoadingInBaseController();
+        } else {
+            $this->error("  Error updating file '{$cleanPath}'.");
+        }
+    }
+
+    private function removeHelperLoadingInBaseController(): void
+    {
+        $file = 'Controllers/BaseController.php';
+
+        $check = '        $this->helpers = array_merge($this->helpers, [\'setting\']);';
 
         // Replace old helper setup
         $replaces = [
             '$this->helpers = array_merge($this->helpers, [\'auth\', \'setting\']);' => $check,
         ];
-        if ($this->replace($file, $replaces)) {
-            return;
-        }
+        $this->replace($file, $replaces);
 
-        // Add helper setup
-        $pattern = '/(' . preg_quote('// Do Not Edit This Line', '/') . ')/u';
-        $replace = $check . "\n\n        " . '$1';
-
-        $this->add($file, $check, $pattern, $replace);
+        // Remove helper setup
+        $replaces = [
+            "\n" . $check . "\n" => '',
+        ];
+        $this->replace($file, $replaces);
     }
 
     private function setupRoutes(): void

tests/Commands/SetupTest.php

@@ -65,6 +65,9 @@ public function testRun(): void
         $this->assertStringContainsString('namespace Config;', $authToken);
         $this->assertStringContainsString('use CodeIgniter\Shield\Config\AuthToken as ShieldAuthToken;', $authToken);
 
+        $autoload = file_get_contents($appFolder . 'Config/Autoload.php');
+        $this->assertStringContainsString('$helpers = [\'auth\', \'setting\'];', $autoload);
+
         $routes = file_get_contents($appFolder . 'Config/Routes.php');
         $this->assertStringContainsString('service(\'auth\')->routes($routes);', $routes);
 
@@ -77,7 +80,7 @@ public function testRun(): void
             '  Created: vfs://root/Config/Auth.php
   Created: vfs://root/Config/AuthGroups.php
   Created: vfs://root/Config/AuthToken.php
-  Updated: vfs://root/Controllers/BaseController.php
+  Updated: vfs://root/Config/Autoload.php
   Updated: vfs://root/Config/Routes.php
   Updated: We have updated file \'vfs://root/Config/Security.php\' for security reasons.
   Updated: vfs://root/Config/Email.php',
@@ -112,7 +115,7 @@ public function testRunEmailConfigIsFine(): void
             '  Created: vfs://root/Config/Auth.php
   Created: vfs://root/Config/AuthGroups.php
   Created: vfs://root/Config/AuthToken.php
-  Updated: vfs://root/Controllers/BaseController.php
+  Updated: vfs://root/Config/Autoload.php
   Updated: vfs://root/Config/Routes.php
   Updated: We have updated file \'vfs://root/Config/Security.php\' for security reasons.',
             $result