Stu\Module\Spacecraft\Lib\SpacecraftWrapper

Complexity

Total Complexity

65

Size/Duplication

Total Lines	418
Duplicated Lines	0 %

Test Coverage

Coverage

65.48%

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
A	reloadEpsUsage()	0	9	2
A	canMan()	0	8	3
A	getRepairCosts()	0	11	1
A	getSpecificShipSystem()	0	8	1
A	getPossibleTorpedoTypes()	0	8	2
A	getCrewStyle()	0	11	3
A	getSensorRange()	0	10	2
A	__toString()	0	12	1
A	getShieldSystemData()	0	6	1
A	getWarpDriveSystemData()	0	6	1
A	setAlertState()	0	7	1
A	getReactorUsage()	0	8	2
A	getEpsSystemData()	0	6	1
B	getReactorWrapper()	0	35	6
A	__construct()	0	13	1
A	getSpacecraftWrapperFactory()	0	4	1
A	isSelectable()	0	5	2
A	getDamagedSystems()	0	24	5
A	getLssSystemData()	0	6	1
A	canFire()	0	13	4
A	canBeRepaired()	0	20	5
A	lowerEpsUsage()	0	4	1
A	getTakeoverTicksLeft()	0	11	2
A	getRepairDurationPreview()	0	4	1
A	getHullSystemData()	0	13	2
A	getEpsUsage()	0	7	2
A	getProjectileLauncherSystemData()	0	6	1
A	getTractoredShipWrapper()	0	9	2
A	getStateIconAndTitle()	0	4	1
A	getRepairDuration()	0	4	1
A	getShieldRegenerationRate()	0	15	3
A	get()	0	4	1
A	getEnergyWeaponSystemData()	0	6	1
A	getSpacecraftSystemManager()	0	4	1

<?php

declare(strict_types=1);

namespace Stu\Module\Spacecraft\Lib;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Override;

The type Override was not found. Maybe you did not declare it correctly or list all dependencies?

use RuntimeException;
use Stu\Component\Spacecraft\Repair\RepairUtilInterface;
use Stu\Component\Spacecraft\SpacecraftAlertStateEnum;
use Stu\Component\Spacecraft\System\Data\AbstractSystemData;
use Stu\Component\Spacecraft\System\Data\EnergyWeaponSystemData;
use Stu\Component\Spacecraft\System\Data\EpsSystemData;
use Stu\Component\Spacecraft\System\Data\FusionCoreSystemData;
use Stu\Component\Spacecraft\System\Data\HullSystemData;
use Stu\Component\Spacecraft\System\Data\LssSystemData;
use Stu\Component\Spacecraft\System\Data\ProjectileLauncherSystemData;
use Stu\Component\Spacecraft\System\Data\ShieldSystemData;
use Stu\Component\Spacecraft\System\Data\SingularityCoreSystemData;
use Stu\Component\Spacecraft\System\Data\WarpCoreSystemData;
use Stu\Component\Spacecraft\System\Data\WarpDriveSystemData;
use Stu\Component\Spacecraft\System\Exception\SystemNotFoundException;
use Stu\Component\Spacecraft\System\SpacecraftSystemManagerInterface;
use Stu\Component\Spacecraft\System\SpacecraftSystemTypeEnum;
use Stu\Component\Spacecraft\System\SystemDataDeserializerInterface;
use Stu\Module\Commodity\CommodityTypeEnum;

The type Stu\Module\Commodity\CommodityTypeEnum was not found. Maybe you did not declare it correctly or list all dependencies?

use Stu\Module\Control\GameControllerInterface;
use Stu\Module\Spacecraft\Lib\Interaction\ShipTakeoverManagerInterface;
use Stu\Module\Spacecraft\Lib\ReactorWrapper;
use Stu\Module\Spacecraft\Lib\ReactorWrapperInterface;
use Stu\Module\Spacecraft\Lib\ShipRepairCost;
use Stu\Module\Spacecraft\Lib\SpacecraftStateChangerInterface;
use Stu\Module\Spacecraft\Lib\SpacecraftWrapperFactoryInterface;
use Stu\Module\Ship\Lib\ShipWrapperInterface;
use Stu\Module\Spacecraft\Lib\Ui\StateIconAndTitle;
use Stu\Orm\Entity\SpacecraftSystemInterface;
use Stu\Orm\Entity\ShipTakeoverInterface;
use Stu\Orm\Entity\SpacecraftInterface;
use Stu\Orm\Repository\TorpedoTypeRepositoryInterface;

