Issues in Source.php - All Issues - Inspection of "Add licence" - onigoetz/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eb283a...ad5b4c )

by Stéphane

created 2016-01-02 20:07 UTC

src/Configuration/Source.php (1 issue)

Showing only issues like (Show All)

strict.coding_against_specific_subtype

Bug Minor

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Onigoetz\Deployer\Configuration;

use Onigoetz\Deployer\Configuration\Containers\ExtendableConfigurationContainer;
use Onigoetz\Deployer\Configuration\Sources\Cloned;
use Onigoetz\Deployer\Configuration\Sources\Upload;

class Source extends ExtendableConfigurationContainer
{
    /**
     * Create a source with the right class
     *
     * @param string $name The source name
     * @param array $data
     * @param ConfigurationManager $manager
     * @param Source $parent
     * @throws \LogicException
     * @return Cloned|Upload
     */
    public static function make($name, array $data, ConfigurationManager $manager, Source $parent = null)
    {
        $strategy = static::findStrategy($name, $data, $manager, $parent);

        switch ($strategy) {
            case 'clone':
                return new Cloned($name, $data, $manager, $parent);
                break;
            case 'upload':
                return new Upload($name, $data, $manager, $parent);
                break;
            default:
        }

        throw new \LogicException("Unrecognized strategy '{$strategy}'");
    }

    protected static function findStrategy($name, $data, ConfigurationManager $manager, Source $parent = null)
    {
        if (isset($data['strategy'])) {
            return $data['strategy'];
        }

        if ($parent) {
            return $parent->getStrategy();
        }

        if (isset($data['extends']) && $manager->has('source', $data['extends'])) {
            return $manager->get('source', $data['extends'])->getStrategy();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        }

        throw new \LogicException("Cannot find a valid strategy for the source '$name'");
    }

    /**
     * {@inheritdoc}
     */
    public function getContainerType()
    {
        return 'source';
    }

    public function getStrategy()
    {
        return $this->getValueOrFail('strategy', "no 'strategy' specified for source '{$this->name}''");
    }

    /**
     * @throws \LogicException
     * @return mixed
     */
    public function getPath()
    {
        return $this->getValueOrFail('path', "no 'path' specified for source '{$this->name}''");
    }

    /**
     * {@inheritdoc}
     */
    public function checkValidity()
    {
        $this->getPath();

        return true;
    }
}


1		<?php
2
3		namespace Onigoetz\Deployer\Configuration;
4
5		use Onigoetz\Deployer\Configuration\Containers\ExtendableConfigurationContainer;
6		use Onigoetz\Deployer\Configuration\Sources\Cloned;
7		use Onigoetz\Deployer\Configuration\Sources\Upload;
8
9		class Source extends ExtendableConfigurationContainer
10		{
11		/**
12		* Create a source with the right class
13		*
14		* @param string $name The source name
15		* @param array $data
16		* @param ConfigurationManager $manager
17		* @param Source $parent
18		* @throws \LogicException
19		* @return Cloned\|Upload
20		*/
21	135	public static function make($name, array $data, ConfigurationManager $manager, Source $parent = null)
22		{
23	135	$strategy = static::findStrategy($name, $data, $manager, $parent);
24
25		switch ($strategy) {
26	132	case 'clone':
27	96	return new Cloned($name, $data, $manager, $parent);
28		break;
29	27	case 'upload':
30	36	return new Upload($name, $data, $manager, $parent);
31		break;
32	2	default:
33	2	}
34
35	3	throw new \LogicException("Unrecognized strategy '{$strategy}'");
36		}
37
38	135	protected static function findStrategy($name, $data, ConfigurationManager $manager, Source $parent = null)
39		{
40	135	if (isset($data['strategy'])) {
41	132	return $data['strategy'];
42		}
43
44	15	if ($parent) {
45	6	return $parent->getStrategy();
46		}
47
48	12	if (isset($data['extends']) && $manager->has('source', $data['extends'])) {
49	9	return $manager->get('source', $data['extends'])->getStrategy();
		0 ignored issues – show Bug introduced 2016-01-01 15:28 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `Onigoetz\Deployer\Config...\ConfigurationContainer` as the method `getStrategy()` does only exist in the following sub-classes of `Onigoetz\Deployer\Config...\ConfigurationContainer`: `Onigoetz\Deployer\Configuration\Source`, `Onigoetz\Deployer\Configuration\Sources\Cloned`, `Onigoetz\Deployer\Configuration\Sources\Upload`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
50		}
51
52	3	throw new \LogicException("Cannot find a valid strategy for the source '$name'");
53		}
54
55		/**
56		* {@inheritdoc}
57		*/
58	48	public function getContainerType()
59		{
60	48	return 'source';
61		}
62
63	12	public function getStrategy()
64		{
65	12	return $this->getValueOrFail('strategy', "no 'strategy' specified for source '{$this->name}''");
66		}
67
68		/**
69		* @throws \LogicException
70		* @return mixed
71		*/
72	60	public function getPath()
73		{
74	60	return $this->getValueOrFail('path', "no 'path' specified for source '{$this->name}''");
75		}
76
77		/**
78		* {@inheritdoc}
79		*/
80	27	public function checkValidity()
81		{
82	27	$this->getPath();
83
84	21	return true;
85		}
86		}
87

onigoetz / deployer

Push — master ( eb283a...ad5b4c )

src/Configuration/Source.php (1 issue)

Showing only issues like (Show All)

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like