Command::describe() - Code Metrics - Inspection of "Full rewriting of the library" - tarsana/command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Amine

created 2017-09-02 18:44 UTC

Command::describe() B

↳ Parent: Command

Complexity

Conditions	6
Paths	6

Size

Total Lines	18
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	8.8571
c	0
b	0
f	0
cc	6
eloc	13
nc	6
nop	2

<?php namespace Tarsana\Command;

use Tarsana\Command\Commands\HelpCommand;
use Tarsana\Command\Commands\VersionCommand;
use Tarsana\Command\Console\Console;
use Tarsana\Command\Console\ExceptionPrinter;
use Tarsana\Command\Interfaces\Console\ConsoleInterface;
use Tarsana\Command\Interfaces\Template\TemplateLoaderInterface;
use Tarsana\Command\SubCommand;
use Tarsana\Command\Template\TemplateLoader;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Tarsana\IO\Filesystem;
use Tarsana\IO\FilesystemInterface;
use Tarsana\Syntax\Exceptions\ParseException;
use Tarsana\Syntax\Factory as S;
use Tarsana\Syntax\Text as T;

class Command {

    protected $name;
    protected $version;
    protected $description;

    protected $syntax;
    protected $descriptions;

    protected $options;
    protected $args;

    protected $action;
    protected $commands;

    protected $console;
    protected $fs;
    protected $templatesLoader;

    public static function create(callable $action = null) {
        $command = new Command;
        if (null !== $action)
            $command->action($action);
        return $command;
    }

    public function __construct()
    {
        $this->commands = [];
        $this->setupSubCommands()
             ->name('Unknown')
             ->version('1.0.0')
             ->description('...')
             ->descriptions([])
             ->options([])
             ->console(new Console)
             ->fs(new Filesystem('.'))
             ->init();
    }

    /**
     * name getter and setter.
     *
     * @param  string
     * @return mixed
     */
    public function name(string $value = null)

    {
        if (null === $value) {
            return $this->name;
        }
        $this->name = $value;
        return $this;
    }

    /**
     * version getter and setter.
     *
     * @param  string
     * @return mixed
     */
    public function version(string $value = null)
    {
        if (null === $value) {
            return $this->version;
        }
        $this->version = $value;
        return $this;
    }

    /**
     * description getter and setter.
     *
     * @param  string
     * @return mixed
     */
    public function description(string $value = null)

    {
        if (null === $value) {
            return $this->description;
        }
        $this->description = $value;
        return $this;
    }

    /**
     * descriptions getter and setter.
     *
     * @param  string
     * @return mixed
     */
    public function descriptions(array $value = null)
    {
        if (null === $value) {
            return $this->descriptions;
        }
        $this->descriptions = $value;
        return $this;
    }

    /**
     * syntax getter and setter.
     *
     * @param  string|null $syntax
     * @return Syntax|self
     */
    public function syntax(string $syntax = null)
    {
        if (null === $syntax)
            return $this->syntax;

        $this->syntax = S::syntax()->parse("{{$syntax}| }");
        return $this;
    }

    /**
     * options getter and setter.
     *
     * @param  array
     * @return mixed
     */
    public function options(array $options = null)
    {
        if (null === $options) {
            return $this->options;
        }

        $this->options = [];
        foreach($options as $option)
            $this->options[$option] = false;

        return $this;
    }

    /**
     * option getter.
     *
     * @param  string
     * @return mixed
     */
    public function option(string $name)
    {
        if (!array_key_exists($name, $this->options))
            throw new \InvalidArgumentException("Unknown option '{$name}'");
        return $this->options[$name];
    }

    /**
     * args getter and setter.
     *
     * @param  stdClass
     * @return mixed
     */
    public function args(\stdClass $value = null)
    {
        if (null === $value) {
            return $this->args;
        }
        $this->args = $value;
        return $this;
    }

    /**
     * console getter and setter.
     *
     * @param  ConsoleInterface
     * @return mixed
     */
    public function console(ConsoleInterface $value = null)
    {
        if (null === $value) {
            return $this->console;
        }
        $this->console = $value;
        foreach ($this->commands as $name => $command) {
            $command->console = $value;
        }
        return $this;
    }

    /**
     * fs getter and setter.
     *
     * @param  Tarsana\IO\Filesystem|string
     * @return mixed
     */
    public function fs($value = null)
    {
        if (null === $value) {
            return $this->fs;
        }
        if (is_string($value))
            $value = new Filesystem($value);
        $this->fs = $value;
        foreach ($this->commands as $name => $command) {
            $command->fs = $value;
        }
        return $this;
    }

