Merge pull request 'KAN-6 Project rely on project templates' (#88) from koda/kan-6-project-rely-on-project-templates into epic/kan-3

Reviewed-on: OpenSource/KanbanGit#88

app/Actions/Projects/CreateProject.php

@@ -14,6 +14,7 @@ use Illuminate\Support\Facades\DB;
 class CreateProject
 {
     public function __construct(
+        private readonly CreateProjectBaseTemplate $createProjectBaseTemplate,
         private readonly DuplicateProjectConfiguration $duplicateProjectConfiguration,
         private readonly InitializeProjectTicketMetadata $initializeProjectTicketMetadata,
         private readonly PermissionService $permissionService,
@@ -49,6 +50,18 @@ class CreateProject
                     $project,
                     $template->configuration_snapshot ?? [],
                 );
+
+                $project->forceFill([
+                    'project_template_id' => $template->id,
+                ])->save();
+            }
+
+            if ($project->project_template_id === null) {
+                $baseTemplate = $this->createProjectBaseTemplate->handle($project->fresh() ?? $project);
+
+                $project->forceFill([
+                    'project_template_id' => $baseTemplate->id,
+                ])->save();
             }
 
             return $project->fresh() ?? $project;

app/Actions/Projects/CreateProjectBaseTemplate.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Actions\Projects;
+
+use App\Models\Project;
+use App\Models\ProjectTemplate;
+
+class CreateProjectBaseTemplate
+{
+    public function __construct(
+        private readonly DuplicateProjectConfiguration $duplicateProjectConfiguration,
+    ) {}
+
+    public function handle(Project $project): ProjectTemplate
+    {
+        $copyAreas = DuplicateProjectConfiguration::copyableAreas();
+
+        return ProjectTemplate::query()->create([
+            'project_id' => $project->id,
+            'source_project_id' => $project->id,
+            'name' => "{$project->name} base template",
+            'slug' => strtolower($project->key).'-base-template',
+            'is_published' => false,
+            'copy_areas' => $copyAreas,
+            'configuration_snapshot' => $this->duplicateProjectConfiguration->export($project, $copyAreas),
+        ]);
+    }
+}

app/Actions/Projects/CreateProjectTemplate.php

@@ -20,9 +20,11 @@ class CreateProjectTemplate
         $copyAreas = array_values(Arr::get($attributes, 'copy_areas', []));
 
         return ProjectTemplate::query()->create([
+            'project_id' => null,
             'source_project_id' => $sourceProject->id,
             'name' => $attributes['name'],
             'slug' => $attributes['slug'],
+            'is_published' => true,
             'copy_areas' => $this->duplicateProjectConfiguration->normalizeCopyAreas($copyAreas),
             'configuration_snapshot' => $this->duplicateProjectConfiguration->export($sourceProject, $copyAreas),
         ]);

app/Http/Controllers/ProjectController.php

@@ -54,7 +54,11 @@ class ProjectController extends Controller
             403,
         );
 
