AbstractCommand - Code Metrics - Inspection of "Enhance code" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — build-options (#162)

by Arnaud

created 2018-09-17 19:27 UTC

AbstractCommand C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	284
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes

Metric	Value
wmc	55
lcom	2
cbo	8
dl	0
loc	284
rs	6
c	0
b	0
f	0

15 Methods

Rating	Name	Size	Complexity
A	__invoke()	22	4
	processCommand()	1	?
A	getConsole()	4	1
A	getRoute()	4	1
A	getPath()	4	1
A	newPB()	17	3
A	getPB()	4	1
A	printPB()	9	2
B	getPHPoole()	31	6
D	messageCallback()	56	31
A	wl()	4	1
A	wlAnnonce()	4	1
A	wlDone()	4	1
A	wlAlert()	4	1
A	wlError()	4	1

How to fix Complexity

<?php
/*
 * This file is part of the PHPoole package.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace PHPoole\Command;

use PHPoole\PHPoole;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;
use Zend\Console\Adapter\AdapterInterface as Console;
use Zend\Console\ColorInterface as Color;
use Zend\Console\Prompt\Confirm;
use Zend\ProgressBar\ProgressBar;
use ZF\Console\Route;

abstract class AbstractCommand
{
    const CONFIG_FILE = 'phpoole.yml';

    /**
     * @var Console
     */
    protected $console;
    /**
     * @var Route
     */
    protected $route;
    /**
     * @var string
     */
    protected $path;
    /**
     * @var PHPoole
     */
    protected $phpoole;
    /**
     * @var Filesystem
     */
    protected $fs;
    /**
     * @var ProgressBar
     */
    protected $progressBar = null;
    /**
     * @var int
     */
    protected $pbMax = 0;
    /**
     * @var bool
     */
    protected $debug = false;
    /**
     * @var bool
     */
    protected $quiet = false;

    /**
     * Start command processing.
     *
     * @param Route   $route
     * @param Console $console
     *
     * @return mixed
     */
    public function __invoke(Route $route, Console $console)
    {
        $this->route = $route;
        $this->console = $console;
        $this->fs = new Filesystem();

        $this->path = $this->route->getMatchedParam('path', getcwd());

        if (realpath($this->path) === false) {
            if ($this->getRoute()->getName() != 'new') {
                throw new \Exception('Invalid <path> provided!');
            }
            if (!Confirm::prompt('The provided <path> doesn\'t exist. Do you want to create it? [y/n]', 'y', 'n')) {
                exit(0);
            }
            $this->fs->mkdir($this->path);
        }
        $this->path = realpath($this->path);
        $this->path = str_replace(DIRECTORY_SEPARATOR, '/', $this->path);

        return $this->processCommand();
    }

    /**
     * Process the command.
     */
    abstract public function processCommand();


    /**
     * @return Console
     */
    public function getConsole()
    {
        return $this->console;
    }

    /**
     * @return Route
     */
    public function getRoute()
    {
        return $this->route;
    }

    /**
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * @param int $start
     * @param int $max
     *
     * @return ProgressBar
     */
    protected function newPB($start, $max)
    {
        if ($this->progressBar === null || $max != $this->pbMax) {
            $this->pbMax = $max;
            $adapter = new \Zend\ProgressBar\Adapter\Console([
                'elements' => [
                    \Zend\ProgressBar\Adapter\Console::ELEMENT_PERCENT,
                    \Zend\ProgressBar\Adapter\Console::ELEMENT_BAR,
                    \Zend\ProgressBar\Adapter\Console::ELEMENT_TEXT,
                ],
                'textWidth' => 30,
            ]);
            $this->progressBar = new ProgressBar($adapter, $start, $max);
        }

        return $this->progressBar;
    }

    /**
     * @return ProgressBar
     */
    protected function getPB()
    {
        return $this->progressBar;
    }

    /**
     * Print progress bar.
     */
    protected function printPB($itemsCount, $itemsMax, $message)
    {
        $this->newPB(0, $itemsMax);
        $this->getPB()->update($itemsCount, "$message");
        if ($itemsCount == $itemsMax) {
            $this->getPB()->update($itemsCount, "[$itemsCount/$itemsMax]");
            $this->getPB()->finish();
        }
    }

    /**
     * @param array $config
     * @param array $options
     *
     * @return PHPoole
     */
    public function getPHPoole(
        array $config = ['debug' => false],
        array $options = ['verbosity' => PHPoole::VERBOSITY_NORMAL])
    {
        if (!file_exists($this->getPath().'/'.self::CONFIG_FILE)) {
            throw new \Exception(sprintf('Config file not found in "%s"!', $this->getPath()));
        }

        // debug mode?
        if ($options['debug']) {
            $this->debug = true;
        }
        // quiet mode?
        if ($options['verbosity'] == PHPoole::VERBOSITY_QUIET) {
            $this->quiet = true;
        }

        try {
            $configFile = Yaml::parse(file_get_contents($this->getPath().'/'.self::CONFIG_FILE));
            $config = array_replace_recursive($configFile, $config);
            $this->phpoole = (new PHPoole($config, $this->messageCallback()))
                ->setSourceDir($this->getPath())
                ->setDestinationDir($this->getPath());
        } catch (ParseException $e) {
            throw new \Exception(sprintf('Config file parse error: %s', $e->getMessage()));
        } catch (\Exception $e) {
            throw new \Exception(sprintf($e->getMessage()));
        }

        return $this->phpoole;
    }

    /**
     * Custom message callback function.
     */
    public function messageCallback()
    {
        return function ($code, $message = '', $itemsCount = 0, $itemsMax = 0) {
            if ($this->quiet) {
                return;
            } else {
                switch ($code) {
                    case 'LOCATE':
                    case 'CREATE':
                    case 'CONVERT':
                    case 'GENERATE':
                    case 'MENU':
                    case 'COPY':
                    case 'RENDER':
                    case 'SAVE':
                        $this->wlAnnonce($message);
                        break;
                    case 'TIME':
                        $this->wl($message);
                        break;
                    case 'LOCATE_PROGRESS':
                    case 'CREATE_PROGRESS':
                    case 'CONVERT_PROGRESS':
                    case 'GENERATE_PROGRESS':
                    case 'MENU_PROGRESS':
                    case 'COPY_PROGRESS':
                    case 'RENDER_PROGRESS':
                    case 'SAVE_PROGRESS':
                        if ($this->debug) {
                            if ($itemsCount > 0) {
                                $this->wlDone(sprintf('(%u/%u) %s', $itemsCount, $itemsMax, $message));
                                break;
                            }
                            $this->wlDone("$message");
                        } else {
                            if (isset($itemsCount) && $itemsMax > 0) {
                                printPB($itemsCount, $itemsMax, $message);
                            } else {
                                $this->wl($message);
                            }
                        }
                        break;
                    case 'LOCATE_ERROR':
                    case 'CREATE_ERROR':
                    case 'CONVERT_ERROR':
                    case 'GENERATE_ERROR':
                    case 'MENU_ERROR':
                    case 'COPY_ERROR':
                    case 'RENDER_ERROR':
                    case 'SAVE_ERROR':
                        $this->wlError($message);
                        break;
                }
            }
        };
    }

    /**
     * @param string $text
     */
    public function wl($text)
    {
        $this->console->writeLine($text);
    }

    /**
     * @param string $text
     */
    public function wlAnnonce($text)
    {
        $this->console->writeLine($text, Color::WHITE);
    }

    /**
     * @param string $text
     */
    public function wlDone($text)
    {
        $this->console->writeLine($text, Color::GREEN);
    }

    /**
     * @param string $text
     */
    public function wlAlert($text)
    {
        $this->console->writeLine($text, Color::YELLOW);
    }

    /**
     * @param string $text
     */
    public function wlError($text)
    {
        $this->console->writeLine($text, Color::RED);
    }
}


