Build::copyComponents() - Code Metrics - Inspection of "Update version" - area17/twill - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — ci/2.5-prep ( 118748...7cd2aa )

by Quentin

created 2021-08-31 14:16 UTC

Build::copyComponents() A

↳ Parent: Build

Complexity

Conditions	3
Paths	4

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	4
nop	0
dl	0
loc	13
rs	10
c	0
b	0
f	0

<?php

namespace A17\Twill\Commands;

use Illuminate\Filesystem\Filesystem;
use Symfony\Component\Process\Process;

class Build extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'twill:build {--noInstall} {--hot} {--watch} {--copyOnly}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = "Build Twill assets with custom Vue components/blocks";

    /**
     * @var Filesystem
     */
    protected $filesystem;

    /**
     * @param Filesystem $filesystem
     */
    public function __construct(Filesystem $filesystem)
    {
        parent::__construct();

        $this->filesystem = $filesystem;
    }

    /*
     * Executes the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        if ($this->option("copyOnly")) {
            return $this->copyCustoms();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }

        return $this->fullBuild();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /*
     * @return void
     */
    private function fullBuild()
    {
        $progressBar = $this->output->createProgressBar(5);
        $progressBar->setFormat("%current%/%max% [%bar%] %message%");

        $npmInstall = !$this->option('noInstall');

        $progressBar->setMessage(($npmInstall ? "Installing" : "Reusing") . " npm dependencies...\n\n");

        $progressBar->start();

        if ($npmInstall) {
            $this->runProcessInTwill(['npm', 'ci']);
        } else {
            sleep(1);
        }

        $this->info('');
        $progressBar->setMessage("Copying custom blocks...\n\n");
        $progressBar->advance();

        $this->copyBlocks();
        sleep(1);

        $this->info('');
        $progressBar->setMessage("Copying custom components...\n\n");
        $progressBar->advance();

        $this->copyComponents();
        sleep(1);

        $this->info('');
        $progressBar->setMessage("Building assets...\n\n");
        $progressBar->advance();

        if ($this->option('hot')) {
            $this->startWatcher(resource_path('assets/js/**/*.vue'), 'php artisan twill:build --copyOnly');
            $this->runProcessInTwill(['npm', 'run', 'serve'], true);
        } elseif ($this->option('watch')) {
            $this->startWatcher(resource_path('assets/js/**/*.vue'), 'php artisan twill:build --copyOnly');
            $this->runProcessInTwill(['npm', 'run', 'watch'], true);
        } else {
            $this->runProcessInTwill(['npm', 'run', 'build']);

            $this->info('');
            $progressBar->setMessage("Publishing assets...\n\n");
            $progressBar->advance();
            $this->call('twill:update');

            $this->info('');
            $progressBar->setMessage("Done.");
            $progressBar->finish();
        }
    }

    /**
     * @return void
     */
    private function startWatcher($pattern, $command)
    {
        if (empty($this->filesystem->glob($pattern))) {
            return;
        }

        $chokidarPath = base_path(config('twill.vendor_path')) . '/node_modules/.bin/chokidar';
        $chokidarCommand = [$chokidarPath, $pattern, "-c", $command];

        if ($this->filesystem->exists($chokidarPath)) {
            $process = new Process($chokidarCommand, base_path());
            $process->setTty(Process::isTtySupported());
            $process->setTimeout(null);

            try {
                $process->start();
            } catch(\Exception $e) {
                $this->warn("Could not start the chokidar watcher ({$e->getMessage()})\n");
            }
        } else {
            $this->warn("The `chokidar-cli` package was not found. It is required to watch custom blocks & components in development. You can install it by running:\n");
            $this->warn("    php artisan twill:dev\n");
            $this->warn("without the `--noInstall` option.\n");
            sleep(2);
        }
    }

    /**
     * @return void
     */
    private function runProcessInTwill(array $command, $disableTimeout = false)
    {
        $process = new Process($command, base_path(config('twill.vendor_path')));
        $process->setTty(Process::isTtySupported());

        if ($disableTimeout) {
            $process->setTimeout(null);
        } else {
            $process->setTimeout(config('twill.build_timeout', 300));
        }

        $process->mustRun();
    }

    /*
     * @return void
     */
    private function copyCustoms()
    {
        $this->info("Copying custom blocks & components...");
        $this->copyBlocks();
        $this->copyComponents();
        $this->info("Done.");
    }

    /**
     * @return void
     */
    private function copyBlocks()
    {
        $localCustomBlocksPath = resource_path(config('twill.block_editor.custom_vue_blocks_resource_path', 'assets/js/blocks'));
        $twillCustomBlocksPath = base_path(config('twill.vendor_path')) . '/frontend/js/components/blocks/customs';

        if (!$this->filesystem->exists($twillCustomBlocksPath)) {
            $this->filesystem->makeDirectory($twillCustomBlocksPath, 0755, true);
        }

        $this->filesystem->cleanDirectory($twillCustomBlocksPath);

        if ($this->filesystem->exists($localCustomBlocksPath)) {
            $this->filesystem->copyDirectory($localCustomBlocksPath, $twillCustomBlocksPath);
        }
    }

    /**
     * @return void
     */
    private function copyComponents()
    {
        $localCustomComponentsPath = resource_path(config('twill.custom_components_resource_path', 'assets/js/components'));
        $twillCustomComponentsPath = base_path(config('twill.vendor_path')) . '/frontend/js/components/customs';

        if (!$this->filesystem->exists($twillCustomComponentsPath)) {
            $this->filesystem->makeDirectory($twillCustomComponentsPath, 0755, true);
        }

        $this->filesystem->cleanDirectory($twillCustomComponentsPath);

        if ($this->filesystem->exists($localCustomComponentsPath)) {
            $this->filesystem->copyDirectory($localCustomComponentsPath, $twillCustomComponentsPath);
        }
    }
}


