Skip to content

feat: LAR-175 upgrade the approbation system #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions app/Actions/Article/DeclineArticleAction.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

declare(strict_types=1);

namespace App\Actions\Article;

use App\Models\Article;
use App\Notifications\ArticleDeclinedNotification;
use Carbon\Carbon;
use Illuminate\Support\Facades\DB;

final class DeclineArticleAction
{
public function execute(string $reason, Article $article): Article
{
return DB::transaction(function () use ($reason, $article) {

$article->update([
'declined_at' => Carbon::now(),
'reason' => $reason,
'submitted_at' => null,
]);

$article->user->notify(new ArticleDeclinedNotification($article));

$article->refresh();

return $article;
});
}
}
4 changes: 4 additions & 0 deletions app/Actions/Article/UpdateArticleAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ public function execute(ArticleData $articleData, Article $article): Article
);
}

if ($articleData->declined_at) {
$articleData->declined_at = null;
}

$article->update($articleData->toArray());

$article->refresh();
Expand Down
1 change: 1 addition & 0 deletions app/Data/ArticleData.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ public function __construct(
public ?string $canonical_url = null,
public ?Carbon $published_at = null,
public ?Carbon $submitted_at = null,
public ?Carbon $declined_at = null,
) {}
}
25 changes: 20 additions & 5 deletions app/Filament/Resources/ArticleResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@
namespace App\Filament\Resources;

