MigrateController::versionAction() - Code Metrics - Inspection of "refactor migration version command" - t4web/Migrations - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2c3775...168ecb )

by max

created 2016-03-03 21:24 UTC

MigrateController::versionAction() A

↳ Parent: MigrateController::listAction()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace T4web\Migrations\Controller;

use Zend\Mvc\Controller\AbstractActionController;
use T4web\Migrations\Service\Migration;
use T4web\Migrations\Service\Generator;
use Zend\Console\Request as ConsoleRequest;
use Zend\Mvc\MvcEvent;

/**
 * Migration commands controller
 */
class MigrateController extends AbstractActionController
{
    /**
     * @var Migration
     */
    protected $migration;

    /**
     * @var Generator
     */
    protected $generator;

    public function onDispatch(MvcEvent $e)
    {
        if (!$this->getRequest() instanceof ConsoleRequest) {
            throw new \RuntimeException('You can only use this action from a console!');
        }

        parent::onDispatch($e);
    }
    /**
     * MigrateController constructor.
     *
     * @param Migration $migration
     * @param Generator $generator
     */
    public function __construct(Migration $migration, Generator $generator)
    {
        $this->migration = $migration;
        $this->generator = $generator;
    }

    /**
     * List migrations - not applied by default, all with 'all' flag.
     *
     * @return string
     */
    public function listAction()
    {
        $migrations = $this->getMigration()->getMigrationClasses($this->getRequest()->getParam('all'));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $list = [];
        foreach ($migrations as $m) {
            $list[] = sprintf("%s %s - %s", $m['applied'] ? '-' : '+', $m['version'], $m['description']);
        }
        return (empty($list) ? 'No migrations available.' : implode("\n", $list)) . "\n";
    }

    /**
     * Apply migration
     */
    public function applyAction()
    {
        $version = $this->getRequest()->getParam('version');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $force = $this->getRequest()->getParam('force');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $down = $this->getRequest()->getParam('down');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $fake = $this->getRequest()->getParam('fake');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        if (is_null($version) && $force) {
            return "Can't force migration apply without migration version explicitly set.\n";
        }
        if (is_null($version) && $fake) {
            return "Can't fake migration apply without migration version explicitly set.\n";
        }

        $this->getMigration()->migrate($version, $force, $down, $fake);
        return "Migrations applied!\n";
    }

    /**
     * Generate new migration skeleton class
     */
    public function generateAction()
    {
        $classPath = $this->getGenerator()->generate();

        return sprintf("Generated skeleton class @ %s\n", realpath($classPath));
    }

    /**
     * @return Migration
     */
    public function getMigration()
    {
        return $this->migration;
    }

    /**
     * @return Generator
     */
    public function getGenerator()
    {
        return $this->generator;
    }
}


1			<?php
2
3			namespace T4web\Migrations\Controller;
4
5			use Zend\Mvc\Controller\AbstractActionController;
6			use T4web\Migrations\Service\Migration;
7			use T4web\Migrations\Service\Generator;
8			use Zend\Console\Request as ConsoleRequest;
9			use Zend\Mvc\MvcEvent;
10
11			/**
12			* Migration commands controller
13			*/
14			class MigrateController extends AbstractActionController
15			{
16			/**
17			* @var Migration
18			*/
19			protected $migration;
20
21			/**
22			* @var Generator
23			*/
24			protected $generator;
25
26			public function onDispatch(MvcEvent $e)
27			{
28			if (!$this->getRequest() instanceof ConsoleRequest) {
29			throw new \RuntimeException('You can only use this action from a console!');
30			}
31
32			parent::onDispatch($e);
33			}
34			/**
35			* MigrateController constructor.
36			*
37			* @param Migration $migration
38			* @param Generator $generator
39			*/
40			public function __construct(Migration $migration, Generator $generator)
41			{
42			$this->migration = $migration;
43			$this->generator = $generator;
44			}
45
46			/**
47			* List migrations - not applied by default, all with 'all' flag.
48			*
49			* @return string
50			*/
51			public function listAction()
52			{
53			$migrations = $this->getMigration()->getMigrationClasses($this->getRequest()->getParam('all'));
			0 ignored issues – show Bug introduced 2016-03-03 20:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getParam()` does only exist in the following implementations of said interface: `Zend\Console\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
54			$list = [];
55			foreach ($migrations as $m) {
56			$list[] = sprintf("%s %s - %s", $m['applied'] ? '-' : '+', $m['version'], $m['description']);
57			}
58			return (empty($list) ? 'No migrations available.' : implode("\n", $list)) . "\n";
59			}
60
61			/**
62			* Apply migration
63			*/
64			public function applyAction()
65			{
66			$version = $this->getRequest()->getParam('version');
			0 ignored issues – show Bug introduced 2016-03-03 20:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getParam()` does only exist in the following implementations of said interface: `Zend\Console\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
67			$force = $this->getRequest()->getParam('force');
			0 ignored issues – show Bug introduced 2016-03-03 20:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getParam()` does only exist in the following implementations of said interface: `Zend\Console\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
68			$down = $this->getRequest()->getParam('down');
			0 ignored issues – show Bug introduced 2016-03-03 20:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getParam()` does only exist in the following implementations of said interface: `Zend\Console\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
69			$fake = $this->getRequest()->getParam('fake');
			0 ignored issues – show Bug introduced 2016-03-03 20:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getParam()` does only exist in the following implementations of said interface: `Zend\Console\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
70
71			if (is_null($version) && $force) {
72			return "Can't force migration apply without migration version explicitly set.\n";
73			}
74			if (is_null($version) && $fake) {
75			return "Can't fake migration apply without migration version explicitly set.\n";
76			}
77
78			$this->getMigration()->migrate($version, $force, $down, $fake);
79			return "Migrations applied!\n";
80			}
81
82			/**
83			* Generate new migration skeleton class
84			*/
85			public function generateAction()
86			{
87			$classPath = $this->getGenerator()->generate();
88
89			return sprintf("Generated skeleton class @ %s\n", realpath($classPath));
90			}
91
92			/**
93			* @return Migration
94			*/
95			public function getMigration()
96			{
97			return $this->migration;
98			}
99
100			/**
101			* @return Generator
102			*/
103			public function getGenerator()
104			{
105			return $this->generator;
106			}
107			}
108

t4web / Migrations

Push — master ( 2c3775...168ecb )

MigrateController::versionAction() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like