Helldar\Support\Tools\Stub

Complexity

Total Complexity

6

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	path()	0	5	2
A	get()	0	7	2
A	replace()	0	5	1
A	isCustom()	0	3	1

<?php
/*
 * This file is part of the "andrey-helldar/support" project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Andrey Helldar <helldar@ai-rus.com>
 *
 * @copyright 2021 Andrey Helldar
 *
 * @license MIT
 *
 * @see https://github.com/andrey-helldar/support
 */

namespace Helldar\Support\Tools;

use Helldar\Support\Exceptions\UnknownStubFileException;
use Helldar\Support\Facades\Helpers\Str;

class Stub
{
    public const PHP_ARRAY = 'php_array.stub';

    public const JSON = 'json.stub';

    /**
     * Replace the contents of the template file.
     *
     * @param  string  $stub_file
     * @param  array  $replace
     *
     * @throws \Helldar\Support\Exceptions\UnknownStubFileException
     *
     * @return string
     */
    public function replace(string $stub_file, array $replace): string
    {
        $content = $this->get($stub_file);

        return Str::replace($content, $replace);
    }

    /**
     * Receive the contents of the template file.
     *
     * @param  string  $filename
     *
     * @throws \Helldar\Support\Exceptions\UnknownStubFileException
     *
     * @return string
     */
    public function get(string $filename): string
    {
        if ($path = $this->path($filename)) {
            return file_get_contents($path);
        }

        throw new UnknownStubFileException($filename);
    }

    /**
     * Receive the path to the template file.
     *
     * @param  string  $filename
     *
     * @return string|null
     */
    protected function path(string $filename): ?string
    {
        $path = $this->isCustom($filename) ? $filename : __DIR__ . '/../../resources/stubs/' . $filename;

        return realpath($path);
    }

    /**
     * Returns a link to the template file.
     *
     * If the file exists under the specified link, it will return it,
     * otherwise it will search in the default folder.
     *
     * @param  string  $path
     *
     * @return bool
     */
    protected function isCustom(string $path): bool
    {
        return file_exists($path);
    }
}