feat: create PathsLoader trait

phpstan.neon.dist

@@ -6,7 +6,6 @@ parameters:
     paths:
         - src
         - config
-        - database
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true

src/Abstracts/Actions/Action.php

@@ -4,5 +4,4 @@
 
 abstract class Action
 {
-
 }

src/Abstracts/Actions/SubAction.php

@@ -4,5 +4,4 @@
 
 abstract class SubAction extends Action
 {
-
 }

src/Abstracts/Commands/ConsoleCommand.php

@@ -6,5 +6,4 @@
 
 abstract class ConsoleCommand extends LaravelCommand
 {
-
 }

src/Abstracts/Controllers/ApiController.php

@@ -4,5 +4,4 @@
 
 abstract class ApiController extends Controller
 {
-
 }

src/Abstracts/Controllers/WebController.php

@@ -4,5 +4,4 @@
 
 abstract class WebController extends Controller
 {
-
 }

src/Abstracts/Exceptions/Exception.php

@@ -6,5 +6,4 @@
 
 abstract class Exception extends LaravelException
 {
-
 }

src/Abstracts/Factories/Factory.php

@@ -6,5 +6,4 @@
 
 abstract class Factory extends LaravelFactory
 {
-
 }

src/Abstracts/Listeners/Listener.php

@@ -4,5 +4,4 @@
 
 abstract class Listener
 {
-
 }

src/Abstracts/Middlewares/Middleware.php

@@ -4,5 +4,4 @@
 
 abstract class Middleware
 {
-
 }

src/Abstracts/Notifications/Notification.php

@@ -6,5 +6,4 @@
 
 abstract class Notification extends LaravelNotification
 {
-
 }

src/Abstracts/Policies/Policy.php

@@ -4,5 +4,4 @@
 
 abstract class Policy
 {
-
 }

src/Abstracts/Providers/AuthServiceProvider.php

