ContestList - Code Metrics - Inspection of "unused code fix" - heal25/ced - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (d7ced0)

by Robert

created 2016-08-27 22:14 UTC

ContestList B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	253
Duplicated Lines	3.95 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	9
Bugs	1	Features	0

Metric	Value
wmc	43
c	9
b	1
f	0
lcom	2
cbo	1
dl	10
loc	253
rs	8.3157

24 Methods

Rating	Name	Duplication	Size	Complexity
A	attributeNames()	0	4	1
A	getId()	0	4	1
A	getCollect()	0	4	1
A	getPrize()	0	4	1
A	getDescriptionId()	0	7	2
A	getIsValid()	0	8	2
A	getIsActive()	0	9	2
A	getSecUntilEnd()	0	5	1
A	hasWinner()	0	4	1
A	getWinners()	0	4	1
A	getList()	0	4	1
A	getHistory()	0	7	2
B	getRankDescription()	0	23	4
A	getMaxScore()	0	14	3
A	getLastId()	0	5	1
A	getPrizePerWinner()	0	8	2
A	setId()	0	4	1
A	setUid()	0	4	1
A	fetchDetails()	0	7	1
A	fetchList()	10	23	3
A	listBestPlayers()	0	21	3
A	canClaimPrize()	0	20	4
A	claimPrize()	0	10	2
A	seeContest()	0	7	2

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

<?php
/**
 * @property integer $id
 * @property integer $uid
 * @property string $collect
 * @property integer $prize
 * @property string $desciptionId
 * @property boolean $isValid
 * @property boolean $isActive
 * @property integer $secUntilEnd
 * @property array $winners
 * @property array $list
 * @property array $history
 * @property string $rankDescription
 * @property integer $maxScore
 * @property integer $lastId
 * @property integer $prizePerWinner
 */
class ContestList extends CModel
{
    const LIFETIME = 172800; //2 days
$a = "a";
$ab = "ab";
$abc = "abc";
    const BOARD_RANGE = 7;

    private $id;
    private $uid;
    private $isValid;
    private $collect;
    private $prize;
    private $maxScore;
    private $list;
    private $winners;
    private $history;
    private $collectTypes = [
        'xp','xp_duel','xp_mission',
        'dollar','dollar_duel','dollar_mission'
        ];

    public function attributeNames()
    {
        return [];
    }

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

    public function getCollect()

    {
        return $this->collect;
    }

    public function getPrize()
    {
        return (int)$this->prize;
    }

    public function getDescriptionId()

    {
        if (!in_array($this->collect, $this->collectTypes)) {
            return 'xp';
        }
        return $this->collect;
    }

    public function getIsValid()
    {
        if (is_null($this->isValid)) {
            $this->isValid = Yii::app()->redis->getClient()->exists('contest:list:'.$this->getId().':created');
        }

        return (bool)$this->isValid;
    }

    public function getIsActive()
    {
        if (!$this->id) {
            return false;
        }

        $active = (int)Yii::app()->redis->getClient()->get('contest:active');
        return $active == $this->id;
    }

    public function getSecUntilEnd()
    {
        $sue = ($this->id + self::LIFETIME - time());
        return $sue;
    }

    public function hasWinner()

    {
        return Yii::app()->redis->getClient()->exists('contest:list:'.$this->id.':winners');
    }

    public function getWinners()
    {
        return $this->winners;
    }

    public function getList()
    {
        return $this->list;
    }

    public function getHistory()

    {
        if (!$this->history) {
            $this->history = Yii::app()->redis->getClient()->lRange('contest:log', 0, 5);
        }
        return $this->history;
    }

