PackageServiceProvider::getPackageName() - Code Metrics - Inspection of "Updating the README.md" - ARCANEDEV/Support - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7e4199...dc29d1 )

by ARCANEDEV

created 2020-08-20 19:04 UTC

PackageServiceProvider::getPackageName() A

↳ Parent: PackageServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Arcanedev\Support\Providers;

use Arcanedev\Support\Exceptions\PackageException;
use Arcanedev\Support\Providers\Concerns\{
    HasAssets, HasConfig, HasFactories, HasMigrations, HasTranslations, HasViews
};
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Str;
use ReflectionClass;

/**
 * Class     PackageServiceProvider
 *
 * @package  Arcanedev\Support\Providers
 * @author   ARCANEDEV <[email protected]>
 */
abstract class PackageServiceProvider extends ServiceProvider
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use HasAssets,
        HasConfig,
        HasFactories,
        HasMigrations,
        HasTranslations,
        HasViews;

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Vendor name.
     *
     * @var string
     */
    protected $vendor = 'arcanedev';

    /**
     * Package name.
     *
     * @var string|null
     */
    protected $package;

    /**
     * Package base path.
     *
     * @var string
     */
    protected $basePath;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create a new service provider instance.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     */
    public function __construct(Application $app)
    {
        parent::__construct($app);

        $this->basePath = $this->resolveBasePath();
    }

    /**
     * Resolve the base path of the package.
     *
     * @return string
     */
    protected function resolveBasePath()
    {
        return dirname(
            (new ReflectionClass($this))->getFileName(), 2
        );
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the base path of the package.
     *
     * @return string
     */
    public function getBasePath()
    {
        return $this->basePath;
    }

    /**
     * Get the vendor name.
     *
     * @return string
     */
    protected function getVendorName(): string
    {
        return $this->vendor;
    }

    /**
     * Get the package name.
     *
     * @return string|null
     */
    protected function getPackageName(): ?string
    {
        return $this->package;
    }

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

    /**
     * Register the service provider.
     */
    public function register()
    {
        parent::register();

        $this->checkPackageName();
    }

    /* -----------------------------------------------------------------
     |  Package Methods
     | -----------------------------------------------------------------
     */

    /**
     * Publish all the package files.
     */
    protected function publishAll(): void
    {
        $this->publishAssets();
        $this->publishConfig();
        $this->publishFactories();
        $this->publishMigrations();
        $this->publishTranslations();
        $this->publishViews();
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check package name.
     *
     * @throws \Arcanedev\Support\Exceptions\PackageException
     */
    protected function checkPackageName(): void
    {
        if (empty($this->getVendorName()) || empty($this->getPackageName())) {
            throw PackageException::unspecifiedName();
        }
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the published tags.
     *
     * @param  string  $tag
     *
     * @return array
     */
    protected function getPublishedTags(string $tag): array
    {
        $package = $this->getPackageName();

        return array_map(function ($name) {
            return Str::slug($name);
        }, [$this->getVendorName(), $package, $tag, $package.'-'.$tag]);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Arcanedev\Support\Providers;
6
7		use Arcanedev\Support\Exceptions\PackageException;
8		use Arcanedev\Support\Providers\Concerns\{
9		HasAssets, HasConfig, HasFactories, HasMigrations, HasTranslations, HasViews
10		};
11		use Illuminate\Contracts\Foundation\Application;
12		use Illuminate\Support\Str;
13		use ReflectionClass;
14
15		/**
16		* Class PackageServiceProvider
17		*
18		* @package Arcanedev\Support\Providers
19		* @author ARCANEDEV <[email protected]>
20		*/
21		abstract class PackageServiceProvider extends ServiceProvider
22		{
23		/* -----------------------------------------------------------------
24		\| Traits
25		\| -----------------------------------------------------------------
26		*/
27
28		use HasAssets,
29		HasConfig,
30		HasFactories,
31		HasMigrations,
32		HasTranslations,
33		HasViews;
34
35		/* -----------------------------------------------------------------
36		\| Properties
37		\| -----------------------------------------------------------------
38		*/
39
40		/**
41		* Vendor name.
42		*
43		* @var string
44		*/
45		protected $vendor = 'arcanedev';
46
47		/**
48		* Package name.
49		*
50		* @var string\|null
51		*/
52		protected $package;
53
54		/**
55		* Package base path.
56		*
57		* @var string
58		*/
59		protected $basePath;
60
61		/* -----------------------------------------------------------------
62		\| Constructor
63		\| -----------------------------------------------------------------
64		*/
65
66		/**
67		* Create a new service provider instance.
68		*
69		* @param \Illuminate\Contracts\Foundation\Application $app
70		*/
71	18	public function __construct(Application $app)
72		{
73	18	parent::__construct($app);
74
75	18	$this->basePath = $this->resolveBasePath();
76	18	}
77
78		/**
79		* Resolve the base path of the package.
80		*
81		* @return string
82		*/
83	18	protected function resolveBasePath()
84		{
85	18	return dirname(
86	18	(new ReflectionClass($this))->getFileName(), 2
87		);
88		}
89
90		/* -----------------------------------------------------------------
91		\| Getters & Setters
92		\| -----------------------------------------------------------------
93		*/
94
95		/**
96		* Get the base path of the package.
97		*
98		* @return string
99		*/
100	18	public function getBasePath()
101		{
102	18	return $this->basePath;
103		}
104
105		/**
106		* Get the vendor name.
107		*
108		* @return string
109		*/
110	18	protected function getVendorName(): string
111		{
112	18	return $this->vendor;
113		}
114
115		/**
116		* Get the package name.
117		*
118		* @return string\|null
119		*/
120	18	protected function getPackageName(): ?string
121		{
122	18	return $this->package;
123		}
124
125		/* -----------------------------------------------------------------
126		\| Main Methods
127		\| -----------------------------------------------------------------
128		*/
129
130		/**
131		* Register the service provider.
132		*/
133	18	public function register()
134		{
135	18	parent::register();
136
137	18	$this->checkPackageName();
138	18	}
139
140		/* -----------------------------------------------------------------
141		\| Package Methods
142		\| -----------------------------------------------------------------
143		*/
144
145		/**
146		* Publish all the package files.
147		*/
148		protected function publishAll(): void
149		{
150		$this->publishAssets();
151		$this->publishConfig();
152		$this->publishFactories();
153		$this->publishMigrations();
154		$this->publishTranslations();
155		$this->publishViews();
156		}
157
158		/* -----------------------------------------------------------------
159		\| Check Methods
160		\| -----------------------------------------------------------------
161		*/
162
163		/**
164		* Check package name.
165		*
166		* @throws \Arcanedev\Support\Exceptions\PackageException
167		*/
168	18	protected function checkPackageName(): void
169		{
170	18	if (empty($this->getVendorName()) \|\| empty($this->getPackageName())) {
171	6	throw PackageException::unspecifiedName();
172		}
173	18	}
174
175		/* -----------------------------------------------------------------
176		\| Other Methods
177		\| -----------------------------------------------------------------
178		*/
179
180		/**
181		* Get the published tags.
182		*
183		* @param string $tag
184		*
185		* @return array
186		*/
187		protected function getPublishedTags(string $tag): array
188		{
189		$package = $this->getPackageName();
190
191		return array_map(function ($name) {
192		return Str::slug($name);
193		}, [$this->getVendorName(), $package, $tag, $package.'-'.$tag]);
194		}
195		}
196

ARCANEDEV / Support

Push — master ( 7e4199...dc29d1 )

PackageServiceProvider::getPackageName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like