PublishAdminLTE::publishDirectory() - Code Metrics - Inspection of "Files are not overwritten when copying folders and..." - acacha/adminlte-laravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ee58ba...a5219d )

by Sergi Tur

created 2016-09-26 15:30 UTC

PublishAdminLTE::publishDirectory() B

↳ Parent: PublishAdminLTE

Complexity

Conditions	5
Paths	3

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	13
rs	8.8571
cc	5
eloc	8
nc	3
nop	2

<?php

namespace Acacha\AdminLTETemplateLaravel\Console;

use Illuminate\Console\Command;
use Illuminate\Filesystem\Filesystem;
use League\Flysystem\Adapter\Local as LocalAdapter;
use League\Flysystem\Filesystem as Flysystem;
use League\Flysystem\MountManager;

/**
 * Class PublishAdminLTE.
 */
class PublishAdminLTE extends Command
{
    /**
     * The filesystem instance.
     *
     * @var \Illuminate\Filesystem\Filesystem
     */
    protected $files;

    /**
     * The name and signature of the console command.
     */
    protected $signature = 'adminlte-laravel:publish {--f|force : Force overwrite of files}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Publish Acacha AdminLTE Template files into laravel project';

    /**
     * Force overwrite of files.
     *
     * @var bool
     */
    protected $force = false;

    /**
     * Create a new command instance.
     *
     * @param \Illuminate\Filesystem\Filesystem $files
     *
     * @return void

     */
    public function __construct(Filesystem $files)
    {
        parent::__construct();
        $this->files = $files;
    }

    /**
     * Execute the console command.
     */
    public function handle()
    {
        $this->processOptions();
        $this->publishHomeController();
        $this->changeRegisterController();
        $this->changeLoginController();
        $this->changeForgotPasswordController();
        $this->changeResetPasswordController();
        $this->publishPublicAssets();
        $this->publishViews();
        $this->publishResourceAssets();
        $this->publishTests();
        $this->publishLanguages();
        $this->publishGravatar();
    }

    /**
     * Install Home Controller.
     */
    private function publishHomeController()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::homeController());
    }

    /**
     * Change Auth Register controller.
     */
    private function changeRegisterController()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::registerController());
    }

    /**
     * Change Auth Login controller.
     */
    private function changeLoginController()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::loginController());
    }

    /**
     * Change Auth Forgot Password controller.
     */
    private function changeForgotPasswordController()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::forgotPasswordController());
    }

    /**
     * Change Auth Reset Password controller.
     */
    private function changeResetPasswordController()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::resetPasswordController());
    }

    /**
     * Install public assets.
     */
    private function publishPublicAssets()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::publicAssets());
    }

    /**
     * Install views.
     */
    private function publishViews()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::viewsToOverwrite());
    }

    /**
     * Install resource assets.
     */
    private function publishResourceAssets()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::resourceAssets());
    }

    /**
     * Install resource assets.
     */
    private function publishTests()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::tests());
    }

    /**
     * Install language assets.
     */
    private function publishLanguages()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::languages());
    }

    /**
     * Install gravatar config file.
     */
    private function publishGravatar()
    {
        $this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::gravatar());
    }

    /**
     * Install files from array.
     *
     * @param $files
     */
    private function install($files)
    {
        foreach ($files as $fileSrc => $fileDst) {
            if (file_exists($fileDst) && !$this->force && !$this->confirmOverwrite(basename($fileDst))) {
                return;
            }
            if ($this->files->isFile($fileSrc)) {
                $this->publishFile($fileSrc, $fileDst);
            } elseif ($this->files->isDirectory($fileSrc)) {
                $this->publishDirectory($fileSrc, $fileDst);
            } else {
                $this->error("Can't locate path: <{$fileSrc}>");
            }
        }
    }

    /**
     * @param $fileName
     * @param string $prompt
     *
     * @return bool
     */
    protected function confirmOverwrite($fileName, $prompt = '')
    {
        $prompt = (empty($prompt))
            ? $fileName.' already exists. Do you want to overwrite it? [y|N]'
            : $prompt;

        return $this->confirm($prompt, false);
    }

    /**
     * Create the directory to house the published files if needed.
     *
     * @param string $directory
     *
     * @return void
     */
    protected function createParentDirectory($directory)
    {
        if (!$this->files->isDirectory($directory)) {
            $this->files->makeDirectory($directory, 0755, true);
        }
    }

    /**
     * Publish the file to the given path.
     *
     * @param string $from
     * @param string $to
     *
     * @return void
     */
    protected function publishFile($from, $to)
    {
        $this->createParentDirectory(dirname($to));
        $this->files->copy($from, $to);
        $this->status($from, $to, 'File');
    }

    /**
     * Publish the directory to the given directory.
     *
     * @param string $from
     * @param string $to
     *
     * @return void
     */
    protected function publishDirectory($from, $to)
    {
        $manager = new MountManager([
            'from' => new Flysystem(new LocalAdapter($from)),
            'to'   => new Flysystem(new LocalAdapter($to)),
        ]);
        foreach ($manager->listContents('from://', true) as $file) {
            if ($file['type'] === 'file' && (!$manager->has('to://'.$file['path']) || $this->force )) {
                $manager->put('to://'.$file['path'], $manager->read('from://'.$file['path']));
            }
        }
        $this->status($from, $to, 'Directory');
    }

    /**
     * Write a status message to the console.
     *
     * @param string $from
     * @param string $to
     * @param string $type
     *
     * @return void
     */
    protected function status($from, $to, $type)
    {
        $from = str_replace(base_path(), '', realpath($from));
        $to = str_replace(base_path(), '', realpath($to));
        $this->line('<info>Copied '.$type.'</info> <comment>['.$from.']</comment> <info>To</info> <comment>['.$to.']</comment>');
    }

    /**
     * Process options before running command.
     */
    private function processOptions()
    {
        $this->force = $this->option('force');

    }
}


