MigrationRunner::withContext() - Code Metrics - Inspection of "DDD Refactor" - baleen/migrations - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Gabriel

created 2015-11-26 05:52 UTC

MigrationRunner::withContext() A

↳ Parent: MigrationRunner

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	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\CollectionContext;
use Baleen\Migrations\Shared\Event\Context\CollectionContextInterface;
use Baleen\Migrations\Shared\Event\Context\ContextInterface;
use Baleen\Migrations\Shared\Event\Context\HasContextTrait;
use Baleen\Migrations\Shared\Event\Publisher\HasInternalPublisherTrait;
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 <[email protected]>
 */
final class MigrationRunner implements ContextualRunnerInterface
{
    use HasInternalPublisherTrait;
    use HasContextTrait;

    /** @var MigrationBusInterface */
    private $migrationBus;

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

     * @param PublisherInterface $publisher

     * @param CollectionContextInterface $context

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

        if (null === $context) {
            $context = CollectionContext::createWithProgress(1, 1);
        }
        $this->setContext($context);

        $this->setPublisher($publisher);
    }

    /**
     * Runs a single version using the specified options
     *
     * @param VersionInterface $version
     * @param OptionsInterface $options
     *
     * @return VersionInterface
     *
     * @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()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $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()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        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

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

    /**
     * @inheritdoc
     */
    final public function withContext(ContextInterface $context) {

        return new static($this->migrationBus, $this->getPublisher(), $context);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace Baleen\Migrations\Service\Runner;
21
22		use Baleen\Migrations\Exception\Service\Runner\RunnerException;
23		use Baleen\Migrations\Migration\Command\MigrationBus;
24		use Baleen\Migrations\Migration\Command\MigrationBusInterface;
25		use Baleen\Migrations\Migration\OptionsInterface;
26		use Baleen\Migrations\Service\Runner\Event\Migration\MigrateAfterEvent;
27		use Baleen\Migrations\Service\Runner\Event\Migration\MigrateBeforeEvent;
28		use Baleen\Migrations\Shared\Event\Context\CollectionContext;
29		use Baleen\Migrations\Shared\Event\Context\CollectionContextInterface;
30		use Baleen\Migrations\Shared\Event\Context\ContextInterface;
31		use Baleen\Migrations\Shared\Event\Context\HasContextTrait;
32		use Baleen\Migrations\Shared\Event\Publisher\HasInternalPublisherTrait;
33		use Baleen\Migrations\Shared\Event\PublisherInterface;
34		use Baleen\Migrations\Version\VersionInterface;
35
36		/**
37		* Class MigrationRunner
38		*
39		* A Runner that emits domain events using an Emitter
40		*
41		* @author Gabriel Somoza <[email protected]>
42		*/
43		final class MigrationRunner implements ContextualRunnerInterface
44		{
45		use HasInternalPublisherTrait;
46		use HasContextTrait;
47
48		/** @var MigrationBusInterface */
49		private $migrationBus;
50
51		/**
52		* MigrationRunner constructor.
53		*
54		* @param MigrationBusInterface $migrationBus
		0 ignored issues – show Documentation introduced 2015-11-23 16:45 UTC by Report Bug Copy Issue Report Should the type for parameter `$migrationBus` not be `null\|MigrationBusInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
55		* @param PublisherInterface $publisher
		0 ignored issues – show Documentation introduced 2015-11-23 16:45 UTC by Report Bug Copy Issue Report Should the type for parameter `$publisher` not be `null\|PublisherInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
56		* @param CollectionContextInterface $context
		0 ignored issues – show Documentation introduced 2015-11-23 16:45 UTC by Report Bug Copy Issue Report Should the type for parameter `$context` not be `null\|CollectionContextInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
57		*/
58	27	public function __construct(
59		MigrationBusInterface $migrationBus = null,
60		PublisherInterface $publisher = null,
61		CollectionContextInterface $context = null
62		) {
63	27	if (null === $migrationBus) {
64	20	$migrationBus = MigrationBus::createDefaultBus();
65	20	}
66	27	$this->migrationBus = $migrationBus;
67
68	27	if (null === $context) {
69	22	$context = CollectionContext::createWithProgress(1, 1);
70	22	}
71	27	$this->setContext($context);
72
73	27	$this->setPublisher($publisher);
74	27	}
75
76		/**
77		* Runs a single version using the specified options
78		*
79		* @param VersionInterface $version
80		* @param OptionsInterface $options
81		*
82		* @return VersionInterface
83		*
84		* @throws RunnerException
85		*/
86	23	public function run(VersionInterface $version, OptionsInterface $options)
87		{
88	23	if (!$this->shouldMigrate($version, $options)) {
89	14	if ($options->isExceptionOnSkip()) {
90	2	throw new RunnerException(sprintf(
91	2	'Cowardly refusing to run %s() on a version that is already "%s" (ID: %s).',
92	2	$options->getDirection(),
93	2	$options->getDirection(),
94	2	$version->getId()
95	2	));
96		}
97
98	12	return false; // skip
99		}
100
101		// Dispatch MIGRATE_BEFORE
102	13	$this->getPublisher()->publish(new MigrateBeforeEvent($version, $options, $this->getContext()));
		0 ignored issues – show Documentation introduced 2015-11-23 16:45 UTC by Report Bug Copy Issue Report `$this->getContext()` is of type `object<Baleen\Migrations...ntext\ContextInterface>`, but the function expects a `null\|object<Baleen\Migra...ectionContextInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
103
104	13	$this->doRun($version, $options);
105
106		// this is safe because it won't get executed if an exception is thrown during migration
107	13	$version->setMigrated($options->getDirection()->isUp());
108
109		// Dispatch MIGRATE_AFTER
110	13	$this->getPublisher()->publish(new MigrateAfterEvent($version, $options, $this->getContext()));
		0 ignored issues – show Documentation introduced 2015-11-23 16:45 UTC by Report Bug Copy Issue Report `$this->getContext()` is of type `object<Baleen\Migrations...ntext\ContextInterface>`, but the function expects a `null\|object<Baleen\Migra...ectionContextInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
111
112	13	return $version;
113		}
114
115		/**
116		* Returns true if the operation is forced, or if the direction is the opposite to the state of the migration.
117		*
118		* @param VersionInterface $version
119		* @param OptionsInterface $options
120		*
121		* @return bool
122		*/
123	23	protected function shouldMigrate(VersionInterface $version, OptionsInterface $options)
124		{
125	23	return $options->isForced()
126	23	\|\| ($options->getDirection()->isUp() ^ $version->isMigrated()); // direction is opposite to state
127		}
128
129		/**
130		* @param VersionInterface $version
131		* @param OptionsInterface $options
132		* @return bool
		0 ignored issues – show Documentation introduced 2015-11-23 16:45 UTC by Report Bug Copy Issue Report Should the return type not be `boolean\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
133		*/
134	13	protected function doRun(VersionInterface $version, OptionsInterface $options)
135		{
136	13	$command = $version->getMigrateCommand($options);
137	13	$this->migrationBus->handle($command);
138	13	}
139
140		/**
141		* @inheritdoc
142		*/
143	18	final public function withContext(ContextInterface $context) {
		0 ignored issues – show Coding Style introduced 2015-11-26 05:55 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
144	18	return new static($this->migrationBus, $this->getPublisher(), $context);
		0 ignored issues – show Documentation introduced 2015-11-26 05:55 UTC by Report Bug Copy Issue Report `$context` is of type `object<Baleen\Migrations...ntext\ContextInterface>`, but the function expects a `null\|object<Baleen\Migra...ectionContextInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
145		}
146		}
147

baleen / migrations

Pull Request — master (#15)

MigrationRunner::withContext() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like