Cleanup backend methods

Signed-off-by: Julius Härtl <jus@bitgrid.net>

lib/Controller/OverviewApiController.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * @copyright Copyright (c) 2020 Jakob Röhrl <jakob.roehrl@web.de>
  *
@@ -23,36 +26,36 @@
 
 namespace OCA\Deck\Controller;
 
-
+use OCA\Deck\Service\OverviewService;
-use OCA\Deck\Service\DashboardService;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
 use OCP\IRequest;
-use OCP\AppFramework\Controller;
 
-class DashboardApiController extends OCSController {
+class OverviewApiController extends OCSController {
+
+	/** @var OverviewService */
+	private $dashboardService;
+
+	/** @var string */
 	private $userId;
-	private $cardService;
 
-	public function __construct($appName, IRequest $request, DashboardService $dashboardService, $userId) {
+	public function __construct($appName, IRequest $request, OverviewService $dashboardService, $userId) {
 		parent::__construct($appName, $request);
-		$this->userId = $userId;
 		$this->dashboardService = $dashboardService;
+		$this->userId = $userId;
 	}
 
 	/**
 	 * @NoAdminRequired
-	 * @return DataResponse
 	 */
-	public function findAllWithDue($userId) {
+	public function findAllWithDue(): DataResponse {
-		return new DataResponse($this->dashboardService->findAllWithDue($userId));
+		return new DataResponse($this->dashboardService->findAllWithDue($this->userId));
 	}
 
 	/**
 	 * @NoAdminRequired
-	 * @return DataResponse
 	 */
-	public function findAssignedCards($userId) {
+	public function findAssignedCards(): DataResponse {
-		return new DataResponse($this->dashboardService->findAssignedCards($userId));
+		return new DataResponse($this->dashboardService->findAssignedCards($this->userId));
 	}
 }

lib/Service/OverviewService.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
  *
@@ -27,6 +30,7 @@ namespace OCA\Deck\Service;
 use OCA\Deck\Activity\ChangeSet;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\Card;
 use OCA\Deck\Db\IPermissionMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\Label;
@@ -34,6 +38,7 @@ use OCA\Deck\Db\Stack;
 use OCA\Deck\NoPermissionException;
 use OCA\Deck\Notification\NotificationHelper;
 use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\Comments\ICommentsManager;
 use OCP\IGroupManager;
 use OCA\Deck\Db\Board;
 use OCA\Deck\Db\BoardMapper;
@@ -43,16 +48,24 @@ use OCA\Deck\BadRequestException;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
-class DashboardService {
+class OverviewService {
+
+	/** @var BoardMapper */
 	private $boardMapper;
+	/** @var LabelMapper */
 	private $labelMapper;
+	/** @var CardMapper */
 	private $cardMapper;
+	/** @var AssignedUsersMapper */
 	private $assignedUsersMapper;
+	/** @var IUserManager */
 	private $userManager;
+	/** @var IGroupManager */
 	private $groupManager;
-	private $userId;
+	/** @var ICommentsManager */
-	/** @var EventDispatcherInterface */
+	private $commentsManager;
-	private $eventDispatcher;
+	/** @var AttachmentService */
+	private $attachmentService;
 
 	public function __construct(
 		BoardMapper $boardMapper,
@@ -61,8 +74,8 @@ class DashboardService {
 		AssignedUsersMapper $assignedUsersMapper,
 		IUserManager $userManager,
 		IGroupManager $groupManager,
-		EventDispatcherInterface $eventDispatcher,
+		ICommentsManager $commentsManager,
-		$userId
+		AttachmentService $attachmentService
 	) {
 		$this->boardMapper = $boardMapper;
 		$this->labelMapper = $labelMapper;
@@ -70,43 +83,33 @@ class DashboardService {
 		$this->assignedUsersMapper = $assignedUsersMapper;
 		$this->userManager = $userManager;
 		$this->groupManager = $groupManager;
-		$this->eventDispatcher = $eventDispatcher;
+		$this->commentsManager = $commentsManager;
-		$this->userId = $userId;
+		$this->attachmentService = $attachmentService;
 	}
 
-	public function enrich($card) {
+	public function enrich(Card $card, string $userId): void {
 		$cardId = $card->getId();
+
 		$this->cardMapper->mapOwner($card);
 		$card->setAssignedUsers($this->assignedUsersMapper->find($cardId));
 		$card->setLabels($this->labelMapper->findAssignedLabelsForCard($cardId));
-		//$card->setAttachmentCount($this->attachmentService->count($cardId));
+		$card->setAttachmentCount($this->attachmentService->count($cardId));
-		//$user = $this->userManager->get($this->userId);
+
-		//$lastRead = $this->commentsManager->getReadMark('deckCard', (string)$card->getId(), $user);
+		$user = $this->userManager->get($userId);
-		//$count = $this->commentsManager->getNumberOfCommentsForObject('deckCard', (string)$card->getId(), $lastRead);
+		if ($user !== null) {
-		//$card->setCommentsUnread($count);
+			$lastRead = $this->commentsManager->getReadMark('deckCard', (string)$card->getId(), $user);
+			$count = $this->commentsManager->getNumberOfCommentsForObject('deckCard', (string)$card->getId(), $lastRead);
+			$card->setCommentsUnread($count);
+		}
 	}
 
-	/**
+	public function findAllWithDue(string $userId): array {
-	 * Set a different user than the current one, e.g. when no user is available in occ
+		$userBoards = $this->findAllBoardsFromUser($userId);
-	 *
-	 * @param string $userId
-	 */
-	public function setUserId(string $userId): void {
-		$this->userId = $userId;
-	}
-
-	
-	/**
-	 * @return array
-	 */
-	public function findAllWithDue($userId) {
-		$userInfo = $this->getBoardPrerequisites();
-		$userBoards = $this->findAllBoardsFromUser($userInfo);
 		$allDueCards = [];
 		foreach ($userBoards as $userBoard) {
 			$service = $this;
-			$allDueCards[] = array_map(function ($card) use ($service, $userBoard) {
+			$allDueCards[] = array_map(static function ($card) use ($service, $userBoard, $userId) {
-				$service->enrich($card);
+				$service->enrich($card, $userId);
 				$cardData = $card->jsonSerialize();
 				$cardData['boardId'] = $userBoard->getId();
 				return $cardData;
@@ -115,47 +118,37 @@ class DashboardService {
 		return $allDueCards;
 	}
 
-	/**
+	public function findAssignedCards(string $userId): array {
-	 * @return array
+		$userBoards = $this->findAllBoardsFromUser($userId);
-	 */
-	public function findAssignedCards($userId) {
-		$userInfo = $this->getBoardPrerequisites();
-		$userBoards = $this->findAllBoardsFromUser($userInfo);
 		$allAssignedCards = [];
 		foreach ($userBoards as $userBoard) {
 			$service = $this;
-			$allAssignedCards[] = array_map(function ($card) use ($service, $userBoard) {
+			$allAssignedCards[] = array_map(static function ($card) use ($service, $userBoard, $userId) {
-				$service->enrich($card);
+				$service->enrich($card, $userId);
 				$cardData = $card->jsonSerialize();
 				$cardData['boardId'] = $userBoard->getId();
 				return $cardData;
-			}, $this->cardMapper->findAssignedCards($userBoard->getId(), $this->userId));
+			}, $this->cardMapper->findAssignedCards($userBoard->getId(), $userId));
 		}
 		return $allAssignedCards;
 	}
 
-	/**
+	// FIXME: This is duplicate code with the board service
-	 * @return array
+
-	 */
+	private function findAllBoardsFromUser(string $userId): array {
-	private function findAllBoardsFromUser($userInfo, $since = -1) {
+		$userInfo = $this->getBoardPrerequisites($userId);
-		$userBoards = $this->boardMapper->findAllByUser($userInfo['user'], null, null, $since);
+		$userBoards = $this->boardMapper->findAllByUser($userInfo['user'], null, null);
-		$groupBoards = $this->boardMapper->findAllByGroups($userInfo['user'], $userInfo['groups'],null, null,  $since);
+		$groupBoards = $this->boardMapper->findAllByGroups($userInfo['user'], $userInfo['groups'],null, null);
-		$circleBoards = $this->boardMapper->findAllByCircles($userInfo['user'], null, null,  $since);
+		$circleBoards = $this->boardMapper->findAllByCircles($userInfo['user'], null, null);
 		return array_merge($userBoards, $groupBoards, $circleBoards);
 	}
 
-	/**
+	private function getBoardPrerequisites($userId): array {
-	 * @return array
+		$user = $this->userManager->get($userId);
-	 */
+		$groups = $user !== null ? $this->groupManager->getUserGroupIds($user) : [];
-	private function getBoardPrerequisites() {
-		$groups = $this->groupManager->getUserGroupIds(
-			$this->userManager->get($this->userId)
-		);
 		return [
-			'user' => $this->userId,
+			'user' => $userId,
 			'groups' => $groups
 		];
 	}
-
-
 }

src/components/overview/Overview.vue

@@ -22,7 +22,7 @@
 
 <template>
 	<div>
-		<Controls :dashboard-name="filter" />
+		<Controls :dashboard-name="filterDisplayName" />
 
 		<div v-if="loading" key="loading" class="emptycontent">
 			<div class="icon icon-loading" />
@@ -31,82 +31,45 @@
 		</div>
 
 		<div v-else>
-			<div v-if="filter=='due'" class="dashboard">
+			<div v-if="isValidFilter" class="dashboard">
+				<div class="dashboard-column">
+					<h2>{{ t('deck', 'No due') }}</h2>
+					<div v-for="card in cardsByDueDate.nodue" :key="card.id">
+						<CardItem :id="card.id" />
+					</div>
+				</div>
+
 				<div class="dashboard-column">
 					<h2>{{ t('deck', 'Overdue') }}</h2>
-					<div v-for="card in withDueDashboardGroup.overdue" :key="card.id">
+					<div v-for="card in cardsByDueDate.overdue" :key="card.id">
 						<CardItem :id="card.id" />
 					</div>
 				</div>
 
 				<div class="dashboard-column">
 					<h2>{{ t('deck', 'Today') }}</h2>
-					<div v-for="card in withDueDashboardGroup.today" :key="card.id">
+					<div v-for="card in cardsByDueDate.today" :key="card.id">
 						<CardItem :id="card.id" />
 					</div>
 				</div>
 
 				<div class="dashboard-column">
 					<h2>{{ t('deck', 'Tomorrow') }}</h2>
-					<div v-for="card in withDueDashboardGroup.tomorrow" :key="card.id">
+					<div v-for="card in cardsByDueDate.tomorrow" :key="card.id">
 						<CardItem :id="card.id" />
 					</div>
 				</div>
 
 				<div class="dashboard-column">
 					<h2>{{ t('deck', 'This week') }}</h2>
-					<div v-for="card in withDueDashboardGroup.later" :key="card.id">
+					<div v-for="card in cardsByDueDate.thisWeek" :key="card.id">
 						<CardItem :id="card.id" />
 					</div>
 				</div>
 
 				<div class="dashboard-column">
 					<h2>{{ t('deck', 'Later') }}</h2>
-					<div v-for="card in withDueDashboardGroup.thisWeek" :key="card.id">
+					<div v-for="card in cardsByDueDate.later" :key="card.id">
-						<CardItem :id="card.id" />
-					</div>
-				</div>
-			</div>
-
-			<div v-if="filter=='assigned'" class="dashboard">
-				<div class="dashboard-column">
-					<h2>{{ t('deck', 'no due') }}</h2>
-					<div v-for="card in assignedCardsDashboardGroup.nodue" :key="card.id">
-						<CardItem :id="card.id" />
-					</div>
-				</div>
-
-				<div class="dashboard-column">
-					<h2>{{ t('deck', 'overdue') }}</h2>
-					<div v-for="card in assignedCardsDashboardGroup.overdue" :key="card.id">
-						<CardItem :id="card.id" />
-					</div>
-				</div>
-
-				<div class="dashboard-column">
-					<h2>{{ t('deck', 'today') }}</h2>
-					<div v-for="card in assignedCardsDashboardGroup.today" :key="card.id">
-						<CardItem :id="card.id" />
-					</div>
-				</div>
-
-				<div class="dashboard-column">
-					<h2>{{ t('deck', 'tomorrow') }}</h2>
-					<div v-for="card in assignedCardsDashboardGroup.tomorrow" :key="card.id">
-						<CardItem :id="card.id" />
-					</div>
-				</div>
-
-				<div class="dashboard-column">
-					<h2>{{ t('deck', 'this week') }}</h2>
-					<div v-for="card in assignedCardsDashboardGroup.thisWeek" :key="card.id">
-						<CardItem :id="card.id" />
-					</div>
-				</div>
-
-				<div class="dashboard-column">
-					<h2>{{ t('deck', 'later') }}</h2>
-					<div v-for="card in withDueDashboardGroup.later" :key="card.id">
 						<CardItem :id="card.id" />
 					</div>
 				</div>
@@ -122,6 +85,14 @@ import CardItem from '../cards/CardItem'
 import { mapGetters } from 'vuex'
 import moment from '@nextcloud/moment'
 
+const FILTER_DUE = 'due'
+const FILTER_ASSIGNED = 'assigned'
+
+const SUPPORTED_FILTERS = [
+	FILTER_ASSIGNED,
+	FILTER_DUE
+]
+
 export default {
 	name: 'Dashboards',
 	components: {
@@ -140,15 +111,30 @@ export default {
 		}
 	},
 	computed: {
+		isValidFilter() {
+			return SUPPORTED_FILTERS.indexOf(this.filter) > -1
+		},
+		filterDisplayName() {
+			switch (this.filter) {
+			case 'assigned':
+				return t('deck', 'My assigned cards')
+			default:
+				return ''
+			}
+		},
 		...mapGetters([
 			'withDueDashboard',
 			'assignedCardsDashboard',
 		]),
-		withDueDashboardGroup() {
+		cardsByDueDate() {
-			return this.groupByDue(this.withDueDashboard)
+			switch (this.filter) {
-		},
+			case FILTER_ASSIGNED:
-		assignedCardsDashboardGroup() {
 				return this.groupByDue(this.assignedCardsDashboard)
+			case FILTER_DUE:
+				return this.groupByDue(this.withDueDashboard)
+			default:
+				return null
+			}
 		},
 	},
 	watch: {