PlaybookCommand::isAllowedInProduction() - Code Metrics - Inspection of "Fix issue with running playbooks in production env..." - teamscaling/laravel-playbook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d2d302...b1c51c )

by Erik van

created 2019-03-07 09:29 UTC

PlaybookCommand::isAllowedInProduction() A

↳ Parent: PlaybookCommand

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	3
nc	2
nop	0

<?php

namespace Scaling\Playbook\Console;

use Illuminate\Support\Str;
use Scaling\Playbook\Playbook;
use Illuminate\Console\Command;
use Scaling\Playbook\PlaybookDefenition;

class PlaybookCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'playbook:run {playbook?}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Run a predefined playbook to fill your application.';

    /**
     * List of definitions that has been run.
     *
     * @var array
     */
    private $ranDefenitions = [];

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        if (! $this->isAllowedInProduction()) {
            $this->error('You can only run commands in local environment');

            return;
        }

        if (is_null($name = $this->argument('playbook'))) {
            $name = $this->askWhichBook($this->getAvailablePlaybooks());
        }

        $this->call('migrate:refresh');

        $this->runPlaybook($this->resolvePlaybook($name));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Run the selected playbook.
     *
     * @param \Scaling\Playbook\PlaybookDefenition $definition
     * @return void
     */
    private function runPlaybook(PlaybookDefenition $definition): void
    {
        foreach ($definition->playbook->before() as $book) {
            $this->runPlaybook($this->resolvePlaybook($book));
        }

        for ($i = 1; $i <= $definition->times; $i++) {
            if ($definition->once && $this->definitionHasRun($definition)) {
                continue;
            }

            $name = get_class($definition->playbook);

            $this->info("Running playbook `{$name}` (#{$i})");

            $definition->playbook->run($this->input, $this->output);
            $definition->playbook->finished();

            $this->ranDefinitions[$definition->id] = ($this->ranDefinitions[$definition->id] ?? 0) + 1;

        }

        foreach ($definition->playbook->after() as $book) {
            $this->runPlaybook($this->resolvePlaybook($book));
        }
    }

    /**
     * Get a list of available playbooks.
     *
     * @return array
     */
    private function getAvailablePlaybooks(): array
    {
        $files = scandir(config('laravel-playbook.path'));

        unset($files[0], $files[1]);

        return array_values(array_map(function (string $fileName) {
            return str_replace('.php', '', $fileName);
        }, $files));
    }

    /**
     * Ask which playbook the developer wants to run.
     *
     * @param array $available
     * @return string
     */
    private function askWhichBook(array $available): string
    {
        return $this->choice('Please choose a playbook', $available);
    }

    /**
     * Resolve the definition for the given playbook.
     *
     * @param Scaling\Playbook\Playbook|Scaling\Playbook\PlaybookDefinition|string $class
     * @return \Scaling\Playbook\PlaybookDefenition
     */
    private function resolvePlaybook($class): PlaybookDefenition
    {
        if ($class instanceof PlaybookDefenition) {
            return $class;
        }

        if ($class instanceof Playbook) {
            return new PlaybookDefenition(get_class($class));
        }

        $namespace = config('laravel-playbook.namespace');

        if (! Str::startsWith($class, [$namespace, "\\{$namespace}"])) {
            $class = "{$namespace}\\{$class}";
        }

        return new PlaybookDefenition($class);
    }

    /**
     * Determine if the given definition has ran before.
     *
     * @param \Scaling\Playbook\PlaybookDefenition $definition
     * @return bool
     */
    private function definitionHasRun(PlaybookDefenition $definition): bool
    {
        return isset($this->ranDefenitions[$definition->id]);
    }

    /**
     * Determine if the action is allowed in a production environment.
     *
     * @return bool
     */
    private function isAllowedInProduction(): bool
    {
        if (!config('laravel-playbook.production') && config('app.env') === 'production') {
            return false;
        }

        return true;
    }
}


