Baleen\Migrations\Service\Runner\MigrationRunner

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
B	run()	0	28	3
A	shouldMigrate()	0	5	2
A	doRun()	0	5	1

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Baleen\Migrations\Service\Runner;

use Baleen\Migrations\Exception\Service\Runner\RunnerException;
use Baleen\Migrations\Migration\Command\MigrationBus;
use Baleen\Migrations\Migration\Command\MigrationBusInterface;
use Baleen\Migrations\Migration\OptionsInterface;
use Baleen\Migrations\Service\Runner\Event\Migration\MigrateAfterEvent;
use Baleen\Migrations\Service\Runner\Event\Migration\MigrateBeforeEvent;
use Baleen\Migrations\Shared\Event\Context\CollectionContextInterface;
use Baleen\Migrations\Shared\Event\PublisherInterface;
use Baleen\Migrations\Version\VersionInterface;

/**
 * Class MigrationRunner
 *
 * A Runner that emits domain events using an Emitter
 *
 * @author Gabriel Somoza <gabriel@strategery.io>
 */
final class MigrationRunner extends AbstractRunner
{
    /** @var MigrationBusInterface */
    private $migrationBus;

    /**
     * MigrationRunner constructor.
     *
     * @param MigrationBusInterface $migrationBus

Should the type for parameter $migrationBus not be null|MigrationBusInterface?

     * @param PublisherInterface $publisher

Should the type for parameter $publisher not be null|PublisherInterface?

     * @param CollectionContextInterface $context

Should the type for parameter $context not be null|CollectionContextInterface?

     */
    public function __construct(
        MigrationBusInterface $migrationBus = null,
        PublisherInterface $publisher = null,
        CollectionContextInterface $context = null
    ) {
        if (null === $migrationBus) {
            $migrationBus = MigrationBus::createDefaultBus();
        }
        $this->migrationBus = $migrationBus;

        parent::__construct($publisher, $context);
    }

    /**
     * Runs a single version using the specified options
     *
     * @param VersionInterface $version
     * @param OptionsInterface $options
     *
     * @return VersionInterface|false
     *
     * @throws RunnerException
     */
    public function run(VersionInterface $version, OptionsInterface $options)
    {
        if (!$this->shouldMigrate($version, $options)) {
            if ($options->isExceptionOnSkip()) {
                throw new RunnerException(sprintf(
                    'Cowardly refusing to run %s() on a version that is already "%s" (ID: %s).',
                    $options->getDirection(),
                    $options->getDirection(),
                    $version->getId()
                ));
            }

            return false; // skip
        }

        // Dispatch MIGRATE_BEFORE
        $this->getPublisher()->publish(new MigrateBeforeEvent($version, $options, $this->getContext()));

$this->getContext() is of type object<Baleen\Migrations\Shared\Event\Context\ContextInterface>, but the function expects a null|object<Baleen\Migrations\Shared\Event\Context\CollectionContextInterface>.

        $this->doRun($version, $options);

        // this is safe because it won't get executed if an exception is thrown during migration
        $version->setMigrated($options->getDirection()->isUp());

        // Dispatch MIGRATE_AFTER
        $this->getPublisher()->publish(new MigrateAfterEvent($version, $options, $this->getContext()));

$this->getContext() is of type object<Baleen\Migrations\Shared\Event\Context\ContextInterface>, but the function expects a null|object<Baleen\Migrations\Shared\Event\Context\CollectionContextInterface>.

        return $version;
    }

    /**
     * Returns true if the operation is forced, or if the direction is the opposite to the state of the migration.
     *
     * @param VersionInterface $version
     * @param OptionsInterface $options
     *
     * @return bool
     */
    protected function shouldMigrate(VersionInterface $version, OptionsInterface $options)
    {
        return $options->isForced()
        || ($options->getDirection()->isUp() ^ $version->isMigrated()); // direction is opposite to state
    }

    /**
     * @param VersionInterface $version
     * @param OptionsInterface $options
     * @return bool

Should the return type not be boolean|null?

     */
    protected function doRun(VersionInterface $version, OptionsInterface $options)
    {
        $command = $version->getMigrateCommand($options);
        $this->migrationBus->handle($command);
    }
}