LogicTesterResult.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Testing\LogicTester;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use Illuminate\Foundation\Testing\Assert;

class LogicTesterResult
{

    private $passes = [];

    private $fails = [];

    private $required = [];

    private $overrideResult;
    
    private $default = false;

    public function pass($userModel = null, $groupModel = null, $roleModel = null)
    {
        $this->passes[] = $this->parseArguments($userModel, $groupModel, $roleModel);
        return $this;
    }

    private function parseArguments($userModel = null, $groupModel = null, $roleModel = null)
    {
        return [($userModel instanceof User ? $userModel->id() : null), ($groupModel instanceof Group ? $groupModel->id() : null), ($roleModel instanceof Role ? $roleModel->id() : null)];
    }
    
    public function fail($userModel = null, $groupModel = null, $roleModel = null)
    {
        $this->fails[] = $this->parseArguments($userModel, $groupModel, $roleModel);
        return $this;
    }

    public function shouldBeCalled($userModel = null, $groupModel = null, $roleModel = null)
    {
        $this->required[] = $this->parseArguments($userModel, $groupModel, $roleModel);
        return $this;
    }

    public function otherwise(bool $value = true)
    {
        $this->default = $value;
        return $this;
    }

    public function alwaysPass()
    {
        $this->overrideResult = true;
    }

    public function alwaysFail()
    {
        $this->overrideResult = false;
    }
    
    public function evaluate($userModel = null, $groupModel = null, $roleModel = null): bool
    {
        $args = $this->parseArguments($userModel, $groupModel, $roleModel);
        $this->required = array_filter($this->required, function($parameters) use ($args) {
            return $parameters !== $args;
        });
     
        if ($this->overrideResult !== null) {
            return $this->overrideResult;
        }
        
        if (in_array($args, $this->passes)) {
            return true;
        }
        if (in_array($args, $this->fails)) {
            return false;
        }
        return $this->default;
    }

    public function __destruct()
    {
        Assert::assertCount(0, $this->required, 'Not all logic tests have been called.');
    }

}