1			<?php
2			/*
3			* This file is part of the PHPoole package.
4			*
5			* Copyright (c) Arnaud Ligny <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace PHPoole\Command;
12
13			use PHPoole\PHPoole;
14			use Symfony\Component\Filesystem\Filesystem;
15			use Symfony\Component\Yaml\Exception\ParseException;
16			use Symfony\Component\Yaml\Yaml;
17			use Zend\Console\Adapter\AdapterInterface as Console;
18			use Zend\Console\ColorInterface as Color;
19			use Zend\Console\Prompt\Confirm;
20			use Zend\ProgressBar\ProgressBar;
21			use ZF\Console\Route;
22
23			abstract class AbstractCommand
24			{
25			const CONFIG_FILE = 'phpoole.yml';
26
27			/**
28			* @var Console
29			*/
30			protected $console;
31			/**
32			* @var Route
33			*/
34			protected $route;
35			/**
36			* @var string
37			*/
38			protected $path;
39			/**
40			* @var PHPoole
41			*/
42			protected $phpoole;
43			/**
44			* @var Filesystem
45			*/
46			protected $fs;
47			/**
48			* @var ProgressBar
49			*/
50			protected $progressBar = null;
51			/**
52			* @var int
53			*/
54			protected $pbMax = 0;
55			/**
56			* @var bool
57			*/
58			protected $debug = false;
59			/**
60			* @var bool
61			*/
62			protected $quiet = false;
63
64			/**
65			* Start command processing.
66			*
67			* @param Route $route
68			* @param Console $console
69			*
70			* @return mixed
71			*/
72			public function __invoke(Route $route, Console $console)
73			{
74			$this->route = $route;
75			$this->console = $console;
76			$this->fs = new Filesystem();
77
78			$this->path = $this->route->getMatchedParam('path', getcwd());
79
80			if (realpath($this->path) === false) {
81			if ($this->getRoute()->getName() != 'new') {
82			throw new \Exception('Invalid <path> provided!');
83			}
84			if (!Confirm::prompt('The provided <path> doesn\'t exist. Do you want to create it? [y/n]', 'y', 'n')) {
85			exit(0);
86			}
87			$this->fs->mkdir($this->path);
88			}
89			$this->path = realpath($this->path);
90			$this->path = str_replace(DIRECTORY_SEPARATOR, '/', $this->path);
91
92			return $this->processCommand();
93			}
94
95			/**
96			* Process the command.
97			*/
98			abstract public function processCommand();
			0 ignored issues – show Documentation introduced 2017-09-19 23:37 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
