Feature/add revision structure to analyze between current and previous versions issue 334

src/Entities/Revision.php

@@ -3,6 +3,7 @@
 namespace Unusualify\Modularity\Entities;
 
 use Illuminate\Database\Eloquent\Model as BaseModel;
+use Illuminate\Support\Str;
 
 abstract class Revision extends BaseModel
 {
@@ -13,15 +14,16 @@ abstract class Revision extends BaseModel
     protected $fillable = [
         'payload',
         'user_id',
+        'source_revision_id',
     ];
 
     public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
 
-        // Remember to update this if you had fields to the fillable array here
+        // Remember to update this if you add fields to the fillable array here
         // this is to allow child classes to provide a custom foreign key in fillable
-        if (count($this->fillable) == 2) {
+        if (count($this->fillable) == 3) {
             $this->fillable[] = mb_strtolower(str_replace('Revision', '', get_called_class())) . '_id';
         }
     }
@@ -35,4 +37,13 @@ public function getByUserAttribute()
     {
         return isset($this->user) ? $this->user->name : 'System';
     }
+
+    public function isDraft(): bool
+    {
+        $data = json_decode($this->payload, true);
+
+        $cmsSaveType = $data['cmsSaveType'] ?? '';
+
+        return Str::startsWith($cmsSaveType, 'draft-revision');
+    }
 }

src/Entities/Traits/HasRevisions.php

@@ -0,0 +1,105 @@
+<?php
+
+namespace Unusualify\Modularity\Entities\Traits;
+
+use Illuminate\Support\Facades\Auth;
+use RuntimeException;
+use Unusualify\Modularity\Facades\Modularity;
+
+trait HasRevisions
+{
+    /**
+     * Defines the one-to-many relationship for revisions.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function revisions()
+    {
+        return $this->hasMany($this->getRevisionModel())->orderBy('created_at', 'desc');
+    }
+
+    /**
+     * Scope a query to only include the current user's revisions.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeMine($query)
+    {
+        $user = Auth::guard(Modularity::getAuthGuardName())->user();
+
+        if (! $user) {
+            return $query->whereRaw('1 = 0');
+        }
+
+        return $query->whereHas('revisions', function ($query) {
+            $query->where('user_id', Auth::guard(Modularity::getAuthGuardName())->id());
+        });
+    }
+
+    /**
+     * Returns an array of revisions for the CMS views.
+     *
+     * @return array
+     */
+    public function revisionsArray()
+    {
+        $revisions = $this->revisions; // ordered DESC (newest first)
+        $total = $revisions->count();
+
+        $versionMap = $revisions->mapWithKeys(function ($revision, $index) use ($total) {
+            return [$revision->id => $total - $index];
+        });
+
+        return $revisions
+            ->map(function ($revision, $index) use ($total, $versionMap) {
+                $sourceLabel = $revision->source_revision_id && isset($versionMap[$revision->source_revision_id])
+                    ? 'V' . $versionMap[$revision->source_revision_id]
+                    : null;
+
+                return [
+                    'id' => $revision->id,
+                    'author' => $revision->user->name ?? 'Unknown',
+                    'datetime' => $revision->created_at->toIso8601String(),
+                    'label' => 'V' . ($total - $index),
+                    'source_label' => $sourceLabel,
+                ];
+            })
+            ->toArray();
+    }
+
+    /**
+     * Deletes revisions from specific collection position
+     * Used to keep max revision on specific Twill's module.
+     */
+    public function deleteSpecificRevisions(int $maxRevisions): void
+    {
+        if (isset($this->limitRevisions) && $this->limitRevisions > 0) {
+            $maxRevisions = $this->limitRevisions;
+        }
+
+        $this->revisions()->get()->slice($maxRevisions)->each->delete();
+    }
+
+
+    public function getRevisionModel()
+    {
+        if (property_exists($this, 'revisionModel') && is_string($this->revisionModel) && @class_exists($this->revisionModel)) {
+            return $this->revisionModel;
+        }
+
+        $modelClass = get_class($this);
+        $candidates = [
+            preg_replace('/\\\\Entities\\\\([^\\\\]+)$/', '\\Entities\\Revisions\\$1Revision', $modelClass),
+            modularityConfig('namespace') . "\\Models\\Revisions\\" . class_basename($this) . 'Revision',
+        ];
+
+        foreach ($candidates as $candidate) {
+            if (is_string($candidate) && @class_exists($candidate)) {
+                return $candidate;
+            }
+        }
+
+        throw new RuntimeException("Revision model could not be resolved for [{$modelClass}]. Define a \$revisionModel property.");
+    }
+}

