AdminLteStatusCommand::handle() - Code Metrics - Inspection of "New Install, Update and Status Artisan Commands" - jeroennoten/Laravel-AdminLTE - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#679)

by Diego

created 2020-07-26 17:48 UTC

AdminLteStatusCommand::handle() A

↳ Parent: AdminLteStatusCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	2
Bugs	1	Features	0

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

<?php

namespace JeroenNoten\LaravelAdminLte\Console;

use Illuminate\Console\Command;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\AssetsResource;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\AuthViewsResource;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\BasicRoutesResource;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\BasicViewsResource;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\ConfigResource;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\MainViewsResource;
use JeroenNoten\LaravelAdminLte\Console\PackageResources\TranslationsResource;

class AdminLteStatusCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'adminlte:status ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Checks the installation status of the AdminLTE resources';

    /**
     * Array with all the available package resources.
     *
     * @var array
     */
    protected $pkgResources;

    /**
     * Array with the possible resources statuses.
     *
     * @var array
     */
    protected $status = [
        'installed' => [
            'label' => 'Installed',
            'legend' => 'The resource is installed and matches with the default package resource',
            'color' => 'green',
        ],
        'mismatch' => [
            'label' => 'Mismatch',
            'legend' => 'The installed resource mismatch the package resource (update available or resource modified)',
            'color' => 'yellow',
        ],
        'uninstalled' => [
            'label' => 'Not Installed',
            'legend' => 'The package resource is not installed',
            'color' => 'red',
        ],
    ];

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();

        // Fill the array with the package resources.

        $this->pkgResources = [
            'assets'       => new AssetsResource(),
            'config'       => new ConfigResource(),
            'translations' => new TranslationsResource(),
            'main_views'   => new MainViewsResource(),
            'auth_views'   => new AuthViewsResource(),
            'basic_views'  => new BasicViewsResource(),
            'basic_routes' => new BasicRoutesResource(),
        ];
    }

    /**
     * Execute the console command.
     *
     * @return void
     */
    public function handle()
    {
        // Display the resources installation status.

        $this->showResourcesStatus();

        // Display the legends table.

        $this->line('');
        $this->showStatusLegends();
    }

    /**
     * Display the resources status.
     *
     * @return void
     */
    protected function showResourcesStatus()
    {
        // Define the table headers.

        $tblHeader = [
            $this->styleOutput('Package Resource', 'cyan'),
            $this->styleOutput('Description', 'cyan'),
            $this->styleOutput('Status', 'cyan'),
            $this->styleOutput('Required', 'cyan'),
        ];

        // Get the table rows.

        $tblContent = $this->getResourcesStatusRows();

        // Display the table.

        $this->line('');
        $this->table($tblHeader, $tblContent);
    }

    /**
     * Get the rows for the resources status table.
     *
     * @return array
     */
    protected function getResourcesStatusRows()
    {
        // Define the array that will hold the table rows.

        $tblContent = [];

        // Create a progress bar.

        $steps = count($this->pkgResources);
        $bar = $this->output->createProgressBar($steps);

        // Initialize the status check procedure.

        $this->line('Checking the resources installation ...');
        $bar->start();

        foreach ($this->pkgResources as $name => $resource) {

            // Fill the status row of the current resource.

            $tblContent[] = [
                $name,
                $resource->description,
                $this->getResourceStatus($resource),
                var_export($resource->required, true),
            ];

            // Advance the progress bar one step.

            $bar->advance();
        }

        // Finish the progress bar.

        $bar->finish();
        $this->line('');
        $this->line('All resources checked succesfully!');

        // Return the rows.

        return $tblContent;
    }

    /**
     * Get the installation status of a package resource.
     *
     * @param PackageResource $resource The package resource to check
     * @return string The resource status
     */
    protected function getResourceStatus($resource)
    {
        $status = $this->status['uninstalled'];

        if ($resource->installed()) {
            $status = $this->status['installed'];
        } elseif ($resource->exists()) {
            $status = $this->status['mismatch'];
        }

        return $this->styleOutput($status['label'], $status['color']);
    }

    /**
     * Display the legends of the possible status values.
     *
     * @return void
     */
    protected function showStatusLegends()
    {
        $this->line('Status legends:');

        // Create the table headers for the legends.

        $tblHeader = [
            $this->styleOutput('Status', 'cyan'),
            $this->styleOutput('Description', 'cyan'),
        ];

        // Create the table rows for the legends.

        $tblContent = [];

        foreach ($this->status as $status) {
            $tblContent[] = [
                $this->styleOutput($status['label'], $status['color']),
                $status['legend'],
            ];
        }

        // Display the legends table.

        $this->table($tblHeader, $tblContent);
    }

    /**
     * Give output style to some text.
     *
     * @param string $text The text to be styled
     * @param string $color The output color for the text
     * @return string The styled text
     */
    protected function styleOutput($text, $color)
    {
        return "<fg={$color}>{$text}</>";
    }
}