@@ -17,8 +17,6 @@ abstract class AuthServiceProvider extends LaravelAuthServiceProvider
 
     /**
      * Register any authentication / authorization services.
-     *
-     * @return void
      */
     public function boot(): void
     {

src/Abstracts/Providers/BroadcastServiceProvider.php

@@ -6,5 +6,4 @@
 
 abstract class BroadcastServiceProvider extends LaravelBroadcastServiceProvider
 {
-
 }

src/Abstracts/Providers/EventServiceProvider.php

@@ -6,5 +6,4 @@
 
 abstract class EventServiceProvider extends LaravelEventServiceProvider
 {
-
 }

src/Abstracts/Providers/MainServiceProvider.php

@@ -13,8 +13,6 @@ abstract class MainServiceProvider extends LaravelAppServiceProvider
 
     /**
      * Register any application services.
-     *
-     * @return void
      */
     public function register(): void
     {
@@ -24,11 +22,8 @@ public function register(): void
 
     /**
      * Bootstrap any application services.
-     *
-     * @return void
      */
     public function boot(): void
     {
-
     }
 }

src/Abstracts/Providers/MiddlewareServiceProvider.php

@@ -19,6 +19,7 @@ abstract class MiddlewareServiceProvider extends MainServiceProvider
 
     /**
      * Perform post-registration booting of services.
+     *
      * @throws BindingResolutionException
      */
     public function boot(): void

src/Abstracts/Providers/RouteServiceProvider.php

@@ -9,19 +9,8 @@ abstract class RouteServiceProvider extends LaravelRouteServiceProvider
 {
     use RoutesLoaderTrait;
 
-    /**
-     * The controller namespace for the application.
-     *
-     * When present, controller route declarations will automatically be prefixed with this namespace.
-     *
-     * @var string|null
-     */
-    // protected $namespace = 'App\\Http\\Controllers';
-
     /**
      * Define your route model bindings, pattern filters, etc.
-     *
-     * @return void
      */
     public function boot(): void
     {

src/Abstracts/Requests/Request.php

@@ -6,5 +6,4 @@
 
 abstract class Request extends LaravelRequest
 {
-
 }

src/Abstracts/Seeders/Seeder.php

@@ -6,5 +6,4 @@
 
 abstract class Seeder extends LaravelSeeder
 {
-
 }

src/Abstracts/Tasks/Task.php

@@ -4,5 +4,4 @@
 
 abstract class Task
 {
-
 }

src/Abstracts/Tests/PhpUnit/TestCase.php

@@ -6,5 +6,4 @@
 
 abstract class TestCase extends LaravelTestCase
 {
-
 }

src/Facades/Porto.php

@@ -5,19 +5,6 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static array getShipFoldersNames()
- * @method static array getShipPath()
- * @method static array getSectionContainerNames(string $sectionName)
- * @method static mixed getClassObjectFromFile($filePathName)
- * @method static string getClassFullNameFromFile($filePathName)
- * @method static array getSectionPaths()
- * @method static mixed getClassType($className)
- * @method static array getAllContainerNames()
- * @method static array getAllContainerPaths()
- * @method static array getSectionNames()
- * @method static array getSectionContainerPaths(string $sectionName)
- * @method static void verifyClassExist(string $className)
- *
  * @see \AdminKit\Porto\Porto
  */
 class Porto extends Facade

src/Loaders/AliasesLoaderTrait.php

@@ -18,10 +18,6 @@ public function loadAliases(): static
         return $this;
     }
 
-    /**
-     * @param $aliasKey
-     * @param $aliasValue
-     */
     private function loadAlias($aliasKey, $aliasValue): void
     {
         AliasLoader::getInstance()->alias($aliasKey, $aliasValue);

src/Loaders/AutoLoaderTrait.php

@@ -2,8 +2,6 @@
 
 namespace AdminKit\Porto\Loaders;
 
-use AdminKit\Porto\Facades\Porto;
-
 trait AutoLoaderTrait
 {
     // Using each component loader trait
@@ -15,6 +13,7 @@ trait AutoLoaderTrait
     use CommandsLoaderTrait;
     use AliasesLoaderTrait;
     use HelpersLoaderTrait;
+    use PathsLoaderTrait;
 
     public function runLoaderBoot(): void
     {
@@ -25,7 +24,7 @@ public function runLoaderBoot(): void
         $this->loadCommandsFromShip();
 
         // Iterate over all the containers folders and autoload most of the components
-        foreach (Porto::getAllContainerPaths() as $containerPath) {
+        foreach ($this->getAllContainerPaths() as $containerPath) {
             $this->loadMigrationsFromContainers($containerPath);
             $this->loadLocalsFromContainers($containerPath);
             $this->loadViewsFromContainers($containerPath);
@@ -39,7 +38,7 @@ public function runLoaderRegister(): void
         $this->loadConfigsFromShip();
         $this->loadShipServiceProviderFromShip();
 
-        foreach (Porto::getAllContainerPaths() as $containerPath) {
+        foreach ($this->getAllContainerPaths() as $containerPath) {
             $this->loadConfigsFromContainers($containerPath);
             $this->loadMainServiceProvidersFromContainers($containerPath);
         }

src/Loaders/CommandsLoaderTrait.php

@@ -2,14 +2,15 @@
 
 namespace AdminKit\Porto\Loaders;
 
-use AdminKit\Porto\Facades\Porto;
 use Illuminate\Support\Facades\File;
 
 trait CommandsLoaderTrait
 {
+    use PathsLoaderTrait;
+
     public function loadCommandsFromContainers($containerPath): void
     {
-        $containerCommandsDirectory = $containerPath . '/UI/CLI/Commands';
+        $containerCommandsDirectory = $containerPath.'/UI/CLI/Commands';
         $this->loadTheConsoles($containerCommandsDirectory);
     }
 
@@ -20,8 +21,8 @@ private function loadTheConsoles($directory): void
 
             foreach ($files as $consoleFile) {
                 // Do not load route files
-                if (!$this->isRouteFile($consoleFile)) {
-                    $consoleClass = Porto::getClassFullNameFromFile($consoleFile->getPathname());
+                if (! $this->isRouteFile($consoleFile)) {
+                    $consoleClass = $this->getClassFullNameFromFile($consoleFile->getPathname());
                     // When user from the Main Service Provider, which extends Laravel
                     // service provider you get access to `$this->commands`
                     $this->commands([$consoleClass]);
@@ -32,12 +33,12 @@ private function loadTheConsoles($directory): void
 
     private function isRouteFile($consoleFile): bool
     {
-        return $consoleFile->getFilename() === "closures.php";
+        return $consoleFile->getFilename() === 'closures.php';
     }
 
     public function loadCommandsFromShip(): void
     {
-        $shipCommandsDirectory = base_path('app/Ship/Commands');
+        $shipCommandsDirectory = $this->getShipPath().'/Commands';
         $this->loadTheConsoles($shipCommandsDirectory);
     }
 }

src/Loaders/ConfigsLoaderTrait.php

@@ -2,14 +2,15 @@
 
 namespace AdminKit\Porto\Loaders;
 
-
 use Illuminate\Support\Facades\File;
 
 trait ConfigsLoaderTrait
 {
+    use PathsLoaderTrait;
+
     public function loadConfigsFromShip(): void
     {
-        $shipConfigsDirectory = base_path('app/Ship/Configs');
+        $shipConfigsDirectory = $this->getShipPath().'/Configs';
         $this->loadConfigs($shipConfigsDirectory);
     }
 
@@ -20,7 +21,7 @@ private function loadConfigs($configFolder): void
 
             foreach ($files as $file) {
                 $name = File::name($file);
-                $path = $configFolder . '/' . $name . '.php';
+                $path = $configFolder.'/'.$name.'.php';
 
                 $this->mergeConfigFrom($path, $name);
             }
@@ -29,7 +30,7 @@ private function loadConfigs($configFolder): void
 
     public function loadConfigsFromContainers($containerPath): void
     {
-        $containerConfigsDirectory = $containerPath . '/Configs';
+        $containerConfigsDirectory = $containerPath.'/Configs';
         $this->loadConfigs($containerConfigsDirectory);
     }
 }

src/Loaders/HelpersLoaderTrait.php

@@ -7,9 +7,11 @@
 
 trait HelpersLoaderTrait
 {
+    use PathsLoaderTrait;
+
     public function loadHelpersFromContainers($containerPath): void
     {
-        $containerHelpersDirectory = $containerPath . '/Helpers';
+        $containerHelpersDirectory = $containerPath.'/Helpers';
         $this->loadHelpers($containerHelpersDirectory);
     }
 
@@ -20,7 +22,7 @@ private function loadHelpers($helpersFolder): void
 
             foreach ($files as $file) {
                 try {
-                    require($file);
+                    require $file;
                 } catch (FileNotFoundException $e) {
                 }
             }
@@ -29,7 +31,7 @@ private function loadHelpers($helpersFolder): void
 
     public function loadHelpersFromShip(): void
     {
-        $shipHelpersDirectory = base_path('app/Ship/Helpers');
+        $shipHelpersDirectory = $this->getShipPath().'/Helpers';
         $this->loadHelpers($shipHelpersDirectory);
     }
 }

src/Loaders/LocalizationLoaderTrait.php

@@ -7,9 +7,11 @@
 
 trait LocalizationLoaderTrait
 {
+    use PathsLoaderTrait;
+
     public function loadLocalsFromContainers($containerPath): void
     {
-        $containerLocaleDirectory = $containerPath . '/Languages';
+        $containerLocaleDirectory = $containerPath.'/Languages';
         $containerName = basename($containerPath);
         $pathParts = explode(DIRECTORY_SEPARATOR, $containerPath);
         $sectionName = $pathParts[count($pathParts) - 2];
@@ -27,14 +29,14 @@ private function loadLocals($directory, $containerName, $sectionName = null): vo
 
     private function buildLocaleNamespace(?string $sectionName, string $containerName): string
     {
-        return $sectionName ? (Str::camel($sectionName) . '@' . Str::camel($containerName)) : Str::camel(
+        return $sectionName ? (Str::camel($sectionName).'@'.Str::camel($containerName)) : Str::camel(
             $containerName
         );
     }
 
     public function loadLocalsFromShip(): void
     {
-        $shipLocaleDirectory = base_path('app/Ship/Languages');
-        $this->loadLocals($shipLocaleDirectory, 'ship');
+        $shipLocaleDirectory = $this->getShipPath().'/Languages';
+        $this->loadLocals($shipLocaleDirectory, $this->shipFolderName);
     }
 }