99
100			/**
101			* @return Console
102			*/
103			public function getConsole()
104			{
105			return $this->console;
106			}
107
108			/**
109			* @return Route
110			*/
111			public function getRoute()
112			{
113			return $this->route;
114			}
115
116			/**
117			* @return string
118			*/
119			public function getPath()
120			{
121			return $this->path;
122			}
123
124			/**
125			* @param int $start
126			* @param int $max
127			*
128			* @return ProgressBar
129			*/
130			protected function newPB($start, $max)
131			{
132			if ($this->progressBar === null \|\| $max != $this->pbMax) {
133			$this->pbMax = $max;
134			$adapter = new \Zend\ProgressBar\Adapter\Console([
135			'elements' => [
136			\Zend\ProgressBar\Adapter\Console::ELEMENT_PERCENT,
137			\Zend\ProgressBar\Adapter\Console::ELEMENT_BAR,
138			\Zend\ProgressBar\Adapter\Console::ELEMENT_TEXT,
139			],
140			'textWidth' => 30,
141			]);
142			$this->progressBar = new ProgressBar($adapter, $start, $max);
143			}
144
145			return $this->progressBar;
146			}
147
148			/**
149			* @return ProgressBar
150			*/
151			protected function getPB()
152			{
153			return $this->progressBar;
154			}
155
156			/**
157			* Print progress bar.
158			*/
159			protected function printPB($itemsCount, $itemsMax, $message)
160			{
161			$this->newPB(0, $itemsMax);
162			$this->getPB()->update($itemsCount, "$message");
163			if ($itemsCount == $itemsMax) {
164			$this->getPB()->update($itemsCount, "[$itemsCount/$itemsMax]");
165			$this->getPB()->finish();
166			}
167			}
168
169			/**
170			* @param array $config
171			* @param array $options
172			*
173			* @return PHPoole
174			*/
175			public function getPHPoole(
176			array $config = ['debug' => false],
177			array $options = ['verbosity' => PHPoole::VERBOSITY_NORMAL])
178			{
179			if (!file_exists($this->getPath().'/'.self::CONFIG_FILE)) {
180			throw new \Exception(sprintf('Config file not found in "%s"!', $this->getPath()));
181			}
182
183			// debug mode?
184			if ($options['debug']) {
185			$this->debug = true;
186			}
187			// quiet mode?
188			if ($options['verbosity'] == PHPoole::VERBOSITY_QUIET) {
189			$this->quiet = true;
190			}
191
192			try {
193			$configFile = Yaml::parse(file_get_contents($this->getPath().'/'.self::CONFIG_FILE));
194			$config = array_replace_recursive($configFile, $config);
195			$this->phpoole = (new PHPoole($config, $this->messageCallback()))
196			->setSourceDir($this->getPath())
197			->setDestinationDir($this->getPath());
198			} catch (ParseException $e) {
199			throw new \Exception(sprintf('Config file parse error: %s', $e->getMessage()));
200			} catch (\Exception $e) {
201			throw new \Exception(sprintf($e->getMessage()));
202			}
203
204			return $this->phpoole;
205			}
206
207			/**
208			* Custom message callback function.
209			*/
210			public function messageCallback()
211			{
212			return function ($code, $message = '', $itemsCount = 0, $itemsMax = 0) {
213			if ($this->quiet) {
214			return;
215			} else {
216			switch ($code) {
217			case 'LOCATE':
218			case 'CREATE':
219			case 'CONVERT':
220			case 'GENERATE':
221			case 'MENU':
222			case 'COPY':
223			case 'RENDER':
224			case 'SAVE':
225			$this->wlAnnonce($message);
226			break;
227			case 'TIME':
228			$this->wl($message);
229			break;
230			case 'LOCATE_PROGRESS':
231			case 'CREATE_PROGRESS':
232			case 'CONVERT_PROGRESS':
233			case 'GENERATE_PROGRESS':
234			case 'MENU_PROGRESS':
235			case 'COPY_PROGRESS':
236			case 'RENDER_PROGRESS':
237			case 'SAVE_PROGRESS':
238			if ($this->debug) {
239			if ($itemsCount > 0) {
240			$this->wlDone(sprintf('(%u/%u) %s', $itemsCount, $itemsMax, $message));
241			break;
242			}
243			$this->wlDone("$message");
244			} else {
245			if (isset($itemsCount) && $itemsMax > 0) {
246			printPB($itemsCount, $itemsMax, $message);
247			} else {
248			$this->wl($message);
249			}
250			}
251			break;
252			case 'LOCATE_ERROR':
253			case 'CREATE_ERROR':
254			case 'CONVERT_ERROR':
255			case 'GENERATE_ERROR':
256			case 'MENU_ERROR':
257			case 'COPY_ERROR':
258			case 'RENDER_ERROR':
259			case 'SAVE_ERROR':
260			$this->wlError($message);
261			break;
262			}
263			}
264			};
265			}
266
267			/**
268			* @param string $text
269			*/
270			public function wl($text)
271			{
272			$this->console->writeLine($text);
273			}
274
275			/**
276			* @param string $text
277			*/
278			public function wlAnnonce($text)
279			{
280			$this->console->writeLine($text, Color::WHITE);
281			}
282
283			/**
284			* @param string $text
285			*/
286			public function wlDone($text)
287			{
288			$this->console->writeLine($text, Color::GREEN);
289			}
290
291			/**
292			* @param string $text
293			*/
294			public function wlAlert($text)
295			{
296			$this->console->writeLine($text, Color::YELLOW);
297			}
298
299			/**
300			* @param string $text
301			*/
302			public function wlError($text)
303			{
304			$this->console->writeLine($text, Color::RED);
305			}
306			}
307

Cecilapp / Cecil

Pull Request — build-options (#162)

AbstractCommand C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like