SpareParts\Overseer\Assembly\VotingAssembly

Complexity

Total Complexity

25

Size/Duplication

Total Lines	173
Duplicated Lines	15.03 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

22.81%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	commenceVote()	0	17	4
A	strategyFirstVoteDecides()	0	9	3
A	strategyAllowUnlessDenied()	13	13	4
A	strategyDenyUnlessAllowed()	13	13	4
A	prepareResult()	0	13	4
B	canVoteOn()	0	11	5

<?php
namespace SpareParts\Overseer\Assembly;


use SpareParts\Overseer\Identity\IVotingContext;
use SpareParts\Overseer\IVotingResult;
use SpareParts\Overseer\Strategy;
use SpareParts\Overseer\InvalidVotingResultException;
use SpareParts\Overseer\Voter\IVoter;
use SpareParts\Overseer\Voter\IVotingSubject;
use SpareParts\Overseer\VotingResult;

class VotingAssembly implements IVotingAssembly
{

	/**
	 * @var string
	 */
	private $strategy;

	/**
	 * @var IVoter[]
	 */
	private $voters;

	/**
	 * @var string
	 */
	private $subjectName;

	/**
	 * @var string
	 */
	private $actionName;

	/**
	 * @var null|string
	 */
	private $contextClassname;


	/**
	 * VotingAssembly constructor.
	 * @param string $subjectName
	 * @param string $actionName
	 * @param string $strategy
	 * @param \SpareParts\Overseer\Voter\IVoter[] $voters
	 * @param string|null $contextClassname If present, this assembly will require specific context class
	 */
	public function __construct(
		$subjectName,
		$actionName,
		$strategy,
		array $voters,
		$contextClassname = IVotingContext::class
	) {
		$this->strategy = $strategy;
		$this->voters = $voters;
		$this->subjectName = $subjectName;
		$this->actionName = $actionName;
		$this->contextClassname = $contextClassname;
	}


	/**
	 * @param \SpareParts\Overseer\Voter\IVotingSubject $votingSubject
	 * @param \SpareParts\Overseer\Identity\IVotingContext $votingContext
	 * @return null|\SpareParts\Overseer\IVotingResult
	 * @throws \SpareParts\Overseer\InvalidVotingResultException
	 */
	public function commenceVote(IVotingSubject $votingSubject, IVotingContext $votingContext)
	{
		$result = null;

$result is not used, you could remove the assignment.

		switch ($this->strategy) {
			case Strategy::FIRST_VOTE_DECIDES:
				return $this->strategyFirstVoteDecides($votingSubject, $votingContext);

			case Strategy::ALLOW_UNLESS_DENIED:
				return $this->strategyAllowUnlessDenied($votingSubject, $votingContext);

			case Strategy::DENY_UNLESS_ALLOWED:
				return $this->strategyDenyUnlessAllowed($votingSubject, $votingContext);

			default:
				throw new InvalidVotingResultException('Unable to decide on result, invalid strategy: '.$this->strategy);
		}
	}


	/**
	 * @param \SpareParts\Overseer\Voter\IVotingSubject $votingSubject
	 * @param \SpareParts\Overseer\Identity\IVotingContext $votingContext
	 * @return \SpareParts\Overseer\IVotingResult
	 * @throws \SpareParts\Overseer\InvalidVotingResultException
	 */
	private function strategyFirstVoteDecides(IVotingSubject $votingSubject, IVotingContext $votingContext)
	{
		foreach ($this->voters as $name => $voter) {
			if (($result = $voter->vote($votingSubject, $votingContext)) !== null) {
				return $this->prepareResult($name, $result);
			}
		}
		throw new InvalidVotingResultException('Voting assembly did not decide on any result!');
	}


	/**
	 * @param \SpareParts\Overseer\Voter\IVotingSubject $votingSubject
	 * @param \SpareParts\Overseer\Identity\IVotingContext $votingContext
	 * @return \SpareParts\Overseer\IVotingResult
	 */
	private function strategyAllowUnlessDenied($votingSubject, $votingContext)

This method seems to be duplicated in your project.

	{
		foreach ($this->voters as $name => $voter) {
			if (($result = $voter->vote($votingSubject, $votingContext)) !== null) {
				$vote = $this->prepareResult($name, $result);
				// at least one voter denied access
				if (!$vote->isAllowed()) {
					return $vote;
				}
			}
		}
		return new VotingResult(IVotingResult::ALLOW);
	}


	/**
	 * @param \SpareParts\Overseer\Voter\IVotingSubject $votingSubject
	 * @param \SpareParts\Overseer\Identity\IVotingContext $votingContext
	 * @return \SpareParts\Overseer\IVotingResult
	 */
	private function strategyDenyUnlessAllowed($votingSubject, $votingContext)

This method seems to be duplicated in your project.

	{
		foreach ($this->voters as $name => $voter) {
			if (($result = $voter->vote($votingSubject, $votingContext)) !== null) {
				$vote = $this->prepareResult($name, $result);
				// at least one voter allowed access
				if ($vote->isAllowed()) {
					return $vote;
				}
			}
		}
		return new VotingResult(IVotingResult::DENY);
	}


	/**
	 * @param string $voterName
	 * @param string|IVotingResult $partialResult
	 * @return \SpareParts\Overseer\IVotingResult|null
	 * @throws \SpareParts\Overseer\InvalidVotingResultException
	 */
	protected function prepareResult($voterName, $partialResult)
	{
		if (is_null($partialResult)) {
			return null;
		}
		if (is_string($partialResult)) {
			return new VotingResult($partialResult, $voterName);
		}
		if (!($partialResult instanceof IVotingResult)) {
			throw new InvalidVotingResultException('Expected bool or IVotingResult, got '.(string)$partialResult);
		}
		return $partialResult;
	}


	/**
	 * @param string $actionName
	 * @param \SpareParts\Overseer\Voter\IVotingSubject $subject
	 * @param \SpareParts\Overseer\Identity\IVotingContext $context
	 * @return bool
	 */
	public function canVoteOn($actionName, IVotingSubject $subject, IVotingContext $context)
	{
		if ($this->contextClassname && !($context instanceof $this->contextClassname)) {

The expression $this->contextClassname of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

			return false;
		}

		if ($subject->getVotingSubjectName() === $this->subjectName && $actionName === $this->actionName) {
			return true;
		}
		return false;
	}
}