KevinGH\Box\StubGenerator

Complexity

Total Complexity

26

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	generateBannerStmt()	0	17	2
A	getAliasStmt()	0	3	2
A	generate()	0	23	2
A	arg()	0	3	1
A	alias()	0	5	1
A	intercept()	0	5	1
A	shebang()	0	9	2
C	generatePharConfigStmt()	0	48	10
A	checkRequirements()	0	5	1
A	getShebang()	0	3	1
A	banner()	0	5	1
A	create()	0	3	1
A	index()	0	5	1

<?php

declare(strict_types=1);

/*
 * This file is part of the box project.
 *
 * (c) Kevin Herrera <kevin@herrera.io>
 *     Théo Fidry <theo.fidry@gmail.com>
 *
 * 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";
    }
}