BaseCircle - Code Metrics - Inspection of "uniqueId and Token are shortened to 8 chars when r..." - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8d67fa...90f02e )

by Maxence

created 2017-06-12 10:30 UTC

BaseCircle B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	298
Duplicated Lines	3.36 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	43
c	1
b	0
f	0
lcom	3
cbo	0
dl	10
loc	298
rs	8.3157

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	3
A	setId()	0	5	1
A	getId()	0	3	1
A	setUniqueId()	0	5	1
A	getUniqueId()	0	3	1
A	generateUniqueId()	0	4	1
A	shortenUniqueId()	0	3	1
A	setName()	0	5	1
A	getName()	0	3	1
A	getOwner()	0	3	1
A	setOwner()	0	5	1
A	getUser()	0	3	1
A	setUser()	0	5	1
A	setDescription()	0	5	1
A	getDescription()	0	3	1
A	setSettings()	0	9	3
B	getSettings()	0	20	5
A	setSetting()	0	3	1
A	getSetting()	0	10	3
A	setType()	0	5	1
A	getType()	0	3	1
A	setCreation()	0	5	1
A	getCreation()	0	3	1
A	setMembers()	0	5	1
A	getMembers()	0	3	1
A	setLinks()	0	5	1
A	getLinks()	0	3	1
B	typeInt()	10	19	6

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 BaseCircle 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 BaseCircle, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Circles - Bring cloud-users closer together.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <[email protected]>
 * @copyright 2017
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Circles\Model;

use OC\L10N\L10N;

class BaseCircle {

	const CIRCLES_SETTINGS_DEFAULT = [
		'allow_links'       => 'false',
		'allow_links_auto'  => 'false',
		'allow_links_files' => 'false'
	];

	const CIRCLES_PERSONAL = 1;
	const CIRCLES_HIDDEN = 2;
	const CIRCLES_PRIVATE = 4;
	const CIRCLES_PUBLIC = 8;

	const CIRCLES_ALL = 15;

	/** @var int */
	private $id;

	/** @var L10N */
	protected $l10n;

	/** @var string */
	private $uniqueId;

	/** @var string */
	private $name;

	/** @var Member */
	private $owner;

	/** @var Member */
	private $user;

	/** @var string */
	private $description = '';

	/** @var array */
	private $settings = [];

	/** @var int */
	private $type;

	/** @var string */
	private $creation;

	/** @var Member[] */
	private $members;

	/** @var FederatedLink[] */
	private $links;

	/** @var FederatedLink[] */
	private $remote;

	public function __construct($l10n, $type = -1, $name = '') {
		$this->l10n = $l10n;

		if ($type > -1) {
			$this->type = $type;
		}
		if ($name !== '') {
			$this->name = $name;
		}
	}


	public function setId($id) {
		$this->id = $id;

		return $this;
	}

	public function getId() {
		return $this->id;
	}


