SpareParts / Overseer

src/IResult.php

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
 
 interface IResult
 {
-    /**
-     * @return VotingDecisionEnum
-     */
-    public function getDecision();
+	/**
+	 * @return VotingDecisionEnum
+	 */
+	public function getDecision();
 }

src/VotingDecisionEnum.php

Indentation +54 added lines, -54 removed lines

@@ -4,58 +4,58 @@
 
 final class VotingDecisionEnum
 {
-    /**
-     * @var string
-     */
-    private $value;
-
-    /**
-     * @var self[]
-     */
-    static private $registry = [];
-
-    private function __construct($value)
-    {
-        $this->value = $value;
-    }
-
-
-    /**
-     * @return self
-     */
-    public static function ALLOWED()
-    {
-        return static::instance('allowed');
-    }
-
-
-    /**
-     * @return self
-     */
-    public static function DENIED()
-    {
-        return static::instance('denied');
-    }
-
-
-    /**
-     * @param $string
-     * @return self
-     */
-    private static function instance($string)
-    {
-        if (!isset(static::$registry[$string])) {
-            static::$registry[$string] = new static($string);
-        }
-        return static::$registry[$string];
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->value;
-    }
+	/**
+	 * @var string
+	 */
+	private $value;
+
+	/**
+	 * @var self[]
+	 */
+	static private $registry = [];
+
+	private function __construct($value)
+	{
+		$this->value = $value;
+	}
+
+
+	/**
+	 * @return self
+	 */
+	public static function ALLOWED()
+	{
+		return static::instance('allowed');
+	}
+
+
+	/**
+	 * @return self
+	 */
+	public static function DENIED()
+	{
+		return static::instance('denied');
+	}
+
+
+	/**
+	 * @param $string
+	 * @return self
+	 */
+	private static function instance($string)
+	{
+		if (!isset(static::$registry[$string])) {
+			static::$registry[$string] = new static($string);
+		}
+		return static::$registry[$string];
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->value;
+	}
 }

src/Assembly/VotingAbilityAwareAssembly.php

Indentation +50 added lines, -50 removed lines

@@ -10,64 +10,64 @@
 class VotingAbilityAwareAssembly extends VotingAssembly implements IVotingAbilityAwareAssembly
 {
 
-    /**
-     * @var string
-     */
-    protected $subjectClassName;
+	/**
+	 * @var string
+	 */
+	protected $subjectClassName;
 
-    /**
-     * @var string
-     */
-    protected $contextClassName;
+	/**
+	 * @var string
+	 */
+	protected $contextClassName;
 
-    /**
-     * @var string[]
-     */
-    protected $actionList;
+	/**
+	 * @var string[]
+	 */
+	protected $actionList;
 
 
-    /**
-     * @param \SpareParts\Overseer\StrategyEnum $strategy
-     * @param IVoter[] $voters
-     * @param string|string[] $actions
-     * @param string $contextClassName
-     * @param string $subjectClassName
-     */
-    public function __construct(
-        StrategyEnum $strategy,
-        array $voters,
-        $actions = null,
-        $contextClassName = IIdentityContext::class,
-        $subjectClassName = null
-    ) {
-        parent::__construct($strategy, $voters);
+	/**
+	 * @param \SpareParts\Overseer\StrategyEnum $strategy
+	 * @param IVoter[] $voters
+	 * @param string|string[] $actions
+	 * @param string $contextClassName
+	 * @param string $subjectClassName
+	 */
+	public function __construct(
+		StrategyEnum $strategy,
+		array $voters,
+		$actions = null,
+		$contextClassName = IIdentityContext::class,
+		$subjectClassName = null
+	) {
+		parent::__construct($strategy, $voters);
 
-        $this->actionList = (array) $actions;
-        $this->subjectClassName = $subjectClassName;
-        $this->contextClassName = $contextClassName;
-    }
+		$this->actionList = (array) $actions;
+		$this->subjectClassName = $subjectClassName;
+		$this->contextClassName = $contextClassName;
+	}
 
 
-    /**
-     * @param string $actionName
-     * @param object $subject
-     * @param \SpareParts\Overseer\Context\IVotingContext $context
-     * @return bool
-     */
-    public function canVoteOn($actionName, $subject, IVotingContext $context)
-    {
-        if ($this->subjectClassName && !($subject instanceof $this->subjectClassName)) {
-            return false;
-        }
+	/**
+	 * @param string $actionName
+	 * @param object $subject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $context
+	 * @return bool
+	 */
+	public function canVoteOn($actionName, $subject, IVotingContext $context)
+	{
+		if ($this->subjectClassName && !($subject instanceof $this->subjectClassName)) {
+			return false;
+		}
 
-        if ($this->contextClassName && !($context instanceof $this->contextClassName)) {
-            return false;
-        }
+		if ($this->contextClassName && !($context instanceof $this->contextClassName)) {
+			return false;
+		}
 
-        if ($this->actionList && !in_array($actionName, $this->actionList)) {
-            return false;
-        }
-        return true;
-    }
+		if ($this->actionList && !in_array($actionName, $this->actionList)) {
+			return false;
+		}
+		return true;
+	}
 
 }

