ResourceAggregator - Code Metrics - Inspection of "refactor: use resource aggregator to prepare confi..." - phwoolcon/test-starter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 19e140...7b3764 )

by Christopher

created 2017-11-19 11:40 UTC

ResourceAggregator B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	247
Duplicated Lines	42.51 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	52
c	1
b	0
f	0
lcom	1
cbo	1
dl	105
loc	247
ccs	146
cts	146
cp	1
rs	7.9487

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	aggregate()	0	14	1
A	appendLocalResources()	0	8	1
A	detectPackages()	0	17	3
B	installAliases()	18	18	6
C	installConfig()	8	27	8
B	installDi()	19	19	5
A	installLocale()	15	15	4
B	installMigrations()	9	18	5
B	installRoutes()	21	21	5
A	installViews()	15	15	4
A	message()	0	11	4
B	resetTestRoot()	0	29	3
A	spacePad()	0	5	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ResourceAggregator often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ResourceAggregator, and based on these observations, apply Extract Interface, too.

<?php

namespace Phwoolcon\TestStarter;

use Symfony\Component\Console\Output\ConsoleOutput;

class ResourceAggregator
{
    const FLAG_CONTINUE = 0b0001;
    const FLAG_SPACE_PAD = 0b0010;
    const FLAG_SPACE_PAD_CONTINUE = 0b0011;

    protected $cliOutput;
    protected $packages = [];
    protected $rootDir;
    protected $testRootDir;

    public function __construct($rootDir)
    {
        $this->rootDir = $rootDir;
        $this->testRootDir = $rootDir . '/tests/root';
    }

    public function aggregate()
    {
        $this->resetTestRoot();
        $this->detectPackages();

        $this->installAliases();
        $this->installConfig();
        $this->installDi();
        $this->installLocale();
        $this->installMigrations();
        $this->installRoutes();
        $this->installViews();
        $this->appendLocalResources();
    }

    protected function appendLocalResources()
    {
        $this->message('Appending local resources...', static::FLAG_SPACE_PAD_CONTINUE);
        $source = $this->rootDir . '/tests/resource';
        $destination = $this->testRootDir;
        symlinkDirOverride($source, $destination);
        $this->message(' <info>[ OK ]</info>');
    }

