Dhii/simple-test-abstract

<?php

namespace Dhii\SimpleTest\Suite;

use Dhii\SimpleTest\Test;
use Dhii\SimpleTest\Coordinator;

/**
 * Most basic common test suite functionality.
 *
 * @since 0.1.0
 */
abstract class AbstractSuite extends Test\AbstractSource implements SuiteInterface
{
    protected $coordinator;

    /**
     * Sets the coordinator to be used by this instance.
     *
     * @since 0.1.0
     *
     * @param Coordinator\CoordinatorInterface $coordinator The coordinator to set.
     *
     * @return AbstractSuite This instance.
     */
    protected function _setCoordinator(Coordinator\CoordinatorInterface $coordinator)
    {
        $this->coordinator = $coordinator;

        return $this;
    }

    /**
     * Retrieve the coordinator that is used by this instance.
     *
     * @since 0.1.0
     *
     * @return Coordinator\CoordinatorInterface The coordinator used by this instance.
     */
    protected function _getCoordinator()
    {
        return $this->coordinator;
    }

    /**
     * {@inheritdoc}
     *
     * @since 0.1.0
     */
    public function getTests()
    {
        return $this->_getTests();
    }

    /**
     * Low-level multiple tests retrieval.
     *
     * @since 0.1.0
     *
     * @return Test\TestInterface[]|\Traversable The tests in this suite.
     */
    protected function _getTests()
    {
        return $this->items;
    }

    /**
     * {@inheritdoc}
     *
     * @since 0.1.0
     */
    public function addTest(Test\TestInterface $test)
    {
        $this->_getCoordinator()->beforeAddTest($test, $this);
        if ($test->getSuiteCode()) {
            throw new \InvalidArgumentException(sprintf('Could not add test "%3$s" to suite "%1$s": test already belongs to suite "%2$s"', $this->getCode(), $test->getSuiteCode(), $test->getKey()));
        }

        $this->_addTest($test);
        $this->_getCoordinator()->afterAddTest($test, $this);

        return $this;
    }

    /**
     * Low-level single test adding.
     *
     * @since 0.1.0
     *
     * @param Test\TestInterface $test The test to add.
     *
     * @return AbstractSuite This instance.
     */
    protected function _addTest(Test\TestInterface $test)
    {
        $test->setSuiteCode($this->getCode());
        $this->_addItem($test);

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @since 0.1.0
     */
    public function addTests($tests)
    {
        $this->_addTests($tests);

        return $this;
    }

    /**
     * Low-level multiple test adding.
     *
     * @since 0.1.0
     *
     * @param Test\TestInterface[]|\Traversable $tests The tests to add.
     *
     * @return AbstractSuite This instance.
     */
    protected function _addTests($tests)
    {
        foreach ($tests as $_test) {
            $this->addTest($_test);
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @since 0.1.0
     */
    public function getCode()
    {
        return $this->_getCode();
    }

    /**
     * Low-level suite code retrieval.
     *
     * @since 0.1.0
     *
     * @return string The code of this suite.
     */
    protected function _getCode()
    {
        return $this->code;
    }

    /**
     * Low-level suite code setting.
     *
     * @since 0.1.0
     *
     * @param string $code The suite code to set.
     *
     * @return AbstractSuite This instance.
     */
    protected function _setCode($code)
    {
        $this->code = $code;

        return $this;
    }
}