    /**
     * templatesLoader getter and setter.
     *
     * @param  Tarsana\Command\Interfaces\Template\TemplateLoaderInterface
     * @return mixed
     */
    public function templatesLoader(TemplateLoaderInterface $value = null)
    {
        if (null === $value) {
            return $this->templatesLoader;
        }
        $this->templatesLoader = $value;
        return $this;
    }

    public function templatesPath(string $path, string $cachePath = null) {
        $this->templatesLoader = new TemplateLoader($path, $cachePath);
        return $this;
    }

    public function template(string $name) {
        if (null == $this->templatesLoader)
            throw new \Exception("Please initialize the templates loader before trying to load templates!");
        return $this->templatesLoader->load($name);
    }

    /**
     * action getter and setter.
     *
     * @param  callable
     * @return mixed
     */
    public function action(callable $value = null)

    {
        if (null === $value) {
            return $this->action;
        }
        $this->action = $value;
        return $this;
    }

    public function command(string $name, Command $command = null)
    {
        if (null === $command) {
            if (!array_key_exists($name, $this->commands))
                throw new \InvalidArgumentException("subcommand '{$name}' not found!");
            return $this->commands[$name];
        }
        $this->commands[$name] = $command;
        return $this;
    }

    protected function setupSubCommands()
    {
        return $this->command('--help', new HelpCommand($this))
             ->command('--version', new VersionCommand($this));
    }

    public function describe(string $name, string $description = null)
    {
        if (null === $description)
            return array_key_exists($name, $this->descriptions)
                ? $this->descriptions[$name] : '';
        if (substr($name, 0, 2) == '--' && array_key_exists($name, $this->options())) {
            $this->descriptions[$name] = $description;
            return $this;
        }
        try {
            $this->syntax->field($name);
            // throws exception if field is missing
            $this->descriptions[$name] = $description;
            return $this;
        } catch (\Exception $e) {
            throw new \InvalidArgumentException("Unknown field '{$name}'");
        }
    }

    public function run(array $args = null, array $options = [], bool $rawArgs = true)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        try {
            $this->clear();

            if ($rawArgs) {
                if (null === $args) {
                    $args = $GLOBALS['argv'];
                    array_shift($args);
                }

                if (!empty($args) && array_key_exists($args[0], $this->commands)) {
                    $name = $args[0];
                    array_shift($args);
                    return $this->command($name)->run($args);
                }

                $this->parseArguments($args);
            } else {
                $this->args = (object) $args;
                foreach ($options as $name) {

                    if (!array_key_exists($name, $this->options))
                        throw new \Exception("Unknown option '{$name}'");
                    $this->options[$name] = true;
                }
            }

            if (null === $this->action)
                $this->execute();
            else
                ($this->action)($this);
        } catch (\Exception $e) {
            $this->handleError($e);
        }
    }

    public function clear()
    {
        $this->args = null;
        foreach($this->options as $name => $value) {
            $this->options[$name] = false;
        }
    }

    public function parseArguments(array $args)
    {
        if (null === $this->syntax) {
            $this->args = null;
            return;
        }

        $arguments = [];
        foreach ($args as &$arg) {

            if (array_key_exists($arg, $this->options))
                $this->options[$arg] = true;
            else
                $arguments[] = $arg;
        }
        $arguments = T::join($arguments, ' ');
        $this->args = $this->syntax->parse($arguments);
    }

    protected function handleError(\Exception $e) {
        $output = (new ExceptionPrinter)->print($e);
        $this->console()->error($output);
    }

    protected function init() {}
    protected function execute() {}

}


