CliApplication::printResult() - Code Metrics - Inspection of "Added support for delayed output" - rtens/domin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 15cb6d...86e5be )

by Nikolas

created 2015-12-03 08:48 UTC

CliApplication::printResult() C

↳ Parent: CliApplication

Complexity

Conditions	8
Paths	7

Size

Total Lines	27
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	27
rs	5.3846
cc	8
eloc	23
nc	7
nop	2

<?php
namespace rtens\domin\delivery\cli;

use rtens\domin\Action;
use rtens\domin\ActionRegistry;
use rtens\domin\delivery\cli\fields\ArrayField;
use rtens\domin\delivery\cli\fields\BooleanField;
use rtens\domin\delivery\cli\fields\DateIntervalField;
use rtens\domin\delivery\cli\fields\DateTimeField;
use rtens\domin\delivery\cli\fields\EnumerationField;
use rtens\domin\delivery\cli\fields\FileField;
use rtens\domin\delivery\cli\fields\HtmlField;
use rtens\domin\delivery\cli\fields\IdentifierField;
use rtens\domin\delivery\cli\fields\MultiField;
use rtens\domin\delivery\cli\fields\NullableField;
use rtens\domin\delivery\cli\fields\ObjectField;
use rtens\domin\delivery\cli\fields\PrimitiveField;
use rtens\domin\delivery\cli\renderers\ArrayRenderer;
use rtens\domin\delivery\cli\renderers\BooleanRenderer;
use rtens\domin\delivery\cli\renderers\ChartRenderer;
use rtens\domin\delivery\cli\renderers\DateIntervalRenderer;
use rtens\domin\delivery\cli\renderers\DateTimeRenderer;
use rtens\domin\delivery\cli\renderers\DelayedOutputRenderer;
use rtens\domin\delivery\cli\renderers\FileRenderer;
use rtens\domin\delivery\cli\renderers\HtmlRenderer;
use rtens\domin\delivery\cli\renderers\IdentifierRenderer;
use rtens\domin\delivery\cli\renderers\ObjectRenderer;
use rtens\domin\delivery\cli\renderers\PrimitiveRenderer;
use rtens\domin\delivery\cli\renderers\tables\DataTableRenderer;
use rtens\domin\delivery\cli\renderers\tables\ObjectTableRenderer;
use rtens\domin\delivery\cli\renderers\tables\TableRenderer;
use rtens\domin\delivery\FieldRegistry;
use rtens\domin\delivery\ParameterReader;
use rtens\domin\delivery\RendererRegistry;
use rtens\domin\execution\ExecutionResult;
use rtens\domin\execution\FailedResult;
use rtens\domin\execution\MissingParametersResult;
use rtens\domin\execution\NoResult;
use rtens\domin\execution\NotPermittedResult;
use rtens\domin\execution\RedirectResult;
use rtens\domin\execution\RenderedResult;
use rtens\domin\Executor;
use rtens\domin\reflection\CommentParser;
use rtens\domin\reflection\types\TypeFactory;
use watoki\factory\Factory;
use watoki\reflect\ValuePrinter;

class CliApplication {

    const OK = 0;
    const ERROR = 1;

    /** @var Factory */
    public $factory;

    /** @var ActionRegistry */
    public $actions;

    /** @var FieldRegistry */
    public $fields;

    /** @var RendererRegistry */
    public $renderers;

    /** @var TypeFactory */
    public $types;

    /** @var CommentParser */
    public $parser;

    /**
     * @param Factory $factory <-
     * @param ActionRegistry $actions <-
     * @param FieldRegistry $fields <-
     * @param RendererRegistry $renderers <-
     * @param TypeFactory $types <-
     * @param CommentParser $parser <-
     */
    public function __construct(Factory $factory, ActionRegistry $actions, FieldRegistry $fields,
                                RendererRegistry $renderers, TypeFactory $types, CommentParser $parser) {
        $this->factory = $factory;

        $this->actions = $actions;
        $this->fields = $fields;
        $this->renderers = $renderers;
        $this->types = $types;
        $this->parser = $parser;
    }