src/Http/Controllers/BaseController.php

@@ -15,6 +15,7 @@
 use Illuminate\Support\Str;
 use Unusualify\Modularity\Http\Controllers\Traits\ManageIndexAjax;
 use Unusualify\Modularity\Http\Controllers\Traits\ManageInertia;
+use Unusualify\Modularity\Http\Controllers\Traits\ManagePreview;
 use Unusualify\Modularity\Http\Controllers\Traits\ManagePrevious;
 use Unusualify\Modularity\Http\Controllers\Traits\ManageSingleton;
 use Unusualify\Modularity\Http\Controllers\Traits\ManageTranslations;
@@ -23,7 +24,7 @@
 
 abstract class BaseController extends PanelController
 {
-    use ManageIndexAjax, ManagePrevious, ManageUtilities, ManageSingleton, ManageInertia, ManageTranslations;
+    use ManageIndexAjax, ManagePrevious, ManageUtilities, ManageSingleton, ManageInertia, ManageTranslations, ManagePreview;
 
     /**
      * @var string
@@ -323,6 +324,7 @@ public function update($id, $submoduleId = null)
             $formRequest = $this->validateFormRequest();
 
             $this->repository->update($id, $formRequest->all(), $this->getPreviousRouteSchema());
+            $item = $this->repository->getById($id);
 
             // $this->handleActionEvent($item, __FUNCTION__);
 

src/Http/Controllers/Traits/ManagePreview.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Unusualify\Modularity\Http\Controllers\Traits;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Response;
+use Illuminate\Support\Facades\View;
+use Illuminate\Support\Str;
+use Unusualify\Modularity\Services\MessageStage;
+
+trait ManagePreview
+{
+    public function showView($id)
+    {
+        // dd($id);
+        // dd($this->request->has('revisionId'));
+        if ($this->request->has('revisionId')) {
+            $item = $this->repository->previewForRevision($id, $this->request->get('revisionId'));
+        } else {
+            $formRequest = $this->validateFormRequest();
+            $item = $this->repository->preview($id, $formRequest->all());
+        }
+
+        if ($this->request->has('activeLanguage')) {
+            //App::setLocale($this->request->get('activeLanguage'));
+        }
+
+        // dd($this->previewView);
+
+        $previewView = $this->previewView ?? (Config::get('twill.frontend.views_path', 'site') . '.' . Str::singular(
+            $this->moduleName
+        ));
+
+        // dd($previewView);
+
+        return View::exists($previewView) ? View::make(
+            $previewView,
+            array_replace([
+                'item' => $item,
+            ], $this->previewData($item))
+        ) : View::make('twill::errors.preview', [
+            'moduleName' => Str::singular($this->moduleName),
+        ]);
+    }
+
+    public function listRevisions($id)
+    {
+        $revisions = $this->repository->getRevisions($id);
+        return $revisions;
+    }
+
+    public function restoreRevision($id)
+    {
+        // dd('restoreRevision');
+        if (! $this->routeHasTrait('revisions')) {
+            return $this->respondWithError(__('Revisions are not enabled for this route.'));
+        }
+
+        $params = $this->request->route()->parameters();
+        $id = last($params);
+        $revisionId = (int) $this->request->get('revisionId');
+        // dd($revisionId);
+
+        if ($revisionId < 1) {
+            return $this->respondWithError(__('Revision id is required.'));
+        }
+
+        if ($this->request->get('preview')) {
+            // dd("preview is called for revision id: $revisionId");
+            $rawPayload = $this->repository->getRevisionPayload((int) $id, $revisionId);
+
+            return Response::json([
+                'form_fields' => $rawPayload,
+            ]);
+        }
+
+
+        $item = $this->repository->restoreRevision((int) $id, $revisionId);
+        // dd($item);
+
+        return Response::json([
+            'message' => __('Revision restored successfully.'),
+            'variant' => MessageStage::SUCCESS,
+            'revisions' => $item->revisionsArray(),
+            'form_fields' => $this->repository->getFormFields($item, $this->getPreviousRouteSchema()),
+        ]);
+    }
+
+}

src/Http/Controllers/Traits/ManageUtilities.php

@@ -172,6 +172,9 @@ protected function getFormData($id = null)
                 'actionUrl' => $this->getFormUrl($itemId),
                 'schema' => $eventualSchema,
                 'languages' => getLanguagesForVueStore($eventualSchema, $translate)['all'] ?? [],
+                'revisions' => $this->routeHasTrait('revisions') && $item ? $item->revisionsArray() : [],
+                'restoreUrl' => Route::has($restoreRouteName) && $itemId ? moduleRoute($this->moduleName, $this->routePrefix, 'restoreRevision', [$itemId]) : null,
+                'previewUrl' => Route::has($previewRouteName) && $itemId ? moduleRoute($this->moduleName, $this->routePrefix, 'preview', [$itemId]) : null,
             ], $formAttributes),
             'endpoints' => [
                 ($isEditing ? 'update' : 'store') => $this->getFormUrl($itemId),

src/Hydrates/Inputs/RevisionHydrate.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Unusualify\Modularity\Hydrates\Inputs;
+
+class RevisionHydrate extends InputHydrate
+{
+    /**
+     * Default values to set before hydrating
+     *
+     *
+     * @var array
+     */
+    public $requirements = [
+        'name' => 'revision_id',
+        'noSubmit' => true,
+        'col' => ['cols' => 12],
+        'default' => null,
+    ];
+
+    /**
+     * Manipulate Input Schema Structure
+     *
+     * @return void
+     */
+    public function hydrate()
+    {
+        $input = $this->input;
+
+        $input['type'] = 'input-revision';
+        $input['name'] = 'revisionable_id';
+
+
+        $snakeRouteName = snakeCase($this->routeName);
+
+        $input['restoreEndpoint'] = $this->module->getRouteActionUrl(
+            $this->routeName,
+            'restoreRevision',
+            [$snakeRouteName => ':id']
+        );
+
+        $input['showViewEndpoint'] = $this->module->getRouteActionUrl(
+            $this->routeName,
+            'showView',
+            [$snakeRouteName => ':id']
+        );
+
+        $input['listRevisionsEndpoint'] = $this->module->getRouteActionUrl(
+            $this->routeName,
+            'listRevisions',
+            [$snakeRouteName => ':id']
+        );
+
+        dd($input);
+
+        return $input;
+    }
+}