//TODO increase coverage
/**
 * @template T of SpacecraftInterface
 */
abstract class SpacecraftWrapper implements SpacecraftWrapperInterface
{
    /** @var Collection<int, AbstractSystemData> */
    private Collection $shipSystemDataCache;

    private ?ReactorWrapperInterface $reactorWrapper = null;

    private ?int $epsUsage = null;

    /**
     * @param T $spacecraft
     */
    public function __construct(
        protected SpacecraftInterface $spacecraft,
        private SpacecraftSystemManagerInterface $spacecraftSystemManager,
        private SystemDataDeserializerInterface $systemDataDeserializer,
        private TorpedoTypeRepositoryInterface $torpedoTypeRepository,
        protected GameControllerInterface $game,
        protected SpacecraftWrapperFactoryInterface $spacecraftWrapperFactory,
        private SpacecraftStateChangerInterface $spacecraftStateChanger,
        private RepairUtilInterface $repairUtil,
        private StateIconAndTitle $stateIconAndTitle
    ) {

        $this->shipSystemDataCache = new ArrayCollection();
    }

    #[Override]
    public function get(): SpacecraftInterface
    {
        return $this->spacecraft;
    }

    #[Override]
    public function getSpacecraftWrapperFactory(): SpacecraftWrapperFactoryInterface
    {
        return $this->spacecraftWrapperFactory;
    }

    #[Override]
    public function getSpacecraftSystemManager(): SpacecraftSystemManagerInterface
    {
        return $this->spacecraftSystemManager;
    }

