Completed
Pull Request — master (#7)
by Ondrej
05:55
created

BitMaskConverter   A

Complexity

Total Complexity 15

Size/Duplication

Total Lines 88
Duplicated Lines 21.59 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 94.29%

Importance

Changes 0
Metric Value
wmc 15
lcom 1
cbo 3
dl 19
loc 88
ccs 33
cts 35
cp 0.9429
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
A convertFromEnumSet() 0 9 2
A setEnumClass() 7 7 3
A prepareInnerMapping() 0 18 4
A __construct() 0 7 3
A convertToEnumSet() 12 12 3

How to fix   Duplicated Code   

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:

1
<?php
2
namespace SpareParts\Enum\Set\Converter;
3
4
use SpareParts\Enum\Enum;
5
use SpareParts\Enum\Exception\EnumSetMustContainEnumsException;
6
use SpareParts\Enum\Exception\InvalidEnumClassException;
7
use SpareParts\Enum\Set\ISet;
8
use SpareParts\Enum\Set\ImmutableSet;
9
10
class BitMaskConverter implements IEnumSetConverter
11
{
12
    /**
13
     * @var string
14
     */
15
    private $enumClass;
16
17
    /**
18
     * @var array
19
     */
20
    private $mapping;
21
22
    /**
23
     * @param Enum[] $enumValuesMap
24
     */
25 11
    public function __construct($enumValuesMap)
26
    {
27 11
        if (!is_array($enumValuesMap) || !count($enumValuesMap)) {
28 2
            throw new EnumSetMustContainEnumsException('You have to provide converter mapping.');
29
        }
30 9
        $this->mapping = $this->prepareInnerMapping($enumValuesMap);
31 9
    }
32
33
    /**
34
     * @param int $values
35
     * @return ISet
36
     */
37 5 View Code Duplication
    public function convertToEnumSet($values)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
38
    {
39 5
        $bitValue = (int) $values;
40
41 5
        $set = [];
42 5
        foreach ($this->mapping as $value => $bit) {
43 5
            if ($bitValue & $bit) {
44 4
                $set[] = call_user_func([$this->enumClass, 'instance'], $value);
45 4
            }
46 5
        }
47 5
        return new ImmutableSet($this->enumClass, $set);
48
    }
49
50
    /**
51
     * @param ISet $enumSet
52
     * @return int
53
     */
54 4
    public function convertFromEnumSet(ISet $enumSet)
55
    {
56 4
        $bitValue = 0;
57
        /** @var Enum $value */
58 4
        foreach ($enumSet as $value) {
59 3
            $bitValue = $bitValue | $this->mapping[(string) $value];
60 4
        }
61 4
        return $bitValue;
62
    }
63
64
    /**
65
     * @param string $enumClass
66
     */
67 9 View Code Duplication
    protected function setEnumClass($enumClass)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
68
    {
69 9
        if (!is_null($enumClass) && !is_subclass_of($enumClass, Enum::class)) {
0 ignored issues
show
Bug introduced by
Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if \SpareParts\Enum\Enum::class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.
Loading history...
70
            throw new InvalidEnumClassException("Class ${enumClass} does not implement Enum (as it should).");
71
        }
72
        $this->enumClass = $enumClass;
73
    }
74
75
    /**
76
     * @param $enumValuesMap
77
     * @return array
78
     */
79
    private function prepareInnerMapping($enumValuesMap)
80
    {
81
        // translate enum values to bit values mapping
82 9
        $innerMapping = [];
83 9
        $shift = 0;
84 9
        foreach ($enumValuesMap as $value) {
85
            // try to guess enum class
86 9
            if (is_null($this->enumClass)) {
87 9
                $this->setEnumClass(get_class($value));
88 9
            }
89 9
            if (!($value instanceof $this->enumClass)) {
90
                throw new EnumSetMustContainEnumsException(sprintf("Expected %s, got %s", $this->enumClass, get_class($value)));
91
            }
92 9
            $innerMapping[(string)$value] = 1 << $shift;
93 9
            $shift++;
94 9
        }
95 9
        return $innerMapping;
96
    }
97
}
98