StubGenerator::index() - Code Metrics - Inspection of "Add PHAR constraint check" - humbug/box - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#116)

by Théo

created 2018-04-21 12:58 UTC

StubGenerator::index() A

↳ Parent: StubGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	2
nc	1
nop	1

<?php

declare(strict_types=1);

/*
 * This file is part of the box project.
 *
 * (c) Kevin Herrera <[email protected]>
 *     Théo Fidry <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace KevinGH\Box;

use Assert\Assertion;
use KevinGH\Box\RequirementChecker\RequirementsDumper;

/**
 * Generates a new PHP bootstrap loader stub for a PHAR.
 *
 * @private
 */
final class StubGenerator
{
    private const CHECK_FILE_NAME = RequirementsDumper::CHECK_FILE_NAME;

    private const STUB_TEMPLATE = <<<'STUB'
__BOX_SHEBANG__
<?php
__BOX_BANNER__

__BOX_PHAR_CONFIG__

__HALT_COMPILER(); ?>

STUB;

    /**
     * @var null|string The alias to be used in "phar://" URLs
     */
    private $alias;

    /**
     * @var null|string The top header comment banner text
     */
    private $banner;

    /**
     * @var null|string The location within the PHAR of index script
     */
    private $index;

    /**
     * @var bool Use the Phar::interceptFileFuncs() method?
     */
    private $intercept = false;

    /**
     * @var null|string The shebang line
     */
    private $shebang;

    private $checkRequirements = true;

    /**
     * Creates a new instance of the stub generator.
     *
     * @return StubGenerator the stub generator
     */
    public static function create()
    {
        return new static();
    }

    /**
     * @return string The stub
     */
    public function generate(): string
    {
        $stub = self::STUB_TEMPLATE;

        $stub = str_replace(
            "__BOX_SHEBANG__\n",
            null === $this->shebang ? '' : $this->shebang."\n",
            $stub
        );

        $stub = str_replace(
            "__BOX_BANNER__\n",
            $this->generateBannerStmt(),
            $stub
        );

        $stub = str_replace(
            "__BOX_PHAR_CONFIG__\n",
            (string) $this->generatePharConfigStmt(),
            $stub
        );

        return $stub;
    }

    public function alias(?string $alias): self
    {
        $this->alias = $alias;

        return $this;
    }

    public function banner(?string $banner): self
    {
        $this->banner = $banner;

        return $this;
    }

    public function index(?string $index): self
    {
        $this->index = $index;

        return $this;
    }

    public function intercept(bool $intercept): self
    {
        $this->intercept = $intercept;

        return $this;
    }

    public function shebang(?string $shebang): self
    {
        if (null !== $shebang) {
            Assertion::notEmpty($shebang, 'Cannot use an empty string for the shebang.');
        }

        $this->shebang = $shebang;

        return $this;
    }

    public function getShebang(): ?string
    {
        return $this->shebang;
    }

    public function checkRequirements(bool $checkRequirements): self
    {
        $this->checkRequirements = $checkRequirements;

        return $this;
    }

    /**
     * Escapes an argument so it can be written as a string in a call.
     *
     * @param string $arg
     * @param string $quote
     *
     * @return string The escaped argument
     */
    private function arg(string $arg, string $quote = "'"): string
    {
        return $quote.addcslashes($arg, $quote).$quote;
    }

    private function getAliasStmt(): ?string
    {
        return null !== $this->alias ? 'Phar::mapPhar('.$this->arg($this->alias).');' : null;
    }

    private function generateBannerStmt(): string
    {
        if (null === $this->banner) {
            return '';
        }

        $banner = "/*\n * ";

        $banner .= str_replace(
            " \n",
            "\n",
            str_replace("\n", "\n * ", $this->banner)
        );

        $banner .= "\n */";

        return "\n".$banner."\n";
    }