    /**
     * @param callable $callback Receives the CliApplication instance
     * @param null|Factory $factory
     * @return Factory
     */
    public static function init(callable $callback, Factory $factory = null) {
        $factory = $factory ?: new Factory();
        $callback($factory->setSingleton($factory->getInstance(self::class)));
        return $factory;
    }

    public static function run(Factory $factory, Console $console = null) {
        global $argv;
function myFunction($a, $b) {
    // Do something
}

        /** @var self $app */
        $app = $factory->getInstance(self::class);
        exit($app->doRun($console ?: new Console($argv)));

    }

    private function doRun(Console $console) {

        if ($console->getArguments()) {
            if ($console->getArguments()[0] == '!') {
                $actionId = $this->selectAction($console);
                $reader = new InteractiveCliParameterReader($this->fields, $console);

                $this->printActionHeader($console, $actionId);
            } else {
                $actionId = $console->getArguments()[0];
                $reader = new CliParameterReader($console);
            }
        } else {
            $this->printUsage($console);
            $this->printActions($console);
            return self::OK;
        }

        $this->registerFields($reader);
        $this->registerRenderers();

        $executor = new Executor($this->actions, $this->fields, $this->renderers, $reader);
        return $this->printResult($console, $executor->execute($actionId));
    }

    private function printResult(Console $console, ExecutionResult $result) {
        if ($result instanceof RenderedResult) {
            $console->writeLine((string)$result->getOutput());
            return self::OK;
        } else if ($result instanceof MissingParametersResult) {
            $console->writeLine("Missing parameters " . ValuePrinter::serialize($result->getParameters()));
            return self::ERROR;
        } else if ($result instanceof NotPermittedResult) {
            $console->writeLine('Permission denied');
            return self::ERROR;
        } else if ($result instanceof FailedResult) {
            $console->writeLine("Error: " . $result->getMessage());

            $exception = $result->getException();
            $console->error(
                $exception->getMessage() . ' ' .
                '[' . $exception->getFile() . ':' . $exception->getLine() . ']' . "\n" .
                $exception->getTraceAsString()
            );
            return $exception->getCode() ?: self::ERROR;
        } else if ($result instanceof NoResult || $result instanceof RedirectResult) {
            return self::OK;
        } else {
            $console->writeLine('Cannot print [' . (new \ReflectionClass($result))->getShortName() . ']');
            return self::OK;
        }
    }

    private function selectAction(Console $console) {
        $console->writeLine();
        $console->writeLine('Available Actions');
        $console->writeLine('~~~~~~~~~~~~~~~~~');

        $i = 1;
        $actionIds = [];
        foreach ($this->actions->getAllActions() as $id => $action) {

            $console->writeLine($i++ . " - " . $action->caption() . $this->shortDescription($action));
            $actionIds[] = $id;
        }

        $console->writeLine();
        $actionIndex = $console->read('Action: ');

        return $actionIds[$actionIndex - 1];
    }

    private function printActionHeader(Console $console, $actionId) {
        $action = $this->actions->getAction($actionId);
        $console->writeLine();
        $console->writeLine($action->caption());
        $console->writeLine(str_repeat('~', strlen($action->caption())));
        $console->writeLine();

        if ($action->description()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $console->writeLine($action->description());
            $console->writeLine();
        }
    }

    private function printUsage(Console $console) {
        $console->writeLine();

        $console->writeLine("Interactive mode: php {$console->getScriptName()} !");
        $console->writeLine("Execute Action:   php {$console->getScriptName()} <actionId> --<parameterName> <parameterValue> ...");
        $console->writeLine();
    }

    private function printActions(Console $console) {
        $console->writeLine('Available Actions');
        $console->writeLine('~~~~~~~~~~~~~~~~~');

        foreach ($this->actions->getAllActions() as $id => $action) {

            $console->writeLine($id . ' - ' . $action->caption() . $this->shortDescription($action));
        }
    }