    #[Override]
    public function getEpsUsage(): int
    {
        if ($this->epsUsage === null) {
            $this->epsUsage = $this->reloadEpsUsage();
        }
        return $this->epsUsage;

The expression return $this->epsUsage could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    #[Override]
    public function lowerEpsUsage(int $value): void
    {
        $this->epsUsage -= $value;
    }

    private function reloadEpsUsage(): int
    {
        $result = 0;

        foreach ($this->spacecraftSystemManager->getActiveSystems($this->spacecraft) as $shipSystem) {
            $result += $this->spacecraftSystemManager->getEnergyConsumption($shipSystem->getSystemType());
        }

        return $result + $this->spacecraft->getAlertState()->getEpsUsage();
    }

    public function getReactorUsage(): int
    {
        $reactor = $this->reactorWrapper;
        if ($reactor === null) {
            throw new RuntimeException('this should not happen');
        }

        return $this->getEpsUsage() + $reactor->getUsage();
    }

    #[Override]
    public function getReactorWrapper(): ?ReactorWrapperInterface
    {
        if ($this->reactorWrapper === null) {
            $ship = $this->spacecraft;

It seems like $this->spacecraft of type Stu\Orm\Entity\SpacecraftInterface is incompatible with the declared type Stu\Module\Spacecraft\Lib\T of property $spacecraft.

            $reactorSystemData = null;


            if ($ship->hasSpacecraftSystem(SpacecraftSystemTypeEnum::WARPCORE)) {
                $reactorSystemData = $this->getSpecificShipSystem(
                    SpacecraftSystemTypeEnum::WARPCORE,
                    WarpCoreSystemData::class
                );
            }
            if ($ship->hasSpacecraftSystem(SpacecraftSystemTypeEnum::SINGULARITY_REACTOR)) {
                $reactorSystemData = $this->getSpecificShipSystem(
                    SpacecraftSystemTypeEnum::SINGULARITY_REACTOR,
                    SingularityCoreSystemData::class
                );
            }
            if ($ship->hasSpacecraftSystem(SpacecraftSystemTypeEnum::FUSION_REACTOR)) {
                $reactorSystemData = $this->getSpecificShipSystem(
                    SpacecraftSystemTypeEnum::FUSION_REACTOR,
                    FusionCoreSystemData::class
                );
            }

            if ($reactorSystemData === null) {
                return null;
            }

            $this->reactorWrapper = new ReactorWrapper($this, $reactorSystemData);
        }

        return $this->reactorWrapper;
    }

    #[Override]
    public function setAlertState(SpacecraftAlertStateEnum $alertState): ?string
    {
        $msg = $this->spacecraftStateChanger->changeAlertState($this, $alertState);
        $this->epsUsage = $this->reloadEpsUsage();

        return $msg;
    }

    #[Override]
    public function getSensorRange(): int
    {
        $lssSystemData = $this->getLssSystemData();
        if ($lssSystemData === null) {
            return 0;
        }

        return (int) (ceil($lssSystemData->getSensorRange()
            * $this->get()->getSpacecraftSystem(SpacecraftSystemTypeEnum::LSS)->getStatus() / 100));
    }

    #[Override]
    public function getShieldRegenerationRate(): int
    {
        $regenerationPercentage = $this->get()->isSystemHealthy(SpacecraftSystemTypeEnum::SHIELDS) ? 10 : 0;

        $shield = $this->get()->getShield();
        $maxshield = $this->get()->getMaxShield();

        $result = (int) ceil(($maxshield / 100) * $regenerationPercentage);

        if ($result > $maxshield - $shield) {
            $result = $maxshield - $shield;
        }

        return $result;
    }

    /**
     * highest damage first, then prio
     *
     * @return SpacecraftSystemInterface[]
     */
    #[Override]
    public function getDamagedSystems(): array
    {
        $damagedSystems = [];
        $prioArray = [];
        foreach ($this->spacecraft->getSystems() as $system) {
            if ($system->getStatus() < 100) {
                $damagedSystems[] = $system;
                $prioArray[$system->getSystemType()->value] = $this->spacecraftSystemManager->lookupSystem($system->getSystemType())->getPriority();
            }
        }

        // sort by damage and priority
        usort(
            $damagedSystems,
            function (SpacecraftSystemInterface $a, SpacecraftSystemInterface $b) use ($prioArray): int {
                if ($a->getStatus() === $b->getStatus()) {
                    return $prioArray[$b->getSystemType()->value] <=> $prioArray[$a->getSystemType()->value];
                }
                return ($a->getStatus() < $b->getStatus()) ? -1 : 1;
            }
        );

        return $damagedSystems;
    }

    #[Override]
    public function isSelectable(): bool
    {
        return $this->game->getUser() === $this->spacecraft->getUser()
            && $this->spacecraft->getType()->getModuleView() !== null;
    }

    #[Override]
    public function canBeRepaired(): bool
    {
        if ($this->spacecraft->getAlertState() !== SpacecraftAlertStateEnum::ALERT_GREEN) {
            return false;
        }

        if ($this->spacecraft->isShielded()) {
            return false;
        }

        if ($this->spacecraft->isCloaked()) {
            return false;
        }

        if ($this->getDamagedSystems() !== []) {
            return true;
        }

        return $this->spacecraft->getHull() < $this->spacecraft->getMaxHull();
    }

    #[Override]
    public function canFire(): bool
    {
        $ship = $this->spacecraft;

It seems like $this->spacecraft of type Stu\Orm\Entity\SpacecraftInterface is incompatible with the declared type Stu\Module\Spacecraft\Lib\T of property $spacecraft.

        if (!$ship->getNbs()) {
            return false;
        }
        if (!$ship->hasActiveWeapon()) {
            return false;
        }

        $epsSystem = $this->getEpsSystemData();
        return $epsSystem !== null && $epsSystem->getEps() !== 0;
    }

    #[Override]
    public function canMan(): bool
    {
        $buildplan = $this->spacecraft->getBuildplan();

        return $buildplan !== null
            && $buildplan->getCrew() > 0
            && $this->spacecraft->hasSpacecraftSystem(SpacecraftSystemTypeEnum::LIFE_SUPPORT);
    }

    #[Override]
    public function getRepairDuration(): int
    {
        return $this->repairUtil->getRepairDuration($this);
    }

    #[Override]
    public function getRepairDurationPreview(): int
    {
        return $this->repairUtil->getRepairDurationPreview($this);
    }

    #[Override]
    public function getRepairCosts(): array
    {
        $neededParts = $this->repairUtil->determineSpareParts($this, false);

        $neededSpareParts = $neededParts[CommodityTypeEnum::COMMODITY_SPARE_PART];
        $neededSystemComponents = $neededParts[CommodityTypeEnum::COMMODITY_SYSTEM_COMPONENT];

        return [
            new ShipRepairCost($neededSpareParts, CommodityTypeEnum::COMMODITY_SPARE_PART, CommodityTypeEnum::getDescription(CommodityTypeEnum::COMMODITY_SPARE_PART)),
            new ShipRepairCost($neededSystemComponents, CommodityTypeEnum::COMMODITY_SYSTEM_COMPONENT, CommodityTypeEnum::getDescription(CommodityTypeEnum::COMMODITY_SYSTEM_COMPONENT))
        ];
    }

    #[Override]
    public function getPossibleTorpedoTypes(): array
    {
        if ($this->spacecraft->hasSpacecraftSystem(SpacecraftSystemTypeEnum::TORPEDO_STORAGE)) {
            return $this->torpedoTypeRepository->getAll();
        }

        return $this->torpedoTypeRepository->getByLevel($this->spacecraft->getRump()->getTorpedoLevel());
    }

    #[Override]
    public function getTractoredShipWrapper(): ?ShipWrapperInterface
    {
        $tractoredShip = $this->spacecraft->getTractoredShip();
        if ($tractoredShip === null) {
            return null;
        }

        return $this->spacecraftWrapperFactory->wrapShip($tractoredShip);
    }

    #[Override]
    public function getStateIconAndTitle(): ?array
    {
        return $this->stateIconAndTitle->getStateIconAndTitle($this);
    }

    #[Override]
    public function getTakeoverTicksLeft(?ShipTakeoverInterface $takeover = null): int
    {
        $takeover ??= $this->spacecraft->getTakeoverActive();
        if ($takeover === null) {
            throw new RuntimeException('should not call when active takeover is null');
        }

        $currentTurn = $this->game->getCurrentRound()->getTurn();

        return $takeover->getStartTurn() + ShipTakeoverManagerInterface::TURNS_TO_TAKEOVER - $currentTurn;
    }

    #[Override]
    public function getCrewStyle(): string
    {
        $ship = $this->spacecraft;

It seems like $this->spacecraft of type Stu\Orm\Entity\SpacecraftInterface is incompatible with the declared type Stu\Module\Spacecraft\Lib\T of property $spacecraft.

        $excessCrew = $ship->getExcessCrewCount();

        if ($excessCrew === 0) {
            return "";
        }

        return $excessCrew > 0 ? "color: green;" : "color: red;";
    }

    #[Override]
    public function getHullSystemData(): HullSystemData
    {
        $hullSystemData = $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::HULL,
            HullSystemData::class
        );

        if ($hullSystemData === null) {
            throw new SystemNotFoundException('no hull installed?');
        }

        return $hullSystemData;
    }

