Helldar\LaravelLangPublisher\Support\Path

Complexity

Total Complexity

21

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Test Coverage

Coverage

84.62%

Importance

Changes	3
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	source()	0	9	2
A	filename()	0	7	1
A	cleanable()	0	9	2
A	targetFull()	0	7	2
A	isEnglish()	0	5	1
A	target()	0	9	2
A	getSourcePath()	0	3	1
A	clean()	0	5	2
A	locales()	0	5	1
A	getBasePath()	0	3	1
A	extension()	0	7	1
A	getLocalesPath()	0	3	1
A	directory()	0	7	1
A	getTargetPath()	0	3	1
A	sourceFull()	0	7	2

<?php

namespace Helldar\LaravelLangPublisher\Support;

use Helldar\LaravelLangPublisher\Concerns\Logger;
use Helldar\LaravelLangPublisher\Constants\Locales as LocalesList;
use Helldar\LaravelLangPublisher\Facades\Config as ConfigFacade;

final class Path
{
    use Logger;

The trait Helldar\LaravelLangPublisher\Concerns\Logger requires the property $output which is not provided by Helldar\LaravelLangPublisher\Support\Path.

    public function source(string $package, string $locale): string
    {
        $this->log('Getting the path to the source files of the localization:', $package, $locale);

        if ($this->isEnglish($locale)) {
            return $this->cleanable($this->getBasePath(), $package, $this->getSourcePath());
        }

        return $this->locales($package, $locale);
    }

    public function sourceFull(string $package, string $locale, ?string $filename, bool $is_json = false): string
    {
        $this->log('Getting the full path to the source files of the localization:', $package, $locale, $filename, $is_json);

        $suffix = $is_json ? $locale . '.json' : $filename;

        return $this->source($package, $locale) . '/' . $suffix;
    }

    public function target(string $locale, bool $is_json = false): string
    {
        $this->log('Getting the path to the target files of the localization:', $locale, $is_json);

        $path = $this->getTargetPath();

        $suffix = $is_json ? '' : '/' . $locale;

        return $this->clean($path) . $suffix;
    }

    public function targetFull(string $locale, ?string $filename, bool $is_json = false): string
    {
        $this->log('Getting the full path to the target files of the localization:', $locale, $filename, $is_json);

        $suffix = $is_json ? '../' . $locale . '.json' : $filename;

        return $this->target($locale) . '/' . $suffix;
    }

    public function locales(string $package, string $locale = null): string
    {
        $this->log('Getting the path to the source translation files for', $package, $locale);

        return $this->cleanable($this->getBasePath(), $package, $this->getLocalesPath(), $locale);
    }

    public function directory(string $path): string
    {
        $this->log('Getting the path to a directory:', $path);

        $path = pathinfo($path, PATHINFO_DIRNAME);

        return $this->clean($path);

The expression return $this->clean($path) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

It seems like $path can also be of type array; however, parameter $path of Helldar\LaravelLangPublisher\Support\Path::clean() does only seem to accept null|string, maybe add an additional type check?

    }

    public function filename(string $path): string
    {
        $this->log('Getting file name without extension and path:', $path);

        $path = pathinfo($path, PATHINFO_FILENAME);

        return $this->clean($path);

It seems like $path can also be of type array; however, parameter $path of Helldar\LaravelLangPublisher\Support\Path::clean() does only seem to accept null|string, maybe add an additional type check?

The expression return $this->clean($path) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function extension(string $path): string
    {
        $this->log('Getting file extension from path:', $path);

        $path = pathinfo($path, PATHINFO_EXTENSION);

        return $this->clean($path);

The expression return $this->clean($path) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

It seems like $path can also be of type array; however, parameter $path of Helldar\LaravelLangPublisher\Support\Path::clean() does only seem to accept null|string, maybe add an additional type check?

    }

    protected function cleanable(...$values): string
    {
        $this->log('Cleaning values to compile a path:', $values);

        foreach ($values as &$value) {
            $value = $this->clean($value);
        }

        return implode('/', $values);
    }

    protected function clean(string $path = null): ?string
    {
        $this->log('Clearing the path from the trailing character:', $path);

        return ! empty($path) ? rtrim($path, '\\/') : $path;
    }

    protected function isEnglish(string $locale): bool
    {
        $this->log('Check if localization is English: ' . $locale);

        return $locale === LocalesList::ENGLISH;
    }

    protected function getBasePath(): string
    {
        return ConfigFacade::basePath();
    }

    protected function getSourcePath(): string
    {
        return ConfigFacade::sourcePath();
    }

    protected function getLocalesPath(): string
    {
        return ConfigFacade::localesPath();
    }

    protected function getTargetPath(): string
    {
        return ConfigFacade::resourcesPath();
    }
}