    private function registerFields(ParameterReader $reader) {
        $this->fields->add(new PrimitiveField());
        $this->fields->add(new BooleanField());
        $this->fields->add(new FileField());
        $this->fields->add(new HtmlField($reader));
        $this->fields->add(new DateTimeField());
        $this->fields->add(new DateIntervalField());
        $this->fields->add(new ArrayField($this->fields, $reader));
        $this->fields->add(new NullableField($this->fields, $reader));
        $this->fields->add(new ObjectField($this->types, $this->fields, $reader));
        $this->fields->add(new MultiField($this->fields, $reader));
        $this->fields->add(new IdentifierField($this->fields));
        $this->fields->add(new EnumerationField($this->fields));
    }

    private function registerRenderers() {
        $this->renderers->add(new BooleanRenderer());
        $this->renderers->add(new PrimitiveRenderer());
        $this->renderers->add(new DateTimeRenderer());
        $this->renderers->add(new DateIntervalRenderer());
        $this->renderers->add(new HtmlRenderer());
        $this->renderers->add(new IdentifierRenderer());
        $this->renderers->add(new FileRenderer(''));
        $this->renderers->add(new DelayedOutputRenderer());
        $this->renderers->add(new ObjectTableRenderer($this->renderers));
        $this->renderers->add(new DataTableRenderer($this->renderers));
        $this->renderers->add(new TableRenderer($this->renderers));
        $this->renderers->add(new ChartRenderer($this->renderers));
        $this->renderers->add(new ArrayRenderer($this->renderers));
        $this->renderers->add(new ObjectRenderer($this->renderers, $this->types));
    }

    private function shortDescription(Action $action) {
        $description = $this->parser->shorten($action->description());
        return $description ? " ($description)" : '';
    }
}

Push — master ( 15cb6d...86e5be )

