AbstractGenerator::end() - Code Metrics - Inspection of "Added isGenerated flag to avoid multiple generator..." - samsonframework/generator - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( c730e0...935351 )

by Vitaly

created 2017-04-04 08:19 UTC

AbstractGenerator::end() B

↳ Parent: AbstractGenerator

Complexity

Conditions	4
Paths	3

Size

Total Lines	22
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	9
cts	9
cp	1
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	9
nc	3
nop	0
crap	4

<?php declare(strict_types=1);
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 03.09.16 at 11:37
 */
namespace samsonframework\generator;

/**
 * Abstract code generator.
 *
 * @author Vitaly Egorov <[email protected]>
 */
abstract class AbstractGenerator
{
    /** @var AbstractGenerator Parent class generator */
    protected $parent;

    /** @var array Generated code grouped by generator class name */
    protected $generatedCode = [];

    /** @var int Indentation level */
    protected $indentation = 0;

    /** @var bool Flag that class has already had generated its code */
    protected $isGenerated = false;

    /**
     * AbstractGenerator constructor.
     *
     * @param AbstractGenerator $parent Parent generator
     */
    public function __construct(AbstractGenerator $parent = null)
    {
        $this->parent = $parent;
    }

    /**
     * Close current generator and return parent.
     *
     * @return AbstractGenerator|ClassGenerator|FunctionGenerator|MethodGenerator|PropertyGenerator|ClassConstantGenerator|ConditionGenerator|IfGenerator
     */
    public function end() : AbstractGenerator
    {
        // Generate code
        $generatedCode = $this->code();

        // Avoid creating empty strings
        if (!$this->isGenerated && $generatedCode !== '') {
            // Create array item
            $class = get_class($this);
            if (!array_key_exists($class, $this->parent->generatedCode)) {
                $this->parent->generatedCode[$class] = [];
            }

            // Pass generated code to parent
            $this->parent->generatedCode[$class][] = $generatedCode;

            // Set flag that we already generated code for this class
            $this->isGenerated = true;
        }

        return $this->parent;
    }

    /**
     * Generate code.
     *
     * @return string Generated code
     */
    abstract public function code(): string;

    /**
     * Set Comments block.
     *
     * @return CommentsGenerator Comments block generator
     */
    public function defComment() : CommentsGenerator
    {
        return (new CommentsGenerator($this))->setIndentation($this->indentation);
    }

    /**
     * Decrease indentation.
     *
     * @param int $indentation
     *
     * @return $this|AbstractGenerator|ClassGenerator
     */
    public function setIndentation(int $indentation): AbstractGenerator
    {
        $this->indentation = $indentation;

        return $this;
    }

    /**
     * Build nested class code array.
     *
     * @param string $className     Nested class name
     * @param array  $formattedCode Collection of code
     *
     * @return array Collection of code with added nested class code
     */
    protected function buildNestedCode(string $className, array $formattedCode = []): array
    {
        $code = $this->getNestedCode($className);
        if ($code !== '') {
            $formattedCode[] = $code;
        }

        return $formattedCode;
    }

    /**
     * Get generated nested code.
     *
     * @param string $className Nested class name
     *
     * @return string Generated nested code or empty string
     */
    protected function getNestedCode(string $className): string
    {
        if (array_key_exists($className, $this->generatedCode)) {
            return ltrim(implode("", $this->generatedCode[$className]), "\n");
        } else {
            return '';
        }
    }

    /**
     * Generate correct value.
     *
     * Method handles arrays, numerics, strings and constants.
     *
     * @param mixed $value Value
     *
     * @return mixed Value
     */
    protected function parseValue($value)
    {
        // If item value is array - recursion
        if (is_array($value)) {
            return $this->arrayValue($value);
        } elseif (is_numeric($value) || is_float($value)) {
            return $value;
        } elseif ($value === null) {
            return null;
        } else {
            try { // Try to evaluate
                eval('$value2 = ' . $value . ';');
                return $value;
            } catch (\Throwable $e) { // Consider it as a string
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                return '\''.$value.'\'';
            }
        }
    }

