forked from infection/infection
/
ArrayItemRemoval.php
129 lines (111 loc) · 4.23 KB
/
ArrayItemRemoval.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?php
/**
* This code is licensed under the BSD 3-Clause License.
*
* Copyright (c) 2017-2019, Maks Rafalko
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
declare(strict_types=1);
namespace Infection\Mutator\Removal;
use Infection\Config\Exception\InvalidConfigException;
use Infection\Mutator\Util\Mutator;
use Infection\Mutator\Util\MutatorConfig;
use PhpParser\Node;
use Generator;
/**
* @internal
*/
final class ArrayItemRemoval extends Mutator
{
private const DEFAULT_SETTINGS = [
'remove' => 'first',
'limit' => PHP_INT_MAX,
];
private $remove;
private $limit;
public function __construct(MutatorConfig $config)
{
parent::__construct($config);
$settings = $this->getResultSettings();
$this->remove = $settings['remove'];
$this->limit = $settings['limit'];
}
public function mutate(Node $arrayNode): Generator
{
/** @var Node\Expr\Array_ $arrayNode */
foreach ($this->getItemsIndexes($arrayNode->items) as $indexToRemove) {
/** @var Node\Expr\Array_ $newArrayNode */
$newArrayNode = clone $arrayNode;
unset($newArrayNode->items[$indexToRemove]);
yield $newArrayNode;
}
}
protected function mutatesNode(Node $node): bool
{
if (!$node instanceof Node\Expr\Array_) {
return false;
}
$itemsCount = \count($node->items);
return $itemsCount && ($this->remove !== 'all' || $itemsCount <= $this->limit);
}
private function getItemsIndexes(array $items): array
{
switch ($this->remove) {
case 'first':
return [0];
case 'last':
return [\count($items) - 1];
default:
return \array_keys($items);
}
}
private function getResultSettings(): array
{
$settings = \array_merge(self::DEFAULT_SETTINGS, $this->getSettings());
if (!\is_string($settings['remove'])) {
$this->throwConfigException('remove');
}
$settings['remove'] = \strtolower($settings['remove']);
if (!\in_array($settings['remove'], ['first', 'last', 'all'])) {
$this->throwConfigException('remove');
}
if (!\is_numeric($settings['limit']) || $settings['limit'] < 1) {
$this->throwConfigException('limit');
}
return $settings;
}
private function throwConfigException(string $property): void
{
$value = $this->getSettings()[$property];
throw new InvalidConfigException(sprintf(
'Invalid configuration of ArrayItemRemoval mutator. Setting `%s` is invalid (%s)',
$property,
\is_scalar($value) ? $value : '<' . \strtoupper(\gettype($value)) . '>'
));
}
}