FunctionGenerator::code() - Code Metrics - Inspection of "Added function generator comments generation and c..." - samsonframework/generator - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 935351...02c4a2 )

by Vitaly

created 2017-04-04 08:30 UTC

FunctionGenerator::code() B

↳ Parent: FunctionGenerator

Complexity

Conditions	4
Paths	8

Size

Total Lines	23
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	23
ccs	13
cts	13
cp	1
rs	8.7972
c	0
b	0
f	0
cc	4
eloc	13
nc	8
nop	0
crap	4

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

/**
 * Function generation class.
 *
 * @author Vitaly Egorov <[email protected]>
 */
class FunctionGenerator extends AbstractGenerator
{
    use CodeTrait;

    /** @var string Function name */
    protected $name;

    /** @var array Collection of function arguments */
    protected $arguments = [];

    /** @var array Collection of function arguments descriptions */
    protected $argumentDescriptions = [];

    /** @var array Collection of function arguments default values */
    protected $argumentDefaults = [];

    /** @var string Return type hint */
    protected $returnType;

    /** @var CommentsGenerator */
    protected $commentGenerator;

    /**
     * FunctionGenerator constructor.
     *
     * @param string            $name   Function name
     * @param AbstractGenerator $parent Parent Generator
     */
    public function __construct(string $name, AbstractGenerator $parent = null)
    {
        $this->name = $name;

        $this->commentGenerator = (new CommentsGenerator($this))
            ->setIndentation($this->indentation);

        parent::__construct($parent);
    }