-        $sourceTemplates = ProjectTemplate::query()->with('sourceProject')->orderBy('name')->get();
+        $sourceTemplates = ProjectTemplate::query()
+            ->published()
+            ->with('sourceProject')
+            ->orderBy('name')
+            ->get();
         $selectedTemplateId = $request->integer('template');
 
         return Inertia::render('projects/Create', [

app/Http/Controllers/ProjectTemplateController.php

@@ -26,6 +26,7 @@ class ProjectTemplateController extends Controller
             'status' => session('status'),
             'templates' => ProjectTemplateResource::collection(
                 ProjectTemplate::query()
+                    ->published()
                     ->with('sourceProject')
                     ->orderBy('name')
                     ->get(),
@@ -51,6 +52,8 @@ class ProjectTemplateController extends Controller
 
     public function destroy(ProjectTemplate $projectTemplate): RedirectResponse
     {
+        abort_if(! $projectTemplate->is_published, 404);
+
         $templateName = $projectTemplate->name;
         $projectTemplate->delete();
 

app/Http/Requests/StoreProjectRequest.php

@@ -85,7 +85,7 @@ class StoreProjectRequest extends FormRequest
                 Rule::requiredIf(fn (): bool => $this->input('creation_mode') === 'template'),
                 'nullable',
                 'integer',
-                Rule::exists('project_templates', 'id'),
+                Rule::exists('project_templates', 'id')->where(fn ($query) => $query->where('is_published', true)),
             ],
             'copy_areas' => ['nullable', 'array'],
             'copy_areas.*' => [

app/Http/Resources/ProjectResource.php

@@ -18,6 +18,7 @@ class ProjectResource extends JsonResource
             'id' => $this->id,
             'name' => $this->name,
             'key' => $this->key,
+            'project_template_id' => $this->project_template_id,
             'show_author' => $this->show_author,
             'show_story_points' => $this->show_story_points,
             'created_at' => $this->created_at?->toISOString(),

app/Http/Resources/ProjectTemplateResource.php

@@ -19,12 +19,14 @@ class ProjectTemplateResource extends JsonResource
         if ($this->resource instanceof ProjectTemplate) {
             return [
                 'id' => $this->id,
+                'project_id' => $this->project_id,
                 'source_project_id' => $this->source_project_id,
                 'source_project' => $this->relationLoaded('sourceProject') && $this->sourceProject !== null
                     ? ProjectResource::make($this->sourceProject)->resolve()
                     : null,
                 'name' => $this->name,
                 'slug' => $this->slug,
+                'is_published' => $this->is_published,
                 'copy_areas' => $this->copy_areas ?? [],
                 'created_at' => $this->created_at?->toISOString(),
                 'updated_at' => $this->updated_at?->toISOString(),
@@ -33,10 +35,12 @@ class ProjectTemplateResource extends JsonResource
 
         return [
             'id' => Arr::get($this->resource, 'id'),
+            'project_id' => Arr::get($this->resource, 'project_id'),
             'source_project_id' => Arr::get($this->resource, 'source_project_id'),
             'source_project' => Arr::get($this->resource, 'source_project'),
             'name' => Arr::get($this->resource, 'name'),
             'slug' => Arr::get($this->resource, 'slug'),
+            'is_published' => Arr::get($this->resource, 'is_published', true),
             'copy_areas' => Arr::get($this->resource, 'copy_areas', []),
             'created_at' => Arr::get($this->resource, 'created_at'),
             'updated_at' => Arr::get($this->resource, 'updated_at'),

app/Models/Project.php

@@ -7,11 +7,13 @@ use Illuminate\Database\Eloquent\Attributes\Fillable;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Support\Str;
 
-#[Fillable(['name', 'key', 'show_author', 'show_story_points'])]
+#[Fillable(['name', 'key', 'project_template_id', 'show_author', 'show_story_points'])]
 class Project extends Model
 {
     /** @use HasFactory<ProjectFactory> */
@@ -44,6 +46,17 @@ class Project extends Model
         return $this->morphMany(PermissionAssignment::class, 'scope');
     }
 
+    public function projectTemplate(): BelongsTo
+    {
+        return $this->belongsTo(ProjectTemplate::class, 'project_template_id');
+    }
+
+    public function baseTemplate(): HasOne
+    {
+        return $this->hasOne(ProjectTemplate::class)
+            ->where('is_published', false);
+    }
+
     public function boardColumns(): HasMany
     {
         return $this->hasMany(BoardColumn::class)

app/Models/ProjectTemplate.php

@@ -7,8 +7,9 @@ use Illuminate\Database\Eloquent\Attributes\Fillable;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Builder;
 
-#[Fillable(['source_project_id', 'name', 'slug', 'copy_areas', 'configuration_snapshot'])]
+#[Fillable(['project_id', 'source_project_id', 'name', 'slug', 'is_published', 'copy_areas', 'configuration_snapshot'])]
 class ProjectTemplate extends Model
 {
     /** @use HasFactory<ProjectTemplateFactory> */
@@ -19,9 +20,20 @@ class ProjectTemplate extends Model
         return [
             'copy_areas' => 'array',
             'configuration_snapshot' => 'array',
+            'is_published' => 'boolean',
         ];
     }
 
+    public function scopePublished(Builder $query): Builder
+    {
+        return $query->where('is_published', true);
+    }
+
+    public function project(): BelongsTo
+    {
+        return $this->belongsTo(Project::class);
+    }
+
     public function sourceProject(): BelongsTo
     {
         return $this->belongsTo(Project::class, 'source_project_id');