1			<?php
2
3			namespace Acacha\AdminLTETemplateLaravel\Console;
4
5			use Illuminate\Console\Command;
6			use Illuminate\Filesystem\Filesystem;
7			use League\Flysystem\Adapter\Local as LocalAdapter;
8			use League\Flysystem\Filesystem as Flysystem;
9			use League\Flysystem\MountManager;
10
11			/**
12			* Class PublishAdminLTE.
13			*/
14			class PublishAdminLTE extends Command
15			{
16			/**
17			* The filesystem instance.
18			*
19			* @var \Illuminate\Filesystem\Filesystem
20			*/
21			protected $files;
22
23			/**
24			* The name and signature of the console command.
25			*/
26			protected $signature = 'adminlte-laravel:publish {--f\|force : Force overwrite of files}';
27
28			/**
29			* The console command description.
30			*
31			* @var string
32			*/
33			protected $description = 'Publish Acacha AdminLTE Template files into laravel project';
34
35			/**
36			* Force overwrite of files.
37			*
38			* @var bool
39			*/
40			protected $force = false;
41
42			/**
43			* Create a new command instance.
44			*
45			* @param \Illuminate\Filesystem\Filesystem $files
46			*
47			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-09-15 10:20 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
48			*/
49			public function __construct(Filesystem $files)
50			{
51			parent::__construct();
52			$this->files = $files;
53			}
54
55			/**
56			* Execute the console command.
57			*/
58			public function handle()
59			{
60			$this->processOptions();
61			$this->publishHomeController();
62			$this->changeRegisterController();
63			$this->changeLoginController();
64			$this->changeForgotPasswordController();
65			$this->changeResetPasswordController();
66			$this->publishPublicAssets();
67			$this->publishViews();
68			$this->publishResourceAssets();
69			$this->publishTests();
70			$this->publishLanguages();
71			$this->publishGravatar();
72			}
73
74			/**
75			* Install Home Controller.
76			*/
77			private function publishHomeController()
78			{
79			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::homeController());
80			}
81
82			/**
83			* Change Auth Register controller.
84			*/
85			private function changeRegisterController()
86			{
87			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::registerController());
88			}
89
90			/**
91			* Change Auth Login controller.
92			*/
93			private function changeLoginController()
94			{
95			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::loginController());
96			}
97
98			/**
99			* Change Auth Forgot Password controller.
100			*/
101			private function changeForgotPasswordController()
102			{
103			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::forgotPasswordController());
104			}
105
106			/**
107			* Change Auth Reset Password controller.
108			*/
109			private function changeResetPasswordController()
110			{
111			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::resetPasswordController());
112			}
113
114			/**
115			* Install public assets.
116			*/
117			private function publishPublicAssets()
118			{
119			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::publicAssets());
120			}
121
122			/**
123			* Install views.
124			*/
125			private function publishViews()
126			{
127			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::viewsToOverwrite());
128			}
129
130			/**
131			* Install resource assets.
132			*/
133			private function publishResourceAssets()
134			{
135			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::resourceAssets());
136			}
137
138			/**
139			* Install resource assets.
140			*/
141			private function publishTests()
142			{
143			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::tests());
144			}
145
146			/**
147			* Install language assets.
148			*/
149			private function publishLanguages()
150			{
151			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::languages());
152			}
153
154			/**
155			* Install gravatar config file.
156			*/
157			private function publishGravatar()
158			{
159			$this->install(\Acacha\AdminLTETemplateLaravel\Facades\AdminLTE::gravatar());
160			}
161
162			/**
163			* Install files from array.
164			*
165			* @param $files
166			*/
167			private function install($files)
168			{
169			foreach ($files as $fileSrc => $fileDst) {
170			if (file_exists($fileDst) && !$this->force && !$this->confirmOverwrite(basename($fileDst))) {
171			return;
172			}
173			if ($this->files->isFile($fileSrc)) {
174			$this->publishFile($fileSrc, $fileDst);
175			} elseif ($this->files->isDirectory($fileSrc)) {
176			$this->publishDirectory($fileSrc, $fileDst);
177			} else {
178			$this->error("Can't locate path: <{$fileSrc}>");
179			}
180			}
181			}
182
183			/**
184			* @param $fileName
185			* @param string $prompt
186			*
187			* @return bool
188			*/
189			protected function confirmOverwrite($fileName, $prompt = '')
190			{
191			$prompt = (empty($prompt))
192			? $fileName.' already exists. Do you want to overwrite it? [y\|N]'
193			: $prompt;
194
195			return $this->confirm($prompt, false);
196			}
197
198			/**
199			* Create the directory to house the published files if needed.
200			*
201			* @param string $directory
202			*
203			* @return void
204			*/
205			protected function createParentDirectory($directory)
206			{
207			if (!$this->files->isDirectory($directory)) {
208			$this->files->makeDirectory($directory, 0755, true);
209			}
210			}
211
212			/**
213			* Publish the file to the given path.
214			*
215			* @param string $from
216			* @param string $to
217			*
218			* @return void
219			*/
220			protected function publishFile($from, $to)
221			{
222			$this->createParentDirectory(dirname($to));
223			$this->files->copy($from, $to);
224			$this->status($from, $to, 'File');
225			}
226
227			/**
228			* Publish the directory to the given directory.
229			*
230			* @param string $from
231			* @param string $to
232			*
233			* @return void
234			*/
235			protected function publishDirectory($from, $to)
236			{
237			$manager = new MountManager([
238			'from' => new Flysystem(new LocalAdapter($from)),
239			'to' => new Flysystem(new LocalAdapter($to)),
240			]);
241			foreach ($manager->listContents('from://', true) as $file) {
242			if ($file['type'] === 'file' && (!$manager->has('to://'.$file['path']) \|\| $this->force )) {
243			$manager->put('to://'.$file['path'], $manager->read('from://'.$file['path']));
244			}
245			}
246			$this->status($from, $to, 'Directory');
247			}
248
249			/**
250			* Write a status message to the console.
251			*
252			* @param string $from
253			* @param string $to
254			* @param string $type
255			*
256			* @return void
257			*/
258			protected function status($from, $to, $type)
259			{
260			$from = str_replace(base_path(), '', realpath($from));
261			$to = str_replace(base_path(), '', realpath($to));
262			$this->line('<info>Copied '.$type.'</info> <comment>['.$from.']</comment> <info>To</info> <comment>['.$to.']</comment>');
263			}
264
265			/**
266			* Process options before running command.
267			*/
268			private function processOptions()
269			{
270			$this->force = $this->option('force');
			0 ignored issues – show Documentation Bug introduced 2016-09-17 08:14 UTC by Report Bug Copy Issue Report It seems like `$this->option('force')` of type `string` or `array` is incompatible with the declared type `boolean` of property `$force`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
271			}
272			}
273

acacha / adminlte-laravel

Push — master ( ee58ba...a5219d )

PublishAdminLTE::publishDirectory() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like