Feature article summary

code/app/Athenia/Contracts/Repositories/Wiki/ArticleSummaryRepositoryContract.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Repositories\Wiki;
+
+use App\Athenia\Contracts\Repositories\BaseRepositoryContract;
+
+/**
+ * Interface ArticleSummaryRepositoryContract
+ * @package App\Athenia\Contracts\Repositories\Wiki
+ */
+interface ArticleSummaryRepositoryContract extends BaseRepositoryContract
+{}

code/app/Athenia/Http/Core/Controllers/Wiki/ArticleSummaryControllerAbstract.php

@@ -0,0 +1,118 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Http\Core\Controllers\Wiki;
+
+use App\Athenia\Contracts\Repositories\Wiki\ArticleSummaryRepositoryContract;
+use App\Athenia\Http\Core\Controllers\BaseControllerAbstract;
+use App\Athenia\Models\BaseModelAbstract;
+use App\Http\Core\Requests;
+use App\Models\Wiki\Article;
+use App\Models\Wiki\ArticleSummary;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class ArticleSummaryControllerAbstract
+ * @package App\Athenia\Http\Core\Controllers\Wiki
+ */
+abstract class ArticleSummaryControllerAbstract extends BaseControllerAbstract
+{
+    /**
+     * @var ArticleSummaryRepositoryContract
+     */
+    private ArticleSummaryRepositoryContract $repository;
+
+    /**
+     * ArticleSummaryController constructor.
+     * @param ArticleSummaryRepositoryContract $repository
+     */
+    public function __construct(ArticleSummaryRepositoryContract $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    /**
+     * Display the summary for the article
+     *
+     * @param Requests\Wiki\ArticleSummary\ViewRequest $request
+     * @param Article $article
+     * @return JsonResponse
+     */
+    public function show(Requests\Wiki\ArticleSummary\ViewRequest $request, Article $article): JsonResponse
+    {
+        $summary = $article->articleSummary;
+
+        if (!$summary) {
+            return new JsonResponse([
+                'message' => 'Article summary not found.'
+            ], 404);
+        }
+
+        return new JsonResponse($summary, 200);
+    }
+
+    /**
+     * Create a new summary for the article
+     *
+     * @param Requests\Wiki\ArticleSummary\StoreRequest $request
+     * @param Article $article
+     * @return JsonResponse
+     */
+    public function store(Requests\Wiki\ArticleSummary\StoreRequest $request, Article $article): JsonResponse
+    {
+        $data = $request->json()->all();
+        $data['article_id'] = $article->id;
+
+        /** @var ArticleSummary $model */
+        $model = $this->repository->create($data);
+
+        return new JsonResponse($model, 201);
+    }
+
+    /**
+     * Update the article summary
+     *
+     * @param Requests\Wiki\ArticleSummary\UpdateRequest $request
+     * @param Article $article
+     * @return JsonResponse
+     */
+    public function update(Requests\Wiki\ArticleSummary\UpdateRequest $request, Article $article): JsonResponse
+    {
+        $summary = $article->articleSummary;
+
+        if (!$summary) {
+            return new JsonResponse([
+                'message' => 'Article summary not found.'
+            ], 404);
+        }
+
+        $data = $request->json()->all();
+
+        /** @var ArticleSummary $updated */
+        $updated = $this->repository->update($summary, $data);
+
+        return new JsonResponse($updated, 200);
+    }
+
+    /**
+     * Delete the article summary
+     *
+     * @param Requests\Wiki\ArticleSummary\DeleteRequest $request
+     * @param Article $article
+     * @return JsonResponse
+     */
+    public function destroy(Requests\Wiki\ArticleSummary\DeleteRequest $request, Article $article): JsonResponse
+    {
+        $summary = $article->articleSummary;
+
+        if (!$summary) {
+            return new JsonResponse([
+                'message' => 'Article summary not found.'
+            ], 404);
+        }
+
+        $this->repository->delete($summary);
+
+        return new JsonResponse(null, 204);
+    }
+}

code/app/Athenia/Http/Core/Requests/Wiki/ArticleSummary/DeleteRequest.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Http\Core\Requests\Wiki\ArticleSummary;
+
+use App\Athenia\Http\Core\Requests\BaseAuthenticatedRequestAbstract;
+use App\Athenia\Http\Core\Requests\Traits\HasNoExpands;
+use App\Athenia\Http\Core\Requests\Traits\HasNoRules;
+use App\Models\Wiki\ArticleSummary;
+use App\Policies\Wiki\ArticleSummaryPolicy;
+
+/**
+ * Class DeleteRequest
+ * @package App\Athenia\Http\Core\Requests\Wiki\ArticleSummary
+ */
+class DeleteRequest extends BaseAuthenticatedRequestAbstract
+{
+    use HasNoRules, HasNoExpands;
+
+    /**
+     * Get the policy action for the guard
+     *
+     * @return string
+     */
+    protected function getPolicyAction(): string
+    {
+        return ArticleSummaryPolicy::ACTION_DELETE;
+    }
+
+    /**
+     * Get the class name of the policy that this request utilizes
+     *
+     * @return string
+     */
+    protected function getPolicyModel(): string
+    {
+        return ArticleSummary::class;
+    }
+
+    /**
+     * Gets any additional parameters needed for the policy function
+     *
+     * @return array
+     */
+    protected function getPolicyParameters(): array
+    {
+        return [
+            $this->route('article'),
+        ];
+    }
+}

code/app/Athenia/Http/Core/Requests/Wiki/ArticleSummary/StoreRequest.php

@@ -0,0 +1,59 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Http\Core\Requests\Wiki\ArticleSummary;
+
+use App\Athenia\Http\Core\Requests\BaseAuthenticatedRequestAbstract;
+use App\Athenia\Http\Core\Requests\Traits\HasNoExpands;
+use App\Models\Wiki\ArticleSummary;
+use App\Policies\Wiki\ArticleSummaryPolicy;
+
+/**
+ * Class StoreRequest
+ * @package App\Athenia\Http\Core\Requests\Wiki\ArticleSummary
+ */
+class StoreRequest extends BaseAuthenticatedRequestAbstract
+{
+    use HasNoExpands;
+
+    /**
+     * Get the policy action for the guard
+     *
+     * @return string
+     */
+    protected function getPolicyAction(): string
+    {
+        return ArticleSummaryPolicy::ACTION_CREATE;
+    }
+
+    /**
+     * Get the class name of the policy that this request utilizes
+     *
+     * @return string
+     */
+    protected function getPolicyModel(): string
+    {
+        return ArticleSummary::class;
+    }
+
+    /**
+     * Gets any additional parameters needed for the policy function
+     *
+     * @return array
+     */
+    protected function getPolicyParameters(): array
+    {
+        return [
+            $this->route('article'),
+        ];
+    }
+
+    /**
+     * @param ArticleSummary $model
+     * @return array
+     */
+    public function rules(ArticleSummary $model)
+    {
+        return $model->getValidationRules(ArticleSummary::VALIDATION_RULES_CREATE);
+    }
+}

code/app/Athenia/Http/Core/Requests/Wiki/ArticleSummary/UpdateRequest.php

@@ -0,0 +1,60 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Http\Core\Requests\Wiki\ArticleSummary;
+
+use App\Athenia\Http\Core\Requests\BaseAuthenticatedRequestAbstract;
+use App\Athenia\Http\Core\Requests\Traits\HasNoExpands;
+use App\Models\Wiki\ArticleSummary;
+use App\Policies\Wiki\ArticleSummaryPolicy;
+
+/**
+ * Class UpdateRequest
+ * @package App\Athenia\Http\Core\Requests\Wiki\ArticleSummary
+ */
+class UpdateRequest extends BaseAuthenticatedRequestAbstract
+{
+    use HasNoExpands;
+
+    /**
+     * Get the policy action for the guard
+     *
+     * @return string
+     */
+    protected function getPolicyAction(): string
+    {
+        return ArticleSummaryPolicy::ACTION_UPDATE;
+    }
+
+    /**
+     * Get the class name of the policy that this request utilizes
+     *
+     * @return string
+     */
+    protected function getPolicyModel(): string
+    {
+        return ArticleSummary::class;
+    }
+
+    /**
+     * Gets any additional parameters needed for the policy function
+     *
+     * @return array
+     */
+    protected function getPolicyParameters(): array
+    {
+        return [
+            $this->route('article'),
+        ];
+    }
+
+    /**
+     * The rules for this request
+     *
+     * @param ArticleSummary $model
+     */
+    public function rules(ArticleSummary $model)
+    {
+        return $model->getValidationRules(ArticleSummary::VALIDATION_RULES_UPDATE);
+    }
+}

code/app/Athenia/Http/Core/Requests/Wiki/ArticleSummary/ViewRequest.php

@@ -0,0 +1,47 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Http\Core\Requests\Wiki\ArticleSummary;
+
+use App\Athenia\Http\Core\Requests\BaseAuthenticatedRequestAbstract;
+use App\Athenia\Http\Core\Requests\Traits\HasNoExpands;
+use App\Athenia\Http\Core\Requests\Traits\HasNoRules;
+use App\Models\Wiki\ArticleSummary;
+use App\Policies\Wiki\ArticleSummaryPolicy;
+
+/**
+ * Class ViewRequest
+ * @package App\Athenia\Http\Core\Requests\Wiki\ArticleSummary
+ */
+class ViewRequest extends BaseAuthenticatedRequestAbstract
+{
+    use HasNoRules, HasNoExpands;
+
+    /**
+     * Get the policy action for the guard
+     *
+     * @return string
+     */
+    protected function getPolicyAction(): string
+    {
+        return ArticleSummaryPolicy::ACTION_VIEW;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getPolicyModel(): string
+    {
+        return ArticleSummary::class;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getPolicyParameters(): array
+    {
+        return [
+            $this->route('article'),
+        ];
+    }
+}

code/app/Athenia/Models/Wiki/Article.php

@@ -15,11 +15,13 @@
 use App\Models\User\User;
 use App\Models\Wiki\ArticleIteration;
 use App\Models\Wiki\ArticleModification;
+use App\Models\Wiki\ArticleSummary;
 use App\Models\Wiki\ArticleVersion;
 use Eloquent;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 
 /**
  * Class Article
@@ -163,6 +165,16 @@ public function articleNotes() : HasMany
         return $this->hasMany(\App\Models\User\ArticleNote::class);
     }
 
+    /**
+     * The summary for this article
+     *
+     * @return HasOne
+     */
+    public function articleSummary() : HasOne
+    {
+        return $this->hasOne(ArticleSummary::class);
+    }
+
     /**
      * Gets the content of the article
      *