FlipsideAPIUser - Code Metrics - Inspection of "Fix Code Climate Issues" - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e938ca...eb16f0 )

by Patrick

created 2016-06-06 23:22 UTC

FlipsideAPIUser B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	187
Duplicated Lines	6.42 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	12
loc	187
rs	8.2769
wmc	41
lcom	1
cbo	1

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getDisplayName()	0	8	2
A	getGivenName()	0	8	2
A	getEmail()	0	8	2
A	getUid()	0	8	2
A	getPhoneNumber()	0	8	2
A	getOrganization()	0	8	2
A	getTitles()	0	8	2
A	getState()	0	8	2
A	getCity()	0	8	2
A	getLastName()	0	8	2
A	getNickName()	0	8	2
A	getAddress()	0	8	2
A	getPostalCode()	0	8	2
A	getCountry()	0	8	2
A	getOrganizationUnits()	0	8	2
A	getLoginProviders()	0	8	2
B	isInGroupNamed()	0	21	5
A	__construct()	12	15	4

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

<?php
namespace Auth;
if(!class_exists('Httpful\Request'))
{
    require(realpath(dirname(__FILE__)).'/../libs/httpful/bootstrap.php');
}

class FlipsideAPIUser extends User
{
    private $userData;
    private $groupData = null;

    public function __construct($data = false)
    {
        if(($data !== false) && !isset($data['extended']))
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
        {
            //Generic user object
            //TODO get from API
        }
        else
        {
            if(isset($data['extended']))
            {
                $this->userData = $data['extended'];
            }
        }
    }

    public function isInGroupNamed($name)
    {
        if($this->groupData === null)
        {
            $resp = \Httpful\Request::get('https://profiles.test.burningflipside.com/api/v1/users/me/groups')->authenticateWith($this->userData->uid, $this->userData->userPassword)->send();
            if($resp->hasErrors())
            {
                return false;
            }
            $this->groupData = $resp->body;
        }
        $count = count($this->groupData);
        for($i = 0; $i < $count; $i++)
        {
            if($this->groupData[$i]->cn === $name)
            {
                return true;
            }
        }
        return false;
    }

    public function getDisplayName()
    {
        if($this->userData === null)
        {
            return parent::getDisplayName();
        }
        return $this->userData->displayname;
    }

    public function getGivenName()
    {
        if($this->userData === null)
        {
            return parent::getGivenName();
        }
        return $this->userData->givenname;
    }

    public function getEmail()
    {
        if($this->userData === null)
        {
            return parent::getEmail();
        }
        return $this->userData->mail;
    }

    public function getUid()
    {
        if($this->userData === null)
        {
            return parent::getUid();
        }
        return $this->userData->uid;
    }

    public function getPhoneNumber()
    {
        if($this->userData === null)
        {
            return parent::getPhoneNumber();
        }
        return $this->userData->mobile;
    }

    public function getOrganization()
    {
        if($this->userData === null)
        {
            return parent::getOrganization();
        }
        return $this->userData->o;
    }

    public function getTitles()
    {
        if($this->userData === null)
        {
            return parent::getTitles();
        }
        return $this->userData->title;
    }

    public function getState()
    {
        if($this->userData === null)
        {
            return parent::getState();
        }
        return $this->userData->st;
    }

    public function getCity()
    {
        if($this->userData === null)
        {
            return parent::getCity();
        }
        return $this->userData->l;
    }

    public function getLastName()
    {
        if($this->userData === null)
        {
            return parent::getLastName();
        }
        return $this->userData->sn;
    }

    public function getNickName()
    {
        if($this->userData === null)
        {
            return parent::getNickName();
        }
        return $this->userData->displayname;
    }

    public function getAddress()
    {
        if($this->userData === null)
        {
            return parent::getAddress();
        }
        return $this->userData->postaladdress;
    }

    public function getPostalCode()
    {
        if($this->userData === null)
        {
            return parent::getPostalCode();
        }
        return $this->userData->postalcode;
    }

    public function getCountry()
    {
        if($this->userData === null)
        {
            return parent::getCountry();
        }
        return $this->userData->c;
    }

    public function getOrganizationUnits()
    {
        if($this->userData === null)
        {
            return parent::getOrganizationUnits();
        }
        return $this->userData->ou;
    }

