DocumentGenerator - Code Metrics - Inspection of "Generate simple document" - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#601)

unknown

created 2016-03-29 08:28 UTC

DocumentGenerator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	233
Duplicated Lines	9.44 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
wmc	22
c	3
b	0
f	0
lcom	1
cbo	0
dl	22
loc	233
rs	10

9 Methods

Rating	Name	Duplication	Size	Complexity
A	generateDocumentClass()	0	13	1
A	generateDocumentBody()	0	14	3
A	generateDocumentProperties()	11	11	2
A	generateDocumentMethods()	11	11	2
A	generateDocumentMethod()	0	18	1
B	generatePropertyDocBlock()	0	27	6
A	generateDocumentDocBlock()	0	18	2
A	prefixWithSpaces()	0	12	3
A	getClassName()	0	5	2

How to fix Duplicated Code

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Generator;

/**
 * Document Generator
 */
class DocumentGenerator
{
    /**
     * @var string
     */
    private $spaces = '    ';

    /**
     * @var string
     */
    private $getMethodTemplate =

        '/**
 * <description>
 *
 * @return <variableType>
 */
public function <methodName>()
{
<spaces>return $this-><fieldName>;
}';

    /**
     * @var string
     */
    private $setMethodTemplate =

        '/**
 * <description>
 *
 * @param <variableType> $<variableName>
 */
public function <methodName>($<variableName>)
{
<spaces>$this-><fieldName> = $<variableName>;
}';

    /**
     * @param array $metadata
     *
     * @return string
     */
    public function generateDocumentClass(array $metadata)
    {
        $lines[] = "<?php\n";
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $lines[] = sprintf('namespace %s;', substr($metadata['name'], 0, strrpos($metadata['name'], '\\'))) . "\n";
        $lines[] = "use ONGR\\ElasticsearchBundle\\Annotation as ES;\n";
        $lines[] = $this->generateDocumentDocBlock($metadata);
        $lines[] = 'class ' . $this->getClassName($metadata);
        $lines[] = "{";
        $lines[] = str_replace('<spaces>', $this->spaces, $this->generateDocumentBody($metadata));
        $lines[] = "}\n";

        return implode("\n", $lines);
    }

    /**
     * Generates document body
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentBody(array $metadata)
    {
        $lines = [];

        if ($properties = $this->generateDocumentProperties($metadata)) {
            $lines[] = $properties;
        }

        if ($methods = $this->generateDocumentMethods($metadata)) {
            $lines[] = $methods;
        }

        return rtrim(implode("\n", $lines));
    }

    /**
     * Generates document properties
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentProperties(array $metadata)

    {
        $lines = [];

        foreach ($metadata['properties'] as $property) {
            $lines[] = $this->generatePropertyDocBlock($property);
            $lines[] = $this->spaces . 'private $' . $property['field_name'] . ";\n";
        }

        return implode("\n", $lines);
    }

    /**
     * Generates document methods
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentMethods(array $metadata)

    {
        $lines = [];

        foreach ($metadata['properties'] as $property) {
            $lines[] = $this->generateDocumentMethod($property, 'set') . "\n";
            $lines[] = $this->generateDocumentMethod($property, 'get') . "\n";
        }

        return implode("\n", $lines);
    }

    /**
     * Generates document method
     *
     * @param array  $metadata
     * @param string $type
     *
     * @return string
     */
    private function generateDocumentMethod(array $metadata, $type)
    {
        $replacements = [
            '<description>' => ucfirst($type) . ' ' . $metadata['field_name'],
            '<variableType>'      => $metadata['property_type'],
            '<variableName>'      => $metadata['field_name'],
            '<methodName>'        => $type . ucfirst($metadata['field_name']),
            '<fieldName>'         => $metadata['field_name'],
        ];

        return $this->prefixWithSpaces(
            str_replace(
                array_keys($replacements),
                array_values($replacements),
                $this->{$type . 'MethodTemplate'}
            )
        );
    }

    /**
     * Returns property doc block
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generatePropertyDocBlock(array $metadata)
    {
        $lines[] = $this->spaces . '/**';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $lines[] = $this->spaces . ' * @var ' . $metadata['property_type'];

        $lines[] = $this->spaces . ' *';

        $column = [];
        if (isset($metadata['property_name']) && $metadata['property_name'] != $metadata['field_name']) {
            $column[] = 'name="' . $metadata['property_name'] . '"';
        }

        if (isset($metadata['property_type'])) {
            $column[] = 'type="' . $metadata['property_type'] . '"';
        }

        if (isset($metadata['property_options'])  && $metadata['property_options']) {
            $column[] = 'options={' . $metadata['property_options'] . '}';
        }

        $lines[] = $this->spaces . ' * @ES\\' . $metadata['annotation'] . '('
            . implode(', ', $column) . ')';

        $lines[] = $this->spaces . ' */';

