MigrationRunner::__construct() - 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-28 12:38 UTC

MigrationRunner::__construct() A

↳ Parent: MigrationRunner

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	11
ccs	7
cts	7
cp	1
rs	9.4286
cc	2
eloc	7
nc	2
nop	2
crap	2

<?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\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 MigrationRunnerInterface
{
    use HasInternalPublisherTrait;
    use HasContextTrait;

    /**
     * MigrationRunner constructor.
     *
     * @param PublisherInterface $publisher

     * @param CollectionContextInterface $context

     */
    public function __construct(
        PublisherInterface $publisher = null,
        CollectionContextInterface $context = null
    ) {
        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 false|MigrateAfterEvent
     *
     * @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);

        $version->migrate($options); // state will be changed

        // Dispatch MIGRATE_AFTER
        $event = new MigrateAfterEvent($version, $options, $this->getContext());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->getPublisher()->publish($event);

        return $event;
    }

    /**
     * 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
    }

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

        return new static($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\OptionsInterface;
24		use Baleen\Migrations\Service\Runner\Event\Migration\MigrateAfterEvent;
25		use Baleen\Migrations\Service\Runner\Event\Migration\MigrateBeforeEvent;
26		use Baleen\Migrations\Shared\Event\Context\CollectionContext;
27		use Baleen\Migrations\Shared\Event\Context\CollectionContextInterface;
28		use Baleen\Migrations\Shared\Event\Context\ContextInterface;
29		use Baleen\Migrations\Shared\Event\Context\HasContextTrait;
30		use Baleen\Migrations\Shared\Event\Publisher\HasInternalPublisherTrait;
31		use Baleen\Migrations\Shared\Event\PublisherInterface;
32		use Baleen\Migrations\Version\VersionInterface;
33
34		/**
35		* Class MigrationRunner
36		*
37		* A Runner that emits domain events using an Emitter
38		*
39		* @author Gabriel Somoza <[email protected]>
40		*/
41		final class MigrationRunner implements MigrationRunnerInterface
42		{
43		use HasInternalPublisherTrait;
44		use HasContextTrait;
45
46		/**
47		* MigrationRunner constructor.
48		*
49		* @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...
50		* @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...
51		*/
52	29	public function __construct(
53		PublisherInterface $publisher = null,
54		CollectionContextInterface $context = null
55		) {
56	29	if (null === $context) {
57	23	$context = CollectionContext::createWithProgress(1, 1);
58	23	}
59	29	$this->setContext($context);
60
61	29	$this->setPublisher($publisher);
62	29	}
63
64		/**
65		* Runs a single version using the specified options
66		*
67		* @param VersionInterface $version
68		* @param OptionsInterface $options
69		*
70		* @return false\|MigrateAfterEvent
71		*
72		* @throws RunnerException
73		*/
74	23	public function run(VersionInterface $version, OptionsInterface $options)
75		{
76	23	if (!$this->shouldMigrate($version, $options)) {
77	14	if ($options->isExceptionOnSkip()) {
78	2	throw new RunnerException(sprintf(
79	2	'Cowardly refusing to run %s() on a version that is already "%s" (ID: %s).',
80	2	$options->getDirection(),
81	2	$options->getDirection(),
82	2	$version->getId()
83	2	));
84		}
85
86	12	return false; // skip
87		}
88
89		// Dispatch MIGRATE_BEFORE
90	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...
91
92	13	$version->migrate($options); // state will be changed
93
94		// Dispatch MIGRATE_AFTER
95	13	$event = new MigrateAfterEvent($version, $options, $this->getContext());
		0 ignored issues – show Documentation introduced 2015-11-27 19:26 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...
96	13	$this->getPublisher()->publish($event);
97
98	13	return $event;
99		}
100
101		/**
102		* Returns true if the operation is forced, or if the direction is the opposite to the state of the migration.
103		*
104		* @param VersionInterface $version
105		* @param OptionsInterface $options
106		*
107		* @return bool
108		*/
109	23	protected function shouldMigrate(VersionInterface $version, OptionsInterface $options)
110		{
111	23	return $options->isForced()
112	23	\|\| ($options->getDirection()->isUp() ^ $version->isMigrated()); // direction is opposite to state
113		}
114
115		/**
116		* @inheritdoc
117		*/
118	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...
119	18	return new static($this->getPublisher(), $context);
		0 ignored issues – show Documentation introduced 2015-11-27 19:26 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...
120		}
121		}
122

baleen / migrations

Pull Request — master (#15)

MigrationRunner::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like