	/**
	 * @param string $uniqueId
	 *
	 * @return $this
	 */
	public function setUniqueId($uniqueId) {
		$this->uniqueId = (string)$uniqueId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getUniqueId() {
		return $this->uniqueId;
	}

	public function generateUniqueId() {
		$uniqueId = bin2hex(openssl_random_pseudo_bytes(24));
		$this->setUniqueId($uniqueId);
	}

	public function shortenUniqueId() {
		$this->setUniqueId(substr($this->getUniqueId(), 0, 8));
	}

	public function setName($name) {
		$this->name = $name;

		return $this;
	}

	public function getName() {
		return $this->name;
	}


	public function getOwner() {
		return $this->owner;
	}

	public function setOwner($owner) {
		$this->owner = $owner;

		return $this;
	}


	/**
	 * @return Member
	 */
	public function getUser() {
		return $this->user;
	}

	public function setUser($user) {
		$this->user = $user;

		return $this;
	}


	public function setDescription($description) {
		$this->description = $description;

		return $this;
	}

	public function getDescription() {
		return $this->description;
	}


	public function setSettings($settings) {
		if (is_array($settings)) {
			$this->settings = $settings;
		} else if (is_string($settings)) {
			$this->settings = json_decode($settings, true);

		}

		return $this;
	}

	public function getSettings($json = false) {

		if ($json) {
			return json_encode($this->settings);
		}

		$settings = $this->settings;
		if ($settings === null) {
			$settings = [];
		}

		$ak = array_keys(self::CIRCLES_SETTINGS_DEFAULT);
		foreach ($ak AS $k) {
			if (!key_exists($k, $settings)) {
				$settings[$k] = self::CIRCLES_SETTINGS_DEFAULT[$k];
			}
		}

		return $settings;
	}


	public function setSetting($k, $v) {
		$this->settings[$k] = $v;
	}


	/**
	 * @param string $k
	 *
	 * @return string|null
	 */
	public function getSetting($k) {
		if (key_exists($k, $this->settings)) {
			return $this->settings[$k];
		}
		if (key_exists($k, (array)self::CIRCLES_SETTINGS_DEFAULT)) {
			return self::CIRCLES_SETTINGS_DEFAULT[$k];
		}

		return null;
	}


	public function setType($type) {
		$this->type = self::typeInt($type);

		return $this;
	}

	public function getType() {
		return $this->type;
	}


	public function setCreation($creation) {
		$this->creation = $creation;

		return $this;
	}

	public function getCreation() {
		return $this->creation;
	}


	public function setMembers($members) {
		$this->members = $members;

		return $this;
	}

	public function getMembers() {
		return $this->members;
	}


	public function setLinks($links) {
		$this->links = $links;

		return $this;
	}

	public function getLinks() {
		return $this->links;
	}


//	public function getRemote() {

//		return $this->remote;
//	}
//
//	public function addRemote($link) {
//		array_push($this->remote, $link);
//	}
//
//	public function getRemoteFromToken($token) {
//		foreach ($this->links AS $link) {
//			if ($link->getToken() === $token) {
//				return $link;
//			}
//		}
//
//		return null;
//	}
//
//	public function getRemoteFromAddressAndId($address, $id) {
//		foreach ($this->links AS $link) {
//			if ($link->getAddress() === $address && $link->getUniqueId() === $id) {
//				return $link;
//			}
//		}
//
//		return null;
//	}


	public static function typeInt($type) {

		if (is_numeric($type)) {
			return (int)$type;
		}

		switch ($type) {

			case 'Personal':
				return self::CIRCLES_PERSONAL;
			case 'Private':
				return self::CIRCLES_PRIVATE;
			case 'Hidden':
				return self::CIRCLES_HIDDEN;
			case 'Public':
				return self::CIRCLES_PUBLIC;
		}

		return 0;
	}
}

1		<?php
2		/**
3		* Circles - Bring cloud-users closer together.
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Maxence Lange <[email protected]>
9		* @copyright 2017
10		* @license GNU AGPL version 3 or any later version
11		*
12		* This program is free software: you can redistribute it and/or modify
13		* it under the terms of the GNU Affero General Public License as
14		* published by the Free Software Foundation, either version 3 of the
15		* License, or (at your option) any later version.
16		*
17		* This program is distributed in the hope that it will be useful,
18		* but WITHOUT ANY WARRANTY; without even the implied warranty of
19		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20		* GNU Affero General Public License for more details.
21		*
22		* You should have received a copy of the GNU Affero General Public License
23		* along with this program. If not, see <http://www.gnu.org/licenses/>.
24		*
25		*/
26
27		namespace OCA\Circles\Model;
28
29		use OC\L10N\L10N;
30
31		class BaseCircle {
32
33		const CIRCLES_SETTINGS_DEFAULT = [
34		'allow_links' => 'false',
35		'allow_links_auto' => 'false',
36		'allow_links_files' => 'false'
37		];
38
39		const CIRCLES_PERSONAL = 1;
40		const CIRCLES_HIDDEN = 2;
41		const CIRCLES_PRIVATE = 4;
42		const CIRCLES_PUBLIC = 8;
43
44		const CIRCLES_ALL = 15;
45
46		/** @var int */
47		private $id;
48
49		/** @var L10N */
50		protected $l10n;
51
52		/** @var string */
53		private $uniqueId;
54
55		/** @var string */
56		private $name;
57
58		/** @var Member */
59		private $owner;
60
61		/** @var Member */
62		private $user;
63
64		/** @var string */
65		private $description = '';
66
67		/** @var array */
68		private $settings = [];
69
70		/** @var int */
71		private $type;
72
73		/** @var string */
74		private $creation;
75
76		/** @var Member[] */
77		private $members;
78
79		/** @var FederatedLink[] */
80		private $links;
81
82		/** @var FederatedLink[] */
83		private $remote;
84
85		public function __construct($l10n, $type = -1, $name = '') {
86		$this->l10n = $l10n;
87
88		if ($type > -1) {
89		$this->type = $type;
90		}
91		if ($name !== '') {
92		$this->name = $name;
93		}
94		}
95
96
97		public function setId($id) {
98		$this->id = $id;
99
100		return $this;
101		}
102
103		public function getId() {
104		return $this->id;
105		}
106
107
108		/**
109		* @param string $uniqueId
110		*
111		* @return $this
112		*/
113		public function setUniqueId($uniqueId) {
114		$this->uniqueId = (string)$uniqueId;
115
116		return $this;
117		}
118
119		/**
120		* @return string
121		*/
122		public function getUniqueId() {
123		return $this->uniqueId;
124		}
125
126		public function generateUniqueId() {
127		$uniqueId = bin2hex(openssl_random_pseudo_bytes(24));
128		$this->setUniqueId($uniqueId);
129		}
130
131		public function shortenUniqueId() {
132		$this->setUniqueId(substr($this->getUniqueId(), 0, 8));
133		}
134
135		public function setName($name) {
136		$this->name = $name;
137
138		return $this;
139		}
140
141		public function getName() {
142		return $this->name;
143		}
144
145
146		public function getOwner() {
147		return $this->owner;
148		}
149
150		public function setOwner($owner) {
151		$this->owner = $owner;
152
153		return $this;
154		}
155
156
157		/**
158		* @return Member
159		*/
160		public function getUser() {
161		return $this->user;
162		}
163
164		public function setUser($user) {
165		$this->user = $user;
166
167		return $this;
168		}
169
170
171		public function setDescription($description) {
172		$this->description = $description;
173
174		return $this;
175		}
176
177		public function getDescription() {
178		return $this->description;
179		}
180
181
182		public function setSettings($settings) {
183		if (is_array($settings)) {
184		$this->settings = $settings;
185		} else if (is_string($settings)) {
186		$this->settings = json_decode($settings, true);
		0 ignored issues – show Documentation Bug introduced 2017-06-09 21:52 UTC by Report Bug Copy Issue Report It seems like `json_decode($settings, true)` of type `*` is incompatible with the declared type `array` of property `$settings`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
187		}
188
189		return $this;
190		}
191
192		public function getSettings($json = false) {
193
194		if ($json) {
195		return json_encode($this->settings);
196		}
197
198		$settings = $this->settings;
199		if ($settings === null) {
200		$settings = [];
201		}
202
203		$ak = array_keys(self::CIRCLES_SETTINGS_DEFAULT);
204		foreach ($ak AS $k) {
205		if (!key_exists($k, $settings)) {
206		$settings[$k] = self::CIRCLES_SETTINGS_DEFAULT[$k];
207		}
208		}
209
210		return $settings;
211		}
212
213
214		public function setSetting($k, $v) {
215		$this->settings[$k] = $v;
216		}
217
218
219		/**
220		* @param string $k
221		*
222		* @return string\|null
223		*/
224		public function getSetting($k) {
225		if (key_exists($k, $this->settings)) {
226		return $this->settings[$k];
227		}
228		if (key_exists($k, (array)self::CIRCLES_SETTINGS_DEFAULT)) {
229		return self::CIRCLES_SETTINGS_DEFAULT[$k];
230		}
231
232		return null;
233		}
234
235
236		public function setType($type) {
237		$this->type = self::typeInt($type);
238
239		return $this;
240		}
241
242		public function getType() {
243		return $this->type;
244		}
245
246
247		public function setCreation($creation) {
248		$this->creation = $creation;
249
250		return $this;
251		}
252
253		public function getCreation() {
254		return $this->creation;
255		}
256
257
258		public function setMembers($members) {
259		$this->members = $members;
260
261		return $this;
262		}
263
264		public function getMembers() {
265		return $this->members;
266		}
267
268
269		public function setLinks($links) {
270		$this->links = $links;
271
272		return $this;
273		}
274
275		public function getLinks() {
276		return $this->links;
277		}
278
279
280		// public function getRemote() {
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-10 21:42 UTC by Report Bug Copy Issue Report `49%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
281		// return $this->remote;
282		// }
283		//
284		// public function addRemote($link) {
285		// array_push($this->remote, $link);
286		// }
287		//
288		// public function getRemoteFromToken($token) {
289		// foreach ($this->links AS $link) {
290		// if ($link->getToken() === $token) {
291		// return $link;
292		// }
293		// }
294		//
295		// return null;
296		// }
297		//
298		// public function getRemoteFromAddressAndId($address, $id) {
299		// foreach ($this->links AS $link) {
300		// if ($link->getAddress() === $address && $link->getUniqueId() === $id) {
301		// return $link;
302		// }
303		// }
304		//
305		// return null;
306		// }
307
308
309		public static function typeInt($type) {
310
311		if (is_numeric($type)) {
312		return (int)$type;
313		}
314
315	View Code Duplication	switch ($type) {
		0 ignored issues – show Duplication introduced 2017-06-07 17:45 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...
316		case 'Personal':
317		return self::CIRCLES_PERSONAL;
318		case 'Private':
319		return self::CIRCLES_PRIVATE;
320		case 'Hidden':
321		return self::CIRCLES_HIDDEN;
322		case 'Public':
323		return self::CIRCLES_PUBLIC;
324		}
325
326		return 0;
327		}
328		}

nextcloud / circles