Jumilla\Addomnipot\Laravel\Addon

Complexity

Total Complexity

47

Size/Duplication

Total Lines	415
Duplicated Lines	3.37 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

79.19%

Importance

Changes	5
Bugs	1	Features	3

24 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	4	1
A	relativePath()	0	4	1
A	version()	0	4	1
A	phpNamespace()	0	4	1
A	config()	0	4	1
A	transName()	0	4	1
A	viewName()	0	4	1
A	view()	0	4	1
A	specName()	0	4	1
A	spec()	0	4	1
A	registerPackage()	0	19	4
A	create()	0	14	1
B	loadConfig()	0	20	5
A	__construct()	0	6	1
A	path()	0	8	2
A	trans()	7	7	1
A	transChoice()	7	7	1
A	register()	0	13	3
A	registerV4()	0	21	3
A	registerV5()	0	8	2
A	boot()	0	14	3
B	bootV4()	0	21	5
A	bootV5()	0	14	3
A	loadFiles()	0	12	3

<?php

namespace Jumilla\Addomnipot\Laravel;

use Illuminate\Contracts\Foundation\Application;
use Illuminate\Contracts\Config\Repository;
use Jumilla\Addomnipot\Laravel\Repository\ConfigLoader;
use RuntimeException;

class Addon
{
    /**
     * @param string $path
     *
     * @return static
     */
    public static function create($path)
    {
        $pathComponents = explode('/', $path);

        $name = $pathComponents[count($pathComponents) - 1];

        $addonConfig = static::loadConfig($path, $name);

        $config = ConfigLoader::load($path.'/'.array_get($addonConfig, 'paths.config', 'config'));

        $config->set('addon', $addonConfig);

        return new static($name, $path, $config);
    }

    /**
     * @param string $path
     *
     * @return array
     */
    protected static function loadConfig($path, $name)
    {
        if (file_exists($path.'/addon.php')) {
            $config = require $path.'/addon.php';
        } elseif (file_exists($path.'/addon.json')) {
            $config = json_decode(file_get_contents($path.'/addon.json'), true);

            if ($config === null) {
                throw new RuntimeException("Invalid json format at '$path/addon.json'.");
            }
        }
        // compatible v4 addon
        elseif (file_exists($path.'/config/addon.php')) {
            $config = require $path.'/config/addon.php';
        } else {
            throw new RuntimeException("No such config file for addon '$name', need 'addon.php' or 'addon.json'.");
        }

        return $config;
    }

    /**
     * @var string
     */
    protected $name;

    /**
     * @var string
     */
    protected $path;

    /**
     * @var \Illuminate\Contracts\Config\Repository
     */
    protected $config;

    /**
     * @var \Illuminate\Contracts\Foundation\Application
     */
    protected $app;

    /**
     * @param string                       $name
     * @param string                       $path
     * @param \Illuminate\Contracts\Config\Repository $config
     */
    public function __construct($name, $path, Repository $config)
    {
        $this->name = $name;
        $this->path = $path;
        $this->config = $config;
    }

    /**
     * get name.
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * get fullpath.
     *
     * @param string $path
     *
     * @return string
     */
    public function path($path = null)
    {
        if (func_num_args() == 0) {
            return $this->path;
        } else {
            return $this->path.'/'.$path;
        }
    }

    /**
     * get relative path.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     *
     * @return string
     */
    public function relativePath(Application $app)
    {
        return substr($this->path, strlen($app->basePath()) + 1);
    }

    /**
     * get version.
     *
     * @return int
     */
    public function version()
    {
        return $this->config('addon.version', 5);
    }

    /**
     * get PHP namespace.
     *
     * @return string
     */
    public function phpNamespace()
    {
        return trim($this->config('addon.namespace', ''), '\\');
    }

    /**
     * get config value.
     *
     * @param string $key
     * @param mixed $default
     *
     * @return mixed
     */
    public function config($key, $default = null)
    {
        return $this->config->get($key, $default);
    }

    /**
     * Get a lang resource name
     *
     * @param string $resource
     *
     * @return string
     */
    public function transName($resource)
    {
        return $this->name.'::'.$resource;
    }

    /**
     * Translate the given message.
     *
     * @param string $id

There is no parameter named $id. Was it maybe removed?

     * @param array $parameters

There is no parameter named $parameters. Was it maybe removed?

     * @param string $domain

There is no parameter named $domain. Was it maybe removed?

     * @param string $locale

There is no parameter named $locale. Was it maybe removed?

     * @return string
     */
    public function trans()

This method seems to be duplicated in your project.

    {
        $args = func_get_args();
        $args[0] = $this->transName($args[0]);

        return call_user_func_array([$this->app['translator'], 'trans'], $args);
    }