    protected function detectPackages()
    {
        $this->message('Detecting packages...', static::FLAG_SPACE_PAD_CONTINUE);
        $packageFiles = detectPhwoolconPackageFiles($this->rootDir . '/vendor');
        $packageFiles = array_merge($packageFiles, glob($this->rootDir . '/phwoolcon-package/*package*.php'));
        foreach ($packageFiles as $file) {
            // @codeCoverageIgnoreStart
            if (!is_array($package = include($file))) {
                continue;
            }
            // @codeCoverageIgnoreEnd
            $path = dirname(dirname($file));
            $package['path'] = $path;
            $this->packages[$file] = $package;
        }
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installAliases()

    {
        $this->message('Installing class aliases...', static::FLAG_SPACE_PAD_CONTINUE);
        $aliases = [];
        foreach ($this->packages as $packageFile => $package) {
            foreach ($package as $name => $resources) {
                if (empty($resources['class_aliases']) || !is_array($resources['class_aliases'])) {
                    continue;
                }
                foreach ($resources['class_aliases'] as $sort => $detectedAliases) {
                    $aliases[$sort . '-' . $name] = $detectedAliases;
                }
            }
        }
        $target = $this->testRootDir . '/vendor/phwoolcon/class_aliases.php';
        fileSaveArray($target, arraySortedMerge($aliases));
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installConfig()
    {
        $this->message('Installing config...', static::FLAG_SPACE_PAD_CONTINUE);
        $configPath = $this->testRootDir . '/app/config';
        foreach ($this->packages as $packageFile => $package) {
            $path = $package['path'];
            if ($configFiles = glob($path . '/phwoolcon-package/config/*.php')) {

                foreach ($configFiles as $source) {
                    $configFile = basename($source);
                    $destination = $configPath . '/' . $configFile;
                    is_file($destination) and unlink($destination);
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                    symlinkRelative($source, $destination);
                }
            }

            if ($overrides = glob($path . '/phwoolcon-package/config/override-*/*.php')) {
                foreach ($overrides as $override) {
                    $configFile = basename($override);
                    $dir = basename(dirname($override));
                    $destination = $configPath . '/' . $dir . '/' . $configFile;
                    is_file($destination) and unlink($destination);
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                    symlinkRelative($override, $destination);
                }
            }
        }
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installDi()

    {
        $this->message('Installing DI...', static::FLAG_SPACE_PAD_CONTINUE);
        $diFiles = [];
        foreach ($this->packages as $packageFile => $package) {
            $path = $package['path'];
            foreach ($package as $name => $resources) {
                if (empty($resources['di'])) {
                    continue;
                }
                foreach ((array)$resources['di'] as $sort => $file) {
                    $diFiles[$sort][] = $path . '/phwoolcon-package/' . $file;
                }
            }
        }
        $target = $this->testRootDir . '/vendor/phwoolcon/di.php';
        fileSaveInclude($target, arraySortedMerge($diFiles));
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installLocale()

    {
        $this->message('Installing locales...', static::FLAG_SPACE_PAD_CONTINUE);
        $localePath = $this->testRootDir . '/app/locale/';
        foreach ($this->packages as $packageFile => $package) {
            $path = $package['path'];
            if ($items = glob($path . '/phwoolcon-package/locale/*')) {
                foreach ($items as $source) {
                    $destination = $localePath . basename($source);
                    symlinkDirOverride($source, $destination);
                }
            }
        }
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installMigrations()
    {
        $this->message('Installing migrations...', static::FLAG_SPACE_PAD_CONTINUE);
        $migrationPath = $this->testRootDir . '/bin/migrations/';
        foreach ($this->packages as $packageFile => $package) {
            $path = $package['path'];
            if ($items = glob($path . '/phwoolcon-package/migrations/*')) {

                // @codeCoverageIgnoreStart
                foreach ($items as $source) {
                    $destination = $migrationPath . basename($source);
                    is_file($destination) and unlink($destination);
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                    symlinkRelative($source, $destination);
                }
                // @codeCoverageIgnoreEnd
            }
        }
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installRoutes()

    {
        $this->message('Installing routes...', static::FLAG_SPACE_PAD_CONTINUE);
        $routeFiles = [];
        foreach ($this->packages as $packageFile => $package) {
            $path = $package['path'];
            foreach ($package as $name => $resources) {
                if (empty($resources['routes'])) {
                    continue;
                }
                // @codeCoverageIgnoreStart
                foreach ((array)$resources['routes'] as $sort => $file) {
                    $routeFiles[$sort][] = $path . '/phwoolcon-package/' . $file;
                }
                // @codeCoverageIgnoreEnd
            }
        }
        $target = $this->testRootDir . '/vendor/phwoolcon/routes.php';
        fileSaveInclude($target, arraySortedMerge($routeFiles));
        $this->message(' <info>[ OK ]</info>');
    }

    protected function installViews()

    {
        $this->message('Installing views...', static::FLAG_SPACE_PAD_CONTINUE);
        $viewPath = $this->testRootDir . '/app/views/';
        foreach ($this->packages as $packageFile => $package) {
            $path = $package['path'];
            if ($items = glob($path . '/phwoolcon-package/views/*')) {
                foreach ($items as $source) {
                    $destination = $viewPath . basename($source);
                    symlinkDirOverride($source, $destination);
                }
            }
        }
        $this->message(' <info>[ OK ]</info>');
    }

    protected function message($message, $flag = null)
    {
        $eol = !($flag & static::FLAG_CONTINUE);
        $spacePad = $flag & static::FLAG_SPACE_PAD;
        if (!$this->cliOutput) {
            $this->cliOutput = new ConsoleOutput();
        }
        $message = is_array($message) ? implode(PHP_EOL, $message) : $message;
        $message .= $spacePad ? $this->spacePad($message) : '';
        $this->cliOutput->write($message, $eol);
    }

    protected function resetTestRoot()
    {
        $this->message('Resetting test root...', static::FLAG_SPACE_PAD_CONTINUE);
        removeDir($this->testRootDir);
        $assembleDirs = [
            '/app/config',
            '/app/locale',
            '/app/views',
            '/bin/migrations',
            '/storage/cache',
            '/storage/logs',
            '/storage/session',
            '/storage/remote-coverage',
            '/vendor/phwoolcon',
        ];
        foreach ($assembleDirs as $dir) {
            mkdir($this->testRootDir . $dir, 0777, true);
        }
        $mockCompiledFiles = [
            '/vendor/phwoolcon/assets.php',
            '/vendor/phwoolcon/admin_assets.php',
            '/vendor/phwoolcon/commands.php',
        ];
        foreach ($mockCompiledFiles as $mockFile) {
            $filename = $this->testRootDir . $mockFile;
            fileSaveArray($filename, []);
        }
        $this->message(' <info>[ OK ]</info>');
    }

    protected function spacePad($str, $length = 40)
    {
        $spaces = $length - strlen($str);
        return $spaces > 0 ? str_repeat(' ', $spaces) : ' ';
    }
}


Push — master ( 19e140...7b3764 )

ResourceAggregator B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

phwoolcon / test-starter

Push — master ( 19e140...7b3764 )

ResourceAggregator B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like