TickManager::__construct() - Code Metrics - Inspection of "introduce event scheduling and entity locks" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev ( eeaa0f...91a85a )

by Janko

created 2024-08-12 06:13 UTC

TickManager::__construct() A

↳ Parent: TickManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	11
dl	0
loc	14
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

How to fix Many Parameters

<?php

namespace Stu\Module\Tick;

use Override;
filter:
    dependency_paths: ["lib/*"]
use RuntimeException;
use Stu\Component\Building\BuildingEnum;
filter:
    dependency_paths: ["lib/*"]
use Stu\Component\Colony\ColonyFunctionManagerInterface;
use Stu\Component\Event\EventManagerInterface;
use Stu\Component\Event\EventTypeEnum;
use Stu\Component\Event\Payload\PayloadWithIdAndTurn;
use Stu\Component\Event\Payload\PayloadWithTurn;
use Stu\Component\Game\TimeConstants;
filter:
    dependency_paths: ["lib/*"]
use Stu\Module\Logging\LoggerUtilFactoryInterface;
use Stu\Module\Logging\LoggerUtilInterface;
use Stu\Module\PlayerSetting\Lib\UserEnum;
filter:
    dependency_paths: ["lib/*"]
use Stu\Orm\Entity\GameTurnInterface;
use Stu\Orm\Entity\UserInterface;
use Stu\Orm\Repository\AnomalyRepositoryInterface;
use Stu\Orm\Repository\ColonyShipRepairRepositoryInterface;
use Stu\Orm\Repository\GameTurnRepositoryInterface;
use Stu\Orm\Repository\GameTurnStatsRepositoryInterface;
use Stu\Orm\Repository\KnPostRepositoryInterface;
use Stu\Orm\Repository\PlanetFieldRepositoryInterface;
use Stu\Orm\Repository\UserLockRepositoryInterface;
use Stu\Orm\Repository\UserRepositoryInterface;

final class TickManager implements TickManagerInterface
{
    private LoggerUtilInterface $loggerUtil;

    public function __construct(
        private GameTurnRepositoryInterface $gameTurnRepository,
        private UserLockRepositoryInterface $userLockRepository,
        private GameTurnStatsRepositoryInterface $gameTurnStatsRepository,
        private UserRepositoryInterface $userRepository,
        private KnPostRepositoryInterface $knPostRepository,
        private AnomalyRepositoryInterface $anomalyRepository,
        private ColonyShipRepairRepositoryInterface $colonyShipRepairRepository,
        private PlanetFieldRepositoryInterface $planetFieldRepository,
        private ColonyFunctionManagerInterface $colonyFunctionManager,
        private EventManagerInterface $eventManager,
        LoggerUtilFactoryInterface $loggerUtilFactory
    ) {
        $this->loggerUtil = $loggerUtilFactory->getLoggerUtil();
    }

    #[Override]
    public function work(): void
    {
        $turn = $this->gameTurnRepository->getCurrent();
        if ($turn === null) {
            throw new RuntimeException('no current turn exists');
        }

        $this->endTurn($turn);
        $newTurnNumber = $turn->getTurn() + 1;

        $this->createAnomalyProcessingEvents($newTurnNumber);
        $this->shipRepairEvents($newTurnNumber);
        $this->createUserTickEvents($newTurnNumber);
        $this->createAnomalyCreationEvent($newTurnNumber);

        $this->reduceUserLocks();

        $newTurn = $this->startTurn($newTurnNumber);
        $this->createGameTurnStats($newTurn);
    }

    private function endTurn(GameTurnInterface $turn): void
    {
        $turn->setEnd(time());

        $this->gameTurnRepository->save($turn);
    }

    private function startTurn(int $newTurnNumber): GameTurnInterface
    {
        $obj = $this->gameTurnRepository->prototype();
        $obj->setStart(time());
        $obj->setEnd(0);
        $obj->setTurn($newTurnNumber);

        $this->gameTurnRepository->save($obj);

        return $obj;
    }

    private function createAnomalyProcessingEvents(int $newTurnNumber): void
    {
        foreach ($this->anomalyRepository->findAllActive() as $anomaly) {

            $this->eventManager->createEvent(
                EventTypeEnum::ANOMALY_PROCESSING,
                new PayloadWithIdAndTurn($anomaly->getId(), $newTurnNumber)
            );
        }
    }

