Completed
Push — master ( 362b12...9f5558 )
by Michael
02:16
created

StatsJsonView::render()   C

Complexity

Conditions 11
Paths 9

Size

Total Lines 74
Code Lines 36

Duplication

Lines 9
Ratio 12.16 %

Code Coverage

Tests 41
CRAP Score 11.2518

Importance

Changes 11
Bugs 0 Features 0
Metric Value
c 11
b 0
f 0
dl 9
loc 74
ccs 41
cts 47
cp 0.8723
rs 5.5364
cc 11
eloc 36
nc 9
nop 0
crap 11.2518

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace Stats\Views\Stats;
4
5
use Joomla\View\BaseJsonView;
6
7
/**
8
 * JSON response for requesting the stats data.
9
 *
10
 * @property-read  \Stats\Models\StatsModel  $model  The model object.
11
 *
12
 * @since          1.0
13
 */
14
class StatsJsonView extends BaseJsonView
15
{
16
	/**
17
	 * Flag if the response should return the raw data.
18
	 *
19
	 * @var    boolean
20
	 * @since  1.0
21
	 */
22
	private $authorizedRaw = false;
23
24
	/**
25
	 * Array holding the valid data sources.
26
	 *
27
	 * @var    array
28
	 * @since  1.0
29
	 */
30
	private $dataSources = ['php_version', 'db_type', 'db_version', 'cms_version', 'server_os'];
31
32
	/**
33
	 * The data source to return.
34
	 *
35
	 * @var    string
36
	 * @since  1.0
37
	 */
38
	private $source;
39
40
	/**
41
	 * Count of the number of items.
42
	 *
43
	 * @var    integer
44
	 * @since  1.0
45
	 */
46
	private $totalItems = 0;
47
48
	/**
49
	 * Set whether the raw data should be returned.
50
	 *
51
	 * @param   boolean  $authorizedRaw  Flag if the response should return the raw data.
52
	 *
53
	 * @return  void
54
	 *
55
	 * @since   1.0
56
	 */
57 1
	public function isAuthorizedRaw($authorizedRaw)
58
	{
59 1
		$this->authorizedRaw = $authorizedRaw;
60 1
	}
61
62
	/**
63
	 * Method to render the view.
64
	 *
65
	 * @return  string  The rendered view.
66
	 *
67
	 * @since   1.0
68
	 * @throws  \InvalidArgumentException
69
	 */
70 4
	public function render()
71
	{
72 4
		$items = $this->model->getItems($this->source);
73
74 4
		$php_version = [];
75 4
		$db_type     = [];
76 4
		$db_version  = [];
77 4
		$cms_version = [];
78 4
		$server_os   = [];
79
80 4
		if ($this->source)
81 4
		{
82 2
			return $this->processSingleSource($items);
83
		}
84
85
		// If we have the entire database, we have to loop within each group to put it all together
86 2
		for ($i = 0; $i < count($items); $i++)
0 ignored issues
show
Performance Best Practice introduced by
It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration:

for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
Loading history...
87
		{
88 2
			$group = $items[$i];
89
90 2
			$this->totalItems += count($group);
91
92 2
			for ($k = 0; $k < count($group); $k++)
0 ignored issues
show
Performance Best Practice introduced by
It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration:

for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
Loading history...
93
			{
94 2
				$item = $group[$k];
95
96 2
				foreach ($this->dataSources as $source)
97
				{
98 2
					if (isset($item->$source) && !is_null($item->$source))
99 2
					{
100
						// Special case, if the server is empty then change the key to "unknown"
101 2
						if ($source === 'server_os' && empty($item->$source))
102 2
						{
103
							if (!isset(${$source}['unknown']))
104
							{
105
								${$source}['unknown'] = 0;
106
							}
107
108
							${$source}['unknown']++;
109
						}
110 View Code Duplication
						else
0 ignored issues
show
Duplication introduced by
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...
111
						{
112 2
							if (!isset(${$source}[$item->$source]))
113 2
							{
114 2
								${$source}[$item->$source] = 0;
115 2
							}
116
117 2
							${$source}[$item->$source]++;
118
						}
119 2
					}
120 2
				}
121
122 2
				unset($group[$k]);
123 2
			}
124 2
		}
125
126 2
		unset($items);
127
128
		$data = [
129 2
			'php_version' => $php_version,
130 2
			'db_type'     => $db_type,
131 2
			'db_version'  => $db_version,
132 2
			'cms_version' => $cms_version,
133 2
			'server_os'   => $server_os,
134 2
		];
135
136 2
		$responseData = $this->buildResponseData($data);
137
138 2
		$responseData['total'] = $this->totalItems;
139
140 2
		$this->addData('data', $responseData);
141
142 2
		return parent::render();
143
	}
144
145
	/**
146
	 * Set the data source.
147
	 *
148
	 * @param   string  $source  Data source to return.
149
	 *
150
	 * @return  void
151
	 *
152
	 * @since   1.0
153
	 */
154 1
	public function setSource($source)
155
	{
156 1
		$this->source = $source;
157 1
	}
158
159
	/**
160
	 * Process the raw data into the response data format.
161
	 *
162
	 * @param   array  $data  The raw data array.
163
	 *
164
	 * @return  array
165
	 *
166
	 * @since   1.0
167
	 */
168 4
	private function buildResponseData(array $data)
169
	{
170 4
		$responseData = [];
171
172 4
		foreach ($data as $key => $value)
173
		{
174 4
			foreach ($value as $name => $count)
175
			{
176
				if ($name)
177 4
				{
178 4
					$responseData[$key][] = [
179 4
						'name'  => $name,
180
						'count' => $count
181 4
					];
182 4
				}
183 4
			}
184 4
		}
185
186 4
		if (!$this->authorizedRaw)
187 4
		{
188 3
			$responseData = $this->sanitizeData($responseData);
189 3
		}
190
191 4
		return $responseData;
192
	}
193
194
	/**
195
	 * Process the response for a single data source.
196
	 *
197
	 * @param   array  $items  The source items to process.
198
	 *
199
	 * @return  string  The rendered view.
200
	 *
201
	 * @since   1.0
202
	 */
203 2
	private function processSingleSource(array $items)
204
	{
205
		$data = [
206 2
			${$this->source} = [],
207 2
		];
208
209 2
		$this->totalItems = count($items);
210
211 2
		foreach ($items as $item)
212
		{
213 2
			foreach ($this->dataSources as $source)
214
			{
215 2
				if (isset($item->$source) && !is_null($item->$source))
216 2
				{
217
					// Special case, if the server is empty then change the key to "unknown"
218 2
					if ($source === 'server_os' && empty($item->$source))
219 2
					{
220 1
						if (!isset($data[$source]['unknown']))
221 1
						{
222 1
							$data[$source]['unknown'] = 0;
223 1
						}
224
225 1
						$data[$source]['unknown']++;
226 1
					}
227 View Code Duplication
					else
0 ignored issues
show
Duplication introduced by
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...
228
					{
229 2
						if (!isset($data[$source][$item->$source]))
230 2
						{
231 2
							$data[$source][$item->$source] = 0;
232 2
						}
233
234 2
						$data[$source][$item->$source]++;
235
					}
236 2
				}
237 2
			}
238 2
		}
239
240 2
		$responseData = $this->buildResponseData($data);
241
242 2
		$responseData['total'] = $this->totalItems;
243
244 2
		$this->addData('data', $responseData);
245
246 2
		return parent::render();
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (render() instead of processSingleSource()). Are you sure this is correct? If so, you might want to change this to $this->render().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
247
	}
248
249
	/**
250
	 * Sanitize the response data into summarized groups.
251
	 *
252
	 * @param   array  $responseData  The response data to sanitize.
253
	 *
254
	 * @return  array
255
	 *
256
	 * @since   1.0
257
	 */
258 3
	private function sanitizeData(array $responseData)
259
	{
260 3
		foreach ($responseData as $key => $dataGroup)
261
		{
262
			switch ($key)
263
			{
264 3
				case 'php_version':
265 3
				case 'db_version':
266
					// We're going to group by minor version branch here and convert to a percentage
267 2
					$counts = [];
268
269 2
					foreach ($dataGroup as $row)
270
					{
271 2
						$exploded = explode('.', $row['name']);
272 2
						$version  = $exploded[0] . '.' . (isset($exploded[1]) ? $exploded[1] : '0');
273
274
						// If the container does not exist, add it
275 2
						if (!isset($counts[$version]))
276 2
						{
277 2
							$counts[$version] = 0;
278 2
						}
279
280 2
						$counts[$version] += $row['count'];
281 2
					}
282
283 2
					$sanitizedData = [];
284
285 2 View Code Duplication
					foreach ($counts as $version => $count)
0 ignored issues
show
Duplication introduced by
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...
286
					{
287 2
						$sanitizedData[$version] = round(($count / $this->totalItems) * 100, 2);
288 2
					}
289
290 2
					$responseData[$key] = $sanitizedData;
291
292 2
					break;
293
294 2
				case 'server_os':
295
					// We're going to group by operating system here
296 2
					$counts = [];
297
298 2
					foreach ($dataGroup as $row)
299
					{
300 2
						$fullOs = explode(' ', $row['name']);
301 2
						$os     = $fullOs[0];
302
303
						// If the container does not exist, add it
304 2
						if (!isset($counts[$os]))
305 2
						{
306 2
							$counts[$os] = 0;
307 2
						}
308
309 2
						$counts[$os] += $row['count'];
310 2
					}
311
312 2
					$sanitizedData = [];
313
314 2 View Code Duplication
					foreach ($counts as $os => $count)
0 ignored issues
show
Duplication introduced by
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
					{
316 2
						$sanitizedData[$os] = round(($count / $this->totalItems) * 100, 2);
317 2
					}
318
319 2
					$responseData[$key] = $sanitizedData;
320
321 2
					break;
322
323 1
				case 'db_type':
324 1
				case 'cms_version':
325 1
				default:
326
					// For now, group by the object name and figure out the percentages
327 1
					$sanitizedData = [];
328
329 1
					foreach ($dataGroup as $row)
330
					{
331 1
						$sanitizedData[$row['name']] = round(($row['count'] / $this->totalItems) * 100, 2);
332 1
					}
333
334 1
					$responseData[$key] = $sanitizedData;
335
336 1
					break;
337
			}
338 3
		}
339
340 3
		return $responseData;
341
	}
342
}
343