    /**
     * Get array values definition.
     *
     * @param array $items Array key-value pairs collection
     *
     * @return string Array value definition
     */
    protected function arrayValue(array $items = array())
    {
        $result = ['['];
        if (count($items)) {
            $this->increaseIndentation();

            // Iterate array items
            foreach ($items as $key => $value) {
                // Start array key definition
                $result[] = "\n"
                    . $this->indentation($this->indentation)
                    . $this->parseValue($key)
                    . ' => '
                    . $this->parseValue($value)
                    . ',';
            }

            $this->decreaseIndentation();
        }
        $result[] = "\n".$this->indentation($this->indentation).']';

        return implode('', $result);
    }

    /**
     * Increase indentation.
     *
     * @return $this|AbstractGenerator
     */
    public function increaseIndentation(): AbstractGenerator
    {
        return $this->setIndentation($this->indentation + 1);
    }

    /**
     * Get indentation string.
     *
     * @param int $indentation Code level
     *
     * @return string Indentation string
     */
    protected function indentation(int $indentation = 0): string
    {
        return implode('', $indentation > 0 ? array_fill(0, $indentation, '    ') : []);
    }

    /**
     * Decrease indentation.
     *
     * @return $this|AbstractGenerator
     */
    public function decreaseIndentation(): AbstractGenerator
    {
        return $this->setIndentation($this->indentation - 1);
    }
}


