Merge pull request #2 from zonneplan/analysis-8LGLan

Apply fixes from StyleCI

Author: rdgout

src/Module.php

@@ -14,12 +14,10 @@
 use Zonneplan\ModuleLoader\Support\Contracts\ModuleRepositoryContract;
 
 /**
- * Class ModuleLoader
+ * Class ModuleLoader.
  *
  * The module loader acts as an opinionated ServiceProvider and will automatically try to load migrations,
  * views, etc. from a predefined folder structure.
- *
- * @package Zonneplan\LaravelModuleLoader
  */
 abstract class Module extends ServiceProvider implements ModuleContract
 {
@@ -41,8 +39,9 @@ abstract class Module extends ServiceProvider implements ModuleContract
     /**
      * Register the module.
      *
-     * @return void
      * @throws ReflectionException
+     *
+     * @return void
      */
     public function register(): void
     {
@@ -55,8 +54,9 @@ public function register(): void
     /**
      * Boot the module.
      *
-     * @return void
      * @throws ReflectionException
+     *
+     * @return void
      */
     public function boot(): void
     {
@@ -84,8 +84,9 @@ protected function loadCommandSchedule(): void
     }
 
     /**
-     * @return void
      * @throws ReflectionException
+     *
+     * @return void
      */
     protected function loadMigrations(): void
     {
@@ -97,8 +98,9 @@ protected function loadMigrations(): void
     }
 
     /**
-     * @return void
      * @throws ReflectionException
+     *
+     * @return void
      */
     protected function loadViews(): void
     {
@@ -110,8 +112,9 @@ protected function loadViews(): void
     }
 
     /**
-     * @return void
      * @throws ReflectionException
+     *
+     * @return void
      */
     protected function loadTranslations(): void
     {
@@ -123,8 +126,9 @@ protected function loadTranslations(): void
     }
 
     /**
-     * @return void
      * @throws ReflectionException
+     *
+     * @return void
      */
     protected function loadConfigs(): void
     {
@@ -169,8 +173,9 @@ protected function registerListeners(): void
     }
 
     /**
-     * @return string
      * @throws ReflectionException
+     *
+     * @return string
      */
     protected function getModulePath(): string
     {
@@ -203,7 +208,7 @@ protected function scheduleCommands(Schedule $schedule): void
     }
 
     /**
-     * Registers the commands of the schedule
+     * Registers the commands of the schedule.
      *
      * @return void
      */
@@ -213,7 +218,7 @@ private function registerCommands(): void
     }
 
     /**
-     * Registers middleware
+     * Registers middleware.
      *
      * @return void
      */
@@ -228,14 +233,14 @@ private function registerMiddleware(): void
     }
 
     /**
-     * Registers factories
+     * Registers factories.
      *
      * @return void
      */
     private function registerFactories(): void
     {
         $this->app->afterResolving(Factory::class, function (Factory $faker) {
-            $faker->load($this->getModulePath() . '/Database/Factories');
+            $faker->load($this->getModulePath().'/Database/Factories');
         });
     }
 

src/ModulesServiceProvider.php

@@ -11,7 +11,7 @@
 class ModulesServiceProvider extends ServiceProvider
 {
     /**
-     * Register services
+     * Register services.
      *
      * @return void
      */
@@ -29,7 +29,7 @@ public function register(): void
      */
     public function boot(): void
     {
-        $loader = new ModuleRouteLoader;
+        $loader = new ModuleRouteLoader();
 
         Router::macro('module', function (string $name, ?string $type = 'routes') use ($loader) {
             $loader->load($name, $type);

src/Support/ModuleRepository.php

@@ -16,7 +16,7 @@ class ModuleRepository implements ModuleRepositoryContract
     protected $modules = [];
 
     /**
-     * Registers a new module with a path
+     * Registers a new module with a path.
      *
      * @param string $module
      * @param string $path
@@ -31,7 +31,7 @@ public function register(string $module, string $path): self
     }
 
     /**
-     * Returns a list of all loaded modules
+     * Returns a list of all loaded modules.
      *
      * @return array
      */
@@ -41,7 +41,7 @@ public function getAll(): array
     }
 
     /**
-     * Check if the module is loaded
+     * Check if the module is loaded.
      *
      * @param string $module
      *
@@ -53,11 +53,13 @@ public function isLoaded(string $module): bool
     }
 
     /**
-     * Retrieves the path from the module
+     * Retrieves the path from the module.
      *
      * @param string $module
-     * @return string
+     *
      * @throws ModuleNotFoundException
+     *
+     * @return string
      */
     public function get(string $module): string
     {

src/Support/ModuleRouteLoader.php

@@ -10,11 +10,12 @@ class ModuleRouteLoader
     private const FALLBACK_ROUTE_TYPE = 'routes';
 
     private const ROUTE_TYPES = [
-        self::FALLBACK_ROUTE_TYPE, 'api', 'channels', 'console', 'web'
+        self::FALLBACK_ROUTE_TYPE, 'api', 'channels', 'console', 'web',
     ];
 
     /**
      * @param string $type
+     *
      * @return void
      */
     public function loadAll(string $type): void
@@ -27,8 +28,10 @@ public function loadAll(string $type): void
     /**
      * @param string $moduleName
      * @param string $type
-     * @return void
+     *
      * @throws ModuleNotFoundException
+     *
+     * @return void
      */
     public function load(string $moduleName, string $type): void
     {
@@ -40,6 +43,7 @@ public function load(string $moduleName, string $type): void
      *
      * @param string $path
      * @param string $type
+     *
      * @return void
      */
     protected function loadRoutes(string $path, string $type): void
@@ -48,7 +52,7 @@ protected function loadRoutes(string $path, string $type): void
             return;
         }
 
-        $file =  $type === self::FALLBACK_ROUTE_TYPE
+        $file = $type === self::FALLBACK_ROUTE_TYPE
             ? "{$path}/{$type}.php"
             : "{$path}/Routes/{$type}.php";
 

tests/TestCase.php

@@ -19,6 +19,7 @@ protected function getPackageProviders($app)
             ModulesServiceProvider::class,
         ];
     }
+
     protected function getPackageAliases($app)
     {
         return [