GcmComponent - Code Metrics - Inspection of "Corrections suggested by Scrutinizer" - ker0x/CakeGCM - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — cake3 (07b67b)

by Romain

created 2015-12-01 19:48 UTC

GcmComponent B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	290
Duplicated Lines	4.14 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
wmc	45
c	3
b	0
f	0
lcom	1
cbo	3
dl	12
loc	290
rs	8.3673

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
C	send()	12	44	13
A	sendNotification()	0	4	1
A	sendData()	0	4	1
A	response()	0	8	2
B	_executePush()	0	25	4
A	_buildMessage()	0	18	4
B	_checkNotification()	0	20	6
B	_checkData()	0	21	5
C	_checkParameters()	0	23	8

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like GcmComponent often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use GcmComponent, and based on these observations, apply Extract Interface, too.

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Romain Monteil
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Romain Monteil
 * @link          http://cakephp.org CakePHP(tm) Project
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace CakeGcm\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cake\Network\Http\Client;
use Cake\Utility\Hash;

/**
 * Gcm Component
 *
 */
class GcmComponent extends Component
{

	/**
	 * Default config
	 *
	 * @var array
	 */
	protected $_defaultConfig = [
		'api' => [
			'key' => null,
			'url' => 'https://gcm-http.googleapis.com/gcm/send'
		],
		'parameters' => [
			'collapse_key' => null,
			'priority' => 'normal',
			'delay_while_idle' => false,
			'dry_run' => false,
			'time_to_live' => 0,
			'restricted_package_name' => null
		]
	];

	/**
	 * Error code and message.
	 *
	 * @var array
	 */
	protected $_errorMessages = [];

	/**
	 * Response of the request
	 *
	 * @var object
	 */
	protected $_response = null;

	/**
	 * Constructor
	 *
	 * @param ComponentRegistry $collection A ComponentRegistry
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param array $config Array of configuration settings
	 */
	public function __construct(ComponentRegistry $registry, array $config = [])
	{
		$this->_errorMessages = [
			'400' => __('Error 400. The request could not be parsed as JSON.'),
			'401' => __('Error 401. Unable to authenticating the sender account.'),
			'500' => __('Error 500. Internal Server Error.'),
			'503' => __('Error 503. Service Unavailable.')
		];
	}

