feat: [LAR-132] create update article action and add locale field on … (

#260)

app/Actions/Article/CreateArticleAction.php

@@ -4,15 +4,14 @@
 
 namespace App\Actions\Article;
 
-use App\Data\CreateArticleData;
+use App\Data\ArticleData;
 use App\Models\Article;
-use App\Models\User;
 use Carbon\Carbon;
 use Illuminate\Support\Facades\Auth;
 
 final class CreateArticleAction
 {
-    public function execute(CreateArticleData $articleData): Article
+    public function execute(ArticleData $articleData): Article
     {
         if ($articleData->published_at) {
             $articleData->published_at = new Carbon(
@@ -21,20 +20,22 @@ public function execute(CreateArticleData $articleData): Article
             );
         }
 
-        /** @var User $author */
-        $author = Auth::user();
+        if ($articleData->submitted_at) {
+            $articleData->submitted_at = new Carbon(
+                time: $articleData->submitted_at,
+                timezone: config('app.timezone')
+            );
+        }
 
-        /** @var Article $article */
-        $article = Article::query()->create([
+        // @phpstan-ignore-next-line
+        return Article::query()->create([
             'title' => $articleData->title,
             'slug' => $articleData->slug,
             'body' => $articleData->body,
             'published_at' => $articleData->published_at,
-            'submitted_at' => $articleData->is_draft ? null : now(),
+            'submitted_at' => $articleData->submitted_at,
             'canonical_url' => $articleData->canonical_url,
-            'user_id' => $author->id,
+            'user_id' => Auth::id(),
         ]);
-
-        return $article;
     }
 }

app/Actions/Article/UpdateArticleAction.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions\Article;
+
+use App\Data\ArticleData;
+use App\Exceptions\CannotUpdateApprovedArticle;
+use App\Models\Article;
+use Carbon\Carbon;
+
+final class UpdateArticleAction
+{
+    public function execute(ArticleData $articleData, Article $article): Article
+    {
+        if ($article->isApproved()) {
+            throw new CannotUpdateApprovedArticle(__('notifications.exceptions.approved_article'));
+        }
+
+        if ($articleData->published_at) {
+            $articleData->published_at = new Carbon(
+                time: $articleData->published_at,
+                timezone: config('app.timezone')
+            );
+        }
+
+        if ($articleData->submitted_at) {
+            $articleData->submitted_at = new Carbon(
+                time: $articleData->submitted_at,
+                timezone: config('app.timezone')
+            );
+        }
+
+        $article->update($articleData->toArray());
+
+        $article->refresh();
+
+        return $article;
+    }
+}

app/Data/CreateArticleData.php → app/Data/ArticleData.php

@@ -7,14 +7,15 @@
 use Carbon\Carbon;
 use Spatie\LaravelData\Data;
 
-final class CreateArticleData extends Data
+final class ArticleData extends Data
 {
     public function __construct(
         public string $title,
         public string $slug,
         public string $body,
-        public string $canonical_url,
-        public ?Carbon $published_at,
-        public bool $is_draft = false,
+        public string $locale,
+        public ?string $canonical_url = null,
+        public ?Carbon $published_at = null,
+        public ?Carbon $submitted_at = null,
     ) {}
 }

app/Exceptions/CannotUpdateApprovedArticle.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exceptions;
+
+final class CannotUpdateApprovedArticle extends \Exception {}

app/Livewire/Components/Slideovers/ArticleForm.php

@@ -5,7 +5,8 @@
 namespace App\Livewire\Components\Slideovers;
 
 use App\Actions\Article\CreateArticleAction;
-use App\Data\CreateArticleData;
+use App\Actions\Article\UpdateArticleAction;
+use App\Data\ArticleData;
 use App\Exceptions\UnverifiedUserException;
 use App\Livewire\Traits\WithAuthenticatedUser;
 use App\Models\Article;
@@ -44,6 +45,7 @@ public function mount(?int $articleId = null): void
         $this->form->fill(array_merge($this->article->toArray(), [
             'is_draft' => ! $this->article->published_at, // @phpstan-ignore-line
             'published_at' => $this->article->published_at, // @phpstan-ignore-line
+            'locale' => $this->article->locale ?? app()->getLocale(),
         ]));
     }
 
@@ -114,6 +116,11 @@ public function form(Form $form): Form
                             ->required()
                             ->minItems(1)
                             ->maxItems(3),
+                        Forms\Components\ToggleButtons::make('locale')
+                            ->label(__('validation.attributes.locale'))
+                            ->options(['en' => 'En', 'fr' => 'Fr'])
+                            ->helperText(__('global.locale_help'))
+                            ->grouped(),
                     ])
                     ->columnSpan(1),
                 Forms\Components\Group::make()