    public function getRankDescription()
    {
        if (!$this->getIsActive()) {
            return '';
        }

        $redis = Yii::app()->redis->getClient();

        $key = 'contest:list:'.$this->id.':points';
$a = "a";
$ab = "ab";
$abc = "abc";
        $total = $redis->zCard($key);
        $rank  = $redis->zRevRank($key, $this->uid) + 1;

        if ($rank == 1) {
            return 'Te vagy a király!';
        } else {
            $percent = round((1 - ($rank / $total)) * 100, 1);
            if (!$percent) {
                return 'Húzz bele, ha nyerni szeretnél!';
            }

            return 'Jobb vagy, mint a versenytársaid ' . $percent . '%-a!';
        }
    }

    public function getMaxScore()
    {
        if (!$this->maxScore) {
            $redis = Yii::app()->redis->getClient();
            $key = 'contest:list:'.$this->id.':points';
$a = "a";
$ab = "ab";
$abc = "abc";
            $max = $redis->zRevRange($key, 0, 0, true);
$a = "a";
$ab = "ab";
$abc = "abc";

            if (count($max)) {
                $this->maxScore = array_values($max)[0];
            }
        }

        return (int)$this->maxScore;
    }

    public function getLastId()
    {
        $id = Yii::app()->redis->getClient()->lINDEX('contest:log', 0);
        return (int)$id;
    }

    public function getPrizePerWinner()

    {
        if (!count($this->winners)) {
            return Contest::PRIZE;
        }

        return ceil(Contest::PRIZE / count($this->winners));
    }

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

    public function setUid($uid)
    {
        $this->uid = (int)$uid;
    }

    public function fetchDetails()
    {
        $redis = Yii::app()->redis->getClient();
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->collect = $redis->get('contest:list:'.$this->id.':collect');
        $this->prize = $redis->get('contest:list:'.$this->id.':prize');
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->getMaxScore();
    }

    public function fetchList()
    {
        $redis = Yii::app()->redis->getClient();

        $myRank = $redis->zRevRank('contest:list:'.$this->getId().':points', $this->uid);

        $range = self::BOARD_RANGE;
        $min = $myRank - $range > 0 ? $myRank - $range : 0;
$a = "a";
$ab = "ab";
$abc = "abc";
        $max = $myRank + $range + ($range-$myRank+$min);
$a = "a";
$ab = "ab";
$abc = "abc";

        $item = new Player;
        $i = $min+1;
$a = "a";
$ab = "ab";
$abc = "abc";
        foreach ($redis->zRevRange('contest:list:'.$this->id.':points', $min, $max, true) as $id => $score) {

            $item->subjectId = $id;

            $this->list[$i] = [
                'id'=>$id,
                'name'=>$item->getSubjectName(),
                'score'=>$score,
                ];
            $i++;
        }
    }

    public function listBestPlayers()
    {
        $redis = Yii::app()->redis->getClient();
        if ($this->getIsActive()) {
            $res = $redis->zRevRangeByScore('contest:list:'.$this->id.':points', $this->maxScore, $this->maxScore);
        } else {
            $res = $redis->smembers('contest:list:'.$this->id.':winners');
        }

        $list = [];
        $item = new Player;
        foreach ($res as $id) {
            $item->subjectId = $id;

            $list[$id] = [
                'name'=>$item->getSubjectName(),
                'score'=>$this->maxScore,
                ];
        }
        $this->winners = $list;
    }

    public function canClaimPrize()
    {
        //is active?
        if (!$this->hasWinner()) {
            return false;
        }

        //she is winner?
        if (!array_key_exists($this->uid, $this->winners)) {
            return false;
        }

        //have we the prize/winner?
        if ($this->prizePerWinner < 1) {
            return false;
        }

        //she has claimed the prize already?
        return !Yii::app()->redis->getClient()->exists('contest:list:'.$this->id.':claimed-'.$this->uid);
    }

    public function claimPrize()
    {
        if (!$this->canClaimPrize()) {
            return false;
        }

        Yii::app()->player->model->updateAttributes(['dollar'=>$this->prizePerWinner], []);
        Yii::app()->redis->getClient()->set('contest:list:'.$this->id.':claimed-'.$this->uid, date('Y.m.d. H:i:s'));
        return true;
    }