	/**
	 * send method
	 *
	 * @param string|array $ids
	 * @param array $payload
	 * @param array $parameters
	 * @return boolean
	 */
	public function send($ids = false, array $payload = [], array $parameters = [])
	{
		if (is_string($ids)) {
			$ids = (array)$ids;
		}

		if ($ids === false || !is_array($ids) || empty($ids)) {
			throw new \LogicException(__('Ids must be a string or an array.'));
		}

		if (!is_array($payload)) {
			throw new \LogicException(__('Data must be an array.'));
		}

		if (!is_array($parameters)) {
			throw new \LogicException(__('Parameters must be an array.'));
		}

		if (isset($payload['notification'])) {

			$payload['notification'] = $this->_checkNotification($payload['notification']);
			if (!$payload['notification']) {
				throw new \LogicException(__("Unable to check notification."));
			}
		}

		if (isset($payload['data'])) {

			$payload['data'] = $this->_checkData($payload['data']);
			if (!$payload['data']) {
				throw new \LogicException(__("Unable to check data."));
			}
		}

		$parameters = $this->_checkParameters($parameters);
		if (!$parameters) {
			throw new \ErrorException(__('Unable to check parameters.'));
		}

		$message = $this->_buildMessage($ids, $payload, $parameters);
		if ($message === false) {
			throw new \ErrorException(__('Unable to build the message.'));
		}

		return $this->_executePush($message);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * sendNotification method
	 *
	 * @param string|array $ids
	 * @param array $notification
	 * @param array $parameters
	 * @return void
	 */
	public function sendNotification($ids = false, array $notification = [], array $parameters = []) 
	{
		return $this->send($ids, ['notification' => $notification], $parameters);
	}

	/**
	 * sendData method
	 *
	 * @param string|array $ids
	 * @param array $data
	 * @param array $parameters
	 * @return void
	 */
	public function sendData($ids = false, array $data = [], array $parameters = []) 
	{
		return $this->send($ids, ['data' => $data], $parameters);
	}

	/**
	 * response method
	 *
	 * @return void
	 */
	public function response()
	{
		if (array_key_exists($this->_response->code, $this->_errorMessages)) {
			return $this->_errorMessages[$this->_response->code];
		}

		return json_decode($this->_response->body, true);
	}

	/**
	 * _executePush method
	 *
	 * @param json $message
	 * @return boolean
	 */
	protected function _executePush($message = false)
	{
		if ($message === false) {
			return false;
		}

		if ($this->_config['api']['key'] === null) {
			throw new \ErrorException(__('No API key set. Push not triggered'));
		}

		$http = new Client();
		$this->_response = $http->post($this->_config['api']['url'], $message, [
			'type' => 'json',
			'header' => [
				'Authorization' => 'key=' . $this->config['api']['key'],

				'Content-Type' => 'application/json'
			]
		]);

		if ($this->_response->code === '200') {
			return true;
		}

		return false;
	}

	/**
	 * _buildMessage method
	 *
	 * @param array $ids
	 * @param array $payload
	 * @param array $parameters
	 * @return json
	 */
	protected function _buildMessage($ids = false, $payload = false, $parameters = false)
	{
		if ($ids === false) {
			return false;
		}

		$message = ['registration_ids' => $ids];

		if (!empty($payload)) {
			$message += $payload;
		}

		if (!empty($parameters)) {
			$message += $parameters;
		}

		return json_encode($message);
	}

	/**
	 * _checkNotification method
	 *
	 * @param array $notification
	 * @return array $notification
	 */
	protected function _checkNotification($notification = false) 
	{
		if ($notification === false) {
			return false;
		}

		if (!is_array($notification)) {
			throw new \LogicException("Notification must be an array.");
		}

		if (empty($notification) || !isset($notification['title'])) {
			throw new \LogicException("Notification's array must contain at least a key title.");
		}

		if (!isset($notification['icon'])) {
			$notification['icon'] = 'myicon';
		}

		return $notification;
	}

	/**
	 * _checkData method
	 *
	 * @param array $data
	 * @return array $data
	 */
	public function _checkData($data = false) 
	{
		if ($data === false) {
			return false;
		}

		if (!is_array($data)) {
			throw new \LogicException("Data must ba an array.");
		}

		if (empty($data)) {
			throw new \LogicException("Data's array can't be empty.");
		}

		// Convert all data into string
		foreach ($data as $key => $value) {
			$data[$key] = (string)$value;
		}

		return $data;
	}

	/**
	 * _checkParameters method
	 *
	 * @param array $parameters
	 * @return array $parameters
	 */
	protected function _checkParameters($parameters = false)
	{
		if ($parameters === false) {
			return false;
		}

		$parameters = Hash::merge($this->_config['parameters'], $parameters);
		$parameters = array_filter($parameters);

		if (isset($parameters['time_to_live']) && !is_int($parameters['time_to_live'])) {
			$parameters['time_to_live'] = (int)$parameters['time_to_live'];
		}

		if (isset($parameters['delay_while_idle']) && !is_bool($parameters['delay_while_idle'])) {
			$parameters['delay_while_idle'] = (bool)$parameters['delay_while_idle'];
		}

		if (isset($parameters['dry_run']) && !is_bool($parameters['dry_run'])) {
			$parameters['dry_run'] = (bool)$parameters['dry_run'];
		}

		return $parameters;
	}
}


1		<?php
2		/**
3		* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
4		* Copyright (c) Romain Monteil
5		*
6		* Licensed under The MIT License
7		* For full copyright and license information, please see the LICENSE.txt
8		* Redistributions of files must retain the above copyright notice.
9		*
10		* @copyright Copyright (c) Romain Monteil
11		* @link http://cakephp.org CakePHP(tm) Project
12		* @license http://www.opensource.org/licenses/mit-license.php MIT License
13		*/
14		namespace CakeGcm\Controller\Component;
15
16		use Cake\Controller\Component;
17		use Cake\Controller\ComponentRegistry;
18		use Cake\Network\Http\Client;
19		use Cake\Utility\Hash;
20
21		/**
22		* Gcm Component
23		*
24		*/
25		class GcmComponent extends Component
26		{
27
28		/**
29		* Default config
30		*
31		* @var array
32		*/
33		protected $_defaultConfig = [
34		'api' => [
35		'key' => null,
36		'url' => 'https://gcm-http.googleapis.com/gcm/send'
37		],
38		'parameters' => [
39		'collapse_key' => null,
40		'priority' => 'normal',
41		'delay_while_idle' => false,
42		'dry_run' => false,
43		'time_to_live' => 0,
44		'restricted_package_name' => null
45		]
46		];
47
48		/**
49		* Error code and message.
50		*
51		* @var array
52		*/
53		protected $_errorMessages = [];
54
55		/**
56		* Response of the request
57		*
58		* @var object
59		*/
60		protected $_response = null;
61
62		/**
63		* Constructor
64		*
65		* @param ComponentRegistry $collection A ComponentRegistry
		0 ignored issues – show Bug introduced 2015-12-01 19:50 UTC by Report Bug Copy Issue Report There is no parameter named `$collection`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
66		* @param array $config Array of configuration settings
67		*/
68		public function __construct(ComponentRegistry $registry, array $config = [])
69		{
70		$this->_errorMessages = [
71		'400' => __('Error 400. The request could not be parsed as JSON.'),
72		'401' => __('Error 401. Unable to authenticating the sender account.'),
73		'500' => __('Error 500. Internal Server Error.'),
74		'503' => __('Error 503. Service Unavailable.')
75		];
76		}
77
78		/**
79		* send method
80		*
81		* @param string\|array $ids
82		* @param array $payload
83		* @param array $parameters
84		* @return boolean
85		*/
86		public function send($ids = false, array $payload = [], array $parameters = [])
87		{
88		if (is_string($ids)) {
89		$ids = (array)$ids;
90		}
91
92		if ($ids === false \|\| !is_array($ids) \|\| empty($ids)) {
93		throw new \LogicException(__('Ids must be a string or an array.'));
94		}
95
96		if (!is_array($payload)) {
97		throw new \LogicException(__('Data must be an array.'));
98		}
99
100		if (!is_array($parameters)) {
101		throw new \LogicException(__('Parameters must be an array.'));
102		}
103
104	View Code Duplication	if (isset($payload['notification'])) {
		0 ignored issues – show Duplication introduced 2015-11-29 00:41 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...
105		$payload['notification'] = $this->_checkNotification($payload['notification']);
106		if (!$payload['notification']) {
107		throw new \LogicException(__("Unable to check notification."));
108		}
109		}
110
111	View Code Duplication	if (isset($payload['data'])) {
		0 ignored issues – show Duplication introduced 2015-11-29 00:41 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...
112		$payload['data'] = $this->_checkData($payload['data']);
113		if (!$payload['data']) {
114		throw new \LogicException(__("Unable to check data."));
115		}
116		}
117
118		$parameters = $this->_checkParameters($parameters);
119		if (!$parameters) {
120		throw new \ErrorException(__('Unable to check parameters.'));
121		}
122
123		$message = $this->_buildMessage($ids, $payload, $parameters);
124		if ($message === false) {
125		throw new \ErrorException(__('Unable to build the message.'));
126		}
127
128		return $this->_executePush($message);
		0 ignored issues – show Documentation introduced 2015-12-01 19:50 UTC by Report Bug Copy Issue Report `$message` is of type `string`, but the function expects a `false\|object<CakeGcm\Controller\Component\json>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
129		}
130
131		/**
132		* sendNotification method
133		*
134		* @param string\|array $ids
135		* @param array $notification
136		* @param array $parameters
137		* @return void
138		*/
139		public function sendNotification($ids = false, array $notification = [], array $parameters = [])
140		{
141		return $this->send($ids, ['notification' => $notification], $parameters);
142		}
143
144		/**
145		* sendData method
146		*
147		* @param string\|array $ids
148		* @param array $data
149		* @param array $parameters
150		* @return void
151		*/
152		public function sendData($ids = false, array $data = [], array $parameters = [])
153		{
154		return $this->send($ids, ['data' => $data], $parameters);
155		}
156
157		/**
158		* response method
159		*
160		* @return void
161		*/
162		public function response()
163		{
164		if (array_key_exists($this->_response->code, $this->_errorMessages)) {
165		return $this->_errorMessages[$this->_response->code];
166		}
167
168		return json_decode($this->_response->body, true);
169		}
170
171		/**
172		* _executePush method
173		*
174		* @param json $message
175		* @return boolean
176		*/
177		protected function _executePush($message = false)
178		{
179		if ($message === false) {
180		return false;
181		}
182
183		if ($this->_config['api']['key'] === null) {
184		throw new \ErrorException(__('No API key set. Push not triggered'));
185		}
186
187		$http = new Client();
188		$this->_response = $http->post($this->_config['api']['url'], $message, [
189		'type' => 'json',
190		'header' => [
191		'Authorization' => 'key=' . $this->config['api']['key'],
		0 ignored issues – show Bug introduced 2015-11-29 00:41 UTC by Report Bug Copy Issue Report The property `config` does not seem to exist. Did you mean `_defaultConfig`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
192		'Content-Type' => 'application/json'
193		]
194		]);
195
196		if ($this->_response->code === '200') {
197		return true;
198		}
199
200		return false;
201		}
202
203		/**
204		* _buildMessage method
205		*
206		* @param array $ids
207		* @param array $payload
208		* @param array $parameters
209		* @return json
210		*/
211		protected function _buildMessage($ids = false, $payload = false, $parameters = false)
212		{
213		if ($ids === false) {
214		return false;
215		}
216
217		$message = ['registration_ids' => $ids];
218
219		if (!empty($payload)) {
220		$message += $payload;
221		}
222
223		if (!empty($parameters)) {
224		$message += $parameters;
225		}
226
227		return json_encode($message);
228		}
229
230		/**
231		* _checkNotification method
232		*
233		* @param array $notification
234		* @return array $notification
235		*/
236		protected function _checkNotification($notification = false)
237		{
238		if ($notification === false) {
239		return false;
240		}
241
242		if (!is_array($notification)) {
243		throw new \LogicException("Notification must be an array.");
244		}
245
246		if (empty($notification) \|\| !isset($notification['title'])) {
247		throw new \LogicException("Notification's array must contain at least a key title.");
248		}
249
250		if (!isset($notification['icon'])) {
251		$notification['icon'] = 'myicon';
252		}
253
254		return $notification;
255		}
256
257		/**
258		* _checkData method
259		*
260		* @param array $data
261		* @return array $data
262		*/
263		public function _checkData($data = false)
264		{
265		if ($data === false) {
266		return false;
267		}
268
269		if (!is_array($data)) {
270		throw new \LogicException("Data must ba an array.");
271		}
272
273		if (empty($data)) {
274		throw new \LogicException("Data's array can't be empty.");
275		}
276
277		// Convert all data into string
278		foreach ($data as $key => $value) {
279		$data[$key] = (string)$value;
280		}
281
282		return $data;
283		}
284
285		/**
286		* _checkParameters method
287		*
288		* @param array $parameters
289		* @return array $parameters
290		*/
291		protected function _checkParameters($parameters = false)
292		{
293		if ($parameters === false) {
294		return false;
295		}
296
297		$parameters = Hash::merge($this->_config['parameters'], $parameters);
298		$parameters = array_filter($parameters);
299
300		if (isset($parameters['time_to_live']) && !is_int($parameters['time_to_live'])) {
301		$parameters['time_to_live'] = (int)$parameters['time_to_live'];
302		}
303
304		if (isset($parameters['delay_while_idle']) && !is_bool($parameters['delay_while_idle'])) {
305		$parameters['delay_while_idle'] = (bool)$parameters['delay_while_idle'];
306		}
307
308		if (isset($parameters['dry_run']) && !is_bool($parameters['dry_run'])) {
309		$parameters['dry_run'] = (bool)$parameters['dry_run'];
310		}
311
312		return $parameters;
313		}
314		}
315

ker0x / CakeGCM