Score::getTest() - Code Metrics - johnnymast/redbox-testsuite - Measure and Improve Code Quality continuously with Scrutinizer

Score::getTest() A
last analyzed 2021-03-13 19:44 UTC

↳ Parent: Score

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
ccs	0
cts	0
cp	0
crap	2

<?php

/**
 * Score.php
 *
 * This file will maintain the Test scores.
 *
 * PHP version 7.4
 *
 * @category Core
 * @package  RedboxTestSuite
 * @author   Johnny Mast <[email protected]>
 * @license  https://opensource.org/licenses/MIT MIT
 * @link     https://github.com/johnnymast/redbox-testsuite
 * @since    1.0
 */

namespace Redbox\Testsuite;

/**
 * Class Score
 *
 * @package Redbox\Testsuite
 */
class Score
{
    /**
     * The current score.
     *
     * @var mixed
     */
    protected $score = 0;
    
    /**
     * The number of increments this score went over.
     *
     * @var int
     */
    private int $increments = 0;
    
    /**
     * Reference to the test the score belongs to.
     *
     * @var TestCase
     */
    private TestCase $test;
    
    /**
     * Array containing score information.
     *
     * @var array
     */
    private array $results = [];
    
    /**
     * Score constructor.
     *
     * @param TestCase $test The Test this score belongs to.
     */
    public function __construct(TestCase $test)
    {
        $this->test = $test;
        
        $this->reset();
    }
    
    /**
     * Reset the values to default.
     *
     * @return void
     */
    public function reset(): void
    {
        $this->score = $this->minScore();
        $this->increments = 0;
        $this->results = [];
    }
    
    /**
     * Increment the score by $score amount.
     *
     * @param mixed  $value      The value to increment the score with (float/double or int).
     * @param string $motivation A motivation for this score.
     * @param string $answer     Option to provide the given answer.
     *
     * @return void
     */
    public function increment($value, $motivation = '', $answer = ''): void
    {
        $this->score += $value;
        $this->results[$this->increments] = [
          'score' => $value,
          'increment' => $this->increments,
          'motivation' => $motivation,
          'answer' => $answer,
        ];
        $this->increments++;
    }
    
    /**
     * Return the percentage the score is
     * compared to the maximal score.
     *
     * @return float|int
     */
    public function percentage()
    {
        return round(($this->getScore() / $this->maxScore()) * 100, 2);
    }
    
    /**
     * Calculate the average for this
     * score.
     *
     * @return float|int
     */
    public function average()
    {
        return ($this->increments > 0) ? ($this->score / $this->increments) : false;

    }
    
    /**
     * Return the number of increments the
     * score went over.
     *
     * @return int
     */
    public function getIncrements(): int
    {
        return $this->increments;
    }
    
    /**
     * Return information about the scores.
     *
     * @return array
     */
    public function getScoreInfo(): array
    {
        return $this->results;
    }
    
    /**
     * Return the minimal score.
     *
     * @return mixed
     */
    public function minScore()
    {
        return $this->test->minScore();
    }
    
    /**
     * Return the maximal score.
     *
     * @return mixed
     */
    public function maxScore()
    {
        return $this->test->maxScore();
    }
    
    /**
     * Return the current score.
     *
     * @return mixed
     */
    public function getScore(): int
    {
        return $this->score;
    }
    
    /**
     * Return the parent class instance.
     *
     * @return TestCase
     */
    public function getTest(): TestCase
    {
        return $this->test;
    }
    
    /**
     * Set to score to a given value.
     *
     * @param mixed $value The value to set as the score.
     *
     * @return void
     */
    public function setScore($value): void
    {
        $this->score = $value;
    }
}


