[Enhancement] Fix code style (#1837)

* fix code style
Power-Components · Feb 6, 2025 · 7e6682a · 7e6682a
1 parent 7e361e3
commit 7e6682a
Show file tree

Hide file tree

Showing 58 changed files with 314 additions and 187 deletions.
diff --git a/src/Button.php b/src/Button.php
@@ -2,6 +2,7 @@
 
 namespace PowerComponents\LivewirePowerGrid;
 
+use Closure;
 use Illuminate\Support\Traits\Macroable;
 use Livewire\Wireable;
 
@@ -17,7 +18,7 @@
  * @method static route(string $route, array $params, string $target)
  * @method static method(string $method)
  * @method static target(string $target) _blank, _self, _top, _parent, null
- * @method static can(bool|\Closure $allowed = true)
+ * @method static can(bool|Closure $allowed = true)
  * @method static id(string $id = null)
  * @method static confirm(string $message = 'Are you sure you want to perform this action?')
  * @method static confirmPrompt(string $message = 'Are you sure you want to perform this action?', string $confirmValue = 'Confirm')
@@ -38,7 +39,7 @@ final class Button implements Wireable
 
     public array $iconAttributes = [];
 
-    public bool | \Closure $can = true;
+    public bool|Closure $can = true;
 
     public function __construct(public string $action)
     {

diff --git a/src/Column.php b/src/Column.php
@@ -3,14 +3,15 @@
 namespace PowerComponents\LivewirePowerGrid;
 
 use Illuminate\Support\Traits\Macroable;
+use Livewire\Wireable;
 
 /**
  * Macros
  * @method static naturalSort()
  * @method static searchableRaw(string $sql)
  * @method static searchableJson(string $tableName) // sqlite, mysql
  */
-final class Column implements \Livewire\Wireable
+final class Column implements Wireable
 {
     use Macroable;
 
@@ -81,7 +82,7 @@ public static function add(): self
      */
     public static function make(string $title, string $field, string $dataField = ''): self
     {
-        return (new static())
+        return (new Column())
             ->title($title)
             ->field($field, $dataField);
     }
@@ -91,7 +92,7 @@ public static function make(string $title, string $field, string $dataField = ''
      */
     public static function action(string $title): self
     {
-        return (new static())
+        return (new Column())
             ->title($title)
             ->isAction()
             ->visibleInExport(false);

diff --git a/src/Commands/Actions/AskComponentDatasource.php b/src/Commands/Actions/AskComponentDatasource.php
@@ -12,16 +12,16 @@ public static function handle(): string
     {
         // Must pass options as array<int, "label"> to
         // improve users experience when Laravel prompt falls back.
-        $datasources = Datasource::asOptions();
+        $datasource = Datasource::asOptions();
 
         $choice = strval(select(
             label: 'Select your preferred Data source:',
-            options: $datasources->values()->toArray(), // @phpstan-ignore-line
+            options: $datasource->values()->toArray(), // @phpstan-ignore-line
             default: 0
         ));
 
         // Find and return they key based on user's choice.
-        return (string) $datasources->filter(function ($item) use ($choice) {
+        return (string) $datasource->filter(function ($item) use ($choice) {
             return $item === $choice;
         })->keys()[0];
     }

diff --git a/src/Commands/Actions/AskComponentName.php b/src/Commands/Actions/AskComponentName.php
@@ -31,8 +31,8 @@ public static function handle(): string
     private static function checkIfComponentAlreadyExists(): void
     {
         if (File::exists(powergrid_components_path(self::$componentName . '.php'))) {
-            $confirmation = (bool) confirm(
-                "Component [" . self::$componentName . "] already exists. Overwrite it?",
+            $confirmation = confirm(
+                'Component [' . self::$componentName . '] already exists. Overwrite it?',
                 default: false,
                 hint: '❗ WARNING ❗'
             );

diff --git a/src/Commands/Actions/AskDatabaseTableName.php b/src/Commands/Actions/AskDatabaseTableName.php
@@ -11,6 +11,7 @@ final class AskDatabaseTableName
     public static function handle(): string
     {
         $tableExists = false;
+        $tableName   = '';
 
         while (!$tableExists) {
             $tableName = suggest(

diff --git a/src/Commands/Actions/AskModelName.php b/src/Commands/Actions/AskModelName.php
@@ -15,17 +15,15 @@ final class AskModelName
      */
     public static function handle(): array
     {
-        {
-            while (self::$model === '') {
-                self::setModel(suggest(
-                    label: 'Select a Model or enter its Fully qualified name.',
-                    options: ListModels::handle(),
-                    required: true,
-                ));
-            }
-
-            return ['model' => self::$model, 'fqn' => self::$fqn];
+        while (self::$model === '') {
+            self::setModel(suggest(
+                label: 'Select a Model or enter its Fully qualified name.',
+                options: ListModels::handle(),
+                required: true,
+            ));
         }
+
+        return ['model' => self::$model, 'fqn' => self::$fqn];
     }
 
     private static function setModel(string $model): void

diff --git a/src/Commands/Actions/CheckIfDatabaseHasTables.php b/src/Commands/Actions/CheckIfDatabaseHasTables.php
@@ -2,15 +2,16 @@
 
 namespace PowerComponents\LivewirePowerGrid\Commands\Actions;
 
+use Exception;
 use Illuminate\Support\Facades\Schema;
 
 final class CheckIfDatabaseHasTables
 {
     public static function handle(): bool
     {
         try {
-            return count(Schema::getTables()) > 0 ? true : false;
-        } catch (\Exception $e) {
+            return count(Schema::getTables()) > 0;
+        } catch (Exception) {
             return false;
         }
     }

diff --git a/src/Commands/Actions/GetStubVarsFromDbTable.php b/src/Commands/Actions/GetStubVarsFromDbTable.php
@@ -83,8 +83,8 @@ public static function handle(PowerGridComponentMaker $component): array
             $columns .= '            Column::make(\'' . $title . '\', \'' . $field . '\')' . "\n" . '                ->sortable()' . "\n" . '                ->searchable(),' . "\n\n";
         }
 
-        $columns .= "        ];";
-        $filters .= "        ];";
+        $columns .= '        ];';
+        $filters .= '        ];';
 
         return [
             'PowerGridFields' => $datasource,

diff --git a/src/Commands/Actions/GetStubVarsFromFromModel.php b/src/Commands/Actions/GetStubVarsFromFromModel.php
@@ -2,6 +2,7 @@
 
 namespace PowerComponents\LivewirePowerGrid\Commands\Actions;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\Str;
 use PowerComponents\LivewirePowerGrid\Commands\Support\PowerGridComponentMaker;
@@ -15,7 +16,7 @@ class GetStubVarsFromFromModel
      */
     public static function handle(PowerGridComponentMaker $component): array
     {
-        /** @var  \Illuminate\Database\Eloquent\Model $model*/
+        /** @var Model $model */
         $model = new $component->modelFqn();
 
         $getFillable = $model->getFillable();
@@ -106,8 +107,8 @@ public static function handle(PowerGridComponentMaker $component): array
 
         $columns .= '            Column::action(\'Action\')' . "\n";
 
-        $columns .= "        ];";
-        $filters .= "        ];";
+        $columns .= '        ];';
+        $filters .= '        ];';
 
         return [
             'PowerGridFields' => $datasource,

diff --git a/src/Commands/Actions/ListDatabaseTables.php b/src/Commands/Actions/ListDatabaseTables.php
@@ -2,6 +2,7 @@
 
 namespace PowerComponents\LivewirePowerGrid\Commands\Actions;
 
+use Exception;
 use Illuminate\Support\Facades\Schema;
 
 final class ListDatabaseTables
@@ -18,8 +19,8 @@ public static function handle(): array
             return array_values(collect(Schema::getTables())
                 ->pluck('name')
                 ->diff(self::HIDDEN_TABLES)
-                ->toArray());
-        } catch (\Exception $e) {
+                ->all());
+        } catch (Exception) {
             return [];
         }
     }

diff --git a/src/Commands/Actions/ListModels.php b/src/Commands/Actions/ListModels.php
@@ -3,19 +3,20 @@
 namespace PowerComponents\LivewirePowerGrid\Commands\Actions;
 
 use Illuminate\Support\Facades\File;
+use ReflectionClass;
+use ReflectionException;
 use Symfony\Component\Finder\SplFileInfo;
 
 final class ListModels
 {
     /**
      * List files in Models
-     *
      */
     public static function handle(): array
     {
         $directories = config('livewire-powergrid.auto_discover_models_paths', [app_path('Models')]);
 
-        /** @var Array<int,string> $directories */
+        /** @var array<int,string> $directories */
         return collect($directories)
             ->filter(fn (string $directory) => File::exists($directory))
             ->map(fn (string $directory) => File::allFiles($directory))
@@ -33,8 +34,10 @@ public static function handle(): array
             ->filter()
 
             // Remove classes that do not extend an Eloquent Model
-            /** @phpstan-ignore-next-line */
-            ->reject(fn (string $fqnClass) => rescue(fn () => (new \ReflectionClass($fqnClass))->isSubclassOf(\Illuminate\Database\Eloquent\Model::class), false) === false)
-            ->toArray();
+            /** @phpstan-ignore-next-line
+             * @throws ReflectionException
+             */
+            ->reject(fn (string $fqnClass) => rescue(fn () => (new ReflectionClass($fqnClass))->isSubclassOf(\Illuminate\Database\Eloquent\Model::class), false) === false)
+            ->all();
     }
 }
diff --git a/src/Commands/Actions/ParseFqnClassInCode.php b/src/Commands/Actions/ParseFqnClassInCode.php
@@ -2,19 +2,21 @@
 
 namespace PowerComponents\LivewirePowerGrid\Commands\Actions;
 
+use Exception;
+
 final class ParseFqnClassInCode
 {
     /**
      * Parse namespace from PHP source code
      * Inspired by: https://gist.github.com/ludofleury/1886076
-     * @throws \Exception
+     * @throws Exception
      */
     public static function handle(string $sourceCode): string
     {
         if (preg_match('#^namespace\s+(.+?);.*class\s+(\w+).+;$#sm', $sourceCode, $matches)) {
             return $matches[1] . '\\' . $matches[2];
         }
 
-        throw new \Exception('could not find a FQN Class is source-code');
+        throw new Exception('could not find a FQN Class is source-code');
     }
 }
diff --git a/src/Commands/Actions/SanitizeComponentName.php b/src/Commands/Actions/SanitizeComponentName.php
@@ -15,11 +15,11 @@ public static function handle(string $componentName): string
             //Convert multiple spaces into forward slashes
             ->replaceMatches('/\s+/', '//')
             //multiple back slashes into forward slashes
-            ->replaceMatches('/\\\{2,}/', "\\")
+            ->replaceMatches('/\\\{2,}/', '\\')
             //Multiple forward slashes
-            ->replaceMatches('/\/{2,}/', "\\")
+            ->replaceMatches('/\/{2,}/', '\\')
             //Multile dots
-            ->replaceMatches('/\.{2,}/', ".")
+            ->replaceMatches('/\.{2,}/', '.')
             ->replace('.', '\\')
             //Left over backslahes into forward slashes
             ->replace('/', '\\')

diff --git a/src/Commands/CreateCommand.php b/src/Commands/CreateCommand.php
@@ -2,6 +2,7 @@
 
 namespace PowerComponents\LivewirePowerGrid\Commands;
 
+use Exception;
 use Illuminate\Console\Command;
 
 use function Laravel\Prompts\{error, info, note};
@@ -34,17 +35,17 @@ public function handle(): int
 
         try {
             $this
-            ->step1()
-            ->step2()
-            ->step3()
-            ->step4()
-            ->step5()
-            ->step6()
-            ->save()
-            ->feedback();
+                ->step1()
+                ->step2()
+                ->step3()
+                ->step4()
+                ->step5()
+                ->step6()
+                ->save()
+                ->feedback();
 
             return self::SUCCESS;
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             error($e->getMessage());
 
             return self::FAILURE;
@@ -130,7 +131,7 @@ public function feedback(): void
 
         note("💡 include the <comment>{$this->component?->name}</comment> component using the tag: <comment>{$this->component?->htmlTag}</comment>");
 
-        info("👍 Please consider <comment>⭐ starring ⭐</comment> <info>our repository. Visit: </info><comment>https://github.com/Power-Components/livewire-powergrid</comment>" . PHP_EOL);
+        info('👍 Please consider <comment>⭐ starring ⭐</comment> <info>our repository. Visit: </info><comment>https://github.com/Power-Components/livewire-powergrid</comment>' . PHP_EOL);
     }
 
     private function AutoImportLabel(): string

diff --git a/src/Commands/Enums/Datasource.php b/src/Commands/Enums/Datasource.php
@@ -20,9 +20,9 @@ public static function from(string $datasource): mixed
     public function label(): string
     {
         return match ($this) {
-            Datasource::ELOQUENT_BUILDER => "Eloquent Builder",
-            Datasource::QUERY_BUILDER    => "Query Builder",
-            Datasource::COLLECTION       => "Collection"
+            Datasource::ELOQUENT_BUILDER => 'Eloquent Builder',
+            Datasource::QUERY_BUILDER    => 'Query Builder',
+            Datasource::COLLECTION       => 'Collection'
         };
     }
 
@@ -70,7 +70,7 @@ public function stubTemplate(): string
     }
 
     /**
-    * Datasource with labels for dropdown select
+     * Datasource with labels for dropdown select
      *
      * @return Collection<string,string>
      */

diff --git a/src/Commands/InteractsWithVersions.php b/src/Commands/InteractsWithVersions.php
@@ -25,7 +25,7 @@ class InteractsWithVersions
      */
     public function ensureLatestVersion(): array
     {
-        $composer  = Factory::create(new NullIo(), null, false);
+        $composer  = Factory::create(new NullIo());
         $localRepo = $composer->getRepositoryManager()->getLocalRepository();
 
         return $this->searchPackage($localRepo);
@@ -73,7 +73,7 @@ public function getLatestVersion(): string
 
             /** @phpstan-ignore-next-line */
             $version = collect($package['packages']['power-components/livewire-powergrid'])
-                    ->first()['version'];
+                ->first()['version'];
 
             if (!is_string($version)) {
                 throw new Exception('Error: could find PowerGrid version.');