src/Module.php

@@ -54,6 +54,9 @@ class Module extends NwidartModule
         'tagsUpdate',
         'assignments',
         'createAssignment',
+        'restoreRevision',
+        'showView',
+        'listRevisions',
     ];
 
     /**

src/Providers/RouteServiceProvider.php

@@ -361,7 +361,9 @@ protected function bootMacros()
                 // 'feature',
                 // 'preview',
                 // 'bulkFeature',
-                // 'restoreRevision',
+                'showView',
+                'listRevisions',
+                'restoreRevision',
 
                 'restore',
                 'bulkRestore',
@@ -400,8 +402,9 @@ protected function bootMacros()
                     'uses' => "{$controllerClass}@{$customRoute}",
                 ];
 
-                if ($customRoute === 'assignments') {
-                    Route::get("{$url}/{{$snakeCase}}/assignments", $mapping);
+                if (in_array($customRoute, ['assignments', 'listRevisions'])) {
+                    // dd($customRoute, $routeSlug, $mapping, $url, $snakeCase);
+                    Route::get("{$url}/{{$snakeCase}}/{$customRouteKebab}", $mapping, );
                 }
 
                 if ($customRoute === 'createAssignment') {
@@ -429,11 +432,12 @@ protected function bootMacros()
                     Route::put($routeSlug, $mapping);
                 }
 
-                if (in_array($customRoute, ['duplicate'])) {
+                if (in_array($customRoute, ['duplicate', 'preview', 'showView','restoreRevision'])) {
                     Route::put($routeSlug . "/{{$snakeCase}}", $mapping);
                 }
 
-                if (in_array($customRoute, ['preview'])) {
+                if (in_array($customRoute, ['preview', 'showView', 'restoreRevision'])) {
+                    // dd($customRoute, $routeSlug, $routeSlug . "/{{$snakeCase}}", $mapping);
                     Route::put($routeSlug . "/{{$snakeCase}}", $mapping);
                 }