use App\Actions\Article\ApprovedArticleAction;
use App\Actions\Article\DeclineArticleAction;
use App\Filament\Resources\ArticleResource\Pages;
use App\Models\Article;
use Awcodes\FilamentBadgeableColumn\Components\Badge;
use Awcodes\FilamentBadgeableColumn\Components\BadgeableColumn;
use Filament\Forms\Components\Textarea;
use Filament\Notifications\Notification;
use Filament\Resources\Resource;
use Filament\Support\Enums\MaxWidth;
use Filament\Tables;
Expand Down Expand Up @@ -123,15 +126,27 @@ public static function table(Table $table): Table
->label('Décliner')
->icon('heroicon-s-x-mark')
->color('warning')
->modalHeading(__('Voulez vous décliner cet article'))
->successNotificationTitle(__('Opération effectuée avec succès'))
->form([
Textarea::make('reason')
->label(__('Raison du refus'))
->maxLength(255)
->required(),
])
->modalHeading('Décliner l\'article')
->modalDescription('Veuillez fournir une raison détaillée pour le refus de cet article. L\'auteur recevra cette explication.')
->successNotificationTitle('Article décliné avec succès')
->requiresConfirmation()
->modalIcon('heroicon-s-x-mark')
->action(function ($record): void {
->action(function (array $data, Article $record): void {
Gate::authorize('decline', $record);

$record->declined_at = now();
$record->save();
app(DeclineArticleAction::class)->execute($data['reason'], $record);

Notification::make()
->title('Article décliné')
->body('L\'auteur a été notifié de la raison du refus.')
->success()
->send();
}),
Tables\Actions\Action::make('show')
->icon('untitledui-eye')
Expand Down
10 changes: 10 additions & 0 deletions app/Filament/Resources/ArticleResource/Pages/ListArticles.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use App\Filament\Resources\ArticleResource;
use App\Models\Article;
use Closure;
use Filament\Resources\Components\Tab;
use Filament\Resources\Pages\ListRecords;

final class ListArticles extends ListRecords
Expand All @@ -17,4 +18,13 @@ public function isTableRecordSelectable(): Closure
{
return fn (Article $record): bool => $record->isNotPublished();
}

public function getTabs(): array
{
return [
'En attente' => Tab::make()->query(fn ($query) => $query->awaitingApproval()),
'Apprové' => Tab::make()->query(fn ($query) => $query->published()),
'Décliné' => Tab::make()->query(fn ($query) => $query->declined()),
];
}
}
2 changes: 2 additions & 0 deletions app/Models/Article.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
* @property bool $is_pinned
* @property int $is_sponsored
* @property string | null $canonical_url
* @property string | null $reason
* @property int | null $tweet_id
* @property int $user_id
* @property string | null $locale
Expand Down Expand Up @@ -63,6 +64,7 @@ final class Article extends Model implements HasMedia, ReactableInterface, Sitem
'body',
'slug',
'canonical_url',
'reason',
'show_toc',
'is_pinned',
'user_id',
Expand Down
41 changes: 41 additions & 0 deletions app/Notifications/ArticleDeclinedNotification.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?php

declare(strict_types=1);

namespace App\Notifications;

use App\Models\Article;
use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

final class ArticleDeclinedNotification extends Notification
{
use Queueable;

public function __construct(public Article $article) {}

public function via(mixed $notifiable): array
{
return ['mail', 'database'];
}

public function toMail(mixed $notifiable): MailMessage
{
return (new MailMessage)
->subject(__('emails/article.article_declined.subject'))
->markdown('emails.article_declined', ['article' => $this->article]);
}

/**
* @return array<string, mixed>
*/
public function toArray(): array
{
return [
'article' => $this->article,
'owner' => $this->article->user->name,
'email' => $this->article->user->email,
];
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

declare(strict_types=1);

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
public function up(): void
{
Schema::table('articles', static function (Blueprint $table): void {
$table->string('reason')->nullable()->after('canonical_url');
});
}
};
20 changes: 20 additions & 0 deletions lang/en/emails/article.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

declare(strict_types=1);

return [

'article_declined' => [
'subject' => 'Your article has been declined',
'head' => 'Your article :title has been declined for the following reason:',
'recommandation_body' => 'Don\'t be discouraged! You can:',
'recommandation_1' => '1. Review your article and the reason for the decline',
'recommandation_2' => '2. Make the necessary changes',
'recommandation_3' => '3. Resubmit your article once the corrections are made',
'help' => 'Our team is here to help you improve your content.',
'closing' => 'Best regards,',
'team' => 'The Laravel Cameroon Team',
'button_update_article' => 'Edit my article',
],

];
20 changes: 20 additions & 0 deletions lang/fr/emails/article.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

declare(strict_types=1);

return [

'article_declined' => [
'subject' => 'Votre article a été décliné',
'head' => 'Votre article :title a été décliné pour la raison suivante :',
'recommandation_body' => 'Ne vous découragez pas ! Vous pouvez :',
'recommandation_1' => '1. Consulter votre article et la raison du refus',
'recommandation_2' => '2. Apporter les modifications nécessaires',
'recommandation_3' => '3. Re-soumettre votre article une fois les corrections effectuées',
'help' => 'Notre équipe est là pour vous aider à améliorer votre contenu.',
'closing' => 'Cordialement,',
'team' => 'L\'équipe Laravel Cameroun',
'button_update_article' => 'Modifier mon article',
],

];
28 changes: 28 additions & 0 deletions resources/views/emails/article_declined.blade.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<x-mail::message>

<x-mail::panel>

{{ __('emails/article.article_declined.head', ['title' => $article->title]) }}

{{ $article->reason }}

{{ __('emails/article.article_declined.recommandation_body') }}

{{ __('emails/article.article_declined.recommandation_1') }}
{{ __('emails/article.article_declined.recommandation_2') }}
{{ __('emails/article.article_declined.recommandation_3') }}

<x-mail::button :url="route('articles.show', $article)">
{{ __('emails/article.article_declined.button_update_article') }}
</x-mail::button>

{{ __('emails/article.article_declined.help') }}

</x-mail::panel>

<p>
{{ __('emails/article.article_declined.closing') }} <br>
{{ __('emails/article.article_declined.team') }}
</p>

</x-mail::message>
18 changes: 7 additions & 11 deletions tests/Feature/Filament/ArticleResourceTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,8 @@

$article->refresh();

expect($article->approved_at)
->not()
->toBe(null)
->and($article->declined_at)
->toBe(null);
expect($article->approved_at)->toBeInstanceOf(\Carbon\Carbon::class)
->and($article->declined_at)->toBeNull();

Livewire::test(ArticleResource\Pages\ListArticles::class)
->assertTableActionHidden('approved', $article)
Expand All @@ -50,15 +47,14 @@
$article = $this->articles->first();

Livewire::test(ArticleResource\Pages\ListArticles::class)
->callTableAction('declined', $article);
->callTableAction('declined', $article, data: [
'reason' => 'Ce contenu ne respecte pas nos règles éditoriales.',
]);

$article->refresh();

expect($article->declined_at)
->not
->toBe(null)
->and($article->approved_at)
->toBe(null);
expect($article->declined_at)->toBeInstanceOf(\Carbon\Carbon::class)
->and($article->approved_at)->toBeNull();

Livewire::test(ArticleResource\Pages\ListArticles::class)
->assertTableActionHidden('approved', $article)
Expand Down
Loading