Introduce modules and first Kanban module

app/Http/Controllers/Api/V1/Board/ModuleController.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1\Board;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\Api\V1\Module\EnableKanbanModuleRequest;
+use App\Http\Resources\V1\Board\ModuleResource;
+use App\Models\Board;
+use App\Models\Module;
+use App\Services\Contracts\Modules\KanbanService;
+
+class ModuleController extends Controller
+{
+    public function __construct(
+        protected KanbanService $kanban
+    ) {
+    }
+
+    public function index(Board $board)
+    {
+        $modules = Module::all()->each(function ($module) use ($board) {
+            $module->enabled = $board->modules?->find($module->id) != null;
+        });
+
+        return ModuleResource::collection($modules);
+    }
+
+    /*
+    |--------------------------------------------------------------------------
+    | Kanban module
+    |--------------------------------------------------------------------------
+    |
+    | Endpoints related to Kanban module.
+    |
+    */
+
+    public function kanbanSettings(Board $board)
+    {
+        $settings = $this->kanban->getSettings($board);
+
+        return response(['data' => $settings]);
+    }
+
+    public function enableKanban(EnableKanbanModuleRequest $request, Board $board)
+    {
+        $this->kanban->enable($board, $request->validated());
+
+        return response('', 204);
+    }
+
+    public function disableKanban(Board $board)
+    {
+        $this->kanban->disable($board);
+
+        return response('', 204);
+    }
+}

app/Http/Controllers/Api/V1/Project/BoardController.php

@@ -21,6 +21,7 @@ public function index(Project $project)
     {
         $boards = QueryBuilder::for($project->boards())
             ->allowedFields([BoardResource::class], [BoardResource::class])
+            ->allowedIncludes(['modules'])
             ->get();
 
         return BoardResource::collection($boards);

app/Http/Requests/Api/V1/Module/EnableKanbanModuleRequest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace App\Http\Requests\Api\V1\Module;
+
+use App\Rules\Api\ColumnInSameBoard;
+use App\Rules\Api\MaxColumnsPerBoard;
+use App\Services\Modules\KanbanService;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+class EnableKanbanModuleRequest extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        $board = $this->route('board');
+
+        return [
+            'todo_column_id' => [
+                'required', 'integer', 'min:0',
+                Rule::when($this->todo_column_id != 0, $this->getDifferentRule('todo_column_id')),
+                new ColumnInSameBoard($this, $board),
+            ],
+            'inprogress_column_id' => [
+                'required', 'integer', 'min:0',
+                Rule::when($this->inprogress_column_id != 0, $this->getDifferentRule('inprogress_column_id')),
+                new ColumnInSameBoard($this, $board),
+            ],
+            'done_column_id' => [
+                'required', 'integer', 'min:0',
+                Rule::when($this->done_column_id != 0, $this->getDifferentRule('done_column_id')),
+                new ColumnInSameBoard($this, $board),
+            ],
+
+            // Optional columns.
+            'onreview_column_id' => [
+                'sometimes', 'required', 'integer', 'min:0',
+                Rule::when($this->onreview_column_id != 0, $this->getDifferentRule('onreview_column_id')),
+                new ColumnInSameBoard($this, $board),
+            ],
+        ];
+    }
+
+    /**
+     * Configure the validator instance.
+     *
+     * @param  \Illuminate\Validation\Validator  $validator
+     * @return void
+     */
+    public function withValidator($validator)
+    {
+        $data = $validator->getData();
+        $newColumns = 0;
+
+        foreach ($data as $key => $value) {
+            if (array_key_exists($key, KanbanService::$availableColumns) && $value == 0) {
+                $newColumns++;
+            }
+        }
+
+        if ($newColumns != 0) {
+            $validator->addRules(['board' => [new MaxColumnsPerBoard($this->route('board'), $newColumns)]]);
+        }
+    }
+
+    protected function getDifferentRule($column)
+    {
+        return array_map(function ($value) {
+                return 'different:' . $value;
+        }, array_keys(array_diff_key(KanbanService::$availableColumns, [$column => 0])));
+    }
+}

app/Http/Resources/V1/Board/BoardResource.php

@@ -22,6 +22,7 @@ public function toArray($request)
             'deleted_at' => $this->when($this->trashed(), $this->deleted_at),
         ], [
             'project' => new ProjectResource($this->whenLoaded('project')),
+            'modules' => ModuleResource::collection($this->whenLoaded('modules')),
         ]);
     }
 

app/Http/Resources/V1/Board/ModuleResource.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Http\Resources\V1\Board;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class ModuleResource extends JsonResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
+     */
+    public function toArray($request)
+    {
+        return [
+            'id' => $this->id,
+            'name' => $this->name,
+            'enabled' => $this->whenNotNull($this->enabled),
+        ];
+    }
+}

app/Http/Resources/V1/Column/ColumnResource.php

@@ -16,7 +16,7 @@ class ColumnResource extends JsonResource implements ResourceWithFields
     public function toArray($request)
     {
         return $this->visible([
-            'id', 'name', 'created_at', 'updated_at',
+            'id', 'name', 'column_type_id', 'created_at', 'updated_at',
         ]);
     }
 