    #[Override]
    public function getShieldSystemData(): ?ShieldSystemData
    {
        return $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::SHIELDS,
            ShieldSystemData::class
        );
    }

    #[Override]
    public function getEpsSystemData(): ?EpsSystemData
    {
        return $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::EPS,
            EpsSystemData::class
        );
    }

    #[Override]
    public function getLssSystemData(): ?LssSystemData
    {
        return $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::LSS,
            LssSystemData::class
        );
    }

    #[Override]
    public function getEnergyWeaponSystemData(): ?EnergyWeaponSystemData
    {
        return $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::PHASER,
            EnergyWeaponSystemData::class
        );
    }

    #[Override]
    public function getWarpDriveSystemData(): ?WarpDriveSystemData
    {
        return $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::WARPDRIVE,
            WarpDriveSystemData::class
        );
    }

    #[Override]
    public function getProjectileLauncherSystemData(): ?ProjectileLauncherSystemData
    {
        return $this->getSpecificShipSystem(
            SpacecraftSystemTypeEnum::TORPEDO,
            ProjectileLauncherSystemData::class
        );
    }

    /**
     * @template T2
     * @param class-string<T2> $className

The doc comment class-string<T2> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T2>.

     *
     * @return T2|null
     */
    protected function getSpecificShipSystem(SpacecraftSystemTypeEnum $systemType, string $className)
    {
        return $this->systemDataDeserializer->getSpecificShipSystem(
            $this->spacecraft,
            $systemType,
            $className,
            $this->shipSystemDataCache,
            $this->spacecraftWrapperFactory
        );
    }

    #[Override]
    public function __toString(): string
    {
        $systems = implode(",\n", $this->spacecraft->getSystems()
            ->filter(fn($system): bool => $system->getData() !== null)
            ->map(fn($system): string => $system->__toString())
            ->toArray());

        return sprintf(
            "spacecraft: {%s,\n  systems: [\n%s\n}\n]",
            $this->spacecraft->__toString(),
            $systems
        );
    }
}