1		<?php namespace Tarsana\Command;
2
3		use Tarsana\Command\Commands\HelpCommand;
4		use Tarsana\Command\Commands\VersionCommand;
5		use Tarsana\Command\Console\Console;
6		use Tarsana\Command\Console\ExceptionPrinter;
7		use Tarsana\Command\Interfaces\Console\ConsoleInterface;
8		use Tarsana\Command\Interfaces\Template\TemplateLoaderInterface;
9		use Tarsana\Command\SubCommand;
10		use Tarsana\Command\Template\TemplateLoader;
		0 ignored issues – show Bug introduced 2017-09-02 18:45 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Tarsana\Command\TemplateLoader`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
11		use Tarsana\IO\Filesystem;
12		use Tarsana\IO\FilesystemInterface;
13		use Tarsana\Syntax\Exceptions\ParseException;
14		use Tarsana\Syntax\Factory as S;
15		use Tarsana\Syntax\Text as T;
16
17		class Command {
18
19		protected $name;
20		protected $version;
21		protected $description;
22
23		protected $syntax;
24		protected $descriptions;
25
26		protected $options;
27		protected $args;
28
29		protected $action;
30		protected $commands;
31
32		protected $console;
33		protected $fs;
34		protected $templatesLoader;
35
36		public static function create(callable $action = null) {
37		$command = new Command;
38		if (null !== $action)
39		$command->action($action);
40		return $command;
41		}
42
43		public function __construct()
44		{
45		$this->commands = [];
46		$this->setupSubCommands()
47		->name('Unknown')
48		->version('1.0.0')
49		->description('...')
50		->descriptions([])
51		->options([])
52		->console(new Console)
53		->fs(new Filesystem('.'))
54		->init();
55		}
56
57		/**
58		* name getter and setter.
59		*
60		* @param string
61		* @return mixed
62		*/
63	View Code Duplication	public function name(string $value = null)
		0 ignored issues – show Duplication introduced 2017-09-02 17:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
64		{
65		if (null === $value) {
66		return $this->name;
67		}
68		$this->name = $value;
69		return $this;
70		}
71
72		/**
73		* version getter and setter.
74		*
75		* @param string
76		* @return mixed
77		*/
78		public function version(string $value = null)
79		{
80		if (null === $value) {
81		return $this->version;
82		}
83		$this->version = $value;
84		return $this;
85		}
86
87		/**
88		* description getter and setter.
89		*
90		* @param string
91		* @return mixed
92		*/
93	View Code Duplication	public function description(string $value = null)
		0 ignored issues – show Duplication introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94		{
95		if (null === $value) {
96		return $this->description;
97		}
98		$this->description = $value;
99		return $this;
100		}
101
102		/**
103		* descriptions getter and setter.
104		*
105		* @param string
106		* @return mixed
107		*/
108		public function descriptions(array $value = null)
109		{
110		if (null === $value) {
111		return $this->descriptions;
112		}
113		$this->descriptions = $value;
114		return $this;
115		}
116
117		/**
118		* syntax getter and setter.
119		*
120		* @param string\|null $syntax
121		* @return Syntax\|self
122		*/
123		public function syntax(string $syntax = null)
124		{
125		if (null === $syntax)
126		return $this->syntax;
127
128		$this->syntax = S::syntax()->parse("{{$syntax}\| }");
129		return $this;
130		}
131
132		/**
133		* options getter and setter.
134		*
135		* @param array
136		* @return mixed
137		*/
138		public function options(array $options = null)
139		{
140		if (null === $options) {
141		return $this->options;
142		}
143
144		$this->options = [];
145		foreach($options as $option)
146		$this->options[$option] = false;
147
148		return $this;
149		}
150
151		/**
152		* option getter.
153		*
154		* @param string
155		* @return mixed
156		*/
157		public function option(string $name)
158		{
159		if (!array_key_exists($name, $this->options))
160		throw new \InvalidArgumentException("Unknown option '{$name}'");
161		return $this->options[$name];
162		}
163
164		/**
165		* args getter and setter.
166		*
167		* @param stdClass
168		* @return mixed
169		*/
170		public function args(\stdClass $value = null)
171		{
172		if (null === $value) {
173		return $this->args;
174		}
175		$this->args = $value;
176		return $this;
177		}
178
179		/**
180		* console getter and setter.
181		*
182		* @param ConsoleInterface
183		* @return mixed
184		*/
185		public function console(ConsoleInterface $value = null)
186		{
187		if (null === $value) {
188		return $this->console;
189		}
190		$this->console = $value;
191		foreach ($this->commands as $name => $command) {
192		$command->console = $value;
193		}
194		return $this;
195		}
196
197		/**
198		* fs getter and setter.
199		*
200		* @param Tarsana\IO\Filesystem\|string
201		* @return mixed
202		*/
203		public function fs($value = null)
204		{
205		if (null === $value) {
206		return $this->fs;
207		}
208		if (is_string($value))
209		$value = new Filesystem($value);
210		$this->fs = $value;
211		foreach ($this->commands as $name => $command) {
212		$command->fs = $value;
213		}
214		return $this;
215		}
216
217		/**
218		* templatesLoader getter and setter.
219		*
220		* @param Tarsana\Command\Interfaces\Template\TemplateLoaderInterface
221		* @return mixed
222		*/
223		public function templatesLoader(TemplateLoaderInterface $value = null)
224		{
225		if (null === $value) {
226		return $this->templatesLoader;
227		}
228		$this->templatesLoader = $value;
229		return $this;
230		}
231
232		public function templatesPath(string $path, string $cachePath = null) {
233		$this->templatesLoader = new TemplateLoader($path, $cachePath);
234		return $this;
235		}
236
237		public function template(string $name) {
238		if (null == $this->templatesLoader)
239		throw new \Exception("Please initialize the templates loader before trying to load templates!");
240		return $this->templatesLoader->load($name);
241		}
242
243		/**
244		* action getter and setter.
245		*
246		* @param callable
247		* @return mixed
248		*/
249	View Code Duplication	public function action(callable $value = null)
		0 ignored issues – show Duplication introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
250		{
251		if (null === $value) {
252		return $this->action;
253		}
254		$this->action = $value;
255		return $this;
256		}
257
258		public function command(string $name, Command $command = null)
259		{
260		if (null === $command) {
261		if (!array_key_exists($name, $this->commands))
262		throw new \InvalidArgumentException("subcommand '{$name}' not found!");
263		return $this->commands[$name];
264		}
265		$this->commands[$name] = $command;
266		return $this;
267		}
268
269		protected function setupSubCommands()
270		{
271		return $this->command('--help', new HelpCommand($this))
272		->command('--version', new VersionCommand($this));
273		}
274
275		public function describe(string $name, string $description = null)
276		{
277		if (null === $description)
278		return array_key_exists($name, $this->descriptions)
279		? $this->descriptions[$name] : '';
280		if (substr($name, 0, 2) == '--' && array_key_exists($name, $this->options())) {
281		$this->descriptions[$name] = $description;
282		return $this;
283		}
284		try {
285		$this->syntax->field($name);
286		// throws exception if field is missing
287		$this->descriptions[$name] = $description;
288		return $this;
289		} catch (\Exception $e) {
290		throw new \InvalidArgumentException("Unknown field '{$name}'");
291		}
292		}
293
294		public function run(array $args = null, array $options = [], bool $rawArgs = true)
		0 ignored issues – show Coding Style introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report `run` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
295		{
296		try {
297		$this->clear();
298
299		if ($rawArgs) {
300		if (null === $args) {
301		$args = $GLOBALS['argv'];
302		array_shift($args);
303		}
304
305		if (!empty($args) && array_key_exists($args[0], $this->commands)) {
306		$name = $args[0];
307		array_shift($args);
308		return $this->command($name)->run($args);
309		}
310
311		$this->parseArguments($args);
312		} else {
313		$this->args = (object) $args;
314	View Code Duplication	foreach ($options as $name) {
		0 ignored issues – show Duplication introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
315		if (!array_key_exists($name, $this->options))
316		throw new \Exception("Unknown option '{$name}'");
317		$this->options[$name] = true;
318		}
319		}
320
321		if (null === $this->action)
322		$this->execute();
323		else
324		($this->action)($this);
325		} catch (\Exception $e) {
326		$this->handleError($e);
327		}
328		}
329
330		public function clear()
331		{
332		$this->args = null;
333		foreach($this->options as $name => $value) {
334		$this->options[$name] = false;
335		}
336		}
337
338		public function parseArguments(array $args)
339		{
340		if (null === $this->syntax) {
341		$this->args = null;
342		return;
343		}
344
345		$arguments = [];
346	View Code Duplication	foreach ($args as &$arg) {
		0 ignored issues – show Duplication introduced 2017-09-02 17:31 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
347		if (array_key_exists($arg, $this->options))
348		$this->options[$arg] = true;
349		else
350		$arguments[] = $arg;
351		}
352		$arguments = T::join($arguments, ' ');
353		$this->args = $this->syntax->parse($arguments);
354		}
355
356		protected function handleError(\Exception $e) {
357		$output = (new ExceptionPrinter)->print($e);
358		$this->console()->error($output);
359		}
360
361		protected function init() {}
362		protected function execute() {}
363
364		}
365

tarsana / command

Pull Request — master (#3)

Command::describe() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like