Passed
Push — stable ( f958a0...2a58cd )
by Nuno
04:01
created

BuildCommand::clear()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 1

Importance

Changes 0
Metric Value
eloc 3
dl 0
loc 7
ccs 4
cts 4
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 1
1
<?php
2
3
declare(strict_types=1);
4
5
/**
6
 * This file is part of Laravel Zero.
7
 *
8
 * (c) Nuno Maduro <[email protected]>
9
 *
10
 *  For the full copyright and license information, please view the LICENSE
11
 *  file that was distributed with this source code.
12
 */
13
14
namespace LaravelZero\Framework\Commands;
15
16
use Illuminate\Support\Facades\File;
17
use Symfony\Component\Process\Process;
18
use Illuminate\Console\Application as Artisan;
19
use Symfony\Component\Console\Output\NullOutput;
20
use Symfony\Component\Console\Helper\ProgressBar;
21
use Symfony\Component\Console\Input\InputInterface;
22
use Symfony\Component\Console\Output\OutputInterface;
23
24
final class BuildCommand extends Command
25
{
26
    /**
27
     * {@inheritdoc}
28
     */
29
    protected $signature = 'app:build {name? : The build name} {--timeout=300 : The timeout in seconds or 0 to disable}';
30
31
    /**
32
     * {@inheritdoc}
33
     */
34
    protected $description = 'Build a single file executable';
35
36
    /**
37
     * Holds the configuration on is original state.
38
     *
39
     * @var string|null
40
     */
41
    private static $config;
42
43
    /**
44
     * Holds the command original output.
45
     *
46
     * @var \Symfony\Component\Console\Output\OutputInterface
47
     */
48
    private $originalOutput;
49
50
    /**
51
     * {@inheritdoc}
52
     */
53 2
    public function handle()
54
    {
55 2
        $this->title('Building process');
56
57 2
        $this->build($this->input->getArgument('name') ?? $this->getBinary());
0 ignored issues
show
Bug introduced by
It seems like $this->input->getArgumen...) ?? $this->getBinary() can also be of type string[]; however, parameter $name of LaravelZero\Framework\Co...s\BuildCommand::build() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

57
        $this->build(/** @scrutinizer ignore-type */ $this->input->getArgument('name') ?? $this->getBinary());
Loading history...
58 1
    }
59
60
    /**
61
     * {@inheritdoc}
62
     */
63 2
    public function run(InputInterface $input, OutputInterface $output)
64
    {
65 2
        parent::run($input, $this->originalOutput = $output);
66 1
    }
67
68
    /**
69
     * Builds the application into a single file.
70
     */
71 2
    private function build(string $name): BuildCommand
72
    {
73
        /*
74
         * We prepare the application for a build, moving it to production. Then,
75
         * after compile all the code to a single file, we move the built file
76
         * to the builds folder with the correct permissions.
77
         */
78 2
        $this->prepare()
79 2
            ->compile($name)
80 1
            ->clear();
81
82 1
        $this->output->writeln(
83 1
            sprintf('    Compiled successfully: <fg=green>%s</>', $this->app->buildsPath($name))
84
        );
85
86 1
        return $this;
87
    }
88
89 2
    private function compile(string $name): BuildCommand