        return implode("\n", $lines);
    }

    /**
     * Generates document doc block
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentDocBlock(array $metadata)
    {
        $lines[] = '/**';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $lines[] = ' * ' . $this->getClassName($metadata);

        $lines[] = ' *';

        $lines[] = sprintf(
            ' * @ES\%s(%s)',
            $metadata['annotation'],
            $metadata['type'] != lcfirst($this->getClassName($metadata))
                ? sprintf('type="%s"', $metadata['type']) : ''
        );

        $lines[] = ' */';

        return implode("\n", $lines);
    }

    /**
     * @param string $code
     *
     * @return string
     */
    private function prefixWithSpaces($code)
    {
        $lines = explode("\n", $code);

        foreach ($lines as $key => $value) {
            if ($value) {
                $lines[$key] = $this->spaces . $lines[$key];
            }
        }

        return implode("\n", $lines);
    }

    /**
     * Returns class name
     *
     * @param array $metadata
     *
     * @return string
     */
    private function getClassName(array $metadata)
    {
        return ($pos = strrpos($metadata['name'], '\\'))
            ? substr($metadata['name'], $pos + 1, strlen($metadata['name'])) : $metadata['name'];
    }
}


1		<?php
2
3		/*
4		* This file is part of the ONGR package.
5		*
6		* (c) NFQ Technologies UAB <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ONGR\ElasticsearchBundle\Generator;
13
14		/**
15		* Document Generator
16		*/
17		class DocumentGenerator
18		{
19		/**
20		* @var string
21		*/
22		private $spaces = ' ';
23
24		/**
25		* @var string
26		*/
27		private $getMethodTemplate =
		0 ignored issues – show Unused Code introduced 2016-03-29 08:31 UTC by Report Bug Copy Issue Report The property `$getMethodTemplate` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
28		'/**
29		* <description>
30		*
31		* @return <variableType>
32		*/
33		public function <methodName>()
34		{
35		<spaces>return $this-><fieldName>;
36		}';
37
38		/**
39		* @var string
40		*/
41		private $setMethodTemplate =
		0 ignored issues – show Unused Code introduced 2016-03-29 08:31 UTC by Report Bug Copy Issue Report The property `$setMethodTemplate` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
42		'/**
43		* <description>
44		*
45		* @param <variableType> $<variableName>
46		*/
47		public function <methodName>($<variableName>)
48		{
49		<spaces>$this-><fieldName> = $<variableName>;
50		}';
51
52		/**
53		* @param array $metadata
54		*
55		* @return string
56		*/
57		public function generateDocumentClass(array $metadata)
58		{
59		$lines[] = "<?php\n";
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-29 08:31 UTC by Report Bug Copy Issue Report `$lines` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$lines = 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...
60		$lines[] = sprintf('namespace %s;', substr($metadata['name'], 0, strrpos($metadata['name'], '\\'))) . "\n";
61		$lines[] = "use ONGR\\ElasticsearchBundle\\Annotation as ES;\n";
62		$lines[] = $this->generateDocumentDocBlock($metadata);
63		$lines[] = 'class ' . $this->getClassName($metadata);
64		$lines[] = "{";
65		$lines[] = str_replace('<spaces>', $this->spaces, $this->generateDocumentBody($metadata));
66		$lines[] = "}\n";
67
68		return implode("\n", $lines);
69		}
70
71		/**
72		* Generates document body
73		*
74		* @param array $metadata
75		*
76		* @return string
77		*/
78		private function generateDocumentBody(array $metadata)
79		{
80		$lines = [];
81
82		if ($properties = $this->generateDocumentProperties($metadata)) {
83		$lines[] = $properties;
84		}
85
86		if ($methods = $this->generateDocumentMethods($metadata)) {
87		$lines[] = $methods;
88		}
89
90		return rtrim(implode("\n", $lines));
91		}
92
93		/**
94		* Generates document properties
95		*
96		* @param array $metadata
97		*
98		* @return string
99		*/
100	View Code Duplication	private function generateDocumentProperties(array $metadata)
		0 ignored issues – show Duplication introduced 2016-03-29 08: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...
101		{
102		$lines = [];
103
104		foreach ($metadata['properties'] as $property) {
105		$lines[] = $this->generatePropertyDocBlock($property);
106		$lines[] = $this->spaces . 'private $' . $property['field_name'] . ";\n";
107		}
108
109		return implode("\n", $lines);
110		}
111
112		/**
113		* Generates document methods
114		*
115		* @param array $metadata
116		*
117		* @return string
118		*/
119	View Code Duplication	private function generateDocumentMethods(array $metadata)
		0 ignored issues – show Duplication introduced 2016-03-29 08: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...
120		{
121		$lines = [];
122
123		foreach ($metadata['properties'] as $property) {
124		$lines[] = $this->generateDocumentMethod($property, 'set') . "\n";
125		$lines[] = $this->generateDocumentMethod($property, 'get') . "\n";
126		}
127
128		return implode("\n", $lines);
129		}
130
131		/**
132		* Generates document method
133		*
134		* @param array $metadata
135		* @param string $type
136		*
137		* @return string
138		*/
139		private function generateDocumentMethod(array $metadata, $type)
140		{
141		$replacements = [
142		'<description>' => ucfirst($type) . ' ' . $metadata['field_name'],
143		'<variableType>' => $metadata['property_type'],
144		'<variableName>' => $metadata['field_name'],
145		'<methodName>' => $type . ucfirst($metadata['field_name']),
146		'<fieldName>' => $metadata['field_name'],
147		];
148
149		return $this->prefixWithSpaces(
150		str_replace(
151		array_keys($replacements),
152		array_values($replacements),
153		$this->{$type . 'MethodTemplate'}
154		)
155		);
156		}
157
158		/**
159		* Returns property doc block
160		*
161		* @param array $metadata
162		*
163		* @return string
164		*/
165		private function generatePropertyDocBlock(array $metadata)
166		{
167		$lines[] = $this->spaces . '/**';
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-29 08:31 UTC by Report Bug Copy Issue Report `$lines` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$lines = 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...
168		$lines[] = $this->spaces . ' * @var ' . $metadata['property_type'];
169
170		$lines[] = $this->spaces . ' *';
171
172		$column = [];
173		if (isset($metadata['property_name']) && $metadata['property_name'] != $metadata['field_name']) {
174		$column[] = 'name="' . $metadata['property_name'] . '"';
175		}
176
177		if (isset($metadata['property_type'])) {
178		$column[] = 'type="' . $metadata['property_type'] . '"';
179		}
180
181		if (isset($metadata['property_options']) && $metadata['property_options']) {
182		$column[] = 'options={' . $metadata['property_options'] . '}';
183		}
184
185		$lines[] = $this->spaces . ' * @ES\\' . $metadata['annotation'] . '('
186		. implode(', ', $column) . ')';
187
188		$lines[] = $this->spaces . ' */';
189
190		return implode("\n", $lines);
191		}
192
193		/**
194		* Generates document doc block
195		*
196		* @param array $metadata
197		*
198		* @return string
199		*/
200		private function generateDocumentDocBlock(array $metadata)
201		{
202		$lines[] = '/**';
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-29 08:31 UTC by Report Bug Copy Issue Report `$lines` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$lines = 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...
203		$lines[] = ' * ' . $this->getClassName($metadata);
204
205		$lines[] = ' *';
206
207		$lines[] = sprintf(
208		' * @ES\%s(%s)',
209		$metadata['annotation'],
210		$metadata['type'] != lcfirst($this->getClassName($metadata))
211		? sprintf('type="%s"', $metadata['type']) : ''
212		);
213
214		$lines[] = ' */';
215
216		return implode("\n", $lines);
217		}
218
219		/**
220		* @param string $code
221		*
222		* @return string
223		*/
224		private function prefixWithSpaces($code)
225		{
226		$lines = explode("\n", $code);
227
228		foreach ($lines as $key => $value) {
229		if ($value) {
230		$lines[$key] = $this->spaces . $lines[$key];
231		}
232		}
233
234		return implode("\n", $lines);
235		}
236
237		/**
238		* Returns class name
239		*
240		* @param array $metadata
241		*
242		* @return string
243		*/
244		private function getClassName(array $metadata)
245		{
246		return ($pos = strrpos($metadata['name'], '\\'))
247		? substr($metadata['name'], $pos + 1, strlen($metadata['name'])) : $metadata['name'];
248		}
249		}
250

ongr-io / ElasticsearchBundle

Pull Request — master (#601)

DocumentGenerator A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like