refactor: revert to PowerGridFields in Commands and Concerns

Author: luanfreitasdev

resources/stubs/table.model.fillable.stub

@@ -41,7 +41,7 @@ final class {{ componentName }} extends PowerGridComponent
 
     public function fields(): PowerGridFields
     {
-        return PowerGrid::fields(){{ Fields }};
+        return PowerGrid::fields(){{ PowerGridFields }};
     }
 
     public function columns(): array

resources/stubs/table.query-builder.fillable.stub

@@ -37,7 +37,7 @@ final class {{ componentName }} extends PowerGridComponent
 
     public function fields(): PowerGridFields
     {
-        return PowerGrid::fields(){{ Fields }};
+        return PowerGrid::fields(){{ PowerGridFields }};
     }
 
     public function columns(): array

src/Commands/Actions/BuildStubVars.php

@@ -19,7 +19,7 @@ final class BuildStubVars
      * @param  list<string>  $fields  Column names, in the order they should be generated.
      * @param  Collection<string, string>  $types  Column name => normalized type bucket.
      * @param  string  $model  Model class used to type-hint generated closures; empty leaves them untyped.
-     * @return array{'Fields': string, 'filters': string, 'columns': string}
+     * @return array{'PowerGridFields': string, 'filters': string, 'columns': string}
      */
     public static function handle(array $fields, Collection $types, string $model = ''): array
     {
@@ -46,7 +46,7 @@ public static function describe(string $type): string
     /**
      * @param  list<string>  $fields
      * @param  Collection<string, string>  $types
-     * @return array{'Fields': string, 'filters': string, 'columns': string}
+     * @return array{'PowerGridFields': string, 'filters': string, 'columns': string}
      */
     private function build(array $fields, Collection $types, string $model): array
     {
@@ -74,7 +74,7 @@ private function build(array $fields, Collection $types, string $model): array
         $this->columns .= '            Column::action(\'Action\')'."\n";
 
         return [
-            'Fields' => $this->fields,
+            'PowerGridFields' => $this->fields,
             'filters' => $this->filters.'        ];',
             'columns' => $this->columns.'        ];',
         ];

src/Commands/Actions/GetStubVarsFromDbTable.php

@@ -8,7 +8,7 @@
 class GetStubVarsFromDbTable
 {
     /**
-     * @return array{'Fields': string, 'filters': string, 'columns': string}
+     * @return array{'PowerGridFields': string, 'filters': string, 'columns': string}
      */
     public static function handle(PowerGridComponentMaker $component): array
     {

src/Commands/Actions/GetStubVarsFromFromModel.php

@@ -8,7 +8,7 @@
 class GetStubVarsFromFromModel
 {
     /**
-     * @return array{'Fields': string, 'filters': string, 'columns': string}
+     * @return array{'PowerGridFields': string, 'filters': string, 'columns': string}
      */
     public static function handle(PowerGridComponentMaker $component): array
     {

src/Commands/Support/PowerGridComponentMaker.php

@@ -213,15 +213,15 @@ private function process(): self
 
         if ($this->autoCreateColumns() === true) {
             if ($this->datasource === Datasource::ELOQUENT_BUILDER) {
-                ['Fields' => $Fields, 'filters' => $filters, 'columns' => $columns] = GetStubVarsFromFromModel::handle($this);
+                ['PowerGridFields' => $PowerGridFields, 'filters' => $filters, 'columns' => $columns] = GetStubVarsFromFromModel::handle($this);
             }
 
             if ($this->datasource === Datasource::QUERY_BUILDER) {
-                ['Fields' => $Fields, 'filters' => $filters, 'columns' => $columns] = GetStubVarsFromDbTable::handle($this);
+                ['PowerGridFields' => $PowerGridFields, 'filters' => $filters, 'columns' => $columns] = GetStubVarsFromDbTable::handle($this);
             }
         }
 
-        $this->stub->setVar('Fields', $Fields ?? '');
+        $this->stub->setVar('PowerGridFields', $PowerGridFields ?? '');
 
         $this->stub->setVar('filters', $filters ?? '');
 

src/Commands/Support/PowerGridStub.php

@@ -35,7 +35,7 @@ private function ensureContentCompatibility(): void
             ->replace('\{{ modelName }}', '{{ model }}')
             ->replace('{{ modelName }}', '{{ modelFqn }}')
             ->replace('{{ modelLastName }}', '{{ model }}')
-            ->replace('{{ datasource }}', '{{ Fields }}')
+            ->replace('{{ datasource }}', '{{ PowerGridFields }}')
             ->replace('{{ dataBaseTableName }}', '{{ databaseTableName }}')
             ->toString();
     }

src/Concerns/Base.php

@@ -4,8 +4,8 @@
 
 use Livewire\Attributes\Computed;
 use PowerComponents\LivewirePowerGrid\Facades\PowerGrid;
+use PowerComponents\LivewirePowerGrid\PowerGridFields;
 use PowerComponents\Turbine\Components\Filters\FilterBase;
-use PowerComponents\Turbine\Fields;
 
 trait Base
 {
@@ -50,7 +50,7 @@ trait Base
 
     public bool $pruneHiddenColumns = true;
 
-    public function fields(): Fields
+    public function fields(): PowerGridFields
     {
         return PowerGrid::fields();
     }

tests/Feature/Actions/BuildStubVarsTest.php

@@ -6,70 +6,70 @@
     $vars = BuildStubVars::handle(['name'], collect(['name' => 'string']));
 
     expect($vars['columns'])->toContain("Column::make('Name', 'name')\n                ->sortable()\n                ->searchable(),")
-        ->and($vars['Fields'])->toContain("->add('name')")
+        ->and($vars['PowerGridFields'])->toContain("->add('name')")
         ->and($vars['filters'])->toContain("Filter::inputText('name')->operators(['contains']),");
 });
 
 it('generates a plain column without a filter for an integer', function () {
     $vars = BuildStubVars::handle(['votes'], collect(['votes' => 'integer']));
 
     expect($vars['columns'])->toContain("Column::make('Votes', 'votes'),")
-        ->and($vars['Fields'])->toContain("->add('votes')")
+        ->and($vars['PowerGridFields'])->toContain("->add('votes')")
         ->and($vars['filters'])->not->toContain('votes');
 });
 
 it('generates a toggleable column with a boolean filter for a boolean', function () {
     $vars = BuildStubVars::handle(['in_stock'], collect(['in_stock' => 'boolean']));
 
     expect($vars['columns'])->toContain("Column::make('In stock', 'in_stock')\n                ->toggleable(),")
-        ->and($vars['Fields'])->toContain("->add('in_stock')")
+        ->and($vars['PowerGridFields'])->toContain("->add('in_stock')")
         ->and($vars['filters'])->toContain("Filter::boolean('in_stock'),");
 });
 
 it('generates a formatted column with a date filter for a date', function () {
     $vars = BuildStubVars::handle(['published_on'], collect(['published_on' => 'date']));
 
     expect($vars['columns'])->toContain("Column::make('Published on', 'published_on_formatted', 'published_on')")
-        ->and($vars['Fields'])->toContain("->add('published_on_formatted', fn (\$model) => Carbon::parse(\$model->published_on)->format('d/m/Y'))")
+        ->and($vars['PowerGridFields'])->toContain("->add('published_on_formatted', fn (\$model) => Carbon::parse(\$model->published_on)->format('d/m/Y'))")
         ->and($vars['filters'])->toContain("Filter::datepicker('published_on'),");
 });
 
 it('generates a formatted column with a datetime filter for a datetime', function () {
     $vars = BuildStubVars::handle(['created_at'], collect(['created_at' => 'datetime']));
 
     expect($vars['columns'])->toContain("Column::make('Created at', 'created_at_formatted', 'created_at')")
-        ->and($vars['Fields'])->toContain("->add('created_at_formatted', fn (\$model) => Carbon::parse(\$model->created_at)->format('d/m/Y H:i:s'))")
+        ->and($vars['PowerGridFields'])->toContain("->add('created_at_formatted', fn (\$model) => Carbon::parse(\$model->created_at)->format('d/m/Y H:i:s'))")
         ->and($vars['filters'])->toContain("Filter::datetimepicker('created_at'),");
 });
 
 it('falls back to a searchable column without a filter for an unknown type', function () {
     $vars = BuildStubVars::handle(['payload'], collect(['payload' => 'other']));
 
     expect($vars['columns'])->toContain("Column::make('Payload', 'payload')\n                ->sortable()\n                ->searchable(),")
-        ->and($vars['Fields'])->toContain("->add('payload')")
+        ->and($vars['PowerGridFields'])->toContain("->add('payload')")
         ->and($vars['filters'])->toBe("[\n        ];");
 });
 
 it('adds the closure example to the first string field only', function () {
     $vars = BuildStubVars::handle(['name', 'email'], collect(['name' => 'string', 'email' => 'string']));
 
-    expect(substr_count($vars['Fields'], 'Example of custom column using a closure'))->toBe(1)
-        ->and($vars['Fields'])->toContain("->add('name_lower', fn (\$model) => strtolower(e(\$model->name)))")
-        ->and($vars['Fields'])->not->toContain('email_lower');
+    expect(substr_count($vars['PowerGridFields'], 'Example of custom column using a closure'))->toBe(1)
+        ->and($vars['PowerGridFields'])->toContain("->add('name_lower', fn (\$model) => strtolower(e(\$model->name)))")
+        ->and($vars['PowerGridFields'])->not->toContain('email_lower');
 });
 
 it('type-hints the model in generated closures', function () {
     $vars = BuildStubVars::handle(['name', 'created_at'], collect(['name' => 'string', 'created_at' => 'datetime']), 'Dish');
 
-    expect($vars['Fields'])
+    expect($vars['PowerGridFields'])
         ->toContain('fn (Dish $model) => strtolower(e($model->name))')
         ->toContain('fn (Dish $model) => Carbon::parse($model->created_at)');
 });
 
 it('skips fields that have no known column type', function () {
     $vars = BuildStubVars::handle(['name', 'ghost'], collect(['name' => 'string']));
 
-    expect($vars['Fields'])->not->toContain('ghost')
+    expect($vars['PowerGridFields'])->not->toContain('ghost')
         ->and($vars['columns'])->not->toContain('ghost');
 });
 
@@ -84,5 +84,5 @@
 
     expect($vars['columns'])->toBe("[\n            Column::action('Action')\n        ];")
         ->and($vars['filters'])->toBe("[\n        ];")
-        ->and($vars['Fields'])->toBe('');
+        ->and($vars['PowerGridFields'])->toBe('');
 });

tests/Feature/Actions/GetStubVarsFromDbTableTest.php

@@ -20,7 +20,7 @@ function waiterQueryBuilderComponent(): PowerGridComponentMaker
 it('reads every column of the given table', function () {
     $vars = GetStubVarsFromDbTable::handle(waiterQueryBuilderComponent());
 
-    expect($vars['Fields'])
+    expect($vars['PowerGridFields'])
         ->toContain("->add('id')")
         ->toContain("->add('name')")
         ->toContain("->add('email')")
@@ -39,13 +39,13 @@ function waiterQueryBuilderComponent(): PowerGridComponentMaker
 it('has no model to hide columns with, unlike the Eloquent source', function () {
     $vars = GetStubVarsFromDbTable::handle(waiterQueryBuilderComponent());
 
-    expect($vars['Fields'])->toContain("->add('internal_note')");
+    expect($vars['PowerGridFields'])->toContain("->add('internal_note')");
 });
 
 it('leaves the generated closures untyped', function () {
     $vars = GetStubVarsFromDbTable::handle(waiterQueryBuilderComponent());
 
-    expect($vars['Fields'])->toContain('fn ($model)');
+    expect($vars['PowerGridFields'])->toContain('fn ($model)');
 });
 
 it('generates nothing when the table does not exist', function () {
@@ -54,7 +54,7 @@ function waiterQueryBuilderComponent(): PowerGridComponentMaker
         ->setDatabaseTable('table_that_does_not_exist')
         ->setAutoCreateColumns();
 
-    expect(GetStubVarsFromDbTable::handle($component)['Fields'])->toBe('');
+    expect(GetStubVarsFromDbTable::handle($component)['PowerGridFields'])->toBe('');
 });
 
 it('renders the generated columns into the query builder stub', function () {