    /**
     * Set function argument.
     *
     * @param string      $name         Argument name
     * @param string|null $type         Argument type
     * @param string      $description  Argument description
     * @param mixed       $defaultValue Argument default value
     *
     * @return FunctionGenerator
     */
    public function defArgument(
        string $name,
        string $type = null,
        string $description = null,
        $defaultValue = null
    ): FunctionGenerator
    {

        $this->arguments[$name] = $type;
        $this->argumentDescriptions[$name] = $description;
        $this->argumentDefaults[$name] = $defaultValue;

        $this->commentGenerator->defParam($name, $type, $description);

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function setIndentation(int $indentation): AbstractGenerator
    {
        // Set comments indentation
        $this->commentGenerator->setIndentation($indentation);

        return parent::setIndentation($indentation);
    }

    /**
     * Set function description comment.
     *
     * @param array $description Function description
     *
     * @return FunctionGenerator
     */
    public function defDescription(array $description): FunctionGenerator
    {
        // Append description lines
        foreach ($description as $line) {
            $this->commentGenerator->defLine($line);
        }

        // Add one empty line at the end
        $this->commentGenerator->defLine('');

        return $this;
    }

    /**
     * Set return value type
     *
     * @param string|null $type        Return type hint
     *
     * @param string      $description Return type description
     *
     * @return FunctionGenerator
     */
    public function defReturnType(string $type, string $description = ''): FunctionGenerator
    {
        // Add comment return type
        $this->commentGenerator->defReturn($type, $description);

        // Set method definition return type, mixed return types are not supported yet
        $this->returnType = strpos($type, '|') !== false ? '' : $type;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function code(): string
    {
        $formattedCode[] =
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            $this->indentation($this->indentation) . $this->buildDefinition()
            . '(' . $this->buildArguments($this->arguments, $this->argumentDefaults) . ')'
            . ($this->returnType ? ' : ' . $this->returnType : '');

        // Prepend inner indentation to code
        $innerIndentation = $this->indentation(1);
        $formattedCode[] = '{';
        foreach ($this->code as $codeLine) {
            $formattedCode[] = $innerIndentation . $codeLine;
        }
        $formattedCode[] = '}';

        // Generate function comments
        $this->commentGenerator->end();

        // Get function comments code
        $comments = $this->getNestedCode(CommentsGenerator::class);

        return "\n\n" . ($comments !== '' ? $comments . "\n" : '') . implode("\n" . $this->indentation($this->indentation), $formattedCode);
    }

    /**
     * Build function definition.
     *
     * @return string Function definition
     */
    protected function buildDefinition()
    {
        return 'function ' . $this->name;
    }

    /**
     * {@inheritdoc}
     */
    public function defComment(): CommentsGenerator
    {
        return $this->commentGenerator;
    }
}


1		<?php declare(strict_types=1);
2		/**
3		* Created by Vitaly Iegorov <[email protected]>.
4		* on 03.09.16 at 11:30
5		*/
6		namespace samsonframework\generator;
7
8		/**
9		* Function generation class.
10		*
11		* @author Vitaly Egorov <[email protected]>
12		*/
13		class FunctionGenerator extends AbstractGenerator
14		{
15		use CodeTrait;
16
17		/** @var string Function name */
18		protected $name;
19
20		/** @var array Collection of function arguments */
21		protected $arguments = [];
22
23		/** @var array Collection of function arguments descriptions */
24		protected $argumentDescriptions = [];
25
26		/** @var array Collection of function arguments default values */
27		protected $argumentDefaults = [];
28
29		/** @var string Return type hint */
30		protected $returnType;
31
32		/** @var CommentsGenerator */
33		protected $commentGenerator;
34
35		/**
36		* FunctionGenerator constructor.
37		*
38		* @param string $name Function name
39		* @param AbstractGenerator $parent Parent Generator
40		*/
41	20	public function __construct(string $name, AbstractGenerator $parent = null)
42		{
43	20	$this->name = $name;
44
45	20	$this->commentGenerator = (new CommentsGenerator($this))
46	20	->setIndentation($this->indentation);
47
48	20	parent::__construct($parent);
49	20	}
50
51		/**
52		* Set function argument.
53		*
54		* @param string $name Argument name
55		* @param string\|null $type Argument type
56		* @param string $description Argument description
57		* @param mixed $defaultValue Argument default value
58		*
59		* @return FunctionGenerator
60		*/
61	8	public function defArgument(
62		string $name,
63		string $type = null,
64		string $description = null,
65		$defaultValue = null
66		): FunctionGenerator
67		{
		0 ignored issues – show Coding Style introduced 2017-04-04 06:41 UTC by Report Bug Copy Issue Report The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line Loading history...
68	8	$this->arguments[$name] = $type;
69	8	$this->argumentDescriptions[$name] = $description;
70	8	$this->argumentDefaults[$name] = $defaultValue;
71
72	8	$this->commentGenerator->defParam($name, $type, $description);
73
74	8	return $this;
75		}
76
77		/**
78		* @inheritdoc
79		*/
80	6	public function setIndentation(int $indentation): AbstractGenerator
81		{
82		// Set comments indentation
83	6	$this->commentGenerator->setIndentation($indentation);
84
85	6	return parent::setIndentation($indentation);
86		}
87
88		/**
89		* Set function description comment.
90		*
91		* @param array $description Function description
92		*
93		* @return FunctionGenerator
94		*/
95		public function defDescription(array $description): FunctionGenerator
96		{
97		// Append description lines
98		foreach ($description as $line) {
99		$this->commentGenerator->defLine($line);
100		}
101
102		// Add one empty line at the end
103		$this->commentGenerator->defLine('');
104
105		return $this;
106		}
107
108		/**
109		* Set return value type
110		*
111		* @param string\|null $type Return type hint
112		*
113		* @param string $description Return type description
114		*
115		* @return FunctionGenerator
116		*/
117	1	public function defReturnType(string $type, string $description = ''): FunctionGenerator
118		{
119		// Add comment return type
120	1	$this->commentGenerator->defReturn($type, $description);
121
122		// Set method definition return type, mixed return types are not supported yet
123	1	$this->returnType = strpos($type, '\|') !== false ? '' : $type;
124
125	1	return $this;
126		}
127
128		/**
129		* {@inheritdoc}
130		*/
131	15	public function code(): string
132		{
133	15	$formattedCode[] =
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-04-04 08:13 UTC by Report Bug Copy Issue Report `$formattedCode` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$formattedCode = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
134	15	$this->indentation($this->indentation) . $this->buildDefinition()
135	15	. '(' . $this->buildArguments($this->arguments, $this->argumentDefaults) . ')'
136	15	. ($this->returnType ? ' : ' . $this->returnType : '');
137
138		// Prepend inner indentation to code
139	15	$innerIndentation = $this->indentation(1);
140	15	$formattedCode[] = '{';
141	15	foreach ($this->code as $codeLine) {
142	9	$formattedCode[] = $innerIndentation . $codeLine;
143		}
144	15	$formattedCode[] = '}';
145
146		// Generate function comments
147	15	$this->commentGenerator->end();
148
149		// Get function comments code
150	15	$comments = $this->getNestedCode(CommentsGenerator::class);
151
152	15	return "\n\n" . ($comments !== '' ? $comments . "\n" : '') . implode("\n" . $this->indentation($this->indentation), $formattedCode);
153		}
154
155		/**
156		* Build function definition.
157		*
158		* @return string Function definition
159		*/
160	5	protected function buildDefinition()
161		{
162	5	return 'function ' . $this->name;
163		}
164
165		/**
166		* {@inheritdoc}
167		*/
168	7	public function defComment(): CommentsGenerator
169		{
170	7	return $this->commentGenerator;
171		}
172		}
173

samsonframework / generator

Push — master ( 935351...02c4a2 )

FunctionGenerator::code() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like