New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Mutators: SpreadAssignment, SpreadRemoval #1529
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
<?php | ||
/** | ||
* This code is licensed under the BSD 3-Clause License. | ||
* | ||
* Copyright (c) 2017, 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\Operator; | ||
|
||
use function count; | ||
use Infection\Mutator\Definition; | ||
use Infection\Mutator\GetMutatorName; | ||
use Infection\Mutator\Mutator; | ||
use Infection\Mutator\MutatorCategory; | ||
use PhpParser\Node; | ||
use Webmozart\Assert\Assert; | ||
|
||
/** | ||
* @internal | ||
* | ||
* @implements Mutator<Node\Expr\Array_> | ||
*/ | ||
final class SpreadAssignment implements Mutator | ||
{ | ||
use GetMutatorName; | ||
|
||
public static function getDefinition(): ?Definition | ||
{ | ||
return new Definition( | ||
<<<'TXT' | ||
Removes a spread operator in an array expression and turns it into an assignment. For example: | ||
|
||
```php | ||
$x = [...$collection]; | ||
``` | ||
|
||
Will be mutated to: | ||
|
||
```php | ||
$x = $collection; | ||
``` | ||
TXT | ||
, | ||
MutatorCategory::SEMANTIC_REDUCTION, | ||
null, | ||
<<<'DIFF' | ||
- $x = [...$collection]; | ||
+ $x = $collection; | ||
DIFF | ||
); | ||
} | ||
|
||
/** | ||
* @psalm-mutation-free | ||
* | ||
* @return iterable<Node\Expr> | ||
*/ | ||
public function mutate(Node $node): iterable | ||
{ | ||
Assert::allNotNull($node->items); | ||
|
||
yield $node->items[0]->value; | ||
} | ||
|
||
public function canMutate(Node $node): bool | ||
{ | ||
if (!$node instanceof Node\Expr\Array_) { | ||
return false; | ||
} | ||
|
||
if (count($node->items) !== 1) { | ||
return false; | ||
} | ||
|
||
Assert::allNotNull($node->items); | ||
|
||
return $node->items[0]->unpack; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
<?php | ||
/** | ||
* This code is licensed under the BSD 3-Clause License. | ||
* | ||
* Copyright (c) 2017, 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\Operator; | ||
|
||
use Infection\Mutator\Definition; | ||
use Infection\Mutator\GetMutatorName; | ||
use Infection\Mutator\Mutator; | ||
use Infection\Mutator\MutatorCategory; | ||
use PhpParser\Node; | ||
|
||
/** | ||
* @internal | ||
* | ||
* @implements Mutator<Node\Expr\ArrayItem> | ||
*/ | ||
final class SpreadRemoval implements Mutator | ||
{ | ||
use GetMutatorName; | ||
|
||
public static function getDefinition(): ?Definition | ||
{ | ||
return new Definition( | ||
<<<'TXT' | ||
Removes a spread operator in an array expression. For example: | ||
|
||
```php | ||
$x = [...$collection, 4, 5]; | ||
``` | ||
|
||
Will be mutated to: | ||
|
||
```php | ||
$x = [$collection, 4, 5]; | ||
``` | ||
TXT | ||
, | ||
MutatorCategory::SEMANTIC_REDUCTION, | ||
null, | ||
<<<'DIFF' | ||
- $x = [...$collection, 4, 5]; | ||
+ $x = [$collection, 4, 5]; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This particular mutator will be killed by static analyzers, which makes it useless. Please, see the following Psalm examples:
in other words, if we are using for example https://github.com/Roave/infection-static-analysis-plugin - this mutant will always be killed, resulting in wasted resources. So I would vote to not do this mutation. Does it make sense? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. interesting point, I'm familiar with that plugin, however, in your example we are making an assumption: we assume that the array is a list of a single type, which might not be the case. There are many situations where an array will have mixed types and this mutator becomes valuable. Here's the simplest example, based on yours: https://psalm.dev/r/6ba915ee93. I've added the assertions at the end to show that the first element of each new array is not the same. There will be other cases where the union type isn't even mentioned because an array can have many different types, so the developer might go with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ok, makes sense ;) |
||
DIFF | ||
); | ||
} | ||
|
||
/** | ||
* @psalm-mutation-free | ||
* | ||
* @return iterable<Node\Expr\ArrayItem> | ||
*/ | ||
public function mutate(Node $node): iterable | ||
{ | ||
yield new Node\Expr\ArrayItem( | ||
$node->value, | ||
null, | ||
false, | ||
$node->getAttributes(), | ||
false | ||
); | ||
} | ||
|
||
public function canMutate(Node $node): bool | ||
{ | ||
return $node instanceof Node\Expr\ArrayItem && $node->unpack; | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the assertion is more for PHPStan because from what I understand and see in other examples the items will be
ArrayItem
, but the type here isArrayItem|null
. Let me know if I'm missing something, it's the first time I'm working with the php parser