Merge pull request #5 from chrisdicarlo/allow-nested-config-folders

Allow nested config folders

Author: chrisdicarlo

src/LaravelConfigCheckerServiceProvider.php

@@ -13,8 +13,7 @@ public function configurePackage(Package $package): void
         $package->name('laravel-config-checker');
 
         if ($this->app->runningInConsole()) {
-            $package
-                ->hasCommand(LaravelConfigCheckerCommand::class);
+            $package->hasCommand(LaravelConfigCheckerCommand::class);
         }
     }
 }

src/Support/FileChecker.php

@@ -31,7 +31,7 @@ public function check(): Collection
         return collect($issues);
     }
 
-    private function checkForFacadeUsage($content): array
+    private function checkForFacadeUsage(string $content): array
     {
         $matches = [];
 
@@ -56,7 +56,7 @@ private function checkForFacadeUsage($content): array
         return $issues;
     }
 
-    private function checkForHelperUsage($content): array
+    private function checkForHelperUsage(string $content): array
     {
         $matches = [];
 

src/Support/LoadConfigKeys.php

@@ -28,7 +28,7 @@ public function __invoke(): array|Collection
         return collect($this->configKeys);
     }
 
-    private function flattenConfig($config, $prefix = '')
+    private function flattenConfig(array $config, string $prefix = '')
     {
         foreach ($config as $key => $value) {
             $fullKey = $prefix ? "{$prefix}.{$key}" : $key;
@@ -48,11 +48,21 @@ private function loadConfigKeys()
         $finder->files()->in($configPath)->name('*.php');
 
         foreach ($finder as $file) {
-            $this->configKeys[] = basename($file->getFilename(), '.php');
+            $relativePath = $file->getRelativePathname();
 
             $config = include $file->getRealPath();
 
-            $this->flattenConfig($config, basename($file->getFilename(), '.php'));
+            $key = pathinfo($relativePath, PATHINFO_FILENAME);
+
+            $folder = pathinfo($relativePath, PATHINFO_DIRNAME);
+
+            if ($folder !== '.') {
+                $key = str_replace('/', '.', $folder).'.'.$key;
+            }
+
+            $this->configKeys[] = $key;
+            $config = include $file->getRealPath();
+            $this->flattenConfig($config, $key);
         }
     }
 }

tests/LoadConfigKeysTest.php

@@ -10,6 +10,17 @@
         'app.nested',
         'app.nested.key',
     ]);
+
+    $this->nestedFolderConfigKeys = collect([
+        'app',
+        'app.valid_key',
+        'app.nested',
+        'app.nested.key',
+        'settings.inside',
+        'settings.inside.inside_subfolder_valid_key',
+        'settings.inside.inside_subfolder_nested',
+        'settings.inside.inside_subfolder_nested.inside_subfolder_nested_key',
+    ]);
 });
 
 it('loads config keys from the config directory', function () {
@@ -30,6 +41,16 @@
     expect($configKeys->count())->toBeGreaterThan(2);
 });
 
+it('loads config keys from the config directory with nested subfolders', function () {
+    $loadConfigKeys = new LoadConfigKeys(realpath(__DIR__.'/fixtures/subfolders/config'));
+
+    $configKeys = $loadConfigKeys();
+
+    foreach ($this->nestedFolderConfigKeys as $configKey) {
+        expect($configKeys)->toContain($configKey);
+    }
+});
+
 it('returns a collection of config keys', function () {
     $loadConfigKeys = new LoadConfigKeys(realpath(__DIR__.'/fixtures/base/config'));
 

tests/fixtures/subfolders/app/TestClassOne.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace ChrisDiCarlo\LaravelConfigChecker\Tests\fixtures\app;
+
+use Illuminate\Support\Facades\Config;
+
+class TestClassOne
+{
+    public function __construct()
+    {
+        config('app.invalid_key');
+        Config::get('app.invalid_key');
+        Config::has('app.invalid_key');
+    }
+}

tests/fixtures/subfolders/app/TestClassTwo.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace ChrisDiCarlo\LaravelConfigChecker\Tests\fixtures\app;
+
+use Illuminate\Support\Facades\Config;
+
+class TestClassTwo
+{
+    public function __construct()
+    {
+        config('app.invalid_key');
+        Config::get('app.invalid_key');
+        Config::has('app.invalid_key');
+    }
+}

tests/fixtures/subfolders/config/app.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'valid_key' => 'Laravel Config Checker',
+    'nested' => [
+        'key' => 'value',
+    ],
+];

tests/fixtures/subfolders/config/settings/inside.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'inside_subfolder_valid_key' => 'Inside Subfolder Laravel Config Checker',
+    'inside_subfolder_nested' => [
+        'inside_subfolder_nested_key' => 'value',
+    ],
+];

tests/fixtures/subfolders/resources/views/test-view-one.blade.php

@@ -0,0 +1,10 @@
+<div>
+    <h1>Test View One</h1>
+    {{ config('app.invalid_key') }}
+    {{ Config::get('app.invalid_key') }}
+    {{ Config::has('app.invalid_key') }}
+
+    {{ config('app.valid_key') }}
+    {{ Config::get('app.valid_key') }}
+    {{ Config::has('app.valid_key') }}
+</div>

tests/fixtures/subfolders/resources/views/test-view-two.blade.php

@@ -0,0 +1,10 @@
+<div>
+    <h1>Test View Two</h1>
+    {{ config('app.invalid_key') }}
+    {{ Config::get('app.invalid_key') }}
+    {{ Config::has('app.invalid_key') }}
+
+    {{ config('app.valid_key') }}
+    {{ Config::get('app.valid_key') }}
+    {{ Config::has('app.valid_key') }}
+</div>