1		<?php declare(strict_types=1);
2		/**
3		* Created by Vitaly Iegorov <[email protected]>.
4		* on 03.09.16 at 11:37
5		*/
6		namespace samsonframework\generator;
7
8		/**
9		* Abstract code generator.
10		*
11		* @author Vitaly Egorov <[email protected]>
12		*/
13		abstract class AbstractGenerator
14		{
15		/** @var AbstractGenerator Parent class generator */
16		protected $parent;
17
18		/** @var array Generated code grouped by generator class name */
19		protected $generatedCode = [];
20
21		/** @var int Indentation level */
22		protected $indentation = 0;
23
24		/** @var bool Flag that class has already had generated its code */
25		protected $isGenerated = false;
26
27		/**
28		* AbstractGenerator constructor.
29		*
30		* @param AbstractGenerator $parent Parent generator
31		*/
32	50	public function __construct(AbstractGenerator $parent = null)
33		{
34	50	$this->parent = $parent;
35	50	}
36
37		/**
38		* Close current generator and return parent.
39		*
40		* @return AbstractGenerator\|ClassGenerator\|FunctionGenerator\|MethodGenerator\|PropertyGenerator\|ClassConstantGenerator\|ConditionGenerator\|IfGenerator
41		*/
42	9	public function end() : AbstractGenerator
43		{
44		// Generate code
45	9	$generatedCode = $this->code();
46
47		// Avoid creating empty strings
48	9	if (!$this->isGenerated && $generatedCode !== '') {
49		// Create array item
50	9	$class = get_class($this);
51	9	if (!array_key_exists($class, $this->parent->generatedCode)) {
52	9	$this->parent->generatedCode[$class] = [];
53		}
54
55		// Pass generated code to parent
56	9	$this->parent->generatedCode[$class][] = $generatedCode;
57
58		// Set flag that we already generated code for this class
59	9	$this->isGenerated = true;
60		}
61
62	9	return $this->parent;
63		}
64
65		/**
66		* Generate code.
67		*
68		* @return string Generated code
69		*/
70		abstract public function code(): string;
71
72		/**
73		* Set Comments block.
74		*
75		* @return CommentsGenerator Comments block generator
76		*/
77	1	public function defComment() : CommentsGenerator
78		{
79	1	return (new CommentsGenerator($this))->setIndentation($this->indentation);
80		}
81
82		/**
83		* Decrease indentation.
84		*
85		* @param int $indentation
86		*
87		* @return $this\|AbstractGenerator\|ClassGenerator
88		*/
89	21	public function setIndentation(int $indentation): AbstractGenerator
90		{
91	21	$this->indentation = $indentation;
92
93	21	return $this;
94		}
95
96		/**
97		* Build nested class code array.
98		*
99		* @param string $className Nested class name
100		* @param array $formattedCode Collection of code
101		*
102		* @return array Collection of code with added nested class code
103		*/
104	20	protected function buildNestedCode(string $className, array $formattedCode = []): array
105		{
106	20	$code = $this->getNestedCode($className);
107	20	if ($code !== '') {
108	7	$formattedCode[] = $code;
109		}
110
111	20	return $formattedCode;
112		}
113
114		/**
115		* Get generated nested code.
116		*
117		* @param string $className Nested class name
118		*
119		* @return string Generated nested code or empty string
120		*/
121	29	protected function getNestedCode(string $className): string
122		{
123	29	if (array_key_exists($className, $this->generatedCode)) {
124	9	return ltrim(implode("", $this->generatedCode[$className]), "\n");
125		} else {
126	27	return '';
127		}
128		}
129
130		/**
131		* Generate correct value.
132		*
133		* Method handles arrays, numerics, strings and constants.
134		*
135		* @param mixed $value Value
136		*
137		* @return mixed Value
138		*/
139	4	protected function parseValue($value)
140		{
141		// If item value is array - recursion
142	4	if (is_array($value)) {
143		return $this->arrayValue($value);
144	4	} elseif (is_numeric($value) \|\| is_float($value)) {
145		return $value;
146	4	} elseif ($value === null) {
147	4	return null;
148		} else {
149		try { // Try to evaluate
150		eval('$value2 = ' . $value . ';');
151		return $value;
152		} catch (\Throwable $e) { // Consider it as a string
		0 ignored issues – show Unused Code introduced 2016-09-04 14:09 UTC by Report Bug Copy Issue Report `catch (\Throwable $e) { ...'\'' . $value . '\''; }` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history... Bug introduced 2016-09-04 14:09 UTC by Report Bug Copy Issue Report The class `Throwable` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
153		return '\''.$value.'\'';
154		}
155		}
156		}
157
158		/**
159		* Get array values definition.
160		*
161		* @param array $items Array key-value pairs collection
162		*
163		* @return string Array value definition
164		*/
165		protected function arrayValue(array $items = array())
166		{
167		$result = ['['];
168		if (count($items)) {
169		$this->increaseIndentation();
170
171		// Iterate array items
172		foreach ($items as $key => $value) {
173		// Start array key definition
174		$result[] = "\n"
175		. $this->indentation($this->indentation)
176		. $this->parseValue($key)
177		. ' => '
178		. $this->parseValue($value)
179		. ',';
180		}
181
182		$this->decreaseIndentation();
183		}
184		$result[] = "\n".$this->indentation($this->indentation).']';
185
186		return implode('', $result);
187		}
188
189		/**
190		* Increase indentation.
191		*
192		* @return $this\|AbstractGenerator
193		*/
194	6	public function increaseIndentation(): AbstractGenerator
195		{
196	6	return $this->setIndentation($this->indentation + 1);
197		}
198
199		/**
200		* Get indentation string.
201		*
202		* @param int $indentation Code level
203		*
204		* @return string Indentation string
205		*/
206	41	protected function indentation(int $indentation = 0): string
207		{
208	41	return implode('', $indentation > 0 ? array_fill(0, $indentation, ' ') : []);
209		}
210
211		/**
212		* Decrease indentation.
213		*
214		* @return $this\|AbstractGenerator
215		*/
216		public function decreaseIndentation(): AbstractGenerator
217		{
218		return $this->setIndentation($this->indentation - 1);
219		}
220		}
221

samsonframework / generator

Push — master ( c730e0...935351 )

AbstractGenerator::end() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like