ScriptsTrait::mergeScripts() - Code Metrics - Inspection of "Updating the package" - ARCANEDEV/Composer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11)

by ARCANEDEV

created 2017-03-13 16:39 UTC

ScriptsTrait::mergeScripts() A

↳ Parent: ScriptsTrait

Complexity

Conditions	4
Paths	3

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php namespace Arcanedev\Composer\Entities\PackageTraits;

use Arcanedev\Composer\Entities\PluginState;
use Composer\Package\RootPackageInterface;

/**
 * Class     ScriptsTrait
 *
 * @package  Arcanedev\Composer\Entities\PackageTraits
 * @author   ARCANEDEV <[email protected]>
 */
trait ScriptsTrait
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use PackageTrait;

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Merge scripts config into a RootPackage.
     *
     * @param  \Composer\Package\RootPackageInterface    $root
     * @param  \Arcanedev\Composer\Entities\PluginState  $state
     */
    protected function mergeScripts(RootPackageInterface $root, PluginState $state)
    {
        $scripts = $this->getPackage()->getScripts();

        if ( ! $state->shouldMergeScripts() || empty($scripts))
            return;

        $rootScripts = $root->getScripts();

        $scripts = $state->replaceDuplicateLinks()
            ? array_merge($rootScripts, $scripts)
            : array_merge($scripts, $rootScripts);

        self::unwrapIfNeeded($root, 'setScripts')
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.
    }
}
            ->setScripts($scripts);
    }
}


1			<?php namespace Arcanedev\Composer\Entities\PackageTraits;
2
3			use Arcanedev\Composer\Entities\PluginState;
4			use Composer\Package\RootPackageInterface;
5
6			/**
7			* Class ScriptsTrait
8			*
9			* @package Arcanedev\Composer\Entities\PackageTraits
10			* @author ARCANEDEV <[email protected]>
11			*/
12			trait ScriptsTrait
13			{
14			/* ------------------------------------------------------------------------------------------------
15			\| Traits
16			\| ------------------------------------------------------------------------------------------------
17			*/
18			use PackageTrait;
19
20			/* ------------------------------------------------------------------------------------------------
21			\| Main Functions
22			\| ------------------------------------------------------------------------------------------------
23			*/
24			/**
25			* Merge scripts config into a RootPackage.
26			*
27			* @param \Composer\Package\RootPackageInterface $root
28			* @param \Arcanedev\Composer\Entities\PluginState $state
29			*/
30			protected function mergeScripts(RootPackageInterface $root, PluginState $state)
31			{
32			$scripts = $this->getPackage()->getScripts();
33
34			if ( ! $state->shouldMergeScripts() \|\| empty($scripts))
35			return;
36
37			$rootScripts = $root->getScripts();
38
39			$scripts = $state->replaceDuplicateLinks()
40			? array_merge($rootScripts, $scripts)
41			: array_merge($scripts, $rootScripts);
42
43			self::unwrapIfNeeded($root, 'setScripts')
			0 ignored issues – show Bug introduced 2017-03-13 16:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Composer\Package\RootPackageInterface` as the method `setScripts()` does only exist in the following implementations of said interface: `Composer\Package\RootPackage`. 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...
44			->setScripts($scripts);
45			}
46			}
47

ARCANEDEV / Composer

Pull Request — master (#11)

ScriptsTrait::mergeScripts() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like