Merge pull request #3782 from nextcloud/enh/backend_serialization_models

Add CardDetail serialization model

lib/Command/UserExport.php

@@ -27,6 +27,7 @@ use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\StackMapper;
+use OCA\Deck\Model\CardDetails;
 use OCA\Deck\Service\BoardService;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\MultipleObjectsReturnedException;
@@ -101,7 +102,9 @@ class UserExport extends Command {
 					$fullCard = $this->cardMapper->find($card->getId());
 					$assignedUsers = $this->assignedUsersMapper->findAll($card->getId());
 					$fullCard->setAssignedUsers($assignedUsers);
-					$data[$board->getId()]['stacks'][$stack->getId()]['cards'][] = (array)$fullCard->jsonSerialize();
+
+					$cardDetails = new CardDetails($fullCard, $fullBoard);
+					$data[$board->getId()]['stacks'][$stack->getId()]['cards'][] = $cardDetails->jsonSerialize();
 				}
 			}
 		}

lib/Controller/SearchController.php

@@ -27,6 +27,7 @@ declare(strict_types=1);
 namespace OCA\Deck\Controller;
 
 use OCA\Deck\Db\Card;
+use OCA\Deck\Model\CardDetails;
 use OCA\Deck\Service\SearchService;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
@@ -50,9 +51,12 @@ class SearchController extends OCSController {
 	public function search(string $term, ?int $limit = null, ?int $cursor = null): DataResponse {
 		$cards = $this->searchService->searchCards($term, $limit, $cursor);
 		return new DataResponse(array_map(function (Card $card) {
-			$json = $card->jsonSerialize();
+			$board = $card->getRelatedBoard();
+			$json = (new CardDetails($card, $board))->jsonSerialize();
+
+			$json['relatedBoard'] = $board;
 			$json['relatedStack'] = $card->getRelatedStack();
-			$json['relatedBoard'] = $card->getRelatedBoard();
+
 			return $json;
 		}, $cards));
 	}

lib/Db/Board.php

@@ -23,6 +23,14 @@
 
 namespace OCA\Deck\Db;
 
+/**
+ * @method int getId()
+ * @method string getTitle()
+ * @method int getShared()
+ * @method bool getArchived()
+ * @method int getDeletedAt()
+ * @method int getLastModified()
+ */
 class Board extends RelationalEntity {
 	protected $title;
 	protected $owner;

lib/Db/Card.php

@@ -27,6 +27,44 @@ use DateTime;
 use DateTimeZone;
 use Sabre\VObject\Component\VCalendar;
 
+/**
+ * @method string getTitle()
+ * @method string getDescription()
+ * @method string getDescriptionPrev()
+ * @method int getStackId()
+ * @method int getOrder()
+ * @method int getLastModified()
+ * @method int getCreatedAt()
+ * @method bool getArchived()
+ * @method bool getNotified()
+ *
+ * @method void setLabels(Label[] $labels)
+ * @method null|Label[] getLabels()
+ *
+ * @method void setAssignedUsers(Assignment[] $users)
+ * @method null|User[] getAssignedUsers()
+ *
+ * @method void setAttachments(Attachment[] $attachments)
+ * @method null|Attachment[] getAttachments()
+ *
+ * @method void setAttachmentCount(int $count)
+ * @method null|int getAttachmentCount()
+ *
+ * @method void setCommentsUnread(int $count)
+ * @method null|int getCommentsUnread()
+ *
+ * @method void setCommentsCount(int $count)
+ * @method null|int getCommentsCount()
+ *
+ * @method void setOwner(string $user)
+ * @method null|string getOwner()
+ *
+ * @method void setRelatedStack(Stack $stack)
+ * @method null|Stack getRelatedStack()
+ *
+ * @method void setRelatedBoard(Board $board)
+ * @method null|Board getRelatedBoard()
+ */
 class Card extends RelationalEntity {
 	public const TITLE_MAX_LENGTH = 255;
 
@@ -70,6 +108,7 @@ class Card extends RelationalEntity {
 		$this->addType('archived', 'boolean');
 		$this->addType('notified', 'boolean');
 		$this->addType('deletedAt', 'integer');
+		$this->addType('duedate', 'string');
 		$this->addRelation('labels');
 		$this->addRelation('assignedUsers');
 		$this->addRelation('attachments');
@@ -87,48 +126,18 @@ class Card extends RelationalEntity {
 		$this->databaseType = $type;
 	}
 
-	public function getDuedate($isoFormat = false) {
-		if ($this->duedate === null) {
-			return null;
-		}
-		$dt = new DateTime($this->duedate);
-		if (!$isoFormat && $this->databaseType === 'mysql') {
-			return $dt->format('Y-m-d H:i:s');
-		}
-		return $dt->format('c');
+	public function getDueDateTime(): ?DateTime {
+		return $this->duedate ? new DateTime($this->duedate) : null;
 	}
 
-	public function jsonSerialize(): array {
-		$json = parent::jsonSerialize();
-		$json['overdue'] = self::DUEDATE_FUTURE;
-		$due = $this->duedate ? strtotime($this->duedate) : false;
-		if ($due !== false) {
-			$today = new DateTime();
-			$today->setTime(0, 0);
-
-			$match_date = new DateTime($this->duedate);
-
-			$match_date->setTime(0, 0);
-
-			$diff = $today->diff($match_date);
-			$diffDays = (integer) $diff->format('%R%a'); // Extract days count in interval
-
-			if ($diffDays === 1) {
-				$json['overdue'] = self::DUEDATE_NEXT;
-			}
-			if ($diffDays === 0) {
-				$json['overdue'] = self::DUEDATE_NOW;
-			}
-			if ($diffDays < 0) {
-				$json['overdue'] = self::DUEDATE_OVERDUE;
-			}
+	public function getDuedate($isoFormat = false): ?string {
+		$dt = $this->getDueDateTime();
+		$format = 'c';
+		if (!$isoFormat && $this->databaseType === 'mysql') {
+			$format = 'Y-m-d H:i:s';
 		}
-		$json['duedate'] = $this->getDuedate(true);
-		unset($json['notified']);
-		unset($json['descriptionPrev']);
-		unset($json['relatedStack']);
-		unset($json['relatedBoard']);
-		return $json;
+
+		return $dt ? $dt->format($format) : null;
 	}
 
 	public function getCalendarObject(): VCalendar {

lib/Db/CardMapper.php

@@ -226,6 +226,21 @@ class CardMapper extends QBMapper implements IPermissionMapper {
 		return $this->findEntities($qb);
 	}
 
+	public function findAllByBoardId(int $boardId, ?int $limit = null, ?int $offset = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('c.*')
+			->from('deck_cards', 'c')
+			->innerJoin('c', 'deck_stacks', 's', 's.id = c.stack_id')
+			->innerJoin('s', 'deck_boards', 'b', 'b.id = s.board_id')
+			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('archived', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
+			->setMaxResults($limit)
+			->setFirstResult($offset)
+			->orderBy('c.lastmodified')
+			->addOrderBy('c.id');
+		return $this->findEntities($qb);
+	}
+
 	public function findAllWithDue($boardId) {
 		$qb = $this->db->getQueryBuilder();
 		$qb->select('c.*')

lib/Model/BoardSummary.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Raul Ferreira Fuentes <raul@nextcloud.com>
+ *
+ * @author Raul Ferreira Fuentes <raul@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ *  published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\Deck\Model;
+
+use OCA\Deck\Db\Board;
+
+class BoardSummary extends Board {
+	private Board $board;
+
+	public function __construct(Board $board) {
+		parent::__construct();
+		$this->board = $board;
+	}
+
+	public function jsonSerialize(): array {
+		return [
+			'id' => $this->getId(),
+			'title' => $this->getTitle()
+		];
+	}
+
+	public function __call($name, $arguments) {
+		return $this->board->__call($name, $arguments);
+	}
+}

lib/Model/CardDetails.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Raul Ferreira Fuentes <raul@nextcloud.com>
+ *
+ * @author Raul Ferreira Fuentes <raul@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ *  published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\Deck\Model;
+
+use DateTime;
+use OCA\Deck\Db\Board;
+use OCA\Deck\Db\Card;
+
+class CardDetails extends Card {
+	private Card $card;
+	private ?Board $board;
+
+	public function __construct(Card $card, ?Board $board = null) {
+		parent::__construct();
+		$this->card = $card;
+		$this->board = $board;
+	}
+
+	public function setBoard(?Board $board): void {
+		$this->board = $board;
+	}
+
+	public function jsonSerialize(array $extras = []): array {
+		$array = $this->card->jsonSerialize();
+		unset($array['notified'], $array['descriptionPrev'], $array['relatedStack'], $array['relatedBoard']);
+
+		$array['overdue'] = $this->getDueStatus();
+		$this->appendBoardDetails($array);
+
+		return $array;
+	}
+
+	private function getDueStatus(): int {
+		$today = new DateTime();
+		$today->setTime(0, 0);
+
+		$match_date = $this->card->getDueDateTime();
+		if (!$match_date) {
+			return Card::DUEDATE_FUTURE;
+		}
+		$match_date->setTime(0, 0);
+
+		$diff = $today->diff($match_date);
+		$diffDays = (int) $diff->format('%R%a'); // Extract days count in interval
+
+
+		if ($diffDays === 1) {
+			return Card::DUEDATE_NEXT;
+		}
+		if ($diffDays === 0) {
+			return Card::DUEDATE_NOW;
+		}
+		if ($diffDays < 0) {
+			return Card::DUEDATE_OVERDUE;
+		}
+
+		return Card::DUEDATE_FUTURE;
+	}
+
+	private function appendBoardDetails(&$array): void {
+		if (!$this->board) {
+			return;
+		}
+
+		$array['boardId'] = $this->board->id;
+		$array['board'] = (new BoardSummary($this->board))->jsonSerialize();
+	}
+
+	public function __call($name, $arguments) {
+		return $this->card->__call($name, $arguments);
+	}
+}

lib/Service/OverviewService.php

@@ -30,9 +30,9 @@ namespace OCA\Deck\Service;
 use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\Card;
 use OCA\Deck\Db\CardMapper;
+use OCA\Deck\Model\CardDetails;
 use OCP\Comments\ICommentsManager;
 use OCP\IGroupManager;
-use OCA\Deck\Db\Board;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\LabelMapper;
 use OCP\IUserManager;
@@ -96,42 +96,35 @@ class OverviewService {
 		$userBoards = $this->findAllBoardsFromUser($userId);
 		$allDueCards = [];
 		foreach ($userBoards as $userBoard) {
-			$service = $this;
-			$allDueCards[] = array_map(static function ($card) use ($service, $userBoard, $userId) {
-				$service->enrich($card, $userId);
-				$cardData = $card->jsonSerialize();
-				$cardData['boardId'] = $userBoard->getId();
-				return $cardData;
+			$allDueCards[] = array_map(function ($card) use ($userBoard, $userId) {
+				$this->enrich($card, $userId);
+				return (new CardDetails($card, $userBoard))->jsonSerialize();
 			}, $this->cardMapper->findAllWithDue($userBoard->getId()));
 		}
-		return $allDueCards;
+		return array_merge(...$allDueCards);
 	}
 
 	public function findUpcomingCards(string $userId): array {
 		$userBoards = $this->findAllBoardsFromUser($userId);
-		$findCards = [];
+		$foundCards = [];
 		foreach ($userBoards as $userBoard) {
-			$service = $this;
-
 			if (count($userBoard->getAcl()) === 0) {
 				// private board: get cards with due date
-				$findCards[] = array_map(static function ($card) use ($service, $userBoard, $userId) {
-					$service->enrich($card, $userId);
-					$cardData = $card->jsonSerialize();
-					$cardData['boardId'] = $userBoard->getId();
-					return $cardData;
-				}, $this->cardMapper->findAllWithDue($userBoard->getId()));
+				$cards = $this->cardMapper->findAllWithDue($userBoard->getId());
 			} else {
 				// shared board: get all my assigned or unassigned cards
-				$findCards[] = array_map(static function ($card) use ($service, $userBoard, $userId) {
-					$service->enrich($card, $userId);
-					$cardData = $card->jsonSerialize();
-					$cardData['boardId'] = $userBoard->getId();
-					return $cardData;
-				}, $this->cardMapper->findToMeOrNotAssignedCards($userBoard->getId(), $userId));
+				$cards = $this->cardMapper->findToMeOrNotAssignedCards($userBoard->getId(), $userId);
 			}
+
+			$foundCards[] = array_map(
+				function (Card $card) use ($userBoard, $userId) {
+					$this->enrich($card, $userId);
+					return (new CardDetails($card, $userBoard))->jsonSerialize();
+				},
+				$cards
+			);
 		}
-		return $findCards;
+		return array_merge(...$foundCards);
 	}
 
 	// FIXME: This is duplicate code with the board service

lib/Service/StackService.php

@@ -30,11 +30,13 @@ use OCA\Deck\BadRequestException;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
+use OCA\Deck\Db\Card;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\ChangeHelper;
 use OCA\Deck\Db\LabelMapper;
 use OCA\Deck\Db\Stack;
 use OCA\Deck\Db\StackMapper;
+use OCA\Deck\Model\CardDetails;
 use OCA\Deck\NoPermissionException;
 use OCA\Deck\StatusException;
 
@@ -84,9 +86,13 @@ class StackService {
 			return;
 		}
 
-		foreach ($cards as $card) {
-			$this->cardService->enrich($card);
-		}
+		$cards = array_map(
+			function (Card $card): CardDetails {
+				$this->cardService->enrich($card);
+				return new CardDetails($card);
+			},
+			$cards
+		);
 
 		$stack->setCards($cards);
 	}
@@ -112,12 +118,18 @@ class StackService {
 
 		$this->permissionService->checkPermission($this->stackMapper, $stackId, Acl::PERMISSION_READ);
 		$stack = $this->stackMapper->find($stackId);
-		$cards = $this->cardMapper->findAll($stackId);
-		foreach ($cards as $cardIndex => $card) {
-			$assignedUsers = $this->assignedUsersMapper->findAll($card->getId());
-			$card->setAssignedUsers($assignedUsers);
-			$card->setAttachmentCount($this->attachmentService->count($card->getId()));
-		}
+
+		$cards = array_map(
+			function (Card $card): CardDetails {
+				$assignedUsers = $this->assignedUsersMapper->findAll($card->getId());
+				$card->setAssignedUsers($assignedUsers);
+				$card->setAttachmentCount($this->attachmentService->count($card->getId()));
+
+				return new CardDetails($card);
+			},
+			$this->cardMapper->findAll($stackId)
+		);
+
 		$stack->setCards($cards);
 
 		return $stack;

tests/unit/Db/CardTest.php

@@ -25,6 +25,7 @@ namespace OCA\Deck\Db;
 
 use DateInterval;
 use DateTime;
+use OCA\Deck\Model\CardDetails;
 use Test\TestCase;
 
 class CardTest extends TestCase {
@@ -59,7 +60,7 @@ class CardTest extends TestCase {
 	public function testDuedate(DateTime $duedate, $state) {
 		$card = $this->createCard();
 		$card->setDuedate($duedate->format('Y-m-d H:i:s'));
-		$this->assertEquals($state, $card->jsonSerialize()['overdue']);
+		$this->assertEquals($state, (new CardDetails($card))->jsonSerialize()['overdue']);
 	}
 
 	public function testJsonSerialize() {
@@ -86,7 +87,7 @@ class CardTest extends TestCase {
 			'commentsCount' => 0,
 			'lastEditor' => null,
 			'ETag' => $card->getETag(),
-		], $card->jsonSerialize());
+		], (new CardDetails($card))->jsonSerialize());
 	}
 	public function testJsonSerializeLabels() {
 		$card = $this->createCard();
@@ -113,7 +114,7 @@ class CardTest extends TestCase {
 			'commentsCount' => 0,
 			'lastEditor' => null,
 			'ETag' => $card->getETag(),
-		], $card->jsonSerialize());
+		], (new CardDetails($card))->jsonSerialize());
 	}
 
 	public function testMysqlDateFallback() {
@@ -150,6 +151,6 @@ class CardTest extends TestCase {
 			'commentsCount' => 0,
 			'lastEditor' => null,
 			'ETag' => $card->getETag(),
-		], $card->jsonSerialize());
+		], (new CardDetails($card))->jsonSerialize());
 	}
 }