Entities: Been through tests to get all passing in dev

Fixed issues and needed test changes along the way.

Author: ssddanbrown

app/Entities/Models/Book.php

@@ -33,7 +33,7 @@ class Book extends Entity implements HasDescriptionInterface, HasCoverInterface,
 
     public float $searchFactor = 1.2;
 
-    protected $hidden = ['pivot', 'deleted_at'];
+    protected $hidden = ['pivot', 'deleted_at', 'entity_id', 'entity_type', 'chapter_id', 'book_id'];
     protected $fillable = ['name'];
 
     /**
@@ -67,7 +67,8 @@ public function directPages(): HasMany
      */
     public function chapters(): HasMany
     {
-        return $this->hasMany(Chapter::class);
+        return $this->hasMany(Chapter::class)
+            ->where('type', '=', 'chapter');
     }
 
     /**

app/Entities/Models/BookChild.php

@@ -30,6 +30,7 @@ public function changeBook(int $newBookId): self
     {
         $oldUrl = $this->getUrl();
         $this->book_id = $newBookId;
+        $this->unsetRelation('book');
         $this->refreshSlug();
         $this->save();
 

app/Entities/Models/Bookshelf.php

@@ -19,7 +19,7 @@ class Bookshelf extends Entity implements HasDescriptionInterface, HasCoverInter
 
     public float $searchFactor = 1.2;
 
-    protected $hidden = ['image_id', 'deleted_at', 'description_html'];
+    protected $hidden = ['image_id', 'deleted_at', 'description_html',  'entity_id', 'entity_type', 'chapter_id', 'book_id'];
     protected $fillable = ['name'];
 
     /**

app/Entities/Models/Chapter.php

@@ -19,7 +19,7 @@ class Chapter extends BookChild implements HasDescriptionInterface, HasDefaultTe
     use ContainerTrait;
 
     public float $searchFactor = 1.2;
-    protected $hidden = ['pivot', 'deleted_at', 'description_html'];
+    protected $hidden = ['pivot', 'deleted_at', 'description_html', 'entity_id', 'entity_type', 'chapter_id'];
     protected $fillable = ['name', 'priority'];
 
     /**

app/Entities/Models/Entity.php

@@ -214,6 +214,8 @@ public function matchesOrContains(self $entity): bool
      */
     public function activity(): MorphMany
     {
+        // TODO - Ensure this is scoped to entity type properly.
+        //   Add test if not.
         return $this->morphMany(Activity::class, 'loggable')
             ->orderBy('created_at', 'desc');
     }
@@ -460,9 +462,10 @@ abstract public function relatedData(): HasOne;
     protected function getContentsAttributes(): array
     {
         $contentFields = [];
+        $contentModel = $this instanceof Page ? EntityPageData::class : EntityContainerData::class;
 
         foreach ($this->attributes as $key => $value) {
-            if (!in_array($key, static::$commonFields)) {
+            if (in_array($key, $contentModel::$fields)) {
                 $contentFields[$key] = $value;
             }
         }

app/Entities/Models/EntityContainerData.php

@@ -20,6 +20,14 @@ class EntityContainerData extends Model
     protected $primaryKey = 'entity_id';
     public $incrementing = false;
 
+    public static array $fields = [
+        'description',
+        'description_html',
+        'default_template_id',
+        'image_id',
+        'sort_rule_id',
+    ];
+
     /**
      * Override the default set keys for save query method to make it work with composite keys.
      */

app/Entities/Models/EntityPageData.php

@@ -12,4 +12,14 @@ class EntityPageData extends Model
     public $timestamps = false;
     protected $primaryKey = 'page_id';
     public $incrementing = false;
+
+    public static array $fields = [
+        'draft',
+        'template',
+        'revision_count',
+        'editor',
+        'html',
+        'text',
+        'markdown',
+    ];
 }

app/Entities/Models/EntityQueryBuilder.php

@@ -26,4 +26,13 @@ public function withoutGlobalScope($scope): static
 
         return parent::withoutGlobalScope($scope);
     }
+
+    /**
+     * Override the default forceDelete method to add type filter onto the query
+     * since it specifically ignores scopes by default.
+     */
+    public function forceDelete()
+    {
+        return $this->query->where('type', '=', $this->model->getMorphClass())->delete();
+    }
 }

app/Entities/Models/Page.php

@@ -34,7 +34,7 @@ class Page extends BookChild
 
     public string $textField = 'text';
     public string $htmlField = 'html';
-    protected $hidden = ['html', 'markdown', 'text', 'pivot', 'deleted_at'];
+    protected $hidden = ['html', 'markdown', 'text', 'pivot', 'deleted_at',  'entity_id', 'entity_type'];
     protected $fillable = ['name', 'priority'];
 
     protected $casts = [

app/Entities/Queries/BookQueries.php

@@ -55,6 +55,11 @@ public function visibleForList(): Builder
             ->select(static::$listAttributes);
     }
 
+    public function visibleForContent(): Builder
+    {
+        return $this->start()->scopes('visible');
+    }
+
     public function visibleForListWithCover(): Builder
     {
         return $this->visibleForList()->with('cover');