1		<?php
2
3		/**
4		* Score.php
5		*
6		* This file will maintain the Test scores.
7		*
8		* PHP version 7.4
9		*
10		* @category Core
11		* @package RedboxTestSuite
12		* @author Johnny Mast <[email protected]>
13		* @license https://opensource.org/licenses/MIT MIT
14		* @link https://github.com/johnnymast/redbox-testsuite
15		* @since 1.0
16		*/
17
18		namespace Redbox\Testsuite;
19
20		/**
21		* Class Score
22		*
23		* @package Redbox\Testsuite
24		*/
25		class Score
26		{
27		/**
28		* The current score.
29		*
30		* @var mixed
31		*/
32		protected $score = 0;
33
34		/**
35		* The number of increments this score went over.
36		*
37		* @var int
38		*/
39		private int $increments = 0;
40
41		/**
42		* Reference to the test the score belongs to.
43		*
44		* @var TestCase
45		*/
46		private TestCase $test;
47
48		/**
49		* Array containing score information.
50		*
51		* @var array
52	32	*/
53		private array $results = [];
54	32
55	32	/**
56		* Score constructor.
57		*
58		* @param TestCase $test The Test this score belongs to.
59		*/
60		public function __construct(TestCase $test)
61		{
62		$this->test = $test;
63
64	12	$this->reset();
65		}
66	12
67	12	/**
68	12	* Reset the values to default.
69		*
70		* @return void
71		*/
72		public function reset(): void
73		{
74		$this->score = $this->minScore();
75		$this->increments = 0;
76	4	$this->results = [];
77		}
78	4
79		/**
80		* Increment the score by $score amount.
81		*
82		* @param mixed $value The value to increment the score with (float/double or int).
83		* @param string $motivation A motivation for this score.
84		* @param string $answer Option to provide the given answer.
85		*
86		* @return void
87	4	*/
88		public function increment($value, $motivation = '', $answer = ''): void
89	4	{
90		$this->score += $value;
91		$this->results[$this->increments] = [
92		'score' => $value,
93		'increment' => $this->increments,
94		'motivation' => $motivation,
95		'answer' => $answer,
96		];
97		$this->increments++;
98	2	}
99
100	2	/**
101		* Return the percentage the score is
102		* compared to the maximal score.
103		*
104		* @return float\|int
105		*/
106		public function percentage()
107		{
108	2	return round(($this->getScore() / $this->maxScore()) * 100, 2);
109		}
110	2
111		/**
112		* Calculate the average for this
113		* score.
114		*
115		* @return float\|int
116		*/
117		public function average()
118	6	{
119		return ($this->increments > 0) ? ($this->score / $this->increments) : false;
		0 ignored issues – show Bug Best Practice introduced 2021-02-10 20:37 UTC by Report Bug Copy Issue Report The expression `return $this->increments...his->increments : false` could also return `false` which is incompatible with the documented return type `double\|integer`. Did you maybe forget to handle an error condition? If the returned type also contains false, it is an indicator that maybe an error condition leading to the specific return statement remains unhandled. Loading history...
120	6	}
121
122		/**
123		* Return the number of increments the
124		* score went over.
125		*
126		* @return int
127		*/
128	22	public function getIncrements(): int
129		{
130	22	return $this->increments;
131		}
132
133		/**
134		* Return information about the scores.
135		*
136		* @return array
137		*/
138		public function getScoreInfo(): array
139		{
140	14	return $this->results;
141		}
142	14
143	14	/**
144		* Return the minimal score.
145		*
146		* @return mixed
147		*/
148		public function minScore()
149		{
150		return $this->test->minScore();
151		}
152
153		/**
154		* Return the maximal score.
155		*
156		* @return mixed
157		*/
158		public function maxScore()
159		{
160		return $this->test->maxScore();
161		}
162
163		/**
164		* Return the current score.
165		*
166		* @return mixed
167		*/
168		public function getScore(): int
169		{
170		return $this->score;
171		}
172
173		/**
174		* Return the parent class instance.
175		*
176		* @return TestCase
177		*/
178		public function getTest(): TestCase
179		{
180		return $this->test;
181		}
182
183		/**
184		* Set to score to a given value.
185		*
186		* @param mixed $value The value to set as the score.
187		*
188		* @return void
189		*/
190		public function setScore($value): void
191		{
192		$this->score = $value;
193		}
194		}
195

johnnymast / redbox-testsuite

Score::getTest() A last analyzed 2021-03-13 19:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Score::getTest() A
last analyzed 2021-03-13 19:44 UTC