Refactor package to using Enum for workflow which can be extended/use…

…d in the consumer applications
plank · Mar 15, 2024 · a301b14 · a301b14
1 parent 337b7c2
commit a301b14
Show file tree

Hide file tree

Showing 10 changed files with 84 additions and 50 deletions.
diff --git a/config/publisher.php b/config/publisher.php
@@ -1,6 +1,9 @@
 <?php
 
+use Plank\Publisher\Enums\Status;
+
 return [
+    'workflow' => Status::class,
     'columns' => [
         'draft' => 'draft',
         'workflow' => 'status',

diff --git a/src/Commands/PublisherMigrations.php b/src/Commands/PublisherMigrations.php
@@ -50,7 +50,7 @@ protected function getMigrationContent(Model&Publishable $model)
         $hasBeenPublishedColumn = config()->get('publisher.columns.has_been_published', 'has_been_published');
         $draftColumn = config()->get('publisher.columns.draft', 'draft');
         $workflowColumn = config()->get('publisher.columns.workflow', 'status');
-        $unpublishedState = $model->unpublishedState();
+        $unpublishedState = $model::workflow()::unpublished()->value;
 
         return <<<EOT
         <?php

diff --git a/src/Concerns/HasPublishableAttributes.php b/src/Concerns/HasPublishableAttributes.php
@@ -13,23 +13,6 @@
  */
 trait HasPublishableAttributes
 {
-    public function initializeHasPublishableAttributes()
-    {
-        $this->mergeCasts([
-            $this->draftColumn() => 'json',
-            $this->hasBeenPublishedColumn() => 'boolean',
-        ]);
-
-        $this->makeHidden($this->draftColumn());
-
-        $this->attributes[$this->hasBeenPublishedColumn()] ??= false;
-    }
-
-    public function draftColumn(): string
-    {
-        return config('publisher.columns.draft', 'draft');
-    }
-
     public static function bootHasPublishableAttributes()
     {
         static::retrieved(function (Publishable&Model $model) {
@@ -44,7 +27,6 @@ public static function bootHasPublishableAttributes()
 
         static::drafting(function (Publishable&Model $model) {
             $model->putAttributesInDraft();
-            $model->{$model->workflowColumn()} = $model->unpublishedState();
         });
 
         static::drafted(function (Publishable&Model $model) {

diff --git a/src/Concerns/IsPublishable.php b/src/Concerns/IsPublishable.php
@@ -5,6 +5,8 @@
 use Illuminate\Database\Eloquent\Model;
 use Plank\Publisher\Builders\PublisherBuilder;
 use Plank\Publisher\Contracts\Publishable;
+use Plank\Publisher\Contracts\PublishingStatus;
+use Plank\Publisher\Enums\Status;
 use Plank\Publisher\Facades\Publisher;
 use Plank\Publisher\Scopes\PublisherScope;
 
@@ -20,7 +22,21 @@ trait IsPublishable
 
     public function initializeIsPublishable()
     {
-        $this->attributes[$this->workflowColumn()] ??= $this->unpublishedState();
+        $this->mergePublishableCasts();
+
+        $this->{$this->workflowColumn()} ??= static::workflow()::unpublished();
+        $this->{$this->hasBeenPublishedColumn()} ??= false;
+
+        $this->makeHidden($this->draftColumn());
+    }
+
+    protected function mergePublishableCasts(): void
+    {
+        $this->mergeCasts([
+            $this->workflowColumn() => Status::class,
+            $this->draftColumn() => 'json',
+            $this->hasBeenPublishedColumn() => 'boolean',
+        ]);
     }
 
     public static function bootIsPublishable()
@@ -80,6 +96,11 @@ public static function bootIsPublishable()
         });
     }
 
+    public function draftColumn(): string
+    {
+        return config('publisher.columns.draft', 'draft');
+    }
+
     public function workflowColumn(): string
     {
         return config()->get('publisher.columns.workflow', 'status');
@@ -90,14 +111,12 @@ public function hasBeenPublishedColumn(): string
         return config()->get('publisher.columns.has_been_published', 'has_been_published');
     }
 
-    public function publishedState(): string
-    {
-        return 'published';
-    }
-
-    public function unpublishedState(): string
+    /**
+     * @return class-string<PublishingStatus>
+     */
+    public static function workflow(): string
     {
-        return 'draft';
+        return config()->get('publisher.workflow');
     }
 
     public static function query(): PublisherBuilder
@@ -112,24 +131,24 @@ public function newEloquentBuilder($query): PublisherBuilder
 
     public function shouldBeDrafted(): bool
     {
-        return $this->attributes[$this->workflowColumn()] !== $this->publishedState();
+        return $this->{$this->workflowColumn()} !== static::workflow()::published();
     }
 
     public function isBeingPublished(): bool
     {
         return $this->isDirty($this->workflowColumn())
-            && $this->attributes[$this->workflowColumn()] === $this->publishedState();
+            && $this->{$this->workflowColumn()} === static::workflow()::published();
     }
 
     public function isBeingUnpublished(): bool
     {
         return $this->isDirty($this->workflowColumn())
-            && $this->attributes[$this->workflowColumn()] !== $this->publishedState();
+            && $this->{$this->workflowColumn()} !== static::workflow()::published();
     }
 
     public function isPublished(): bool
     {
-        return $this->attributes[$this->workflowColumn()] === $this->publishedState();
+        return $this->{$this->workflowColumn()} === static::workflow()::published();
     }
 
     public function isNotPublished(): bool
@@ -140,23 +159,23 @@ public function isNotPublished(): bool
     public function wasPublished(): bool
     {
         return ($this->wasChanged($this->workflowColumn()) || $this->wasRecentlyCreated)
-            && $this->{$this->workflowColumn()} === $this->publishedState();
+            && $this->{$this->workflowColumn()} === static::workflow()::published();
     }
 
     public function wasUnpublished(): bool
     {
         return ($this->wasChanged($this->workflowColumn()) || $this->wasRecentlyCreated)
-            && $this->{$this->workflowColumn()} !== $this->publishedState();
+            && $this->{$this->workflowColumn()} !== static::workflow()::published();
     }
 
     public function wasDrafted(): bool
     {
-        return $this->attributes[$this->workflowColumn()] !== $this->publishedState();
+        return $this->{$this->workflowColumn()} !== static::workflow()::published();
     }
 
     public function wasUndrafted(): bool
     {
-        return $this->attributes[$this->workflowColumn()] === $this->publishedState();
+        return $this->{$this->workflowColumn()} === static::workflow()::published();
     }
 
     public function hasEverBeenPublished(): bool

diff --git a/src/Concerns/QueriesPublishableModels.php b/src/Concerns/QueriesPublishableModels.php
@@ -26,7 +26,7 @@ public function onlyPublished(): Builder&PublisherQueries
     public function onlyDraft(): Builder&PublisherQueries
     {
         return $this->withoutGlobalScope(PublisherScope::class)
-            ->whereNot($this->model->workflowColumn(), $this->model->publishedState());
+            ->whereNot($this->model->workflowColumn(), $this->model::workflow()::published());
     }
 
     public function where($column, $operator = null, $value = null, $boolean = 'and')
@@ -53,13 +53,13 @@ protected function draftAllowedQuery($query, $column, $operator = null, $value =
 
     protected function publishedWhere($query, $column, $operator = null, $value = null)
     {
-        return $query->where($this->model->workflowColumn(), $this->model->publishedState())
+        return $query->where($this->model->workflowColumn(), $this->model::workflow()::published())
             ->where($column, $operator, $value, 'and');
     }
 
     protected function unpublishedWhere($query, $column, $operator = null, $value = null)
     {
-        return $query->whereNot($this->model->workflowColumn(), $this->model->publishedState())
+        return $query->whereNot($this->model->workflowColumn(), $this->model::workflow()::published())
             ->where($this->model->draftColumn().'->'.$column, $operator, $value, 'and');
     }
 

diff --git a/src/Contracts/Publishable.php b/src/Contracts/Publishable.php
@@ -20,14 +20,11 @@ public function workflowColumn(): string;
     public function hasBeenPublishedColumn(): string;
 
     /**
-     * Get the value of the published state
+     * Get the Workflow State Enum
+     * 
+     * @return class-string<PublishingStatus>
      */
-    public function publishedState(): string;
-
-    /**
-     * Get the value of the unpublished state
-     */
-    public function unpublishedState(): string;
+    public static function workflow(): string;
 
     /**
      * Determine if the model should have its attributes stored in draft

diff --git a/src/Contracts/PublishingStatus.php b/src/Contracts/PublishingStatus.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Plank\Publisher\Contracts;
+
+interface PublishingStatus
+{
+    public static function published(): self;
+
+    public static function unpublished(): self;
+}
diff --git a/src/Enums/Status.php b/src/Enums/Status.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Plank\Publisher\Enums;
+
+use Plank\Publisher\Contracts\PublishingStatus;
+
+enum Status: string implements PublishingStatus 
+{
+    case DRAFT = 'draft';
+    case PUBLISHED = 'published';
+
+    public static function published(): self
+    {
+        return self::PUBLISHED;
+    }
+
+    public static function unpublished(): self
+    {
+        return self::DRAFT;
+    }
+}
diff --git a/tests/Feature/MiddlewareTest.php b/tests/Feature/MiddlewareTest.php
@@ -1,18 +1,19 @@
 <?php
 
 use Illuminate\Support\Facades\Gate;
+use Plank\Publisher\Enums\Status;
 use Plank\Publisher\Tests\Helpers\Models\Post;
 use Plank\Publisher\Tests\Helpers\Models\User;
 
 use function Pest\Laravel\get;
 
 beforeEach(function () {
-    $draft = Post::create([
+    $draft = Post::query()->create([
         'author_id' => User::first()->id,
         'title' => '(Published) My First Post',
         'slug' => 'my-first-post',
         'body' => 'A first post.',
-        'status' => 'published',
+        'status' => Status::PUBLISHED,
     ]);
 
     $draft->title = '(Draft) My First Post';

diff --git a/tests/Feature/PublishedTest.php b/tests/Feature/PublishedTest.php
@@ -1,5 +1,6 @@
 <?php
 
+use Plank\Publisher\Enums\Status;
 use Plank\Publisher\Tests\Helpers\Models\Post;
 use Plank\Publisher\Tests\Helpers\Models\User;
 
@@ -34,17 +35,17 @@
         'title' => 'My First Post',
         'slug' => 'my-first-post',
         'body' => 'This is the body of my first post.',
-        'status' => 'published',
+        'status' => Status::published(),
     ]);
 
-    $this->assertEquals('published', $post->status);
+    $this->assertEquals(Status::published(), $post->status);
     $this->assertTrue($post->hasEverBeenPublished());
 
     $post->update([
         'title' => 'My Updated Post',
         'status' => 'draft',
     ]);
 
-    $this->assertEquals('draft', $post->status);
+    $this->assertEquals(Status::unpublished(), $post->status);
     $this->assertTrue($post->hasEverBeenPublished());
 });