Passed
Push — stable ( 2cb6a4...3a423e )
by Nuno
02:21
created

Builder::prepare()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 27
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 17
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 27
ccs 17
cts 17
cp 1
rs 8.8571
c 0
b 0
f 0
cc 1
eloc 15
nc 1
nop 0
crap 1
1
<?php
2
3
/**
4
 * This file is part of Laravel Zero.
5
 *
6
 * (c) Nuno Maduro <[email protected]>
7
 *
8
 *  For the full copyright and license information, please view the LICENSE
9
 *  file that was distributed with this source code.
10
 */
11
12
namespace LaravelZero\Framework\Commands\App;
13
14
use Phar;
15
use FilesystemIterator;
16
use UnexpectedValueException;
17
use Illuminate\Support\Facades\File;
18
use LaravelZero\Framework\Commands\Command;
19
use LaravelZero\Framework\Contracts\Providers\Composer;
20
21
/**
22
 * This is the Laravel Zero Framework Builder Command implementation.
23
 */
24
class Builder extends Command
25
{
26
    /**
27
     * Contains the default app structure.
28
     *
29
     * @var string[]
30
     */
31
    protected $structure = [
32
        'app'.DIRECTORY_SEPARATOR,
33
        'bootstrap'.DIRECTORY_SEPARATOR,
34
        'vendor'.DIRECTORY_SEPARATOR,
35
        'config'.DIRECTORY_SEPARATOR,
36
        'composer.json',
37
        'builder-stub',
38
        '.env',
39
    ];
40
41
    /**
42
     * Holds the stub name.
43
     *
44
     * @var string
45
     */
46
    protected $stub = 'builder-stub';
47
48
    /**
49
     * {@inheritdoc}
50
     */
51
    protected $signature = 'app:build {name=application : The build name}';
52
53
    /**
54
     * {@inheritdoc}
55
     */
56
    protected $description = 'Perform an application build';
57
58
    /**
59
     * Holds the configuration on is original state.
60
     *
61
     * @var string
62
     */
63
    protected static $config;
64
65
    /**
66
     * {@inheritdoc}
67
     */
68 1
    public function handle(): void
69
    {
70 1
        $this->info('Building the application...');
71
72 1
        if (Phar::canWrite()) {
73 1
            $this->build($this->input->getArgument('name') ?: static::BUILD_NAME);
74
        } else {
75
            $this->error(
76
                'Unable to compile a phar because of php\'s security settings. '.'phar.readonly must be disabled in php.ini. '.PHP_EOL.PHP_EOL.'You will need to edit '.php_ini_loaded_file(
77
                ).' and add or set'.PHP_EOL.PHP_EOL.'    phar.readonly = Off'.PHP_EOL.PHP_EOL.'to continue. Details here: http://php.net/manual/en/phar.configuration.php'
78
            );
79
        }
80 1
    }
81
82
    /**
83
     * Builds the application into a single file.
84
     *
85
     * @param string $name The file name.
86
     *
87
     * @return $this
88
     */
89 1
    protected function build(string $name): Builder
90
    {
91
        /*
92
         * We prepare the application for a build, moving it to production. Then,
93
         * after compile all the code to a single file, we move the built file
94
         * to the builds folder with the correct permissions.
95
         */
96 1
        $this->prepare()
97 1
            ->compile($name)
98 1
            ->setPermissions($name)
99 1
            ->clear();
100
101 1
        $this->info(
102 1
            sprintf('Application built into a single file: %s', $this->app->buildsPath($name))
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Foundation\Application as the method buildsPath() does only exist in the following implementations of said interface: LaravelZero\Framework\Application.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
103
        );
104
105 1
        return $this;
106
    }
107
108
    /**
109
     * @param string $name
110
     *
111
     * @return $this
112
     */
113 1
    protected function compile(string $name): Builder
114
    {
115 1
        $compiler = $this->makeBuildsFolder()
116 1
            ->getCompiler($name);
117
118 1
        $structure = config('app.structure') ?: $this->structure;
119
120 1
        $regex = '#'.implode('|', $structure).'#';
121
122 1
        if (stristr(PHP_OS, 'WINNT') !== false) { // For windows:
123
            $compiler->buildFromDirectory($this->app->basePath(), str_replace('\\', '/', $regex));
124
        } else { // Linux, OS X:
125 1
            $compiler->buildFromDirectory($this->app->basePath(), $regex);
126
        }
127
128 1
        $this->task('Compiling code', function () use ($compiler) {
0 ignored issues
show
Documentation Bug introduced by
The method task does not exist on object<LaravelZero\Frame...k\Commands\App\Builder>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
129 1
            $compiler->setStub(
130 1
                "#!/usr/bin/env php \n".$compiler->createDefaultStub(
131 1
                    $this->stub
132
                )
133
            );
134 1
        });
135
136 1
        $file = $this->app->buildsPath($name);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Foundation\Application as the method buildsPath() does only exist in the following implementations of said interface: LaravelZero\Framework\Application.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
137
138 1
        File::move("$file.phar", $file);
139
140 1
        return $this;
141
    }
142
143
    /**
144
     * Gets a new instance of the compiler.
145
     *
146
     * @param string $name
147
     *
148
     * @return \Phar
149
     */
150 1
    protected function getCompiler(string $name): \Phar
151
    {
152
        try {
153 1
            return new Phar(
154 1
                $this->app->buildsPath($name.'.phar'),
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Foundation\Application as the method buildsPath() does only exist in the following implementations of said interface: LaravelZero\Framework\Application.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
155 1
                FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
156 1
                $name
157
            );
158
        } catch (UnexpectedValueException $e) {
159
            $this->app->abort(401, 'Unauthorized.');
160
        }
161
    }
162
163
    /**
164
     * @return $this
165
     */
166 1
    protected function makeBuildsFolder(): Builder
167
    {
168 1
        if (! File::exists($this->app->buildsPath())) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Foundation\Application as the method buildsPath() does only exist in the following implementations of said interface: LaravelZero\Framework\Application.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
169 1
            File::makeDirectory($this->app->buildsPath());
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Foundation\Application as the method buildsPath() does only exist in the following implementations of said interface: LaravelZero\Framework\Application.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
170
        }
171
172 1
        return $this;
173
    }