src/Assembly/VotingAssembly.php

Indentation +103 added lines, -103 removed lines

@@ -12,107 +12,107 @@
 class VotingAssembly implements IVotingAssembly
 {
 
-    /**
-     * @var StrategyEnum
-     */
-    private $strategy;
-
-    /**
-     * @var IVoter[]
-     */
-    private $voters;
-
-
-    /**
-     * VotingAssembly constructor.
-     * @param StrategyEnum $strategy
-     * @param \SpareParts\Overseer\Voter\IVoter[] $voters
-     */
-    public function __construct(StrategyEnum $strategy, array $voters)
-    {
-        $this->strategy = $strategy;
-        $this->voters = $voters;
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return null|\SpareParts\Overseer\IVotingResult
-     * @throws \SpareParts\Overseer\InvalidVotingResultException
-     */
-    public function commenceVote($votingSubject, IVotingContext $votingContext)
-    {
-        $result = null;
-        switch ($this->strategy) {
-            case StrategyEnum::FIRST_VOTE_DECIDES():
-                return $this->strategyFirstVoteDecides($votingSubject, $votingContext);
-
-            case StrategyEnum::ALLOW_UNLESS_DENIED():
-                return $this->strategyAllowUnlessDenied($votingSubject, $votingContext);
-
-            case StrategyEnum::DENY_UNLESS_ALLOWED():
-                return $this->strategyDenyUnlessAllowed($votingSubject, $votingContext);
-
-            default:
-                throw new InvalidVotingResultException('Unable to decide on result, invalid strategy: '.$this->strategy);
-        }
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return \SpareParts\Overseer\IVotingResult
-     * @throws \SpareParts\Overseer\InvalidVotingResultException
-     */
-    private function strategyFirstVoteDecides($votingSubject, IVotingContext $votingContext)
-    {
-        foreach ($this->voters as $voter) {
-            if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
-                return new VotingResult($lastResult->getDecision(), [$lastResult]);
-            }
-        }
-        throw new InvalidVotingResultException('Voting assembly did not decide on any result!');
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return \SpareParts\Overseer\IVotingResult
-     */
-    private function strategyAllowUnlessDenied($votingSubject, IVotingContext $votingContext)
-    {
-        $results = [];
-        foreach ($this->voters as $name => $voter) {
-            if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
-                $results[] = $lastResult;
-                if ($lastResult->getDecision() === VotingDecisionEnum::DENIED()) {
-                    return new VotingResult(VotingDecisionEnum::DENIED(), $results);
-                }
-            }
-        }
-        return new VotingResult(VotingDecisionEnum::ALLOWED(), $results);
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return \SpareParts\Overseer\IVotingResult
-     */
-    private function strategyDenyUnlessAllowed($votingSubject, IVotingContext $votingContext)
-    {
-        $results = [];
-        foreach ($this->voters as $name => $voter) {
-            if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
-                $results[] = $lastResult;
-                if ($lastResult->getDecision() === VotingDecisionEnum::ALLOWED()) {
-                    return new VotingResult(VotingDecisionEnum::ALLOWED(), $results);
-                }
-            }
-        }
-        return new VotingResult(VotingDecisionEnum::DENIED(), $results);
-    }
+	/**
+	 * @var StrategyEnum
+	 */
+	private $strategy;
+
+	/**
+	 * @var IVoter[]
+	 */
+	private $voters;
+
+
+	/**
+	 * VotingAssembly constructor.
+	 * @param StrategyEnum $strategy
+	 * @param \SpareParts\Overseer\Voter\IVoter[] $voters
+	 */
+	public function __construct(StrategyEnum $strategy, array $voters)
+	{
+		$this->strategy = $strategy;
+		$this->voters = $voters;
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return null|\SpareParts\Overseer\IVotingResult
+	 * @throws \SpareParts\Overseer\InvalidVotingResultException
+	 */
+	public function commenceVote($votingSubject, IVotingContext $votingContext)
+	{
+		$result = null;
+		switch ($this->strategy) {
+			case StrategyEnum::FIRST_VOTE_DECIDES():
+				return $this->strategyFirstVoteDecides($votingSubject, $votingContext);
+
+			case StrategyEnum::ALLOW_UNLESS_DENIED():
+				return $this->strategyAllowUnlessDenied($votingSubject, $votingContext);
+
+			case StrategyEnum::DENY_UNLESS_ALLOWED():
+				return $this->strategyDenyUnlessAllowed($votingSubject, $votingContext);
+
+			default:
+				throw new InvalidVotingResultException('Unable to decide on result, invalid strategy: '.$this->strategy);
+		}
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return \SpareParts\Overseer\IVotingResult
+	 * @throws \SpareParts\Overseer\InvalidVotingResultException
+	 */
+	private function strategyFirstVoteDecides($votingSubject, IVotingContext $votingContext)
+	{
+		foreach ($this->voters as $voter) {
+			if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
+				return new VotingResult($lastResult->getDecision(), [$lastResult]);
+			}
+		}
+		throw new InvalidVotingResultException('Voting assembly did not decide on any result!');
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return \SpareParts\Overseer\IVotingResult
+	 */
+	private function strategyAllowUnlessDenied($votingSubject, IVotingContext $votingContext)
+	{
+		$results = [];
+		foreach ($this->voters as $name => $voter) {
+			if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
+				$results[] = $lastResult;
+				if ($lastResult->getDecision() === VotingDecisionEnum::DENIED()) {
+					return new VotingResult(VotingDecisionEnum::DENIED(), $results);
+				}
+			}
+		}
+		return new VotingResult(VotingDecisionEnum::ALLOWED(), $results);
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return \SpareParts\Overseer\IVotingResult
+	 */
+	private function strategyDenyUnlessAllowed($votingSubject, IVotingContext $votingContext)
+	{
+		$results = [];
+		foreach ($this->voters as $name => $voter) {
+			if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
+				$results[] = $lastResult;
+				if ($lastResult->getDecision() === VotingDecisionEnum::ALLOWED()) {
+					return new VotingResult(VotingDecisionEnum::ALLOWED(), $results);
+				}
+			}
+		}
+		return new VotingResult(VotingDecisionEnum::DENIED(), $results);
+	}
 }

src/Assembly/IVotingAbilityAwareAssembly.php

Indentation +7 added lines, -7 removed lines

@@ -13,11 +13,11 @@
 {
 
 
-    /**
-     * @param string $actionName
-     * @param mixed $subject
-     * @param \SpareParts\Overseer\Context\IVotingContext $context
-     * @return bool
-     */
-    public function canVoteOn($actionName, $subject, IVotingContext $context);
+	/**
+	 * @param string $actionName
+	 * @param mixed $subject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $context
+	 * @return bool
+	 */
+	public function canVoteOn($actionName, $subject, IVotingContext $context);
 }

src/Assembly/IVotingAssembly.php

Indentation +6 added lines, -6 removed lines

@@ -6,10 +6,10 @@
 interface IVotingAssembly
 {
 
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return \SpareParts\Overseer\IVotingResult
-     */
-    public function commenceVote($votingSubject, IVotingContext $votingContext);
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return \SpareParts\Overseer\IVotingResult
+	 */
+	public function commenceVote($votingSubject, IVotingContext $votingContext);
 }

src/AbstractVotingManager.php

Indentation +38 added lines, -38 removed lines

@@ -6,42 +6,42 @@
 
 abstract class AbstractVotingManager
 {
-    /**
-     * @var IVotingAbilityAwareAssembly[]
-     */
-    private $votingAssemblies;
-
-
-    /**
-     * VotingManager constructor.
-     * @param IVotingAbilityAwareAssembly[] $votingAssemblies
-     */
-    public function __construct(array $votingAssemblies)
-    {
-        $this->votingAssemblies = $votingAssemblies;
-    }
-
-
-    /**
-     * @param string $action
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return \SpareParts\Overseer\IVotingResult
-     * @throws \SpareParts\Overseer\InvalidVotingResultException
-     */
-    protected function innerVote($action, $votingSubject, IVotingContext $votingContext)
-    {
-        foreach ($this->votingAssemblies as $votingAssembly) {
-            if (!($votingAssembly instanceof IVotingAbilityAwareAssembly)) {
-                throw new InvalidArgumentException('Voting assemblies provided to voting manager must implement IVotingAbilityAwareAssembly interface!');
-            }
-
-            if ($votingAssembly->canVoteOn($action, $votingSubject, $votingContext)) {
-                return $votingAssembly->commenceVote($votingSubject, $votingContext);
-            }
-        }
-
-        throw new InvalidVotingResultException('No voting assembly for subject::action: '.
-            (string) $votingSubject.'::'.$action);
-    }
+	/**
+	 * @var IVotingAbilityAwareAssembly[]
+	 */
+	private $votingAssemblies;
+
+
+	/**
+	 * VotingManager constructor.
+	 * @param IVotingAbilityAwareAssembly[] $votingAssemblies
+	 */
+	public function __construct(array $votingAssemblies)
+	{
+		$this->votingAssemblies = $votingAssemblies;
+	}
+
+
+	/**
+	 * @param string $action
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return \SpareParts\Overseer\IVotingResult
+	 * @throws \SpareParts\Overseer\InvalidVotingResultException
+	 */
+	protected function innerVote($action, $votingSubject, IVotingContext $votingContext)
+	{
+		foreach ($this->votingAssemblies as $votingAssembly) {
+			if (!($votingAssembly instanceof IVotingAbilityAwareAssembly)) {
+				throw new InvalidArgumentException('Voting assemblies provided to voting manager must implement IVotingAbilityAwareAssembly interface!');
+			}
+
+			if ($votingAssembly->canVoteOn($action, $votingSubject, $votingContext)) {
+				return $votingAssembly->commenceVote($votingSubject, $votingContext);
+			}
+		}
+
+		throw new InvalidVotingResultException('No voting assembly for subject::action: '.
+			(string) $votingSubject.'::'.$action);
+	}
 }

src/Context/IdentityContext.php

Indentation +39 added lines, -39 removed lines

@@ -7,43 +7,43 @@
 class IdentityContext implements IIdentityContext
 {
 
-    /**
-     * @var mixed
-     */
-    private $id;
-
-    /**
-     * @var string[]
-     */
-    private $roles;
-
-
-    /**
-     * VotingContext constructor.
-     * @param mixed $id
-     * @param string[] $roles
-     */
-    public function __construct($id, array $roles)
-    {
-        $this->id = $id;
-        $this->roles = $roles;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function getId()
-    {
-        return $this->id;
-    }
-
-
-    /**
-     * @return string[]
-     */
-    public function getRoles()
-    {
-        return $this->roles;
-    }
+	/**
+	 * @var mixed
+	 */
+	private $id;
+
+	/**
+	 * @var string[]
+	 */
+	private $roles;
+
+
+	/**
+	 * VotingContext constructor.
+	 * @param mixed $id
+	 * @param string[] $roles
+	 */
+	public function __construct($id, array $roles)
+	{
+		$this->id = $id;
+		$this->roles = $roles;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function getId()
+	{
+		return $this->id;
+	}
+
+
+	/**
+	 * @return string[]
+	 */
+	public function getRoles()
+	{
+		return $this->roles;
+	}
 }

src/Context/IIdentityContext.php

Indentation +8 added lines, -8 removed lines

@@ -7,14 +7,14 @@
 interface IIdentityContext extends IVotingContext
 {
 
-    /**
-     * @return string|int|null
-     */
-    public function getId();
+	/**
+	 * @return string|int|null
+	 */
+	public function getId();
 
 
-    /**
-     * @return string[]
-     */
-    public function getRoles();
+	/**
+	 * @return string[]
+	 */
+	public function getRoles();
 }