Merge branch '1.x' into feature/content_version_rollback_n_diff

Author: cklei-carly

docs/event-listeners.md

@@ -56,7 +56,7 @@ SolutionForest\InspireCms\Events\Licensing\LicensesRefreshed::class     // When
 You can create an event listener using Laravel's artisan command:
 
 ```bash
-php artisan make:listener YourListener --event=SolutionForest\\InspireCms\\Events\\Content\\CreatedContentVersion
+php artisan make:listener YourListener --event=\\SolutionForest\\InspireCms\\Events\\Content\\CreatedPublishContentVersion
 ```
 
 This creates a new listener in the `app/Listeners` directory.

src/Base/Filament/Concerns/ContentFormTrait.php

@@ -16,6 +16,7 @@
 use SolutionForest\InspireCms\Base\Filament\Resources\Pages\BaseContentCreatePage;
 use SolutionForest\InspireCms\Base\Filament\Resources\Pages\CreateContentRecord\Concerns\Translatable as CmsCreateContentRecordsTranslatable;
 use SolutionForest\InspireCms\Filament\Resources\ContentResource;
+use SolutionForest\InspireCms\Helpers\DiffHelper;
 use SolutionForest\InspireCms\InspireCmsConfig;
 use SolutionForest\InspireCms\Models\Contracts\Content;
 use Throwable;
@@ -234,7 +235,10 @@ public function handlePublishableRecordCreateOrUpdate(array $data, array $publis
 
             $record->setPublishableState($publishableAction);
 
-            $this->propertyDataIsDirtyPreCheck($record->getLatestVersionPropertyData(), $data['propertyData'] ?? []);
+            $this->propertyDataIsDirtyPreCheck(
+                array_merge($record->getLatestVersionPropertyData(), $record->latestContentVersion?->getVersioningCheckDiffData() ?? []),
+                array_merge($data['propertyData'] ?? [], $record->contentVersions()->make([...$publishableData, 'publish_state' => $publishableAction])?->getVersioningCheckDiffData() ?? []),
+            );
 
             $this->record = $this->handleRecordUpdate($record, $data);
             // endregion Handle Record Updating
@@ -389,14 +393,7 @@ protected function propertyDataIsDirtyPreCheck($from, $to)
                 return;
             }
 
-            $modelTmpContentVersion = app(InspireCmsConfig::getContentVersionModelClass(), [
-                'attributes' => [
-                    'from_data' => $from,
-                    'to_data' => $to,
-                ],
-            ]);
-
-            $diff = $modelTmpContentVersion->getDifferences();
+            $diff = DiffHelper::compareArrays($from, $to);
 
             // Display notification if no differences found
             if (empty($diff)) {

src/Dtos/ContentDto.php

@@ -136,7 +136,7 @@ public function getPaginatedChildren($perPage = 10, $pageName = 'page', $page =
 
     public function getParent()
     {
-        return $this->getAncestors()->first();
+        return $this->getAncestors()->last();
     }
 
     public function getAncestors()

src/Helpers/DiffHelper.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace SolutionForest\InspireCms\Helpers;
+
+class DiffHelper
+{
+    public static function compareArrays(array $from, array $to): array
+    {
+        $diff = [];
+        foreach ($from as $key => $value) {
+            if (! array_key_exists($key, $to) || $to[$key] !== $value) {
+                $diff[$key] = ['from' => $value, 'to' => $to[$key] ?? null];
+            }
+        }
+
+        foreach ($to as $key => $value) {
+            if (! array_key_exists($key, $from)) {
+                $diff[$key] = ['from' => null, 'to' => $value];
+            }
+        }
+
+        return $diff;
+    }
+}

src/Listeners/Content/ProcessContentVersion.php

@@ -10,6 +10,7 @@
 use SolutionForest\InspireCms\Events\Content\CreatingPublishContentVersion;
 use SolutionForest\InspireCms\Events\Content\DispatchContentVersion;
 use SolutionForest\InspireCms\Events\Content\GenerateSitemap;
+use SolutionForest\InspireCms\Helpers\DiffHelper;
 use SolutionForest\InspireCms\Models\Contracts\Base\HasContentVersions;
 use SolutionForest\InspireCms\Models\Contracts\ContentVersion;
 
@@ -41,8 +42,15 @@ protected function processContentVersion(HasContentVersions | Model $model)
 
         $contentVersion = $model->contentVersions()->make($contentVersionData);
 
-        if ($contentVersion instanceof ContentVersion && count($contentVersion->getDifferences()) === 0) {
-            return;
+        $latestVersion = $model->latestContentVersion;
+        if ($contentVersion instanceof ContentVersion) {
+            $from = array_merge($contentVersion->from_data ?? [], $latestVersion?->getVersioningCheckDiffData() ?? []);
+            $to = array_merge($contentVersion->to_data ?? [], $contentVersion?->getVersioningCheckDiffData() ?? []);
+            $diff = DiffHelper::compareArrays($from, $to);
+            // If there are no differences, skip creating the version.
+            if (count($diff) === 0) {
+                return;
+            }
         }
 
         // Unload the relations to prevent large amounts of unnecessary data from being serialized.

src/Models/ContentVersion.php

@@ -3,6 +3,7 @@
 namespace SolutionForest\InspireCms\Models;
 
 use Illuminate\Database\Eloquent\Prunable;
+use SolutionForest\InspireCms\Helpers\DiffHelper;
 use SolutionForest\InspireCms\InspireCmsConfig;
 use SolutionForest\InspireCms\Models\Contracts\ContentVersion as ContentVersionContract;
 use SolutionForest\InspireCms\Observers\ContentVersionObserver;
@@ -37,26 +38,26 @@ public function publishLog()
 
     public function getDifferences()
     {
-        $from = $this->from_data;
-        $to = $this->to_data;
-
-        $diff = [];
-
-        foreach ($to as $key => $value) {
-            if (! array_key_exists($key, $from)) {
-                $diff[$key] = [
-                    'from' => null,
-                    'to' => $value,
-                ];
-            } elseif ($from[$key] !== $value) {
-                $diff[$key] = [
-                    'from' => $from[$key],
-                    'to' => $value,
-                ];
-            }
-        }
+        return DiffHelper::compareArrays(
+            $this->from_data ?? [],
+            $this->to_data ?? []
+        );
+    }
+
+    protected function getVersioningCheckDiffAttribtues()
+    {
+        return [
+            'publish_state',
+            'avoid_to_clean',
+        ];
+    }
 
-        return $diff;
+    public function getVersioningCheckDiffData()
+    {
+        return [
+            'publish_state' => $this->publish_state ?? 'draft',
+            'avoid_to_clean' => $this->avoid_to_clean ?? inspirecms_content_statuses()->getOption($this->publish_state ?? 'draft')?->isPublishable() ?? null,
+        ];
     }
 
     // region Scopes

src/Models/Contracts/ContentVersion.php

@@ -38,6 +38,13 @@ public function publishLog();
      */
     public function getDifferences();
 
+    /**
+     * Get the attributes to check for versioning differences.
+     *
+     * @return array
+     */
+    public function getVersioningCheckDiffData();
+
     /**
      * Scope a query to only include published content versions.
      *