SpareParts / Overseer

src/Voter/RoleVoter.php

Indentation +46 added lines, -46 removed lines

@@ -8,50 +8,50 @@
 
 final class RoleVoter implements IVoter
 {
-    /**
-     * @var string[]
-     */
-    private $allowedRoles;
-
-    /**
-     * @var VotingDecisionEnum
-     */
-    private $resultDecision;
-
-    /**
-     * @var mixed|null
-     */
-    private $reason;
-
-
-    /**
-     * RoleVoter constructor.
-     * @param VotingDecisionEnum $resultDecision
-     * @param string|string[] $allowedRoles
-     * @param mixed $reason
-     */
-    public function __construct(VotingDecisionEnum $resultDecision, $allowedRoles, $reason = null)
-    {
-        $this->allowedRoles = (array) $allowedRoles;
-        $this->resultDecision = $resultDecision;
-        $this->reason = $reason;
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return ISingleVoterResult
-     */
-    public function vote($votingSubject, IVotingContext $votingContext)
-    {
-        if (!($votingContext instanceof IIdentityContext)) {
-            throw new InvalidArgumentException('RoleVoter can be used only with specific voting context, implementing IIdentityContext.');
-        }
-
-        if (array_intersect($votingContext->getRoles(), $this->allowedRoles)) {
-            return new SingleVoterResult($this->resultDecision, $this->reason);
-        }
-        return null;
-    }
+	/**
+	 * @var string[]
+	 */
+	private $allowedRoles;
+
+	/**
+	 * @var VotingDecisionEnum
+	 */
+	private $resultDecision;
+
+	/**
+	 * @var mixed|null
+	 */
+	private $reason;
+
+
+	/**
+	 * RoleVoter constructor.
+	 * @param VotingDecisionEnum $resultDecision
+	 * @param string|string[] $allowedRoles
+	 * @param mixed $reason
+	 */
+	public function __construct(VotingDecisionEnum $resultDecision, $allowedRoles, $reason = null)
+	{
+		$this->allowedRoles = (array) $allowedRoles;
+		$this->resultDecision = $resultDecision;
+		$this->reason = $reason;
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return ISingleVoterResult
+	 */
+	public function vote($votingSubject, IVotingContext $votingContext)
+	{
+		if (!($votingContext instanceof IIdentityContext)) {
+			throw new InvalidArgumentException('RoleVoter can be used only with specific voting context, implementing IIdentityContext.');
+		}
+
+		if (array_intersect($votingContext->getRoles(), $this->allowedRoles)) {
+			return new SingleVoterResult($this->resultDecision, $this->reason);
+		}
+		return null;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
      */
     public function __construct(VotingDecisionEnum $resultDecision, $allowedRoles, $reason = null)
     {
-        $this->allowedRoles = (array) $allowedRoles;
+        $this->allowedRoles = (array)$allowedRoles;
         $this->resultDecision = $resultDecision;
         $this->reason = $reason;
     }

src/Voter/IVoter.php

Indentation +6 added lines, -6 removed lines

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

src/Voter/ConstVoter.php

Indentation +32 added lines, -32 removed lines

@@ -8,36 +8,36 @@
 
 class ConstVoter implements IVoter
 {
-    /**
-     * @var VotingDecisionEnum
-     */
-    private $constDecision;
-
-    /**
-     * @var mixed
-     */
-    private $constReason;
-
-
-    /**
-     * ConstVoter constructor.
-     * @param VotingDecisionEnum $constDecision
-     * @param mixed $constReason
-     */
-    public function __construct(VotingDecisionEnum $constDecision, $constReason = null)
-    {
-        $this->constDecision = $constDecision;
-        $this->constReason = $constReason;
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return ISingleVoterResult
-     */
-    public function vote($votingSubject, IVotingContext $votingContext)
-    {
-        return new SingleVoterResult($this->constDecision, $this->constReason);
-    }
+	/**
+	 * @var VotingDecisionEnum
+	 */
+	private $constDecision;
+
+	/**
+	 * @var mixed
+	 */
+	private $constReason;
+
+
+	/**
+	 * ConstVoter constructor.
+	 * @param VotingDecisionEnum $constDecision
+	 * @param mixed $constReason
+	 */
+	public function __construct(VotingDecisionEnum $constDecision, $constReason = null)
+	{
+		$this->constDecision = $constDecision;
+		$this->constReason = $constReason;
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return ISingleVoterResult
+	 */
+	public function vote($votingSubject, IVotingContext $votingContext)
+	{
+		return new SingleVoterResult($this->constDecision, $this->constReason);
+	}
 }

src/IVotingResult.php

Indentation +4 added lines, -4 removed lines

@@ -5,8 +5,8 @@
 
 interface IVotingResult extends IResult
 {
-    /**
-     * @return ISingleVoterResult[]
-     */
-    public function getPartialResults();
+	/**
+	 * @return ISingleVoterResult[]
+	 */
+	public function getPartialResults();
 }

src/GenericVotingManager.php

Indentation +11 added lines, -11 removed lines

@@ -14,15 +14,15 @@
 final class GenericVotingManager extends AbstractVotingManager
 {
 
-    /**
-     * @param string $action
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return \SpareParts\Overseer\IVotingResult
-     * @throws \SpareParts\Overseer\InvalidVotingResultException
-     */
-    public function vote($action, $votingSubject, IVotingContext $votingContext)
-    {
-        return $this->innerVote($action, $votingSubject, $votingContext);
-    }
+	/**
+	 * @param string $action
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return \SpareParts\Overseer\IVotingResult
+	 * @throws \SpareParts\Overseer\InvalidVotingResultException
+	 */
+	public function vote($action, $votingSubject, IVotingContext $votingContext)
+	{
+		return $this->innerVote($action, $votingSubject, $votingContext);
+	}
 }

src/Assembly/VotingAssembly.php

Indentation +137 added lines, -137 removed lines

@@ -13,141 +13,141 @@
 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)
-    {
-        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);
-
-            case StrategyEnum::EVERYONE_MUST_ALLOW_TO_BE_ALLOWED():
-                return $this->strategyEveryoneMustComply($votingSubject, $votingContext, VotingDecisionEnum::ALLOWED(), VotingDecisionEnum::DENIED());
-
-            case StrategyEnum::EVERYONE_MUST_DENY_TO_BE_DENIED():
-                return $this->strategyEveryoneMustComply($votingSubject, $votingContext, VotingDecisionEnum::DENIED(), VotingDecisionEnum::ALLOWED());
-
-            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);
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @param \SpareParts\Overseer\VotingDecisionEnum $defaultDecision
-     * @param \SpareParts\Overseer\VotingDecisionEnum $counterDecision
-     *
-     * @return \SpareParts\Overseer\VotingResult
-     */
-    private function strategyEveryoneMustComply(
-        $votingSubject,
-        IVotingContext $votingContext,
-        VotingDecisionEnum $defaultDecision,
-        VotingDecisionEnum $counterDecision
-    ) {
-        $results = [];
-        $decision = $defaultDecision;
-        foreach ($this->voters as $voter) {
-            $result = $voter->vote($votingSubject, $votingContext);
-            if ($result instanceof ISingleVoterResult) {
-                if ($result->getDecision() !== $defaultDecision) {
-                    $decision = $counterDecision;
-                }
-                $results[] = $result;
-            }
-        }
-        return new VotingResult($decision, $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)
+	{
+		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);
+
+			case StrategyEnum::EVERYONE_MUST_ALLOW_TO_BE_ALLOWED():
+				return $this->strategyEveryoneMustComply($votingSubject, $votingContext, VotingDecisionEnum::ALLOWED(), VotingDecisionEnum::DENIED());
+
+			case StrategyEnum::EVERYONE_MUST_DENY_TO_BE_DENIED():
+				return $this->strategyEveryoneMustComply($votingSubject, $votingContext, VotingDecisionEnum::DENIED(), VotingDecisionEnum::ALLOWED());
+
+			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);
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @param \SpareParts\Overseer\VotingDecisionEnum $defaultDecision
+	 * @param \SpareParts\Overseer\VotingDecisionEnum $counterDecision
+	 *
+	 * @return \SpareParts\Overseer\VotingResult
+	 */
+	private function strategyEveryoneMustComply(
+		$votingSubject,
+		IVotingContext $votingContext,
+		VotingDecisionEnum $defaultDecision,
+		VotingDecisionEnum $counterDecision
+	) {
+		$results = [];
+		$decision = $defaultDecision;
+		foreach ($this->voters as $voter) {
+			$result = $voter->vote($votingSubject, $votingContext);
+			if ($result instanceof ISingleVoterResult) {
+				if ($result->getDecision() !== $defaultDecision) {
+					$decision = $counterDecision;
+				}
+				$results[] = $result;
+			}
+		}
+		return new VotingResult($decision, $results);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -76,7 +76,7 @@ 
     {
         foreach ($this->voters as $voter) {
             if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
-                return new VotingResult($lastResult->getDecision(), [$lastResult]);
+                return new VotingResult($lastResult->getDecision(), [ $lastResult ]);
             }
         }
         throw new InvalidVotingResultException('Voting assembly did not decide on any result!');
@@ -90,10 +90,10 @@ 
      */
     private function strategyAllowUnlessDenied($votingSubject, IVotingContext $votingContext)
     {
-        $results = [];
+        $results = [ ];
         foreach ($this->voters as $name => $voter) {
             if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
-                $results[] = $lastResult;
+                $results[ ] = $lastResult;
                 if ($lastResult->getDecision() === VotingDecisionEnum::DENIED()) {
                     return new VotingResult(VotingDecisionEnum::DENIED(), $results);
                 }
@@ -110,10 +110,10 @@ 
      */
     private function strategyDenyUnlessAllowed($votingSubject, IVotingContext $votingContext)
     {
-        $results = [];
+        $results = [ ];
         foreach ($this->voters as $name => $voter) {
             if (($lastResult = $voter->vote($votingSubject, $votingContext)) !== null) {
-                $results[] = $lastResult;
+                $results[ ] = $lastResult;
                 if ($lastResult->getDecision() === VotingDecisionEnum::ALLOWED()) {
                     return new VotingResult(VotingDecisionEnum::ALLOWED(), $results);
                 }
@@ -137,7 +137,7 @@ 
         VotingDecisionEnum $defaultDecision,
         VotingDecisionEnum $counterDecision
     ) {
-        $results = [];
+        $results = [ ];
         $decision = $defaultDecision;
         foreach ($this->voters as $voter) {
             $result = $voter->vote($votingSubject, $votingContext);
@@ -145,7 +145,7 @@ 
                 if ($result->getDecision() !== $defaultDecision) {
                     $decision = $counterDecision;
                 }
-                $results[] = $result;
+                $results[ ] = $result;
             }
         }
         return new VotingResult($decision, $results);

src/VotingDecisionEnum.php

Indentation +4 added lines, -4 removed lines

@@ -9,8 +9,8 @@
  */
 final class VotingDecisionEnum extends Enum
 {
-    protected static $values = [
-        'ALLOWED',
-        'DENIED',
-    ];
+	protected static $values = [
+		'ALLOWED',
+		'DENIED',
+	];
 }

src/StrategyEnum.php

Indentation +7 added lines, -7 removed lines

@@ -12,11 +12,11 @@
  */
 final class StrategyEnum extends Enum
 {
-    protected static $values = [
-        'FIRST_VOTE_DECIDES',
-        'ALLOW_UNLESS_DENIED',
-        'DENY_UNLESS_ALLOWED',
-        'EVERYONE_MUST_ALLOW_TO_BE_ALLOWED',
-        'EVERYONE_MUST_DENY_TO_BE_DENIED',
-    ];
+	protected static $values = [
+		'FIRST_VOTE_DECIDES',
+		'ALLOW_UNLESS_DENIED',
+		'DENY_UNLESS_ALLOWED',
+		'EVERYONE_MUST_ALLOW_TO_BE_ALLOWED',
+		'EVERYONE_MUST_DENY_TO_BE_DENIED',
+	];
 }

src/Voter/ClosureVoter.php

Indentation +50 added lines, -50 removed lines

@@ -8,54 +8,54 @@
 
 class ClosureVoter implements IVoter
 {
-    /**
-     * @var \Closure
-     */
-    private $authorizationClosure;
-
-
-    /**
-     * ClosureVoter constructor.
-     * @param \Closure $authorizationClosure
-     */
-    public function __construct(\Closure $authorizationClosure)
-    {
-        $this->authorizationClosure = $authorizationClosure;
-    }
-
-
-    /**
-     * @param mixed $votingSubject
-     * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
-     * @return ISingleVoterResult
-     */
-    public function vote($votingSubject, IVotingContext $votingContext)
-    {
-        $closure = $this->authorizationClosure;
-        $result = $closure($votingSubject, $votingContext);
-
-        $result = $this->prepareResult($result);
-
-        return $result;
-    }
-
-
-    /**
-     * @param mixed $result
-     * @return SingleVoterResult
-     */
-    protected function prepareResult($result)
-    {
-        if ($result === true) {
-            $result = new SingleVoterResult(VotingDecisionEnum::ALLOWED());
-            return $result;
-        } elseif ($result === false) {
-            $result = new SingleVoterResult(VotingDecisionEnum::DENIED());
-            return $result;
-        } elseif ($result instanceof VotingDecisionEnum) {
-            $result = new SingleVoterResult($result);
-            return $result;
-        }
-        return $result;
-    }
+	/**
+	 * @var \Closure
+	 */
+	private $authorizationClosure;
+
+
+	/**
+	 * ClosureVoter constructor.
+	 * @param \Closure $authorizationClosure
+	 */
+	public function __construct(\Closure $authorizationClosure)
+	{
+		$this->authorizationClosure = $authorizationClosure;
+	}
+
+
+	/**
+	 * @param mixed $votingSubject
+	 * @param \SpareParts\Overseer\Context\IVotingContext $votingContext
+	 * @return ISingleVoterResult
+	 */
+	public function vote($votingSubject, IVotingContext $votingContext)
+	{
+		$closure = $this->authorizationClosure;
+		$result = $closure($votingSubject, $votingContext);
+
+		$result = $this->prepareResult($result);
+
+		return $result;
+	}
+
+
+	/**
+	 * @param mixed $result
+	 * @return SingleVoterResult
+	 */
+	protected function prepareResult($result)
+	{
+		if ($result === true) {
+			$result = new SingleVoterResult(VotingDecisionEnum::ALLOWED());
+			return $result;
+		} elseif ($result === false) {
+			$result = new SingleVoterResult(VotingDecisionEnum::DENIED());
+			return $result;
+		} elseif ($result instanceof VotingDecisionEnum) {
+			$result = new SingleVoterResult($result);
+			return $result;
+		}
+		return $result;
+	}
 }