90
    {
91 2
        if (! File::exists($this->app->buildsPath())) {
92 2
            File::makeDirectory($this->app->buildsPath());
93
        }
94
95 2
        $process = new Process(
96 2
            './box compile'.' --working-dir="'.base_path().'" --config="'.base_path('box.json').'"',
0 ignored issues
show
Bug introduced by
'./box compile' . ' --wo..._path('box.json') . '"' of type string is incompatible with the type array expected by parameter $command of Symfony\Component\Process\Process::__construct(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

96
            /** @scrutinizer ignore-type */ './box compile'.' --working-dir="'.base_path().'" --config="'.base_path('box.json').'"',
Loading history...
97 2
            dirname(dirname(__DIR__)).'/bin',
98 2
            null,
99 2
            null,
100 2
            $this->getTimeout()
101
        );
102
103 2
        $section = tap($this->originalOutput->section())->write('');
0 ignored issues
show
Bug introduced by
The method section() does not exist on Symfony\Component\Console\Output\OutputInterface. It seems like you code against a sub-type of Symfony\Component\Console\Output\OutputInterface such as Symfony\Component\Console\Style\OutputStyle or Symfony\Component\Console\Output\ConsoleOutput or anonymous//tests/BuildCommandTest.php$1 or anonymous//tests/BuildCommandTest.php$3 or Symfony\Component\Console\Output\ConsoleOutput. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

103
        $section = tap($this->originalOutput->/** @scrutinizer ignore-call */ section())->write('');
Loading history...
104
105 2
        $progressBar = tap(
106 2
            new ProgressBar(
107 2
                $this->output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL ? new NullOutput() : $section, 25
108
            )
109 2
        )->setProgressCharacter("\xF0\x9F\x8D\xBA");
110
111 2
        foreach (tap($process)->start() as $type => $data) {
112 2
            $progressBar->advance();
113
114 2
            if ($this->output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL) {
115 2
                $process::OUT === $type ? $this->info("$data") : $this->error("$data");
116
            }
117
        }
118
119 2
        $progressBar->finish();
120
121 2
        $section->clear();
122
123 1
        $this->task('   2. <fg=yellow>Compile</> into a single file');
124
125 1
        $this->output->newLine();
126
127 1
        File::move($this->app->basePath($this->getBinary()).'.phar', $this->app->buildsPath($name));
128
129 1
        return $this;
130
    }
131
132 2
    private function prepare(): BuildCommand
133
    {
134 2
        $file = $this->app->configPath('app.php');
135 2
        static::$config = File::get($file);
0 ignored issues
show
Bug introduced by
Since $config is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $config to at least protected.
Loading history...
136 2
        $config = include $file;
137
138 2
        $config['production'] = true;
139
140 2
        $version = $this->ask('Build version?', $config['version']);
141 2
        $config['version'] = $version;
142
143 2
        $this->task(
144 2
            '   1. Moving application to <fg=yellow>production mode</>',
145
            function () use ($file, $config) {
146 2
                File::put($file, '<?php return '.var_export($config, true).';'.PHP_EOL);
147 2
            }
148
        );
149
150 2
        return $this;
151
    }
152
153 2
    private function clear(): BuildCommand
154
    {
155 2
        File::put($this->app->configPath('app.php'), static::$config);
0 ignored issues
show
Bug introduced by
Since $config is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $config to at least protected.
Loading history...
156
157 2
        static::$config = null;
158
159 2
        return $this;
160
    }
161
162
    /**
163
     * Returns the artisan binary.
164
     */
165 2
    private function getBinary(): string
166
    {
167 2
        return str_replace(["'", '"'], '', Artisan::artisanBinary());
168
    }
169
170
    /**
171
     * Returns a valid timeout value. Non positive values are converted to null,
172
     * meaning no timeout.
173
     *
174
     * @return float|null
175
     * @throws \InvalidArgumentException
176
     */
177 2
    private function getTimeout(): ?float
178
    {
179 2
        if (! is_numeric($this->option('timeout'))) {
0 ignored issues
show
introduced by
The condition is_numeric($this->option('timeout')) is always true.
Loading history...
180
            throw new \InvalidArgumentException('The timeout value must be a number.');
181
        }
182
183 2
        $timeout = (float) $this->option('timeout');
184
185 2
        return $timeout > 0 ? $timeout : null;
186
    }
187
188
    /**
189
     * Makes sure that the `clear` is performed even
190
     * if the command fails.
191
     *
192
     * @return void
193
     */
194 37
    public function __destruct()
195
    {
196 37
        if (static::$config !== null) {
0 ignored issues
show
Bug introduced by
Since $config is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $config to at least protected.
Loading history...
197 1
            $this->clear();
198
        }
199 37
    }
200
}
201