    /**
     * Translates the given message based on a count.
     *
     * @param string $id

There is no parameter named $id. Was it maybe removed?

     * @param int $number

There is no parameter named $number. Was it maybe removed?

     * @param array $parameters

There is no parameter named $parameters. Was it maybe removed?

     * @param string $domain

There is no parameter named $domain. Was it maybe removed?

     * @param string $locale

There is no parameter named $locale. Was it maybe removed?

     * @return string
     */
    public function transChoice()

This method seems to be duplicated in your project.

    {
         $args = func_get_args();
         $args[0] = $this->transName($args[0]);

         return call_user_func_array([$this->app['translator'], 'transChoice'], $args);
    }

    /**
     * Get a view resource name
     *
     * @param string $resource
     *
     * @return string
     */
    public function viewName($resource)
    {
        return $this->name.'::'.$resource;
    }

    /**
     * @param string $view
     * @param array $data
     * @param array $mergeData
     *
     * @return \Illuminate\View\View
     */
    public function view($view, $data = [], $mergeData = [])
    {
        return $this->app['view']->make($this->viewname($view), $data, $mergeData);
    }

    /**
     * Get a spec resource name
     *
     * @param string $resource
     *
     * @return string
     */
    public function specName($resource)
    {
        return $this->name.'::'.$resource;
    }

    /**
     * Get spec.
     *
     * @param string $path
     *
     * @return \Jumilla\Addomnipot\Laravel\Specs\InputSpec
     */
    public function spec($path)
    {
        return $this->app[SpecFactory::class]->make($this->specName($path));
    }

    /**
     * register addon.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    public function register(Application $app)
    {
        $this->app = $app;

        $version = $this->version();
        if ($version == 4) {
            $this->registerV4($app);
        } elseif ($version == 5) {
            $this->registerV5($app);
        } else {
            throw new RuntimeException($version.': Illigal addon version.');
        }
    }

    /**
     * register addon version 4.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    protected function registerV4(Application $app)
    {
        $this->config['paths'] = [
            'assets' => 'assets',
            'lang' => 'lang',
            'migrations' => 'migrations',
            'seeds' => 'seeds',
            'specs' => 'specs',
            'views' => 'views',
        ];

        // regist service providers
        $providers = $this->config('addon.providers', []);
        foreach ($providers as $provider) {
            if (!starts_with($provider, '\\')) {
                $provider = sprintf('%s\%s', $this->phpNamespace(), $provider);
            }

            $app->register($provider);
        }
    }

    /**
     * register addon version 5.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    protected function registerV5(Application $app)
    {
        // regist service providers
        $providers = $this->config('addon.providers', []);
        foreach ($providers as $provider) {
            $app->register($provider);
        }
    }

    /**
     * boot addon.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    public function boot(Application $app)
    {
        $this->registerPackage($app);

        $version = $this->version();
        if ($version == 4) {
            $this->bootV4($app);
        } elseif ($version == 5) {
            $this->bootV5($app);
        } else {
            throw new RuntimeException($version.': Illigal addon version.');
        }

    }

    /**
     * boot addon version 4.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    protected function bootV4(Application $app)
    {
        $filenames = $this->config('addon.files');

        $files = [];

        if ($filenames !== null) {
            foreach ($filenames as $filename) {
                $files[] = $this->path($filename);
            }
        } else {
            // load *.php on addon's root directory
            foreach ($app['files']->files($this->path) as $file) {
                if (ends_with($file, '.php')) {
                    require $file;
                }
            }
        }

        $this->loadFiles($files);
    }

    /**
     * boot addon version 5.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    protected function bootV5(Application $app)

The parameter $app is not used and could be removed.

    {
        $filenames = $this->config('addon.files');

        $files = [];

        if ($filenames !== null) {
            foreach ($filenames as $filename) {
                $files[] = $this->path($filename);
            }
        }

        $this->loadFiles($files);
    }

    /**
     * load addon initial script files.
     *
     * @param array $files
     */
    protected function loadFiles(array $files)
    {
        foreach ($files as $file) {
            if (!file_exists($file)) {
                $message = "Warning: PHP Script '$file' is nothing.";
                info($message);
                echo $message;
            }

            include $file;
        }
    }
    /**
     * Register the package's component namespaces.
     *
     * @param \Illuminate\Contracts\Foundation\Application $app
     */
    protected function registerPackage(Application $app)
    {
        $namespace = $this->name();

        $lang = $this->path($this->config('addon.paths.lang', 'lang'));
        if (is_dir($lang)) {
            $app['translator']->addNamespace($namespace, $lang);
        }

        $view = $this->path($this->config('addon.paths.views', 'views'));
        if (is_dir($view)) {
            $app['view']->addNamespace($namespace, $view);
        }

        $spec = $this->path($this->config('addon.paths.specs', 'specs'));
        if (is_dir($spec)) {
            $app['specs']->addNamespace($namespace, $spec);
        }
    }
}