IntSequence - Code Metrics - Inspection of "Method `SequenceInterface::getStartValue()` added." - Smoren/sequence-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ae6524...8dfa4a )

by Smoren

created 2022-12-29 08:49 UTC

IntSequence A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	4
eloc	11
c	2
b	0
f	1
dl	0
loc	58
ccs	8
cts	10
cp	0.8
rs	10

4 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	getIterator()	3	1
A	offsetGet()	3	1
A	getStartValue()	3	1

<?php

declare(strict_types=1);

namespace Smoren\Sequence\Structs;

use Smoren\Sequence\Iterators\IntSequenceIterator;
use Smoren\Sequence\Traits\SequenceTrait;
use Smoren\Sequence\Interfaces\SequenceInterface;

/**
 * @implements SequenceInterface<int>
 */
abstract class IntSequence implements SequenceInterface
{
    use SequenceTrait;

    /**
     * @var int
     */
    protected int $start;
    /**
     * @var int<0, max>|null
     */
    protected ?int $size;
    /**
     * @var int
     */
    protected int $step;

    /**
     * @param int $start
     * @param int<0, max>|null $size
     * @param int $step
     */
    public function __construct(int $start, ?int $size, int $step = 1)
    {
        $this->start = $start;
        $this->size = $size;
        $this->step = $step;
    }

    /**
     * @param int $index
     * @return int
     */
    abstract public function getValueByIndex(int $index): int;

    /**
     * @return int
     */
    public function getStartValue(): int
    {
        return $this->getValueByIndex(0);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * {@inheritDoc}
     * @return int
     */
    public function offsetGet($offset): int
    {
        return (int)$this->_offsetGet($offset);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * {@inheritDoc}
     */
    public function getIterator(): IntSequenceIterator
    {
        return new IntSequenceIterator($this);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Smoren\Sequence\Structs;
6
7		use Smoren\Sequence\Iterators\IntSequenceIterator;
8		use Smoren\Sequence\Traits\SequenceTrait;
9		use Smoren\Sequence\Interfaces\SequenceInterface;
10
11		/**
12		* @implements SequenceInterface<int>
13		*/
14		abstract class IntSequence implements SequenceInterface
15		{
16		use SequenceTrait;
17
18		/**
19		* @var int
20		*/
21		protected int $start;
22		/**
23		* @var int<0, max>\|null
24		*/
25		protected ?int $size;
26		/**
27		* @var int
28		*/
29		protected int $step;
30
31		/**
32		* @param int $start
33		* @param int<0, max>\|null $size
34		* @param int $step
35		*/
36	10	public function __construct(int $start, ?int $size, int $step = 1)
37		{
38	10	$this->start = $start;
39	10	$this->size = $size;
40	10	$this->step = $step;
41		}
42
43		/**
44		* @param int $index
45		* @return int
46		*/
47		abstract public function getValueByIndex(int $index): int;
48
49		/**
50		* @return int
51		*/
52		public function getStartValue(): int
53		{
54		return $this->getValueByIndex(0);
		0 ignored issues – show Bug Best Practice introduced 2022-12-29 08:51 UTC by Report Bug Copy Issue Report The expression `return $this->getValueByIndex(0)` returns the type `integer` which is incompatible with the return type mandated by `Smoren\Sequence\Interfac...erface::getStartValue()` of `Smoren\Sequence\Interfaces\T`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
55		}
56
57		/**
58		* {@inheritDoc}
59		* @return int
60		*/
61	10	public function offsetGet($offset): int
62		{
63	10	return (int)$this->_offsetGet($offset);
		0 ignored issues – show Bug Best Practice introduced 2022-12-24 10:39 UTC by Report Bug Copy Issue Report The expression `return (int)$this->_offsetGet($offset)` returns the type `integer` which is incompatible with the return type mandated by `Smoren\Sequence\Interfac...eInterface::offsetGet()` of `Smoren\Sequence\Interfaces\T`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
64		}
65
66		/**
67		* {@inheritDoc}
68		*/
69	7	public function getIterator(): IntSequenceIterator
70		{
71	7	return new IntSequenceIterator($this);
72		}
73		}
74

Smoren / sequence-php

Push — master ( ae6524...8dfa4a )

IntSequence A

Complexity

Size/Duplication

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like