eXpansion\Bundle\VoteManager\Plugins\Votes\AbstractVotePlugin

Complexity

Total Complexity

25

Size/Duplication

Total Lines	227
Duplicated Lines	11.01 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

84.38%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	start()	0	5	1
A	reset()	0	4	1
A	castYes()	8	9	2
A	castNo()	8	9	2
A	cancel()	0	8	2
D	update()	9	29	9
A	getCurrentVote()	0	4	1
A	pass()	0	5	1
A	votePassed()	0	5	1
A	voteFailed()	0	5	1
A	getDuration()	0	4	1
A	getRatio()	0	4	1
A	getElapsedTime()	0	4	1
	getQuestion()	0	1	?
	getCode()	0	1	?
	getReplacementTypes()	0	1	?
	executeVotePassed()	0	1	?
	executeVoteFailed()	0	1	?

<?php

namespace eXpansion\Bundle\VoteManager\Plugins\Votes;

use eXpansion\Bundle\VoteManager\Structures\Vote;
use eXpansion\Framework\Core\Services\Application\DispatcherInterface;
use eXpansion\Framework\Core\Storage\Data\Player;
use eXpansion\Framework\Core\Storage\PlayerStorage;

/**
 * Class AbstractVotePlugin
 *
 * @author    de Cramer Oliver<oliverde8@gmail.com>
 * @copyright 2017 eXpansion
 * @package eXpansion\Bundle\VoteManager\Plugins\Votes
 */
abstract class AbstractVotePlugin
{
    /** @var DispatcherInterface */
    protected $dispatcher;

    /** @var PlayerStorage */
    protected $playerStorage;

    /** @var int */
    protected $duration;

    /** @var float */
    protected $ratio;

    /** @var Vote|null */
    protected $currentVote = null;

    /**
     * AbstractVotePlugin constructor.
     *
     * @param DispatcherInterface $dispatcher
     * @param PlayerStorage $playerStorage
     * @param int $duration
     * @param float $ratio
     */
    public function __construct(
        DispatcherInterface $dispatcher,
        PlayerStorage $playerStorage,
        int $duration,
        float $ratio
    ) {
        $this->dispatcher = $dispatcher;
        $this->playerStorage = $playerStorage;
        $this->duration = $duration;
        $this->ratio = $ratio;
    }

    /**
     * Start a new vote.
     *
     * @param Player $player
     *
     * @return Vote|null
     */
    public function start(Player $player, $params)
    {
        $this->currentVote = new Vote($player, $this->getCode(), $params);
        return $this->currentVote;
    }

    /**
     * Reset current vote session.
     */
    public function reset()
    {
        $this->currentVote = null;
    }

    /**
     * User votes yes
     *
     * @param string $login
     */
    public function castYes($login)

This method seems to be duplicated in your project.

    {
        if ($this->currentVote) {
            $this->currentVote->castYes($login);

            $player = $this->playerStorage->getPlayerInfo($login);
            $this->dispatcher->dispatch("votemanager.voteyes", [$player, $this->currentVote]);
        }
    }

    /**
     * User votes no
     *
     * @param string $login
     */
    public function castNo($login)

This method seems to be duplicated in your project.

    {
        if ($this->currentVote) {
            $this->currentVote->castNo($login);

            $player = $this->playerStorage->getPlayerInfo($login);
            $this->dispatcher->dispatch("votemanager.voteno", [$player, $this->currentVote]);
        }
    }

    /**
     * Cancel ongoing vote.
     */
    public function cancel()
    {
        if (!$this->currentVote) {
            return;
        }

        $this->currentVote->setStatus(Vote::STATUS_CANCEL);
    }

    /**
     * Update the status of the vote, and execute actions if vote passed.
     *
     * @param int $time
     */
    public function update($time = null)
    {
        if (!$this->currentVote || $this->currentVote->getStatus() == Vote::STATUS_CANCEL) {
            return;
        }

        if (is_null($time)) {
            $time = time();
        }

        $playerCount = count($this->playerStorage->getOnline());

        // Check if vote passes when we suppose that all palyers that didn't vote would vote NO.
        if ($playerCount > 0 && ($this->currentVote->getYes() / $playerCount) > $this->ratio) {

This code seems to be duplicated across your project.

            $this->votePassed();
            return;
        }

        // If the vote is still not decided wait for the end to decide.
        if (($time - $this->currentVote->getStartTime()) > $this->duration) {
            $totalVotes = $this->currentVote->getYes() + $this->currentVote->getNo() * 1.0;

            if ($totalVotes >= 1 && ($this->currentVote->getYes() / $totalVotes) > $this->ratio) {

This code seems to be duplicated across your project.

                $this->votePassed();
            } else {
                $this->voteFailed();
            }
        }
    }

    /**
     * @return Vote|null
     */
    public function getCurrentVote()
    {
        return $this->currentVote;
    }

    /**
     *  Pass a vote
     */
    public function pass()
    {
        $this->currentVote->setStatus(Vote::STATUS_PASSED);
        $this->executeVotePassed();
    }

    /**
     * Called when a vote passed.
     */
    protected function votePassed()
    {
        $this->currentVote->setStatus(Vote::STATUS_PASSED);
        $this->executeVotePassed();
    }

    /**
     * Called when a vote failed.
     */
    protected function voteFailed()
    {
        $this->currentVote->setStatus(Vote::STATUS_FAILED);
        $this->executeVoteFailed();
    }

    /**
     * @return int
     */
    public function getDuration(): int
    {
        return $this->duration;
    }

    /**
     * @return float
     */
    public function getRatio(): float
    {
        return $this->ratio;
    }

    /**
     * @return int
     */
    public function getElapsedTime() : int
    {
        return time() - $this->currentVote->getStartTime();
    }

    /**
     * Get question text to display for this vote.
     *
     * @return string
     */
    abstract public function getQuestion(): string;

    /**
     * Get type code of this vote.
     *
     * @return string
     */
    abstract public function getCode(): string;

    /**
     * Get native votes this votes replaces.
     *
     * @return string[]
     */
    abstract public function getReplacementTypes(): array;

    /**
     * Called when vote is passed.
     *
     * @return void
     */
    abstract protected function executeVotePassed();

    /**
     * Called when vote is failed.
     */
    abstract protected function executeVoteFailed();
}