ScoperAutoloadGenerator::dump() - Code Metrics - Inspection of "Fix the whitelisting of classes (#263)" - humbug/php-scoper - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 85c65e...8d63d9 )

by Théo

created 2018-10-11 16:40 UTC

ScoperAutoloadGenerator::dump() B

↳ Parent: ScoperAutoloadGenerator

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	59
ccs	20
cts	20
cp	1
crap	2
rs	8.8945
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

/*
 * This file is part of the humbug/php-scoper package.
 *
 * Copyright (c) 2017 Théo FIDRY <[email protected]>,
 *                    Pádraic Brady <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Humbug\PhpScoper\Autoload;

use Humbug\PhpScoper\Whitelist;
use PhpParser\Node\Name\FullyQualified;
use const PHP_EOL;
use function array_column;
use function array_map;
use function array_unshift;
use function sprintf;
use function str_repeat;
use function str_replace;
use function strpos;

final class ScoperAutoloadGenerator
{
    private $whitelist;

    public function __construct(Whitelist $whitelist)
    {
        $this->whitelist = $whitelist;
    }

    public function dump(string $prefix): string

    {
        $whitelistedFunctions = $this->whitelist->getRecordedWhitelistedFunctions();

        $hasNamespacedFunctions = $this->hasNamespacedFunctions($whitelistedFunctions);

        $statements = implode(
            PHP_EOL,
            $this->createClassAliasStatements(
                $this->whitelist->getRecordedWhitelistedClasses(),
                $hasNamespacedFunctions)
            )
            .PHP_EOL
            .PHP_EOL
        ;
        $statements .= implode(
            PHP_EOL,
            $this->createFunctionAliasStatements(
                $whitelistedFunctions,
                $hasNamespacedFunctions
            )
        );

        if ($hasNamespacedFunctions) {
            $dump = <<<PHP
<?php

// scoper-autoload.php @generated by PhpScoper

namespace {
    \$loader = require_once __DIR__.'/autoload.php';
}

$statements

namespace {
    return \$loader;
}

PHP;
        } else {
            $dump = <<<PHP
<?php

// scoper-autoload.php @generated by PhpScoper

\$loader = require_once __DIR__.'/autoload.php';

$statements

return \$loader;

PHP;
        }

        $dump = $this->cleanAutoload($dump);

        return $dump;
    }

    /**
     * @return string[]
     */
    private function createClassAliasStatements(array $whitelistedClasses, bool $hasNamespacedFunctions): array
    {
        $statements = array_map(
            function (string $prefixedClass): string {
                return sprintf(
                    'class_exists(\'%s\');',
                    $prefixedClass
                );
            },
            array_column(
                $whitelistedClasses,
                1
            )
        );

        if ([] === $statements) {
            return $statements;
        }

        if ($hasNamespacedFunctions) {
            $statements = array_map(
                function (string $statement): string {
                    return str_repeat(' ', 4).$statement;
                },
                $statements
            );

            array_unshift($statements, 'namespace {');
            $statements[] = '}'.PHP_EOL;
        }

        array_unshift(
            $statements,
            <<<'EOF'
// Aliases for the whitelisted classes. For more information see:
// https://github.com/humbug/php-scoper/blob/master/README.md#class-whitelisting
EOF
        );

        return $statements;
    }

    /**
     * @return string[]
     */
    private function createFunctionAliasStatements(array $whitelistedFunctions, bool $hasNamespacedFunctions): array
    {
        $statements = array_map(
            function (array $node) use ($hasNamespacedFunctions): string {
                /**
                 * @var string
                 * @var string $alias
                 */
                [$original, $alias] = $node;
function someFunction() {
    $x = 5;
    echo $x;
}

                $original = new FullyQualified($original);
function someFunction() {
    $x = 5;
    echo $x;
}
                $alias = new FullyQualified($alias);
function someFunction() {
    $x = 5;
    echo $x;
}

                if ($hasNamespacedFunctions) {
                    $namespace = $original->slice(0, -1);

                    return sprintf(
                        <<<'PHP'
namespace %s{
    if (!function_exists('%s')) {
        function %s() {
            return \%s(...func_get_args());
        }
    }
}
PHP
                        ,
                        null === $namespace ? '' : $namespace->toString().' ',
                        $original->toString(),
                        null === $namespace ? $original->toString() : $original->slice(1)->toString(),
                        $alias->toString()
                    );
                }

                return sprintf(
                    <<<'PHP'
if (!function_exists('%1$s')) {
    function %1$s() {
        return \%2$s(...func_get_args());
    }
}
PHP
                    ,
                    $original,
                    $alias
                );
            },
            $whitelistedFunctions
        );

        if ([] === $statements) {
            return $statements;
        }

        array_unshift(
            $statements,
            <<<'EOF'
// Functions whitelisting. For more information see:
// https://github.com/humbug/php-scoper/blob/master/README.md#functions-whitelisting
EOF
        );

        return $statements;
    }

    private function hasNamespacedFunctions(array $functions): bool
    {
        foreach ($functions as [$original, $alias]) {
            /*
             * @var string
             * @var string $alias
             */
            if (false !== strpos($original, '\\')) {

                return true;
            }
        }

        return false;
    }

    private function cleanAutoload(string $dump): string
    {
        $cleanedDump = $dump;

        do {
            $dump = $cleanedDump;
            $cleanedDump = str_replace("\n\n\n", "\n\n", $dump);
        } while ($cleanedDump !== $dump);

        return $dump;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of the humbug/php-scoper package.
7		*
8		* Copyright (c) 2017 Théo FIDRY <[email protected]>,
9		* Pádraic Brady <[email protected]>
10		*
11		* For the full copyright and license information, please view the LICENSE
12		* file that was distributed with this source code.
13		*/
14
15		namespace Humbug\PhpScoper\Autoload;
16
17		use Humbug\PhpScoper\Whitelist;
18		use PhpParser\Node\Name\FullyQualified;
19		use const PHP_EOL;
20		use function array_column;
21		use function array_map;
22		use function array_unshift;
23		use function sprintf;
24		use function str_repeat;
25		use function str_replace;
26		use function strpos;
27
28		final class ScoperAutoloadGenerator
29		{
30		private $whitelist;
31
32	7	public function __construct(Whitelist $whitelist)
33		{
34	7	$this->whitelist = $whitelist;
35		}
36
37	7	public function dump(string $prefix): string
		0 ignored issues – show Unused Code introduced 2018-10-11 11:03 UTC by Report Bug Copy Issue Report The parameter `$prefix` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
38		{
39	7	$whitelistedFunctions = $this->whitelist->getRecordedWhitelistedFunctions();
40
41	7	$hasNamespacedFunctions = $this->hasNamespacedFunctions($whitelistedFunctions);
42
43	7	$statements = implode(
44	7	PHP_EOL,
45	7	$this->createClassAliasStatements(
46	7	$this->whitelist->getRecordedWhitelistedClasses(),
47	7	$hasNamespacedFunctions)
48		)
49	7	.PHP_EOL
50	7	.PHP_EOL
51		;
52	7	$statements .= implode(
53	7	PHP_EOL,
54	7	$this->createFunctionAliasStatements(
55	7	$whitelistedFunctions,
56	7	$hasNamespacedFunctions
57		)
58		);
59
60	7	if ($hasNamespacedFunctions) {
61		$dump = <<<PHP
62		<?php
63
64		// scoper-autoload.php @generated by PhpScoper
65
66		namespace {
67		\$loader = require_once __DIR__.'/autoload.php';
68		}
69
70	2	$statements
71
72		namespace {
73		return \$loader;
74		}
75
76		PHP;
77		} else {
78		$dump = <<<PHP
79		<?php
80
81		// scoper-autoload.php @generated by PhpScoper
82
83		\$loader = require_once __DIR__.'/autoload.php';
84
85	5	$statements
86
87		return \$loader;
88
89		PHP;
90		}
91
92	7	$dump = $this->cleanAutoload($dump);
93
94	7	return $dump;
95		}
96
97		/**
98		* @return string[]
99		*/
100	7	private function createClassAliasStatements(array $whitelistedClasses, bool $hasNamespacedFunctions): array
101		{
102	7	$statements = array_map(
103		function (string $prefixedClass): string {
104	3	return sprintf(
105	3	'class_exists(\'%s\');',
106	3	$prefixedClass
107		);
108	7	},
109	7	array_column(
110	7	$whitelistedClasses,
111	7	1
112		)
113		);
114
115	7	if ([] === $statements) {
116	4	return $statements;
117		}
118
119	3	if ($hasNamespacedFunctions) {
120	1	$statements = array_map(
121		function (string $statement): string {
122	1	return str_repeat(' ', 4).$statement;
123	1	},
124	1	$statements
125		);
126
127	1	array_unshift($statements, 'namespace {');
128	1	$statements[] = '}'.PHP_EOL;
129		}
130
131	3	array_unshift(
132	3	$statements,
133		<<<'EOF'
134	3	// Aliases for the whitelisted classes. For more information see:
135		// https://github.com/humbug/php-scoper/blob/master/README.md#class-whitelisting
136		EOF
137		);
138
139	3	return $statements;
140		}
141
142		/**
143		* @return string[]
144		*/
145	7	private function createFunctionAliasStatements(array $whitelistedFunctions, bool $hasNamespacedFunctions): array
146		{
147	7	$statements = array_map(
148		function (array $node) use ($hasNamespacedFunctions): string {
149		/**
150		* @var string
151		* @var string $alias
152		*/
153	3	[$original, $alias] = $node;
		2 ignored issues – show Bug introduced 2018-07-16 15:39 UTC by Report Bug Copy Issue Report The variable `$original` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history... Bug introduced 2018-07-16 15:39 UTC by Report Bug Copy Issue Report The variable `$alias` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
154
155	3	$original = new FullyQualified($original);
		1 ignored issue – show Bug introduced 2018-07-16 15:39 UTC by Report Bug Copy Issue Report The variable `$original` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
156	3	$alias = new FullyQualified($alias);
		1 ignored issue – show Bug introduced 2018-07-16 15:39 UTC by Report Bug Copy Issue Report The variable `$alias` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
157
158	3	if ($hasNamespacedFunctions) {
159	2	$namespace = $original->slice(0, -1);
160
161	2	return sprintf(
162		<<<'PHP'
163	2	namespace %s{
164		if (!function_exists('%s')) {
165		function %s() {
166		return \%s(...func_get_args());
167		}
168		}
169		}
170		PHP
171		,
172	2	null === $namespace ? '' : $namespace->toString().' ',
173	2	$original->toString(),
174	2	null === $namespace ? $original->toString() : $original->slice(1)->toString(),
175	2	$alias->toString()
176		);
177		}
178
179	1	return sprintf(
180		<<<'PHP'
181	1	if (!function_exists('%1$s')) {
182		function %1$s() {
183		return \%2$s(...func_get_args());
184		}
185		}
186		PHP
187		,
188	1	$original,
189	1	$alias
190		);
191	7	},
192	7	$whitelistedFunctions
193		);
194
195	7	if ([] === $statements) {
196	4	return $statements;
197		}
198
199	3	array_unshift(
200	3	$statements,
201		<<<'EOF'
202	3	// Functions whitelisting. For more information see:
203		// https://github.com/humbug/php-scoper/blob/master/README.md#functions-whitelisting
204		EOF
205		);
206
207	3	return $statements;
208		}
209
210	7	private function hasNamespacedFunctions(array $functions): bool
211		{
212	7	foreach ($functions as [$original, $alias]) {
213		/*
214		* @var string
215		* @var string $alias
216		*/
217	3	if (false !== strpos($original, '\\')) {
		1 ignored issue – show Bug introduced 2018-07-16 15:39 UTC by Report Bug Copy Issue Report The variable `$original` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
218	3	return true;
219		}
220		}
221
222	5	return false;
223		}
224
225	7	private function cleanAutoload(string $dump): string
226		{
227	7	$cleanedDump = $dump;
228
229		do {
230	7	$dump = $cleanedDump;
231	7	$cleanedDump = str_replace("\n\n\n", "\n\n", $dump);
232	7	} while ($cleanedDump !== $dump);
233
234	7	return $dump;
235		}
236		}
237

humbug / php-scoper

Push — master ( 85c65e...8d63d9 )

ScoperAutoloadGenerator::dump() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like