1		<?php
2
3		namespace JeroenNoten\LaravelAdminLte\Console;
4
5		use Illuminate\Console\Command;
6		use JeroenNoten\LaravelAdminLte\Console\PackageResources\AssetsResource;
7		use JeroenNoten\LaravelAdminLte\Console\PackageResources\AuthViewsResource;
8		use JeroenNoten\LaravelAdminLte\Console\PackageResources\BasicRoutesResource;
9		use JeroenNoten\LaravelAdminLte\Console\PackageResources\BasicViewsResource;
10		use JeroenNoten\LaravelAdminLte\Console\PackageResources\ConfigResource;
11		use JeroenNoten\LaravelAdminLte\Console\PackageResources\MainViewsResource;
12		use JeroenNoten\LaravelAdminLte\Console\PackageResources\TranslationsResource;
13
14		class AdminLteStatusCommand extends Command
15		{
16		/**
17		* The name and signature of the console command.
18		*
19		* @var string
20		*/
21		protected $signature = 'adminlte:status ';
22
23		/**
24		* The console command description.
25		*
26		* @var string
27		*/
28		protected $description = 'Checks the installation status of the AdminLTE resources';
29
30		/**
31		* Array with all the available package resources.
32		*
33		* @var array
34		*/
35		protected $pkgResources;
36
37		/**
38		* Array with the possible resources statuses.
39		*
40		* @var array
41		*/
42		protected $status = [
43		'installed' => [
44		'label' => 'Installed',
45		'legend' => 'The resource is installed and matches with the default package resource',
46		'color' => 'green',
47		],
48		'mismatch' => [
49		'label' => 'Mismatch',
50		'legend' => 'The installed resource mismatch the package resource (update available or resource modified)',
51		'color' => 'yellow',
52		],
53		'uninstalled' => [
54		'label' => 'Not Installed',
55		'legend' => 'The package resource is not installed',
56		'color' => 'red',
57		],
58		];
59
60		/**
61		* Create a new command instance.
62		*
63		* @return void
64		*/
65	12	public function __construct()
66		{
67	12	parent::__construct();
68
69		// Fill the array with the package resources.
70
71	12	$this->pkgResources = [
72	12	'assets' => new AssetsResource(),
73	12	'config' => new ConfigResource(),
74	12	'translations' => new TranslationsResource(),
75	12	'main_views' => new MainViewsResource(),
76	12	'auth_views' => new AuthViewsResource(),
77	12	'basic_views' => new BasicViewsResource(),
78	12	'basic_routes' => new BasicRoutesResource(),
79		];
80	12	}
81
82		/**
83		* Execute the console command.
84		*
85		* @return void
86		*/
87	1	public function handle()
88		{
89		// Display the resources installation status.
90
91	1	$this->showResourcesStatus();
92
93		// Display the legends table.
94
95	1	$this->line('');
96	1	$this->showStatusLegends();
97	1	}
98
99		/**
100		* Display the resources status.
101		*
102		* @return void
103		*/
104	1	protected function showResourcesStatus()
105		{
106		// Define the table headers.
107
108		$tblHeader = [
109	1	$this->styleOutput('Package Resource', 'cyan'),
110	1	$this->styleOutput('Description', 'cyan'),
111	1	$this->styleOutput('Status', 'cyan'),
112	1	$this->styleOutput('Required', 'cyan'),
113		];
114
115		// Get the table rows.
116
117	1	$tblContent = $this->getResourcesStatusRows();
118
119		// Display the table.
120
121	1	$this->line('');
122	1	$this->table($tblHeader, $tblContent);
123	1	}
124
125		/**
126		* Get the rows for the resources status table.
127		*
128		* @return array
129		*/
130	1	protected function getResourcesStatusRows()
131		{
132		// Define the array that will hold the table rows.
133
134	1	$tblContent = [];
135
136		// Create a progress bar.
137
138	1	$steps = count($this->pkgResources);
139	1	$bar = $this->output->createProgressBar($steps);
140
141		// Initialize the status check procedure.
142
143	1	$this->line('Checking the resources installation ...');
144	1	$bar->start();
145
146	1	foreach ($this->pkgResources as $name => $resource) {
147
148		// Fill the status row of the current resource.
149
150	1	$tblContent[] = [
151	1	$name,
152	1	$resource->description,
153	1	$this->getResourceStatus($resource),
154	1	var_export($resource->required, true),
155		];
156
157		// Advance the progress bar one step.
158
159	1	$bar->advance();
160		}
161
162		// Finish the progress bar.
163
164	1	$bar->finish();
165	1	$this->line('');
166	1	$this->line('All resources checked succesfully!');
167
168		// Return the rows.
169
170	1	return $tblContent;
171		}
172
173		/**
174		* Get the installation status of a package resource.
175		*
176		* @param PackageResource $resource The package resource to check
177		* @return string The resource status
178		*/
179	1	protected function getResourceStatus($resource)
180		{
181	1	$status = $this->status['uninstalled'];
182
183	1	if ($resource->installed()) {
184	1	$status = $this->status['installed'];
185	1	} elseif ($resource->exists()) {
186	1	$status = $this->status['mismatch'];
187		}
188
189	1	return $this->styleOutput($status['label'], $status['color']);
190		}
191
192		/**
193		* Display the legends of the possible status values.
194		*
195		* @return void
196		*/
197	1	protected function showStatusLegends()
198		{
199	1	$this->line('Status legends:');
200
201		// Create the table headers for the legends.
202
203		$tblHeader = [
204	1	$this->styleOutput('Status', 'cyan'),
205	1	$this->styleOutput('Description', 'cyan'),
206		];
207
208		// Create the table rows for the legends.
209
210	1	$tblContent = [];
211
212	1	foreach ($this->status as $status) {
213	1	$tblContent[] = [
214	1	$this->styleOutput($status['label'], $status['color']),
215	1	$status['legend'],
216		];
217		}
218
219		// Display the legends table.
220
221	1	$this->table($tblHeader, $tblContent);
222	1	}
223
224		/**
225		* Give output style to some text.
226		*
227		* @param string $text The text to be styled
228		* @param string $color The output color for the text
229		* @return string The styled text
230		*/
231	1	protected function styleOutput($text, $color)
232		{
233	1	return "<fg={$color}>{$text}</>";
234		}
235		}
236

jeroennoten / Laravel-AdminLTE

Pull Request — master (#679)

AdminLteStatusCommand::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like