CliApplication::printResult() C

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
2		namespace rtens\domin\delivery\cli;
3
4		use rtens\domin\Action;
5		use rtens\domin\ActionRegistry;
6		use rtens\domin\delivery\cli\fields\ArrayField;
7		use rtens\domin\delivery\cli\fields\BooleanField;
8		use rtens\domin\delivery\cli\fields\DateIntervalField;
9		use rtens\domin\delivery\cli\fields\DateTimeField;
10		use rtens\domin\delivery\cli\fields\EnumerationField;
11		use rtens\domin\delivery\cli\fields\FileField;
12		use rtens\domin\delivery\cli\fields\HtmlField;
13		use rtens\domin\delivery\cli\fields\IdentifierField;
14		use rtens\domin\delivery\cli\fields\MultiField;
15		use rtens\domin\delivery\cli\fields\NullableField;
16		use rtens\domin\delivery\cli\fields\ObjectField;
17		use rtens\domin\delivery\cli\fields\PrimitiveField;
18		use rtens\domin\delivery\cli\renderers\ArrayRenderer;
19		use rtens\domin\delivery\cli\renderers\BooleanRenderer;
20		use rtens\domin\delivery\cli\renderers\ChartRenderer;
21		use rtens\domin\delivery\cli\renderers\DateIntervalRenderer;
22		use rtens\domin\delivery\cli\renderers\DateTimeRenderer;
23		use rtens\domin\delivery\cli\renderers\DelayedOutputRenderer;
24		use rtens\domin\delivery\cli\renderers\FileRenderer;
25		use rtens\domin\delivery\cli\renderers\HtmlRenderer;
26		use rtens\domin\delivery\cli\renderers\IdentifierRenderer;
27		use rtens\domin\delivery\cli\renderers\ObjectRenderer;
28		use rtens\domin\delivery\cli\renderers\PrimitiveRenderer;
29		use rtens\domin\delivery\cli\renderers\tables\DataTableRenderer;
30		use rtens\domin\delivery\cli\renderers\tables\ObjectTableRenderer;
31		use rtens\domin\delivery\cli\renderers\tables\TableRenderer;
32		use rtens\domin\delivery\FieldRegistry;
33		use rtens\domin\delivery\ParameterReader;
34		use rtens\domin\delivery\RendererRegistry;
35		use rtens\domin\execution\ExecutionResult;
36		use rtens\domin\execution\FailedResult;
37		use rtens\domin\execution\MissingParametersResult;
38		use rtens\domin\execution\NoResult;
39		use rtens\domin\execution\NotPermittedResult;
40		use rtens\domin\execution\RedirectResult;
41		use rtens\domin\execution\RenderedResult;
42		use rtens\domin\Executor;
43		use rtens\domin\reflection\CommentParser;
44		use rtens\domin\reflection\types\TypeFactory;
45		use watoki\factory\Factory;
46		use watoki\reflect\ValuePrinter;
47
48		class CliApplication {
49
50		const OK = 0;
51		const ERROR = 1;
52
53		/** @var Factory */
54		public $factory;
55
56		/** @var ActionRegistry */
57		public $actions;
58
59		/** @var FieldRegistry */
60		public $fields;
61
62		/** @var RendererRegistry */
63		public $renderers;
64
65		/** @var TypeFactory */
66		public $types;
67
68		/** @var CommentParser */
69		public $parser;
70
71		/**
72		* @param Factory $factory <-
73		* @param ActionRegistry $actions <-
74		* @param FieldRegistry $fields <-
75		* @param RendererRegistry $renderers <-
76		* @param TypeFactory $types <-
77		* @param CommentParser $parser <-
78		*/
79		public function __construct(Factory $factory, ActionRegistry $actions, FieldRegistry $fields,
80		RendererRegistry $renderers, TypeFactory $types, CommentParser $parser) {
81		$this->factory = $factory;
82
83		$this->actions = $actions;
84		$this->fields = $fields;
85		$this->renderers = $renderers;
86		$this->types = $types;
87		$this->parser = $parser;
88		}
89
90		/**
91		* @param callable $callback Receives the CliApplication instance
92		* @param null\|Factory $factory
93		* @return Factory
94		*/
95		public static function init(callable $callback, Factory $factory = null) {
96		$factory = $factory ?: new Factory();
97		$callback($factory->setSingleton($factory->getInstance(self::class)));
98		return $factory;
99		}
100
101		public static function run(Factory $factory, Console $console = null) {
102		global $argv;
		0 ignored issues – show Compatibility Best Practice introduced 2015-11-20 23:12 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
103
104		/** @var self $app */
105		$app = $factory->getInstance(self::class);
106		exit($app->doRun($console ?: new Console($argv)));
		0 ignored issues – show Coding Style Compatibility introduced 2015-12-03 08:51 UTC by Report Bug Copy Issue Report The method `run()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
107		}
108
109		private function doRun(Console $console) {
		0 ignored issues – show Unused Code introduced 2015-12-03 08:51 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
110		if ($console->getArguments()) {
111		if ($console->getArguments()[0] == '!') {
112		$actionId = $this->selectAction($console);
113		$reader = new InteractiveCliParameterReader($this->fields, $console);
114
115		$this->printActionHeader($console, $actionId);
116		} else {
117		$actionId = $console->getArguments()[0];
118		$reader = new CliParameterReader($console);
119		}
120		} else {
121		$this->printUsage($console);
122		$this->printActions($console);
123		return self::OK;
124		}
125
126		$this->registerFields($reader);
127		$this->registerRenderers();
128
129		$executor = new Executor($this->actions, $this->fields, $this->renderers, $reader);
130		return $this->printResult($console, $executor->execute($actionId));
131		}
132
133		private function printResult(Console $console, ExecutionResult $result) {
134		if ($result instanceof RenderedResult) {
135		$console->writeLine((string)$result->getOutput());
136		return self::OK;
137		} else if ($result instanceof MissingParametersResult) {
138		$console->writeLine("Missing parameters " . ValuePrinter::serialize($result->getParameters()));
139		return self::ERROR;
140		} else if ($result instanceof NotPermittedResult) {
141		$console->writeLine('Permission denied');
142		return self::ERROR;
143		} else if ($result instanceof FailedResult) {
144		$console->writeLine("Error: " . $result->getMessage());
145
146		$exception = $result->getException();
147		$console->error(
148		$exception->getMessage() . ' ' .
149		'[' . $exception->getFile() . ':' . $exception->getLine() . ']' . "\n" .
150		$exception->getTraceAsString()
151		);
152		return $exception->getCode() ?: self::ERROR;
153		} else if ($result instanceof NoResult \|\| $result instanceof RedirectResult) {
154		return self::OK;
155		} else {
156		$console->writeLine('Cannot print [' . (new \ReflectionClass($result))->getShortName() . ']');
157		return self::OK;
158		}
159		}
160
161		private function selectAction(Console $console) {
162		$console->writeLine();
163		$console->writeLine('Available Actions');
164		$console->writeLine('~~~~~~~~~~~~~~~~~');
165
166		$i = 1;
167		$actionIds = [];
168	View Code Duplication	foreach ($this->actions->getAllActions() as $id => $action) {
		0 ignored issues – show Duplication introduced 2015-11-20 23:12 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...
169		$console->writeLine($i++ . " - " . $action->caption() . $this->shortDescription($action));
170		$actionIds[] = $id;
171		}
172
173		$console->writeLine();
174		$actionIndex = $console->read('Action: ');
175
176		return $actionIds[$actionIndex - 1];
177		}
178
179		private function printActionHeader(Console $console, $actionId) {
180		$action = $this->actions->getAction($actionId);
181		$console->writeLine();
182		$console->writeLine($action->caption());
183		$console->writeLine(str_repeat('~', strlen($action->caption())));
184		$console->writeLine();
185
186		if ($action->description()) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-20 23:12 UTC by Report Bug Copy Issue Report The expression `$action->description()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
187		$console->writeLine($action->description());
188		$console->writeLine();
189		}
190		}
191
192		private function printUsage(Console $console) {
193		$console->writeLine();
194
195		$console->writeLine("Interactive mode: php {$console->getScriptName()} !");
196		$console->writeLine("Execute Action: php {$console->getScriptName()} <actionId> --<parameterName> <parameterValue> ...");
197		$console->writeLine();
198		}
199
200		private function printActions(Console $console) {
201		$console->writeLine('Available Actions');
202		$console->writeLine('~~~~~~~~~~~~~~~~~');
203
204	View Code Duplication	foreach ($this->actions->getAllActions() as $id => $action) {
		0 ignored issues – show Duplication introduced 2015-11-20 23:12 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...
205		$console->writeLine($id . ' - ' . $action->caption() . $this->shortDescription($action));
206		}
207		}
208
209		private function registerFields(ParameterReader $reader) {
210		$this->fields->add(new PrimitiveField());
211		$this->fields->add(new BooleanField());
212		$this->fields->add(new FileField());
213		$this->fields->add(new HtmlField($reader));
214		$this->fields->add(new DateTimeField());
215		$this->fields->add(new DateIntervalField());
216		$this->fields->add(new ArrayField($this->fields, $reader));
217		$this->fields->add(new NullableField($this->fields, $reader));
218		$this->fields->add(new ObjectField($this->types, $this->fields, $reader));
219		$this->fields->add(new MultiField($this->fields, $reader));
220		$this->fields->add(new IdentifierField($this->fields));
221		$this->fields->add(new EnumerationField($this->fields));
222		}
223
224		private function registerRenderers() {
225		$this->renderers->add(new BooleanRenderer());
226		$this->renderers->add(new PrimitiveRenderer());
227		$this->renderers->add(new DateTimeRenderer());
228		$this->renderers->add(new DateIntervalRenderer());
229		$this->renderers->add(new HtmlRenderer());
230		$this->renderers->add(new IdentifierRenderer());
231		$this->renderers->add(new FileRenderer(''));
232		$this->renderers->add(new DelayedOutputRenderer());
233		$this->renderers->add(new ObjectTableRenderer($this->renderers));
234		$this->renderers->add(new DataTableRenderer($this->renderers));
235		$this->renderers->add(new TableRenderer($this->renderers));
236		$this->renderers->add(new ChartRenderer($this->renderers));
237		$this->renderers->add(new ArrayRenderer($this->renderers));
238		$this->renderers->add(new ObjectRenderer($this->renderers, $this->types));
239		}
240
241		private function shortDescription(Action $action) {
242		$description = $this->parser->shorten($action->description());
243		return $description ? " ($description)" : '';
244		}
245		}

rtens / domin

Push — master ( 15cb6d...86e5be )

CliApplication::printResult() C

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like