    private function shipRepairEvents(int $newTurnNumber): void
    {
        $usedShipyards = [];

        foreach ($this->colonyShipRepairRepository->getMostRecentJobs() as $colonyShipRepair) {

            $colony = $colonyShipRepair->getColony();
            if ($colony->getUser()->isVacationRequestOldEnough()) {
                continue;
            }

            if ($colony->isBlocked()) {
                continue;
            }

            if (!array_key_exists($colony->getId(), $usedShipyards)) {
                $usedShipyards[$colony->getId()] = [];
            }

            $field = $this->planetFieldRepository->getByColonyAndFieldIndex(
                $colonyShipRepair->getColonyId(),
                $colonyShipRepair->getFieldId()
            );

            if ($field === null) {
                continue;
            }
            if (!$field->isActive()) {
                continue;
            }

            if (!array_key_exists($colony->getId(), $usedShipyards)) {
                $usedShipyards[$colony->getId()] = [];
            }

            //already repaired a ship on this colony field, max is one without repair station
            if (
                in_array($field->getFieldId(), $usedShipyards[$colony->getId()])
                && !$this->colonyFunctionManager->hasActiveFunction($colony, BuildingEnum::BUILDING_FUNCTION_REPAIR_SHIPYARD)
            ) {
                continue;
            }

            $usedShipyards[$colony->getId()][] = $field->getFieldId();

            $this->eventManager->createEvent(
                EventTypeEnum::COLONY_SHIP_REPAIR,
                new PayloadWithIdAndTurn($colonyShipRepair->getId(), $newTurnNumber)
            );
        }
    }

    private function createUserTickEvents(int $newTurnNumber): void
    {
        foreach ($this->userRepository->findAll() as $user) {
            if ($user->isVacationRequestOldEnough()) {
                continue;
            }

            $this->eventManager->createEvent(
                $this->getEventType($user),
                new PayloadWithIdAndTurn($user->getId(), $newTurnNumber)
            );
        }
    }

    private function createAnomalyCreationEvent(int $newTurnNumber): void
    {
        $this->eventManager->createEvent(
            EventTypeEnum::ANOMALY_CREATION,
            new PayloadWithTurn($newTurnNumber)
        );
    }

    private function getEventType(UserInterface $user): EventTypeEnum
    {
        if ($user->getId() === UserEnum::USER_NOONE) {
            return EventTypeEnum::NOONE_TICK;
        }

        return $user->isNpc()
            ? EventTypeEnum::NPC_TICK
            : EventTypeEnum::USER_TICK;
    }

    private function reduceUserLocks(): void
    {
        $locks = $this->userLockRepository->getActive();

        foreach ($locks as $lock) {
            $remainingTicks = $lock->getRemainingTicks();

            if ($remainingTicks === 1) {
                $userId = $lock->getUser()->getId();

                $lock->setUser(null);
                $lock->setUserId(null);
                $lock->setFormerUserId($userId);
                $lock->setRemainingTicks(0);
            } else {
                $lock->setRemainingTicks($remainingTicks - 1);
            }

            $this->userLockRepository->save($lock);
        }
    }

    private function createGameTurnStats(GameTurnInterface $turn): void
    {
        $stats = $this->gameTurnStatsRepository->prototype();

        $this->loggerUtil->log('setting stats values');

        $stats->setTurn($turn);
        $stats->setUserCount($this->userRepository->getActiveAmount());
        $stats->setLogins24h($this->userRepository->getActiveAmountRecentlyOnline(time() - TimeConstants::ONE_DAY_IN_SECONDS));
        $stats->setInactiveCount($this->userRepository->getInactiveAmount(14));
        $stats->setVacationCount($this->userRepository->getVacationAmount());
        $stats->setShipCount($this->gameTurnStatsRepository->getShipCount());
        $stats->setShipCountManned($this->gameTurnStatsRepository->getShipCountManned());
        $stats->setShipCountNpc($this->gameTurnStatsRepository->getShipCountNpc());
        $stats->setKnCount($this->knPostRepository->getAmount());
        $stats->setFlightSig24h($this->gameTurnStatsRepository->getFlightSigs24h());
        $stats->setFlightSigSystem24h($this->gameTurnStatsRepository->getFlightSigsSystem24h());

        $this->gameTurnStatsRepository->save($stats);
        $this->loggerUtil->log('saved stats');
    }
}


1			<?php
2
3			namespace Stu\Module\Tick;
4
5			use Override;
			0 ignored issues – show Bug introduced 2024-07-04 06:34 UTC by Report Bug Copy Issue Report The type `Override` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use RuntimeException;
7			use Stu\Component\Building\BuildingEnum;
			0 ignored issues – show Bug introduced 2024-08-12 06:39 UTC by Report Bug Copy Issue Report The type `Stu\Component\Building\BuildingEnum` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use Stu\Component\Colony\ColonyFunctionManagerInterface;