1			<?php
2
3			namespace A17\Twill\Commands;
4
5			use Illuminate\Filesystem\Filesystem;
6			use Symfony\Component\Process\Process;
7
8			class Build extends Command
9			{
10			/**
11			* The name and signature of the console command.
12			*
13			* @var string
14			*/
15			protected $signature = 'twill:build {--noInstall} {--hot} {--watch} {--copyOnly}';
16
17			/**
18			* The console command description.
19			*
20			* @var string
21			*/
22			protected $description = "Build Twill assets with custom Vue components/blocks";
23
24			/**
25			* @var Filesystem
26			*/
27			protected $filesystem;
28
29			/**
30			* @param Filesystem $filesystem
31			*/
32			public function __construct(Filesystem $filesystem)
33			{
34			parent::__construct();
35
36			$this->filesystem = $filesystem;
37			}
38
39			/*
40			* Executes the console command.
41			*
42			* @return mixed
43			*/
44			public function handle()
45			{
46			if ($this->option("copyOnly")) {
47			return $this->copyCustoms();
			0 ignored issues – show Bug introduced 2021-08-27 22:22 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->copyCustoms()` targeting `A17\Twill\Commands\Build::copyCustoms()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
48			}
49
50			return $this->fullBuild();
			0 ignored issues – show Bug introduced 2021-08-27 22:22 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->fullBuild()` targeting `A17\Twill\Commands\Build::fullBuild()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
51			}
52
53			/*
54			* @return void
55			*/
56			private function fullBuild()
57			{
58			$progressBar = $this->output->createProgressBar(5);
59			$progressBar->setFormat("%current%/%max% [%bar%] %message%");
60
61			$npmInstall = !$this->option('noInstall');
62
63			$progressBar->setMessage(($npmInstall ? "Installing" : "Reusing") . " npm dependencies...\n\n");
64
65			$progressBar->start();
66
67			if ($npmInstall) {
68			$this->runProcessInTwill(['npm', 'ci']);
69			} else {
70			sleep(1);
71			}
72
73			$this->info('');
74			$progressBar->setMessage("Copying custom blocks...\n\n");
75			$progressBar->advance();
76
77			$this->copyBlocks();
78			sleep(1);
79
80			$this->info('');
81			$progressBar->setMessage("Copying custom components...\n\n");
82			$progressBar->advance();
83
84			$this->copyComponents();
85			sleep(1);
86
87			$this->info('');
88			$progressBar->setMessage("Building assets...\n\n");
89			$progressBar->advance();
90
91			if ($this->option('hot')) {
92			$this->startWatcher(resource_path('assets/js/*/.vue'), 'php artisan twill:build --copyOnly');
93			$this->runProcessInTwill(['npm', 'run', 'serve'], true);
94			} elseif ($this->option('watch')) {
95			$this->startWatcher(resource_path('assets/js/*/.vue'), 'php artisan twill:build --copyOnly');
96			$this->runProcessInTwill(['npm', 'run', 'watch'], true);
97			} else {
98			$this->runProcessInTwill(['npm', 'run', 'build']);
99
100			$this->info('');
101			$progressBar->setMessage("Publishing assets...\n\n");
102			$progressBar->advance();
103			$this->call('twill:update');
104
105			$this->info('');
106			$progressBar->setMessage("Done.");
107			$progressBar->finish();
108			}
109			}
110
111			/**
112			* @return void
113			*/
114			private function startWatcher($pattern, $command)
115			{
116			if (empty($this->filesystem->glob($pattern))) {
117			return;
118			}
119
120			$chokidarPath = base_path(config('twill.vendor_path')) . '/node_modules/.bin/chokidar';
121			$chokidarCommand = [$chokidarPath, $pattern, "-c", $command];
122
123			if ($this->filesystem->exists($chokidarPath)) {
124			$process = new Process($chokidarCommand, base_path());
125			$process->setTty(Process::isTtySupported());
126			$process->setTimeout(null);
127
128			try {
129			$process->start();
130			} catch(\Exception $e) {
131			$this->warn("Could not start the chokidar watcher ({$e->getMessage()})\n");
132			}
133			} else {
134			$this->warn("The `chokidar-cli` package was not found. It is required to watch custom blocks & components in development. You can install it by running:\n");
135			$this->warn(" php artisan twill:dev\n");
136			$this->warn("without the `--noInstall` option.\n");
137			sleep(2);
138			}
139			}
140
141			/**
142			* @return void
143			*/
144			private function runProcessInTwill(array $command, $disableTimeout = false)
145			{
146			$process = new Process($command, base_path(config('twill.vendor_path')));
147			$process->setTty(Process::isTtySupported());
148
149			if ($disableTimeout) {
150			$process->setTimeout(null);
151			} else {
152			$process->setTimeout(config('twill.build_timeout', 300));
153			}
154
155			$process->mustRun();
156			}
157
158			/*
159			* @return void
160			*/
161			private function copyCustoms()
162			{
163			$this->info("Copying custom blocks & components...");
164			$this->copyBlocks();
165			$this->copyComponents();
166			$this->info("Done.");
167			}
168
169			/**
170			* @return void
171			*/
172			private function copyBlocks()
173			{
174			$localCustomBlocksPath = resource_path(config('twill.block_editor.custom_vue_blocks_resource_path', 'assets/js/blocks'));
175			$twillCustomBlocksPath = base_path(config('twill.vendor_path')) . '/frontend/js/components/blocks/customs';
176
177			if (!$this->filesystem->exists($twillCustomBlocksPath)) {
178			$this->filesystem->makeDirectory($twillCustomBlocksPath, 0755, true);
179			}
180
181			$this->filesystem->cleanDirectory($twillCustomBlocksPath);
182
183			if ($this->filesystem->exists($localCustomBlocksPath)) {
184			$this->filesystem->copyDirectory($localCustomBlocksPath, $twillCustomBlocksPath);
185			}
186			}
187
188			/**
189			* @return void
190			*/
191			private function copyComponents()
192			{
193			$localCustomComponentsPath = resource_path(config('twill.custom_components_resource_path', 'assets/js/components'));
194			$twillCustomComponentsPath = base_path(config('twill.vendor_path')) . '/frontend/js/components/customs';
195
196			if (!$this->filesystem->exists($twillCustomComponentsPath)) {
197			$this->filesystem->makeDirectory($twillCustomComponentsPath, 0755, true);
198			}
199
200			$this->filesystem->cleanDirectory($twillCustomComponentsPath);
201
202			if ($this->filesystem->exists($localCustomComponentsPath)) {
203			$this->filesystem->copyDirectory($localCustomComponentsPath, $twillCustomComponentsPath);
204			}
205			}
206			}
207

area17 / twill

Push — ci/2.5-prep ( 118748...7cd2aa )

Build::copyComponents() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like