174
175
    /**
176
     * Sets the executable mode on the single application file.
177
     *
178
     * @param string $name
179
     *
180
     * @return $this
181
     */
182 1
    protected function setPermissions($name): Builder
183
    {
184 1
        chmod($this->app->buildsPath($name), 0755);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Foundation\Application as the method buildsPath() does only exist in the following implementations of said interface: LaravelZero\Framework\Application.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
185
186 1
        return $this;
187
    }
188
189
    /**
190
     * @return $this
191
     */
192 1
    protected function prepare(): Builder
193
    {
194 1
        $file = $this->app->configPath('app.php');
195 1
        static::$config = File::get($file);
196 1
        $config = include $file;
197
198 1
        $config['production'] = true;
199
200 1
        $this->task('Moving application to production mode', function () use ($file, $config) {
0 ignored issues
show
Documentation Bug introduced by
The method task does not exist on object<LaravelZero\Frame...k\Commands\App\Builder>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
201 1
            File::put($file, '<?php return '.var_export($config, true).';'.PHP_EOL);
202 1
        });
203
204 1
        $this->task('Temporarily removing dev dependencies', function () {
0 ignored issues
show
Documentation Bug introduced by
The method task does not exist on object<LaravelZero\Frame...k\Commands\App\Builder>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
205 1
            $this->app[Composer::class]->install(['--no-dev']);
206 1
        });
207
208 1
        $stub = str_replace('#!/usr/bin/env php', '', File::get($this->app->basePath(ARTISAN_BINARY)));
0 ignored issues
show
Unused Code introduced by
The call to Application::basePath() has too many arguments starting with ARTISAN_BINARY.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
209
210
        // Remove first line.
211 1
        $stubAsArray = explode("\n", $stub);
212 1
        array_shift($stubAsArray);
213 1
        $stub = implode("\n", $stubAsArray);
214
215 1
        File::put($this->app->basePath($this->stub), $stub);
0 ignored issues
show
Unused Code introduced by
The call to Application::basePath() has too many arguments starting with $this->stub.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
216
217 1
        return $this;
218
    }
219
220
    /**
221
     * @return $this
222
     */
223 1
    protected function clear(): Builder
224
    {
225 1
        File::put($this->app->configPath('app.php'), static::$config);
226
227 1
        File::delete($this->app->basePath($this->stub));
0 ignored issues
show
Unused Code introduced by
The call to Application::basePath() has too many arguments starting with $this->stub.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
228
229 1
        $this->task('Reinstalling dev dependencies', function () {
0 ignored issues
show
Documentation Bug introduced by
The method task does not exist on object<LaravelZero\Frame...k\Commands\App\Builder>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
230 1
            $this->app[Composer::class]->install();
231 1
        });
232
233 1
        static::$config = null;
234
235 1
        return $this;
236
    }
237
238
    /**
239
     * Makes sure that the `clear` is performed even
240
     * if the command fails.
241
     *
242
     * @return void
243
     */
244 18
    public function __destruct()
245
    {
246 18
        if (static::$config !== null) {
247
            $this->clear();
248
            $this->error('Something went wrong.');
249
        }
250 18
    }
251
}
252