9			use Stu\Component\Event\EventManagerInterface;
10			use Stu\Component\Event\EventTypeEnum;
11			use Stu\Component\Event\Payload\PayloadWithIdAndTurn;
12			use Stu\Component\Event\Payload\PayloadWithTurn;
13			use Stu\Component\Game\TimeConstants;
			0 ignored issues – show Bug introduced 2023-07-18 10:33 UTC by Report Bug Copy Issue Report The type `Stu\Component\Game\TimeConstants` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14			use Stu\Module\Logging\LoggerUtilFactoryInterface;
15			use Stu\Module\Logging\LoggerUtilInterface;
16			use Stu\Module\PlayerSetting\Lib\UserEnum;
			0 ignored issues – show Bug introduced 2024-08-12 06:39 UTC by Report Bug Copy Issue Report The type `Stu\Module\PlayerSetting\Lib\UserEnum` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use Stu\Orm\Entity\GameTurnInterface;
18			use Stu\Orm\Entity\UserInterface;
19			use Stu\Orm\Repository\AnomalyRepositoryInterface;
20			use Stu\Orm\Repository\ColonyShipRepairRepositoryInterface;
21			use Stu\Orm\Repository\GameTurnRepositoryInterface;
22			use Stu\Orm\Repository\GameTurnStatsRepositoryInterface;
23			use Stu\Orm\Repository\KnPostRepositoryInterface;
24			use Stu\Orm\Repository\PlanetFieldRepositoryInterface;
25			use Stu\Orm\Repository\UserLockRepositoryInterface;
26			use Stu\Orm\Repository\UserRepositoryInterface;
27
28			final class TickManager implements TickManagerInterface
29			{
30			private LoggerUtilInterface $loggerUtil;
31
32			public function __construct(
33			private GameTurnRepositoryInterface $gameTurnRepository,
34			private UserLockRepositoryInterface $userLockRepository,
35			private GameTurnStatsRepositoryInterface $gameTurnStatsRepository,
36			private UserRepositoryInterface $userRepository,
37			private KnPostRepositoryInterface $knPostRepository,
38			private AnomalyRepositoryInterface $anomalyRepository,
39			private ColonyShipRepairRepositoryInterface $colonyShipRepairRepository,
40			private PlanetFieldRepositoryInterface $planetFieldRepository,
41			private ColonyFunctionManagerInterface $colonyFunctionManager,
42			private EventManagerInterface $eventManager,
43			LoggerUtilFactoryInterface $loggerUtilFactory
44			) {
45			$this->loggerUtil = $loggerUtilFactory->getLoggerUtil();
46			}
47
48			#[Override]
49			public function work(): void
50			{
51			$turn = $this->gameTurnRepository->getCurrent();
52			if ($turn === null) {
53			throw new RuntimeException('no current turn exists');
54			}
55
56			$this->endTurn($turn);
57			$newTurnNumber = $turn->getTurn() + 1;
58
59			$this->createAnomalyProcessingEvents($newTurnNumber);
60			$this->shipRepairEvents($newTurnNumber);
61			$this->createUserTickEvents($newTurnNumber);
62			$this->createAnomalyCreationEvent($newTurnNumber);
63
64			$this->reduceUserLocks();
65
66			$newTurn = $this->startTurn($newTurnNumber);
67			$this->createGameTurnStats($newTurn);
68			}
69
70			private function endTurn(GameTurnInterface $turn): void
71			{
72			$turn->setEnd(time());
73
74			$this->gameTurnRepository->save($turn);
75			}
76
77			private function startTurn(int $newTurnNumber): GameTurnInterface
78			{
79			$obj = $this->gameTurnRepository->prototype();
80			$obj->setStart(time());
81			$obj->setEnd(0);
82			$obj->setTurn($newTurnNumber);
83
84			$this->gameTurnRepository->save($obj);
85
86			return $obj;
87			}
88
89			private function createAnomalyProcessingEvents(int $newTurnNumber): void
90			{
91			foreach ($this->anomalyRepository->findAllActive() as $anomaly) {
92
93			$this->eventManager->createEvent(
94			EventTypeEnum::ANOMALY_PROCESSING,
95			new PayloadWithIdAndTurn($anomaly->getId(), $newTurnNumber)
96			);
97			}
98			}
99
100			private function shipRepairEvents(int $newTurnNumber): void
101			{
102			$usedShipyards = [];
103
104			foreach ($this->colonyShipRepairRepository->getMostRecentJobs() as $colonyShipRepair) {
105
106			$colony = $colonyShipRepair->getColony();
107			if ($colony->getUser()->isVacationRequestOldEnough()) {
108			continue;
109			}
110
111			if ($colony->isBlocked()) {
112			continue;
113			}
114
115			if (!array_key_exists($colony->getId(), $usedShipyards)) {
116			$usedShipyards[$colony->getId()] = [];
117			}
118
119			$field = $this->planetFieldRepository->getByColonyAndFieldIndex(
120			$colonyShipRepair->getColonyId(),
121			$colonyShipRepair->getFieldId()
122			);
123
124			if ($field === null) {
125			continue;
126			}
127			if (!$field->isActive()) {
128			continue;
129			}
130
131			if (!array_key_exists($colony->getId(), $usedShipyards)) {
132			$usedShipyards[$colony->getId()] = [];
133			}
134
135			//already repaired a ship on this colony field, max is one without repair station
136			if (
137			in_array($field->getFieldId(), $usedShipyards[$colony->getId()])
138			&& !$this->colonyFunctionManager->hasActiveFunction($colony, BuildingEnum::BUILDING_FUNCTION_REPAIR_SHIPYARD)
139			) {
140			continue;
141			}
142
143			$usedShipyards[$colony->getId()][] = $field->getFieldId();
144
145			$this->eventManager->createEvent(
146			EventTypeEnum::COLONY_SHIP_REPAIR,
147			new PayloadWithIdAndTurn($colonyShipRepair->getId(), $newTurnNumber)
148			);
149			}
150			}
151
152			private function createUserTickEvents(int $newTurnNumber): void
153			{
154			foreach ($this->userRepository->findAll() as $user) {
155			if ($user->isVacationRequestOldEnough()) {
156			continue;
157			}
158
159			$this->eventManager->createEvent(
160			$this->getEventType($user),
161			new PayloadWithIdAndTurn($user->getId(), $newTurnNumber)
162			);
163			}
164			}
165
166			private function createAnomalyCreationEvent(int $newTurnNumber): void
167			{
168			$this->eventManager->createEvent(
169			EventTypeEnum::ANOMALY_CREATION,
170			new PayloadWithTurn($newTurnNumber)
171			);
172			}
173
174			private function getEventType(UserInterface $user): EventTypeEnum
175			{
176			if ($user->getId() === UserEnum::USER_NOONE) {
177			return EventTypeEnum::NOONE_TICK;
178			}
179
180			return $user->isNpc()
181			? EventTypeEnum::NPC_TICK
182			: EventTypeEnum::USER_TICK;
183			}
184
185			private function reduceUserLocks(): void
186			{
187			$locks = $this->userLockRepository->getActive();
188
189			foreach ($locks as $lock) {
190			$remainingTicks = $lock->getRemainingTicks();
191
192			if ($remainingTicks === 1) {
193			$userId = $lock->getUser()->getId();
194
195			$lock->setUser(null);
196			$lock->setUserId(null);
197			$lock->setFormerUserId($userId);
198			$lock->setRemainingTicks(0);
199			} else {
200			$lock->setRemainingTicks($remainingTicks - 1);
201			}
202
203			$this->userLockRepository->save($lock);
204			}
205			}
206
207			private function createGameTurnStats(GameTurnInterface $turn): void
208			{
209			$stats = $this->gameTurnStatsRepository->prototype();
210
211			$this->loggerUtil->log('setting stats values');
212
213			$stats->setTurn($turn);
214			$stats->setUserCount($this->userRepository->getActiveAmount());
215			$stats->setLogins24h($this->userRepository->getActiveAmountRecentlyOnline(time() - TimeConstants::ONE_DAY_IN_SECONDS));
216			$stats->setInactiveCount($this->userRepository->getInactiveAmount(14));
217			$stats->setVacationCount($this->userRepository->getVacationAmount());
218			$stats->setShipCount($this->gameTurnStatsRepository->getShipCount());
219			$stats->setShipCountManned($this->gameTurnStatsRepository->getShipCountManned());
220			$stats->setShipCountNpc($this->gameTurnStatsRepository->getShipCountNpc());
221			$stats->setKnCount($this->knPostRepository->getAmount());
222			$stats->setFlightSig24h($this->gameTurnStatsRepository->getFlightSigs24h());
223			$stats->setFlightSigSystem24h($this->gameTurnStatsRepository->getFlightSigsSystem24h());
224
225			$this->gameTurnStatsRepository->save($stats);
226			$this->loggerUtil->log('saved stats');
227			}
228			}
229

st-universe / core

Push — dev ( eeaa0f...91a85a )

TickManager::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like