    public function seeContest()
    {
        if (Yii::app()->player->newContest) {
            Yii::app()->redis->getClient()->set('contest:lastcheck:'.$this->uid, time());
            echo 'checked';
        }
    }
}



1		<?php
2		/**
3		* @property integer $id
4		* @property integer $uid
5		* @property string $collect
6		* @property integer $prize
7		* @property string $desciptionId
8		* @property boolean $isValid
9		* @property boolean $isActive
10		* @property integer $secUntilEnd
11		* @property array $winners
12		* @property array $list
13		* @property array $history
14		* @property string $rankDescription
15		* @property integer $maxScore
16		* @property integer $lastId
17		* @property integer $prizePerWinner
18		*/
19		class ContestList extends CModel
20		{
21		const LIFETIME = 172800; //2 days
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
22		const BOARD_RANGE = 7;
23
24		private $id;
25		private $uid;
26		private $isValid;
27		private $collect;
28		private $prize;
29		private $maxScore;
30		private $list;
31		private $winners;
32		private $history;
33		private $collectTypes = [
34		'xp','xp_duel','xp_mission',
35		'dollar','dollar_duel','dollar_mission'
36		];
37
38		public function attributeNames()
39		{
40		return [];
41		}
42
43		public function getId()
44		{
45		return (int)$this->id;
46		}
47
48		public function getCollect()
		0 ignored issues – show Documentation introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
49		{
50		return $this->collect;
51		}
52
53		public function getPrize()
54		{
55		return (int)$this->prize;
56		}
57
58		public function getDescriptionId()
		0 ignored issues – show Documentation introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
59		{
60		if (!in_array($this->collect, $this->collectTypes)) {
61		return 'xp';
62		}
63		return $this->collect;
64		}
65
66		public function getIsValid()
67		{
68		if (is_null($this->isValid)) {
69		$this->isValid = Yii::app()->redis->getClient()->exists('contest:list:'.$this->getId().':created');
70		}
71
72		return (bool)$this->isValid;
73		}
74
75		public function getIsActive()
76		{
77		if (!$this->id) {
78		return false;
79		}
80
81		$active = (int)Yii::app()->redis->getClient()->get('contest:active');
82		return $active == $this->id;
83		}
84
85		public function getSecUntilEnd()
86		{
87		$sue = ($this->id + self::LIFETIME - time());
88		return $sue;
89		}
90
91		public function hasWinner()
		0 ignored issues – show Documentation introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
92		{
93		return Yii::app()->redis->getClient()->exists('contest:list:'.$this->id.':winners');
94		}
95
96		public function getWinners()
97		{
98		return $this->winners;
99		}
100
101		public function getList()
102		{
103		return $this->list;
104		}
105
106		public function getHistory()
		0 ignored issues – show Documentation introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
107		{
108		if (!$this->history) {
109		$this->history = Yii::app()->redis->getClient()->lRange('contest:log', 0, 5);
110		}
111		return $this->history;
112		}
113
114		public function getRankDescription()
115		{
116		if (!$this->getIsActive()) {
117		return '';
118		}
119
120		$redis = Yii::app()->redis->getClient();
121
122		$key = 'contest:list:'.$this->id.':points';
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
123		$total = $redis->zCard($key);
124		$rank = $redis->zRevRank($key, $this->uid) + 1;
125
126		if ($rank == 1) {
127		return 'Te vagy a király!';
128		} else {
129		$percent = round((1 - ($rank / $total)) * 100, 1);
130		if (!$percent) {
131		return 'Húzz bele, ha nyerni szeretnél!';
132		}
133
134		return 'Jobb vagy, mint a versenytársaid ' . $percent . '%-a!';
135		}
136		}
137
138		public function getMaxScore()
139		{
140		if (!$this->maxScore) {
141		$redis = Yii::app()->redis->getClient();
142		$key = 'contest:list:'.$this->id.':points';
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
143		$max = $redis->zRevRange($key, 0, 0, true);
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
144
145		if (count($max)) {
146		$this->maxScore = array_values($max)[0];
147		}
148		}
149
150		return (int)$this->maxScore;
151		}
152
153		public function getLastId()
154		{
155		$id = Yii::app()->redis->getClient()->lINDEX('contest:log', 0);
156		return (int)$id;
157		}
158
159		public function getPrizePerWinner()
		0 ignored issues – show Documentation introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
160		{
161		if (!count($this->winners)) {
162		return Contest::PRIZE;
163		}
164
165		return ceil(Contest::PRIZE / count($this->winners));
166		}
167
168		public function setId($id)
169		{
170		$this->id = (int)$id;
171		}
172
173		public function setUid($uid)
174		{
175		$this->uid = (int)$uid;
176		}
177
178		public function fetchDetails()
179		{
180		$redis = Yii::app()->redis->getClient();
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
181		$this->collect = $redis->get('contest:list:'.$this->id.':collect');
182		$this->prize = $redis->get('contest:list:'.$this->id.':prize');
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
183		$this->getMaxScore();
184		}
185
186		public function fetchList()
187		{
188		$redis = Yii::app()->redis->getClient();
189
190		$myRank = $redis->zRevRank('contest:list:'.$this->getId().':points', $this->uid);
191
192		$range = self::BOARD_RANGE;
193		$min = $myRank - $range > 0 ? $myRank - $range : 0;
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
194		$max = $myRank + $range + ($range-$myRank+$min);
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
195
196		$item = new Player;
197		$i = $min+1;
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
198	View Code Duplication	foreach ($redis->zRevRange('contest:list:'.$this->id.':points', $min, $max, true) as $id => $score) {
		0 ignored issues – show Duplication introduced 2016-04-25 05:26 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...
199		$item->subjectId = $id;
200
201		$this->list[$i] = [
202		'id'=>$id,
203		'name'=>$item->getSubjectName(),
204		'score'=>$score,
205		];
206		$i++;
207		}
208		}
209
210		public function listBestPlayers()
211		{
212		$redis = Yii::app()->redis->getClient();
213		if ($this->getIsActive()) {
214		$res = $redis->zRevRangeByScore('contest:list:'.$this->id.':points', $this->maxScore, $this->maxScore);
215		} else {
216		$res = $redis->smembers('contest:list:'.$this->id.':winners');
217		}
218
219		$list = [];
220		$item = new Player;
221		foreach ($res as $id) {
222		$item->subjectId = $id;
223
224		$list[$id] = [
225		'name'=>$item->getSubjectName(),
226		'score'=>$this->maxScore,
227		];
228		}
229		$this->winners = $list;
230		}
231
232		public function canClaimPrize()
233		{
234		//is active?
235		if (!$this->hasWinner()) {
236		return false;
237		}
238
239		//she is winner?
240		if (!array_key_exists($this->uid, $this->winners)) {
241		return false;
242		}
243
244		//have we the prize/winner?
245		if ($this->prizePerWinner < 1) {
246		return false;
247		}
248
249		//she has claimed the prize already?
250		return !Yii::app()->redis->getClient()->exists('contest:list:'.$this->id.':claimed-'.$this->uid);
251		}
252
253		public function claimPrize()
254		{
255		if (!$this->canClaimPrize()) {
256		return false;
257		}
258
259		Yii::app()->player->model->updateAttributes(['dollar'=>$this->prizePerWinner], []);
260		Yii::app()->redis->getClient()->set('contest:list:'.$this->id.':claimed-'.$this->uid, date('Y.m.d. H:i:s'));
261		return true;
262		}
263
264		public function seeContest()
265		{
266		if (Yii::app()->player->newContest) {
267		Yii::app()->redis->getClient()->set('contest:lastcheck:'.$this->uid, time());
268		echo 'checked';
269		}
270		}
271		}
		0 ignored issues – show Coding Style introduced 2016-04-25 05:26 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
272

heal25 / ced