@@ -163,42 +170,47 @@ public function save(): void
 
         $this->validate();
 
-        $validated = $this->form->getState();
+        $state = $this->form->getState();
+
+        $publishedFields = [
+            'published_at' => data_get($state, 'published_at')
+                ? new Carbon(data_get($state, 'published_at'))
+                : null,
+            'submitted_at' => data_get($state, 'is_draft') ? null : now(),
+        ];
 
         if ($this->article?->id) {
-            $this->article->update(array_merge($validated, [
-                'submitted_at' => $validated['is_draft'] ? null : now(),
-            ]));
-            $this->form->model($this->article)->saveRelationships();
-            $this->article->fresh();
+            $article = app(UpdateArticleAction::class)->execute(
+                articleData: ArticleData::from(array_merge($state, $publishedFields)),
+                article: $this->article
+            );
 
             Notification::make()
                 ->title(
-                    $this->article->submitted_at
+                    $article->submitted_at
                         ? __('notifications.article.submitted')
                         : __('notifications.article.updated'),
                 )
                 ->success()
                 ->send();
         } else {
-            $article = app(CreateArticleAction::class)->execute(CreateArticleData::from(array_merge($validated, [
-                'published_at' => array_key_exists('published_at', $validated)
-                    ? new Carbon($validated['published_at'])
-                    : null,
-            ])));
-            $this->form->model($article)->saveRelationships();
+            $article = app(CreateArticleAction::class)->execute(
+                ArticleData::from(array_merge($state, $publishedFields))
+            );
 
             Notification::make()
                 ->title(
-                    $validated['is_draft'] === false
+                    data_get($state, 'is_draft') === false
                         ? __('notifications.article.submitted')
                         : __('notifications.article.created'),
                 )
                 ->success()
                 ->send();
         }
 
-        $this->redirect(route('articles.show', ['article' => $article ?? $this->article]), navigate: true);
+        $this->form->model($article)->saveRelationships();
+
+        $this->redirect(route('articles.show', ['article' => $article]), navigate: true);
     }
 
     public function render(): View

app/Livewire/Components/Slideovers/DiscussionForm.php

@@ -39,10 +39,10 @@ public function mount(?int $discussionId = null): void
             ? Discussion::query()->findOrFail($discussionId)
             : new Discussion;
 
-        $this->form->fill(array_merge(
-            $this->discussion->toArray(),
-            ['user_id' => $this->discussion->user_id ?? Auth::id()]
-        ));
+        $this->form->fill(array_merge($this->discussion->toArray(), [
+            'user_id' => $this->discussion->user_id ?? Auth::id(),
+            'locale' => $this->discussion->locale ?? app()->getLocale(),
+        ]));
     }
 
     public function form(Form $form): Form
@@ -71,6 +71,11 @@ public function form(Form $form): Form
                     ->minItems(1)
                     ->maxItems(3)
                     ->preload(),
