Introducing the trait FusionBaseModelTrait (#9)

Author: roberto-butti

CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changelog
 
-## 1.0.1 - WIP
+
+## 1.1.0 - 2025-10-19
+- Introducing the trait `FusionBaseModelTrait`
+
+## 1.0.1 - 2025-10-18
 - Adding Static Code Analysis via PHPStan + Larastan (Level 6)
 - Adding env variable FUSION_CONTENT_DIRECTORY for setting the path of content folder (default is app/resources/content)
 - Adding tests for hydrated model
+- Simplify and improving the DX for creating Models
 
 ## 1.0.0 - 2025-10-17
 - Upgrading the support for Laravel 12

README.md

@@ -80,11 +80,12 @@ You can fill the file in this way:
 
 namespace App\Models;
 
+use HiFolks\Fusion\Traits\FusionBaseModelTrait;
+use Illuminate\Database\Eloquent\Model;
 
-use HiFolks\Fusion\Models\FusionBaseModel;
-
-class Article extends FusionBaseModel
+class Article extends Model
 {
+    use FusionBaseModelTrait;
 
     public function frontmatterFields(): array
     {
@@ -285,7 +286,7 @@ php artisan fusion:check
 
 ### Using the Check Model command
 
-To inspect the Model file and check if it extends the right class and uses the proper Traits to be a Model compatible with Markdown files, you can use the `fusion:check-model` command:
+To inspect the Model file and check if it extends the right class  to be a Model compatible with Markdown files, you can use the `fusion:check-model` command:
 
 
 ```shell
@@ -301,7 +302,22 @@ App\Models\Article extends correctly the class HiFolks\Fusion\Models\FusionBaseM
 App\Models\Article uses HiFolks\Fusion\Traits\FusionModelTrait
 ```
 
+## Upgrading from version 0.* to 1.*
+
+With the version 1 we simplified and we reduced the requirements of a Model class.
+Now you can extend the classic Model sub class for Eloquent Models and just use the traits FusionBaseModelTrait for enabling the "hidrate" logic provided by Fusion.
 
+```php
+<?php
+namespace App\Models;
+use HiFolks\Fusion\Traits\FusionBaseModelTrait;
+use Illuminate\Database\Eloquent\Model;
+
+class Page extends Model
+{
+    use FusionBaseModelTrait;
+
+```
 ## Testing
 
 ```bash

src/Console/Commands/CheckModel.php

@@ -4,10 +4,11 @@
 
 namespace HiFolks\Fusion\Console\Commands;
 
-use HiFolks\Fusion\Models\FusionBaseModel;
-use HiFolks\Fusion\Traits\SushiModelTrait;
+use HiFolks\Fusion\Traits\FusionBaseModelTrait;
 use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Model;
 
+/** @package HiFolks\Fusion\Console\Commands */
 class CheckModel extends Command
 {
     /**
@@ -51,28 +52,28 @@ public function handle(): int
             return Command::INVALID;
         }
 
-        if (is_subclass_of($model, FusionBaseModel::class)) {
+        if (is_subclass_of($model, Model::class)) {
             $this->components->twoColumnDetail(
                 '<info>' . $model . '</info>',
-                '<info>Extends correctly the class ' . FusionBaseModel::class . '</info>',
+                '<info>Extends correctly the class ' . Model::class . '</info>',
             );
 
         } else {
             $this->components->twoColumnDetail(
                 '<info>' . $model . '</info>',
-                '<error>Does not extend correctly the class ' . FusionBaseModel::class . '</error>',
+                '<error>Does not extend correctly the class ' . Model::class . '</error>',
             );
         }
 
-        if (trait_exists(SushiModelTrait::class) && in_array(SushiModelTrait::class, class_uses($model))) {
+        if (trait_exists(FusionBaseModelTrait::class) && in_array(FusionBaseModelTrait::class, class_uses($model))) {
             $this->components->twoColumnDetail(
                 '<info>' . $model . '</info>',
-                '<info>Uses correctly the trait ' . SushiModelTrait::class . '</info>',
+                '<info>Uses correctly the trait ' . FusionBaseModelTrait::class . '</info>',
             );
         } else {
             $this->components->twoColumnDetail(
                 '<info>' . $model . '</info>',
-                '<error>Does not use correctly the trait ' . SushiModelTrait::class . '</error>',
+                '<error>Does not use correctly the trait ' . FusionBaseModelTrait::class . '</error>',
             );
 
         }

src/Models/Page.php

@@ -4,8 +4,18 @@
 
 namespace HiFolks\Fusion\Models;
 
-class Page extends FusionBaseModel
+use HiFolks\Fusion\Traits\FusionBaseModelTrait;
+use Illuminate\Database\Eloquent\Model;
+
+class Page extends Model
 {
+    use FusionBaseModelTrait;
+
+    /**
+     * Return the list of the field names managed by the Page Model class
+     *
+     * @return array<int, string>
+     */
     public function frontmatterFields(): array
     {
         return [

src/Models/FusionBaseModel.php src/Traits/FusionBaseModelTrait.phpsrc/Models/FusionBaseModel.php renamed to src/Traits/FusionBaseModelTrait.php

@@ -2,12 +2,10 @@
 
 declare(strict_types=1);
 
-namespace HiFolks\Fusion\Models;
+namespace HiFolks\Fusion\Traits;
 
-use HiFolks\Fusion\Traits\SushiModelTrait;
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
@@ -21,15 +19,15 @@
 use Spatie\CommonMarkHighlighter\FencedCodeRenderer;
 use Spatie\CommonMarkHighlighter\IndentedCodeRenderer;
 use Spatie\YamlFrontMatter\YamlFrontMatter;
+use Sushi\Sushi;
 use Symfony\Component\Yaml\Exception\ParseException;
 
-abstract class FusionBaseModel extends Model
+trait FusionBaseModelTrait
 {
-    use SushiModelTrait;
+    use Sushi;
 
     public function getResourceFolder(): string
     {
-
         $folderName = str_replace(
             ['App\\Models\\', 'HiFolks\\Fusion\\Models\\'],
             '',
@@ -38,18 +36,23 @@ public function getResourceFolder(): string
         $folderName = Str::snake($folderName);
 
         $resourceDirectory = resource_path('content' . DIRECTORY_SEPARATOR);
-        if (! is_null(config('fusion.content_directory'))) {
+        if (!is_null(config('fusion.content_directory'))) {
             $resourceDirectory = __DIR__ . '/../../' . config('fusion.content_directory');
         }
 
         return $resourceDirectory . $folderName;
     }
 
-    public function getRouteKeyName()
+    public function getRouteKeyName(): string
     {
         return 'slug';
     }
 
+    public function getTable()
+    {
+        return parent::getTable();
+    }
+
     /**
      * @return array<int, string>
      */
@@ -98,26 +101,19 @@ public function getRows(): array
      */
     public function getFrontmatterRows(array $columns = []): array
     {
-
         $environment = (new Environment())
             ->addExtension(new CommonMarkCoreExtension());
 
-        // $environment->addExtension(new CommonMarkCoreExtension());
         $environment->addRenderer(FencedCode::class, new FencedCodeRenderer());
         $environment->addRenderer(IndentedCode::class, new IndentedCodeRenderer());
 
         $converter = new MarkdownConverter($environment);
-
-        $filesystem = new FileSystem();
+        $filesystem = new Filesystem();
         $markdowns = [];
 
         foreach (File::allFiles($this->getResourceFolder()) as $file) {
-            // default slug as filename
             $slug = $file->getFilenameWithoutExtension();
-
-            $filename = $file->getRelativePathName();
             $fileContent = $filesystem->get($file->getRealPath());
-
             $object = YamlFrontMatter::parse($fileContent);
 
             if (array_key_exists('slug', $object->matter())) {
@@ -132,8 +128,8 @@ public function getFrontmatterRows(array $columns = []): array
             ];
 
             foreach ($columns as $column) {
-                $row[$column] = is_array($object->matter($column)) ? json_encode($object->matter($column)) : $object->matter($column);
-
+                $value = $object->matter($column);
+                $row[$column] = is_array($value) ? json_encode($value) : $value;
             }
 
             $markdowns[] = $row;

src/Traits/SushiModelTrait.php

@@ -2,12 +2,12 @@
 
 namespace {{ namespace }};
 
-use HiFolks\Fusion\Traits\FusionModelTrait;
-use HiFolks\Fusion\Models\FusionBaseModel;
+use HiFolks\Fusion\Traits\FusionBaseModelTrait;
+use Illuminate\Database\Eloquent\Model;
 
-class {{ class }} extends FusionBaseModel
+class {{ class }} extends Model
 {
-    use FusionModelTrait;
+    use FusionBaseModelTrait;
 
     public function frontmatterFields(): array
     {