    private function generatePharConfigStmt(): ?string
    {
        $previous = false;
        $stub = [];

        if (null !== $aliasStmt = $this->getAliasStmt()) {
            $stub[] = $aliasStmt;

            $previous = true;
        }

        if ($this->intercept) {
            $stub[] = 'Phar::interceptFileFuncs();';

            $previous = true;
        }

        if (false !== $this->checkRequirements) {
            if ($previous) {
                $stub[] = '';
            }

            $checkRequirementsFile = self::CHECK_FILE_NAME;

            $stub[] = null === $this->alias
                ? "require 'phar://' . __FILE__ . '/.box/{$checkRequirementsFile}';"
                : "require 'phar://{$this->alias}/.box/{$checkRequirementsFile}';"
            ;

            $previous = true;
        }

        if (null !== $this->index) {
            if ($previous) {
                $stub[] = '';
            }

            $stub[] = null === $this->alias
                ? "require 'phar://' . __FILE__ . '/{$this->index}';"
                : "require 'phar://{$this->alias}/{$this->index}';"
            ;
        }

        if ([] === $stub) {
            return "// No PHAR config\n";
        }

        return implode("\n", $stub)."\n";
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the box project.
7			*
8			* (c) Kevin Herrera <[email protected]>
9			* Théo Fidry <[email protected]>
10			*
11			* This source file is subject to the MIT license that is bundled
12			* with this source code in the file LICENSE.
13			*/
14
15			namespace KevinGH\Box;
16
17			use Assert\Assertion;
18			use KevinGH\Box\RequirementChecker\RequirementsDumper;
19
20			/**
21			* Generates a new PHP bootstrap loader stub for a PHAR.
22			*
23			* @private
24			*/
25			final class StubGenerator
26			{
27			private const CHECK_FILE_NAME = RequirementsDumper::CHECK_FILE_NAME;
28
29			private const STUB_TEMPLATE = <<<'STUB'
30			__BOX_SHEBANG__
31			<?php
32			__BOX_BANNER__
33
34			__BOX_PHAR_CONFIG__
35
36			__HALT_COMPILER(); ?>
37
38			STUB;
39
40			/**
41			* @var null\|string The alias to be used in "phar://" URLs
42			*/
43			private $alias;
44
45			/**
46			* @var null\|string The top header comment banner text
47			*/
48			private $banner;
49
50			/**
51			* @var null\|string The location within the PHAR of index script
52			*/
53			private $index;
54
55			/**
56			* @var bool Use the Phar::interceptFileFuncs() method?
57			*/
58			private $intercept = false;
59
60			/**
61			* @var null\|string The shebang line
62			*/
63			private $shebang;
64
65			private $checkRequirements = true;
66
67			/**
68			* Creates a new instance of the stub generator.
69			*
70			* @return StubGenerator the stub generator
71			*/
72			public static function create()
73			{
74			return new static();
75			}
76
77			/**
78			* @return string The stub
79			*/
80			public function generate(): string
81			{
82			$stub = self::STUB_TEMPLATE;
83
84			$stub = str_replace(
85			"__BOX_SHEBANG__\n",
86			null === $this->shebang ? '' : $this->shebang."\n",
87			$stub
88			);
89
90			$stub = str_replace(
91			"__BOX_BANNER__\n",
92			$this->generateBannerStmt(),
93			$stub
94			);
95
96			$stub = str_replace(
97			"__BOX_PHAR_CONFIG__\n",
98			(string) $this->generatePharConfigStmt(),
99			$stub
100			);
101
102			return $stub;
103			}
104
105			public function alias(?string $alias): self
106			{
107			$this->alias = $alias;
108
109			return $this;
110			}
111
112			public function banner(?string $banner): self
113			{
114			$this->banner = $banner;
115
116			return $this;
117			}
118
119			public function index(?string $index): self
120			{
121			$this->index = $index;
122
123			return $this;
124			}
125
126			public function intercept(bool $intercept): self
127			{
128			$this->intercept = $intercept;
129
130			return $this;
131			}
132
133			public function shebang(?string $shebang): self
134			{
135			if (null !== $shebang) {
136			Assertion::notEmpty($shebang, 'Cannot use an empty string for the shebang.');
137			}
138
139			$this->shebang = $shebang;
140
141			return $this;
142			}
143
144			public function getShebang(): ?string
145			{
146			return $this->shebang;
147			}
148
149			public function checkRequirements(bool $checkRequirements): self
150			{
151			$this->checkRequirements = $checkRequirements;
152
153			return $this;
154			}
155
156			/**
157			* Escapes an argument so it can be written as a string in a call.
158			*
159			* @param string $arg
160			* @param string $quote
161			*
162			* @return string The escaped argument
163			*/
164			private function arg(string $arg, string $quote = "'"): string
165			{
166			return $quote.addcslashes($arg, $quote).$quote;
167			}
168
169			private function getAliasStmt(): ?string
170			{
171			return null !== $this->alias ? 'Phar::mapPhar('.$this->arg($this->alias).');' : null;
172			}
173
174			private function generateBannerStmt(): string
175			{
176			if (null === $this->banner) {
177			return '';
178			}
179
180			$banner = "/\n ";
181
182			$banner .= str_replace(
183			" \n",
184			"\n",
185			str_replace("\n", "\n * ", $this->banner)
186			);
187
188			$banner .= "\n */";
189
190			return "\n".$banner."\n";
191			}
192
193			private function generatePharConfigStmt(): ?string
194			{
195			$previous = false;
196			$stub = [];
197
198			if (null !== $aliasStmt = $this->getAliasStmt()) {
199			$stub[] = $aliasStmt;
200
201			$previous = true;
202			}
203
204			if ($this->intercept) {
205			$stub[] = 'Phar::interceptFileFuncs();';
206
207			$previous = true;
208			}
209
210			if (false !== $this->checkRequirements) {
211			if ($previous) {
212			$stub[] = '';
213			}
214
215			$checkRequirementsFile = self::CHECK_FILE_NAME;
216
217			$stub[] = null === $this->alias
218			? "require 'phar://' . __FILE__ . '/.box/{$checkRequirementsFile}';"
219			: "require 'phar://{$this->alias}/.box/{$checkRequirementsFile}';"
220			;
221
222			$previous = true;
223			}
224
225			if (null !== $this->index) {
226			if ($previous) {
227			$stub[] = '';
228			}
229
230			$stub[] = null === $this->alias
231			? "require 'phar://' . __FILE__ . '/{$this->index}';"
232			: "require 'phar://{$this->alias}/{$this->index}';"
233			;
234			}
235
236			if ([] === $stub) {
237			return "// No PHAR config\n";
238			}
239
240			return implode("\n", $stub)."\n";
241			}
242			}
243

humbug / box

Pull Request — master (#116)

StubGenerator::index() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like