    public function getLoginProviders()
    {
        if($this->userData === null)
        {
            return parent::getLoginProviders();
        }
        return $this->userData->host;
    }
}



1		<?php
2		namespace Auth;
3		if(!class_exists('Httpful\Request'))
4		{
5		require(realpath(dirname(__FILE__)).'/../libs/httpful/bootstrap.php');
6		}
7
8		class FlipsideAPIUser extends User
9		{
10		private $userData;
11		private $groupData = null;
12
13		public function __construct($data = false)
14		{
15	View Code Duplication	if(($data !== false) && !isset($data['extended']))
		0 ignored issues – show Duplication introduced 2016-06-06 23:25 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... Unused Code introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
16		{
17		//Generic user object
18		//TODO get from API
19		}
20		else
21		{
22		if(isset($data['extended']))
23		{
24		$this->userData = $data['extended'];
25		}
26		}
27		}
28
29		public function isInGroupNamed($name)
30		{
31		if($this->groupData === null)
32		{
33		$resp = \Httpful\Request::get('https://profiles.test.burningflipside.com/api/v1/users/me/groups')->authenticateWith($this->userData->uid, $this->userData->userPassword)->send();
34		if($resp->hasErrors())
35		{
36		return false;
37		}
38		$this->groupData = $resp->body;
39		}
40		$count = count($this->groupData);
41		for($i = 0; $i < $count; $i++)
42		{
43		if($this->groupData[$i]->cn === $name)
44		{
45		return true;
46		}
47		}
48		return false;
49		}
50
51		public function getDisplayName()
52		{
53		if($this->userData === null)
54		{
55		return parent::getDisplayName();
56		}
57		return $this->userData->displayname;
58		}
59
60		public function getGivenName()
61		{
62		if($this->userData === null)
63		{
64		return parent::getGivenName();
65		}
66		return $this->userData->givenname;
67		}
68
69		public function getEmail()
70		{
71		if($this->userData === null)
72		{
73		return parent::getEmail();
74		}
75		return $this->userData->mail;
76		}
77
78		public function getUid()
79		{
80		if($this->userData === null)
81		{
82		return parent::getUid();
83		}
84		return $this->userData->uid;
85		}
86
87		public function getPhoneNumber()
88		{
89		if($this->userData === null)
90		{
91		return parent::getPhoneNumber();
92		}
93		return $this->userData->mobile;
94		}
95
96		public function getOrganization()
97		{
98		if($this->userData === null)
99		{
100		return parent::getOrganization();
101		}
102		return $this->userData->o;
103		}
104
105		public function getTitles()
106		{
107		if($this->userData === null)
108		{
109		return parent::getTitles();
110		}
111		return $this->userData->title;
112		}
113
114		public function getState()
115		{
116		if($this->userData === null)
117		{
118		return parent::getState();
119		}
120		return $this->userData->st;
121		}
122
123		public function getCity()
124		{
125		if($this->userData === null)
126		{
127		return parent::getCity();
128		}
129		return $this->userData->l;
130		}
131
132		public function getLastName()
133		{
134		if($this->userData === null)
135		{
136		return parent::getLastName();
137		}
138		return $this->userData->sn;
139		}
140
141		public function getNickName()
142		{
143		if($this->userData === null)
144		{
145		return parent::getNickName();
146		}
147		return $this->userData->displayname;
148		}
149
150		public function getAddress()
151		{
152		if($this->userData === null)
153		{
154		return parent::getAddress();
155		}
156		return $this->userData->postaladdress;
157		}
158
159		public function getPostalCode()
160		{
161		if($this->userData === null)
162		{
163		return parent::getPostalCode();
164		}
165		return $this->userData->postalcode;
166		}
167
168		public function getCountry()
169		{
170		if($this->userData === null)
171		{
172		return parent::getCountry();
173		}
174		return $this->userData->c;
175		}
176
177		public function getOrganizationUnits()
178		{
179		if($this->userData === null)
180		{
181		return parent::getOrganizationUnits();
182		}
183		return $this->userData->ou;
184		}
185
186		public function getLoginProviders()
187		{
188		if($this->userData === null)
189		{
190		return parent::getLoginProviders();
191		}
192		return $this->userData->host;
193		}
194		}
195
196

BurningFlipside / CommonCode