@@ -27,7 +27,7 @@ public static function defaultName(): string
 
     public static function defaultFields(): array
     {
-        return ['id', 'name'];
+        return ['id', 'name', 'column_type_id'];
     }
 
     public static function allowedFields(): array

app/Models/Board.php

@@ -21,6 +21,8 @@
  * @property-read \App\Models\Team $team
  * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Column[] $columns
  * @property-read int|null $columns_count
+ * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Module[] $modules
+ * @property-read int|null $modules_count
  * @method static \Database\Factories\BoardFactory factory(...$parameters)
  * @method static \Illuminate\Database\Eloquent\Builder|Board newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder|Board newQuery()
@@ -66,4 +68,9 @@ public function team()
         return $this->belongsToThrough(Team::class, Project::class)
             ->withTrashedParents();
     }
+
+    public function modules()
+    {
+        return $this->belongsToMany(Module::class);
+    }
 }

app/Models/Column.php

@@ -3,6 +3,7 @@
 namespace App\Models;
 
 use App\Traits\HasOrder;
+use Illuminate\Contracts\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Znck\Eloquent\Traits\BelongsToThrough;
@@ -15,6 +16,8 @@
  * @property double|null $order
  * @property-read \App\Models\Board $board
  * @property int $board_id
+ * @property-read \App\Models\ColumnType $columnType
+ * @property int $column_type_id
  * @property \Illuminate\Support\Carbon|null $created_at
  * @property \Illuminate\Support\Carbon|null $updated_at
  * @property-read \App\Models\Team $team
@@ -24,6 +27,7 @@
  * @method static \Illuminate\Database\Eloquent\Builder|Column newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder|Column newQuery()
  * @method static \Illuminate\Database\Eloquent\Builder|Column query()
+ * @method static \Illuminate\Database\Eloquent\Builder|Column kanbanRelated()
  * @mixin \Eloquent
  */
 class Column extends Model
@@ -39,6 +43,17 @@ public function getOrderQuery($query)
         return $query->where('board_id', $this->board_id);
     }
 
+    /*
+    |-------------------------------------------------------------
+    | Scopes
+    |-------------------------------------------------------------
+    */
+
+    public function scopeKanbanRelated(Builder $query)
+    {
+        return $query->where('column_type_id', '!=', ColumnType::NONE);
+    }
+
     /*
     |-------------------------------------------------------------
     | Relationships
@@ -60,4 +75,9 @@ public function team()
         return $this->belongsToThrough(Team::class, [Project::class, Board::class])
             ->withTrashedParents();
     }
+
+    public function columnType()
+    {
+        return $this->belongsTo(ColumnType::class);
+    }
 }

app/Models/ColumnType.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * App\Models\ColumnType
+ *
+ * @property int $id
+ * @property string $name
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @method static \Illuminate\Database\Eloquent\Builder|ColumnType newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|ColumnType newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|ColumnType query()
+ * @mixin \Eloquent
+ */
+class ColumnType extends Model
+{
+    public const NONE = 0;
+
+    public const TODO = 1;
+
+    public const IN_PROGRESS = 2;
+
+    public const DONE = 3;
+
+    public const ON_REVIEW = 4;
+}

app/Models/Module.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * App\Models\Module
+ *
+ * @property int $id
+ * @property string $name
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Board[] $boards
+ * @property-read int|null $boards_count
+ * @method static \Illuminate\Database\Eloquent\Builder|Module newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|Module newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|Module query()
+ * @mixin \Eloquent
+ */
+class Module extends Model
+{
+    public const KANBAN = 1;
+
+    /*
+    |-------------------------------------------------------------
+    | Relationships
+    |-------------------------------------------------------------
+    */
+
+    public function boards()
+    {
+        return $this->belongsToMany(Board::class);
+    }
+}

app/Policies/CardPolicy.php

@@ -5,6 +5,7 @@
 use App\Models\Card;
 use App\Models\Column;
 use App\Models\User;
+use App\Services\Contracts\Modules\KanbanService;
 use Illuminate\Auth\Access\HandlesAuthorization;
 
 class CardPolicy
@@ -57,10 +58,21 @@ public function update(User $user, Card $card)
         return $card->team->isMember($user);
     }
 
+    /**
+     * Determine whether the user can update the card.
+     *
+     * @param  \App\Models\User  $user
+     * @param  \App\Models\Card  $card
+     * @param  \App\Models\Column  $column
+     * @return \Illuminate\Auth\Access\Response|bool
+     */
     public function move(User $user, Card $card, Column $column)
     {
-        return $card->team->isMember($user)
+        $baseCondition = $card->team->isMember($user)
             && $column->team->is($card->team);
+
+        return $baseCondition
+            && app(KanbanService::class)->canMoveCardToColumn($card, $column);
     }
 
     /**

app/Policies/ColumnPolicy.php

@@ -4,6 +4,7 @@
 
 use App\Models\Board;
 use App\Models\Column;
+use App\Models\ColumnType;
 use App\Models\User;
 use Illuminate\Auth\Access\HandlesAuthorization;
 
@@ -68,6 +69,7 @@ public function update(User $user, Column $column)
      */
     public function delete(User $user, Column $column)
     {
-        return $column->team->isMember($user);
+        return $column->team->isMember($user)
+            && $column->column_type_id == ColumnType::NONE;
     }
 }