1			<?php
2
3			namespace Scaling\Playbook\Console;
4
5			use Illuminate\Support\Str;
6			use Scaling\Playbook\Playbook;
7			use Illuminate\Console\Command;
8			use Scaling\Playbook\PlaybookDefenition;
9
10			class PlaybookCommand extends Command
11			{
12			/**
13			* The name and signature of the console command.
14			*
15			* @var string
16			*/
17			protected $signature = 'playbook:run {playbook?}';
18
19			/**
20			* The console command description.
21			*
22			* @var string
23			*/
24			protected $description = 'Run a predefined playbook to fill your application.';
25
26			/**
27			* List of definitions that has been run.
28			*
29			* @var array
30			*/
31			private $ranDefenitions = [];
32
33			/**
34			* Execute the console command.
35			*
36			* @return mixed
37			*/
38			public function handle()
39			{
40			if (! $this->isAllowedInProduction()) {
41			$this->error('You can only run commands in local environment');
42
43			return;
44			}
45
46			if (is_null($name = $this->argument('playbook'))) {
47			$name = $this->askWhichBook($this->getAvailablePlaybooks());
48			}
49
50			$this->call('migrate:refresh');
51
52			$this->runPlaybook($this->resolvePlaybook($name));
			0 ignored issues – show Bug introduced 2019-03-06 17:58 UTC by Report Bug Copy Issue Report It seems like `$name` defined by `$this->argument('playbook')` on line `46` can also be of type `array`; however, `Scaling\Playbook\Console...mand::resolvePlaybook()` does only seem to accept `object<Scaling\Playbook\...ybookDefinition>\|string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
53			}
54
55			/**
56			* Run the selected playbook.
57			*
58			* @param \Scaling\Playbook\PlaybookDefenition $definition
59			* @return void
60			*/
61			private function runPlaybook(PlaybookDefenition $definition): void
62			{
63			foreach ($definition->playbook->before() as $book) {
64			$this->runPlaybook($this->resolvePlaybook($book));
65			}
66
67			for ($i = 1; $i <= $definition->times; $i++) {
68			if ($definition->once && $this->definitionHasRun($definition)) {
69			continue;
70			}
71
72			$name = get_class($definition->playbook);
73
74			$this->info("Running playbook `{$name}` (#{$i})");
75
76			$definition->playbook->run($this->input, $this->output);
77			$definition->playbook->finished();
78
79			$this->ranDefinitions[$definition->id] = ($this->ranDefinitions[$definition->id] ?? 0) + 1;
			0 ignored issues – show Bug introduced 2019-03-06 17:58 UTC by Report Bug Copy Issue Report The property `ranDefinitions` does not seem to exist. Did you mean `definition`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
80			}
81
82			foreach ($definition->playbook->after() as $book) {
83			$this->runPlaybook($this->resolvePlaybook($book));
84			}
85			}
86
87			/**
88			* Get a list of available playbooks.
89			*
90			* @return array
91			*/
92			private function getAvailablePlaybooks(): array
93			{
94			$files = scandir(config('laravel-playbook.path'));
95
96			unset($files[0], $files[1]);
97
98			return array_values(array_map(function (string $fileName) {
99			return str_replace('.php', '', $fileName);
100			}, $files));
101			}
102
103			/**
104			* Ask which playbook the developer wants to run.
105			*
106			* @param array $available
107			* @return string
108			*/
109			private function askWhichBook(array $available): string
110			{
111			return $this->choice('Please choose a playbook', $available);
112			}
113
114			/**
115			* Resolve the definition for the given playbook.
116			*
117			* @param Scaling\Playbook\Playbook\|Scaling\Playbook\PlaybookDefinition\|string $class
118			* @return \Scaling\Playbook\PlaybookDefenition
119			*/
120			private function resolvePlaybook($class): PlaybookDefenition
121			{
122			if ($class instanceof PlaybookDefenition) {
123			return $class;
124			}
125
126			if ($class instanceof Playbook) {
127			return new PlaybookDefenition(get_class($class));
128			}
129
130			$namespace = config('laravel-playbook.namespace');
131
132			if (! Str::startsWith($class, [$namespace, "\\{$namespace}"])) {
133			$class = "{$namespace}\\{$class}";
134			}
135
136			return new PlaybookDefenition($class);
137			}
138
139			/**
140			* Determine if the given definition has ran before.
141			*
142			* @param \Scaling\Playbook\PlaybookDefenition $definition
143			* @return bool
144			*/
145			private function definitionHasRun(PlaybookDefenition $definition): bool
146			{
147			return isset($this->ranDefenitions[$definition->id]);
148			}
149
150			/**
151			* Determine if the action is allowed in a production environment.
152			*
153			* @return bool
154			*/
155			private function isAllowedInProduction(): bool
156			{
157			if (!config('laravel-playbook.production') && config('app.env') === 'production') {
158			return false;
159			}
160
161			return true;
162			}
163			}
164

teamscaling / laravel-playbook

Push — master ( d2d302...b1c51c )

PlaybookCommand::isAllowedInProduction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like