Jingga/oms-Kanban
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Kanban.git synced 2026-02-16 20:28:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Implement more unit tests

Browse Source
This commit is contained in:
Dennis Eichhorn 2018-12-25 16:17:50 +01:00
parent 65b9e806e1
commit 1cea44a4ba
1 changed files with 114 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
Controller/ApiController.php
View File

@ -14,6 +14,7 @@ declare(strict_types=1);
namespace Modules\Kanban\Controller; namespace Modules\Kanban\Controller;
use Modules\Kanban\Models\BoardStatus;
use Modules\Kanban\Models\CardStatus; use Modules\Kanban\Models\CardStatus;
use Modules\Kanban\Models\CardType; use Modules\Kanban\Models\CardType;
use Modules\Kanban\Models\KanbanBoard; use Modules\Kanban\Models\KanbanBoard;
@ -26,13 +27,16 @@ use Modules\Kanban\Models\KanbanColumnMapper;
use Modules\Kanban\Models\KanbanLabel; use Modules\Kanban\Models\KanbanLabel;
use Modules\Kanban\Models\KanbanLabelMapper; use Modules\Kanban\Models\KanbanLabelMapper;
use Modules\Kanban\Models\PermissionState; use Modules\Kanban\Models\PermissionState;
use phpOMS\Account\PermissionType; use phpOMS\Account\PermissionType;
use phpOMS\Message\Http\RequestStatusCode; use phpOMS\Message\Http\RequestStatusCode;
use phpOMS\Message\RequestAbstract; use phpOMS\Message\RequestAbstract;
use phpOMS\Message\ResponseAbstract; use phpOMS\Message\ResponseAbstract;
use phpOMS\Message\NotificationLevel;
use phpOMS\Model\Message\FormValidation;
/** /**
* Task class. * Kanban controller class.
* *
* @package Modules\Kanban * @package Modules\Kanban
* @license OMS License 1.0 * @license OMS License 1.0
@ -41,6 +45,17 @@ use phpOMS\Message\ResponseAbstract;
*/ */
final class ApiController extends Controller final class ApiController extends Controller
{ {
/**
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
public function apiKanbanCardCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiKanbanCardCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
if (!empty($val = $this->validateKanbanCardCreate($request))) { if (!empty($val = $this->validateKanbanCardCreate($request))) {
@ -50,43 +65,55 @@ final class ApiController extends Controller
} }
$card = $this->createKanbanCardFromRquest($request); $card = $this->createKanbanCardFromRquest($request);
KanbanCardMapper::create($card); $this->createModel($request, $card, KanbanCardMapper::class, 'card');
$response->set('card', $card->jsonSerialize()); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Card', 'Card successfully created.', $card);
} }
/**
* Method to create card from request.
*
* @param RequestAbstract $request Request
*
* @return KanbanCard
*
* @since 1.0.0
*/
public function createKanbanCardFromRquest(RequestAbstract $request) : KanbanCard public function createKanbanCardFromRquest(RequestAbstract $request) : KanbanCard
{ {
$mardkownParser = new Markdown();
$card = new KanbanCard(); $card = new KanbanCard();
$card->setName((string) ($request->getData('title'))); $card->setName((string) ($request->getData('title')));
$card->setDescription((string) ($request->getData('plain'))); $card->setDescription((string) ($request->getData('plain') ?? ''));
$card->setColumn((int) $request->getData('column')); $card->setColumn((int) $request->getData('column'));
$card->setOrder((int) $request->getData('order')); $card->setOrder((int) ($request->getData('order') ?? 1));
$card->setRef((int) $request->getData('ref')); $card->setRef((int) ($request->getData('ref') ?? 0));
$card->setLabels((array) $request->getData('labels')); $card->setStatus((int) ($request->getData('status') ?? CardStatus::ACTIVE));
$card->setStatus((int) $request->getData('status')); $card->setType((int) ($request->getData('type') ?? CardType::TEXT));
$card->setType((int) $request->getData('type')); $card->setCreatedBy($request->getHeader()->getAccount());
return $card; return $card;
} }
/**
* Validate card create request
*
* @param RequestAbstract $request Request
*
* @return array<string, bool>
*
* @since 1.0.0
*/
private function validateKanbanCardCreate(RequestAbstract $request) : array private function validateKanbanCardCreate(RequestAbstract $request) : array
{ {
$val = []; $val = [];
if (($val['title'] = empty($request->getData('title'))) if (($val['title'] = empty($request->getData('title')))
|| ($val['plain'] = empty($request->getData('plain')))
|| ($val['column'] = empty($request->getData('column'))) || ($val['column'] = empty($request->getData('column')))
|| ($val['order'] = empty($request->getData('order')))
|| ($val['ref'] = empty($request->getData('ref')))
|| ($val['labels'] = empty($request->getData('labels')))
|| ($val['status'] = ( || ($val['status'] = (
$request->getData('status') !== null $request->getData('status') !== null
&& !CardStatus::isValidValue((int) $request->getData('status')) && !CardStatus::isValidValue((int) $request->getData('status'))
)) ))
|| ($val['type'] = ( || ($val['type'] = (
$request->getData('type') === null $request->getData('type') !== null
|| !CardType::isValidValue((int) $request->getData('type')) && !CardType::isValidValue((int) $request->getData('type'))
)) ))
) { ) {
return $val; return $val;
@ -95,6 +122,17 @@ final class ApiController extends Controller
return []; return [];
} }
/**
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
public function apiKanbanBoardCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiKanbanBoardCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
if (!empty($val = $this->validateKanbanBoardCreate($request))) { if (!empty($val = $this->validateKanbanBoardCreate($request))) {
@ -104,29 +142,44 @@ final class ApiController extends Controller
} }
$board = $this->createKanbanBoardFromRquest($request); $board = $this->createKanbanBoardFromRquest($request);
KanbanBoardMapper::create($board); $this->createModel($request, $board, KanbanBoardMapper::class, 'board');
$response->set('board', $board->jsonSerialize()); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Board', 'Board successfully created.', $board);
} }
/**
* Method to create board from request.
*
* @param RequestAbstract $request Request
*
* @return KanbanBoard
*
* @since 1.0.0
*/
public function createKanbanBoardFromRquest(RequestAbstract $request) : KanbanBoard public function createKanbanBoardFromRquest(RequestAbstract $request) : KanbanBoard
{ {
$mardkownParser = new Markdown();
$board = new KanbanBoard(); $board = new KanbanBoard();
$board->setName((string) $request->getData('title')); $board->setName((string) $request->getData('title'));
$board->setDescription((string) $request->getData('plain')); $board->setDescription((string) ($request->getData('plain') ?? ''));
$board->setOrder((int) $request->getData('order')); $board->setOrder((int) ($request->getData('order') ?? 1));
$board->setStatus((int) $request->getData('status')); $board->setStatus((int) ($request->getData('status') ?? BoardStatus::ACTIVE));
$board->setCreatedBy($request->getHeader()->getAccount());
return $board; return $board;
} }
/**
* Validate board create request
*
* @param RequestAbstract $request Request
*
* @return array<string, bool>
*
* @since 1.0.0
*/
private function validateKanbanBoardCreate(RequestAbstract $request) : array private function validateKanbanBoardCreate(RequestAbstract $request) : array
{ {
$val = []; $val = [];
if (($val['title'] = empty($request->getData('title'))) if (($val['title'] = empty($request->getData('title')))
|| ($val['plain'] = empty($request->getData('plain')))
|| ($val['order'] = empty($request->getData('order')))
|| ($val['status'] = ( || ($val['status'] = (
$request->getData('status') !== null $request->getData('status') !== null
&& !CardStatus::isValidValue((int) $request->getData('status')) && !CardStatus::isValidValue((int) $request->getData('status'))
@ -138,6 +191,17 @@ final class ApiController extends Controller
return []; return [];
} }
/**
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $data Generic data
*
* @return void
*
* @api
*
* @since 1.0.0
*/
public function apiKanbanColumnCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiKanbanColumnCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
if (!empty($val = $this->validateKanbanColumnCreate($request))) { if (!empty($val = $this->validateKanbanColumnCreate($request))) {
@ -147,72 +211,43 @@ final class ApiController extends Controller
} }
$column = $this->createKanbanColumnFromRquest($request); $column = $this->createKanbanColumnFromRquest($request);
KanbanColumnMapper::create($column); $this->createModel($request, $column, KanbanColumnMapper::class, 'column');
$response->set('column', $column->jsonSerialize()); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Column', 'Column successfully created.', $column);
} }
/**
* Method to create column from request.
*
* @param RequestAbstract $request Request
*
* @return KanbanColumn
*
* @since 1.0.0
*/
public function createKanbanColumnFromRquest(RequestAbstract $request) : KanbanColumn public function createKanbanColumnFromRquest(RequestAbstract $request) : KanbanColumn
{ {
$mardkownParser = new Markdown();
$column = new KanbanColumn(); $column = new KanbanColumn();
$column->setName((string) $request->getData('title')); $column->setName((string) $request->getData('title'));
$column->setOrder((int) $request->getData('order')); $column->setBoard((int) $request->getData('board'));
$column->setOrder((int) ($request->getData('order') ?? 1));
return $column; return $column;
} }
/**
* Validate column create request
*
* @param RequestAbstract $request Request
*
* @return array<string, bool>
*
* @since 1.0.0
*/
private function validateKanbanColumnCreate(RequestAbstract $request) : array private function validateKanbanColumnCreate(RequestAbstract $request) : array
{ {
$val = []; $val = [];
if (($val['title'] = empty($request->getData('title'))) if (($val['title'] = empty($request->getData('title'))
|| ($val['order'] = empty($request->getData('order'))) || ($val['board'] = empty($request->getData('board'))))
) {
return $val;
}
return [];
}
public function apiKanbanLabelCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{
$account = $this->app->accountManager->get($request->getHeader()->getAccount());
if (!$account->hasPermission(PermissionType::CREATE, $this->app->orgId, $this->app->appName, self::MODULE_NAME, PermissionState::BOARD)
&& !$account->hasPermission(PermissionType::CREATE, $this->app->orgId, $this->app->appName, self::MODULE_NAME, PermissionState::LABEL)
) {
$response->set('kanban_label_create', null);
$response->getHeader()->setStatusCode(RequestStatusCode::R_403);
return;
}
if (!empty($val = $this->validateKanbanLabelCreate($request))) {
$response->set('kanban_label_create', new FormValidation($val));
return;
}
$label = $this->createKanbanLabelFromRquest($request);
KanbanLabelMapper::create($label);
$response->set('label', $label->jsonSerialize());
}
public function createKanbanLabelFromRquest(RequestAbstract $request) : KanbanLabel
{
$label = new KanbanLabel();
$label->setName($request->getData('title'));
$label->setBoard((int) $request->getData('board'));
$label->setcolor((int) $request->getData('color'));
return $label;
}
private function validateKanbanLabelCreate(RequestAbstract $request) : array
{
$val = [];
if (($val['title'] = empty($request->getData('title')))
|| ($val['board'] = empty($request->getData('board')))
|| ($val['color'] = empty($request->getData('color')))
) { ) {
return $val; return $val;
} }