Arcanedev\Support\Providers\Concerns\HasConfig

Complexity

Total Complexity

16

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

31.71%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfigFolder()	0	4	1
A	getConfigKey()	0	8	2
A	getConfigFile()	0	4	1
A	configFilesPaths()	0	4	1
A	registerConfig()	0	6	2
A	registerSingleConfig()	0	4	1
A	registerMultipleConfigs()	0	8	2
A	publishConfig()	0	6	2
A	publishSingleConfig()	0	6	2
A	publishMultipleConfigs()	0	11	2

<?php

declare(strict_types=1);

namespace Arcanedev\Support\Providers\Concerns;

use Illuminate\Support\Str;

/**
 * Trait     HasConfig
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
trait HasConfig
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Merge multiple config files into one instance (package name as root key)
     *
     * @var bool
     */
    protected $multiConfigs = false;

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get config folder.
     *
     * @return string
     */
    protected function getConfigFolder(): string
    {
        return realpath($this->getBasePath().DIRECTORY_SEPARATOR.'config');

It seems like getBasePath() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get config key.
     *
     * @param  bool    $withVendor
     * @param  string  $separator
     *
     * @return string
     */
    protected function getConfigKey(bool $withVendor = false, string $separator = '.'): string
    {
        $package = Str::slug($this->getPackageName());

It seems like getPackageName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $withVendor
            ? Str::slug($this->getVendorName()).$separator.$package

It seems like getVendorName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            : $package;
    }

    /**
     * Get config file path.
     *
     * @return string
     */
    protected function getConfigFile(): string
    {
        return $this->getConfigFolder().DIRECTORY_SEPARATOR."{$this->getPackageName()}.php";

It seems like getPackageName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get the config files (paths).
     *
     * @return array|false
     */
    protected function configFilesPaths()
    {
        return glob($this->getConfigFolder().DIRECTORY_SEPARATOR.'*.php');
    }

    /**
     * Register configs.
     *
     * @param  string  $separator
     */
    protected function registerConfig(string $separator = '.'): void
    {
        $this->multiConfigs
            ? $this->registerMultipleConfigs($separator)
            : $this->registerSingleConfig();
    }

    /**
     * Register a single config file.
     */
    protected function registerSingleConfig(): void
    {
        $this->mergeConfigFrom($this->getConfigFile(), $this->getConfigKey());

It seems like mergeConfigFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Register all package configs.
     *
     * @param  string  $separator
     */
    protected function registerMultipleConfigs(string $separator = '.'): void
    {
        foreach ($this->configFilesPaths() as $path) {

The expression $this->configFilesPaths() of type array|false is not guaranteed to be traversable. How about adding an additional type check?

            $key = $this->getConfigKey(true, $separator).$separator.basename($path, '.php');

            $this->mergeConfigFrom($path, $key);

It seems like mergeConfigFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }

    /**
     * Publish the config file.
     *
     * @param  string|null  $path
     */
    protected function publishConfig(?string $path = null): void
    {
        $this->multiConfigs
            ? $this->publishMultipleConfigs()
            : $this->publishSingleConfig($path);
    }

    /**
     * Publish a single config file.
     *
     * @param  string|null  $path
     */
    protected function publishSingleConfig(?string $path = null): void
    {
        $this->publishes([

It seems like publishes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->getConfigFile() => $path ?: config_path("{$this->getPackageName()}.php"),

It seems like getPackageName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        ], $this->getPublishedTags('config'));

It seems like getPublishedTags() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Publish multiple config files.
     */
    protected function publishMultipleConfigs(): void
    {
        $paths   = [];
        $package = $this->getConfigKey(true, DIRECTORY_SEPARATOR);

        foreach ($this->configFilesPaths() as $file) {

The expression $this->configFilesPaths() of type array|false is not guaranteed to be traversable. How about adding an additional type check?

            $paths[$file] = config_path($package.DIRECTORY_SEPARATOR.basename($file));
        }

        $this->publishes($paths, $this->getPublishedTags('config'));

It seems like getPublishedTags() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like publishes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}