+                Forms\Components\ToggleButtons::make('locale')
+                    ->label(__('validation.attributes.locale'))
+                    ->options(['en' => 'En', 'fr' => 'Fr'])
+                    ->helperText(__('global.locale_help'))
+                    ->grouped(),
                 Forms\Components\MarkdownEditor::make('body')
                     ->toolbarButtons([
                         'blockquote',

app/Livewire/Components/Slideovers/ThreadForm.php

@@ -39,10 +39,10 @@ public function mount(?int $threadId = null): void
             ? Thread::query()->findOrFail($threadId)
             : new Thread;
 
-        $this->form->fill(array_merge(
-            $this->thread->toArray(),
-            ['user_id' => $this->thread->user_id ?? Auth::id()]
-        ));
+        $this->form->fill(array_merge($this->thread->toArray(), [
+            'user_id' => $this->thread->user_id ?? Auth::id(),
+            'locale' => $this->thread->locale ?? app()->getLocale(),
+        ]));
     }
 
     public static function panelMaxWidth(): string
@@ -78,10 +78,15 @@ public function form(Form $form): Form
                 Forms\Components\Select::make('channels')
                     ->multiple()
                     ->relationship(titleAttribute: 'name')
-                    ->searchable()
+                    ->preload()
                     ->required()
                     ->minItems(1)
                     ->maxItems(3),
+                Forms\Components\ToggleButtons::make('locale')
+                    ->label(__('validation.attributes.locale'))
+                    ->options(['en' => 'En', 'fr' => 'Fr'])
+                    ->helperText(__('global.locale_help'))
+                    ->grouped(),
                 Forms\Components\MarkdownEditor::make('body')
                     ->fileAttachmentsDisk('public')
                     ->toolbarButtons([

app/Models/Article.php

@@ -31,15 +31,16 @@
  * @property string | null $canonical_url
  * @property int | null $tweet_id
  * @property int $user_id
+ * @property string | null $locale
  * @property-read User $user
- * @property \Illuminate\Support\Carbon | null $published_at
- * @property \Illuminate\Support\Carbon | null $submitted_at
- * @property \Illuminate\Support\Carbon | null $approved_at
- * @property \Illuminate\Support\Carbon | null $shared_at
- * @property \Illuminate\Support\Carbon | null $declined_at
- * @property \Illuminate\Support\Carbon | null $sponsored_at
- * @property \Illuminate\Support\Carbon $created_at
- * @property \Illuminate\Support\Carbon $updated_at
+ * @property \Carbon\Carbon | null $published_at
+ * @property \Carbon\Carbon | null $submitted_at
+ * @property \Carbon\Carbon | null $approved_at
+ * @property \Carbon\Carbon | null $shared_at
+ * @property \Carbon\Carbon | null $declined_at
+ * @property \Carbon\Carbon | null $sponsored_at
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
  * @property \Illuminate\Database\Eloquent\Collection | Tag[] $tags
  */
 final class Article extends Model implements HasMedia, ReactableInterface, Viewable
@@ -69,6 +70,7 @@ final class Article extends Model implements HasMedia, ReactableInterface, Viewa
         'shared_at',
         'sponsored_at',
         'published_at',
+        'locale',
     ];
 
     protected $casts = [

app/Models/Discussion.php

@@ -34,6 +34,7 @@
  * @property string $body
  * @property bool $locked
  * @property bool $is_pinned
+ * @property string | null $locale
  * @property int $user_id
  * @property-read int $count_all_replies_with_child
  * @property Carbon $created_at
@@ -62,6 +63,7 @@ final class Discussion extends Model implements ReactableInterface, ReplyInterfa
         'user_id',
         'is_pinned',
         'locked',
+        'locale',
     ];
 
     protected $casts = [

app/Models/Thread.php

@@ -43,6 +43,7 @@
  * @property int $user_id
  * @property int $solution_reply_id
  * @property bool $locked
+ * @property string | null $locale
  * @property Carbon | null $last_posted_at
  * @property Carbon $created_at
  * @property Carbon $updated_at
@@ -73,6 +74,7 @@ final class Thread extends Model implements Feedable, ReactableInterface, ReplyI
         'body',
         'slug',
         'user_id',
+        'locale',
     ];
 
     protected $casts = [

database/factories/ArticleFactory.php

@@ -19,6 +19,28 @@ public function definition(): array
             'title' => $this->faker->sentence(),
             'body' => $this->faker->paragraphs(3, true),
             'slug' => $this->faker->unique()->slug(),
+            'locale' => $this->faker->randomElement(['en', 'fr']),
         ];
     }
+
+    public function approved(): self
+    {
+        return $this->state(function (array $attributes): array {
+            return [
+                'published_at' => now()->addDays(2),
+                'submitted_at' => now(),
+                'approved_at' => now(),
+            ];
+        });
+    }
+
+    public function submitted(): self
+    {
+        return $this->state(function (array $attributes): array {
+            return [
+                'submitted_at' => now(),
+                'published_at' => now()->addDay(),
+            ];
+        });
+    }
 }

database/factories/TagFactory.php

@@ -19,4 +19,14 @@ public function definition(): array
             'concerns' => ['post', 'discussion', 'tutorial'],
         ];
     }
+
+    public function article(): self
+    {
+        return $this->state(['concerns' => ['post', 'tutorial']]);
+    }
+
+    public function discussion(): self
+    {
+        return $this->state(['concerns' => ['discussion']]);
+    }
 }

lang/en/global.php

@@ -102,5 +102,6 @@
     'website' => 'Website',
     'characters' => ':number characters',
     'like' => ':count like',
+    'locale_help' => 'The language in which your content will be available on the site.',
 
 ];

lang/en/notifications.php

@@ -22,6 +22,7 @@
     'exceptions' => [
         'unverified_user' => 'You are not authorized to do this. Your e-mail is not verified',
         'spam_exist' => 'Spam already reported.',
+        'approved_article' => 'An approved article cannot be updated.',
     ],
 
     'reply' => [