From e7d280f3c47de47da3803441977a6e985cf441d8 Mon Sep 17 00:00:00 2001
From: maks-rafalko <b0rn@list.ru>
Date: Sat, 31 Oct 2020 18:02:45 +0300
Subject: [PATCH] Implement UnwrapStrShuffle mutator

---
 resources/schema.json                         |   1 +
 src/Mutator/ProfileList.php                   |   2 +
 src/Mutator/Unwrap/UnwrapStrShuffle.php       |  72 +++++++
 .../Mutator/Unwrap/UnwrapStrShuffleTest.php   | 191 ++++++++++++++++++
 4 files changed, 266 insertions(+)
 create mode 100644 src/Mutator/Unwrap/UnwrapStrShuffle.php
 create mode 100644 tests/phpunit/Mutator/Unwrap/UnwrapStrShuffleTest.php

diff --git a/resources/schema.json b/resources/schema.json
index 117bdae6a..c99a60cb0 100644
--- a/resources/schema.json
+++ b/resources/schema.json
@@ -351,6 +351,7 @@
                 "UnwrapLcFirst": { "$ref": "#/definitions/default-mutator-config" },
                 "UnwrapStrRepeat": { "$ref": "#/definitions/default-mutator-config" },
                 "UnwrapStrReplace": { "$ref": "#/definitions/default-mutator-config" },
+                "UnwrapStrShuffle": { "$ref": "#/definitions/default-mutator-config" },
                 "UnwrapStrToLower": { "$ref": "#/definitions/default-mutator-config" },
                 "UnwrapStrToUpper": { "$ref": "#/definitions/default-mutator-config" },
                 "UnwrapTrim": { "$ref": "#/definitions/default-mutator-config" },
diff --git a/src/Mutator/ProfileList.php b/src/Mutator/ProfileList.php
index 2cc11e3a6..cbf98fc52 100644
--- a/src/Mutator/ProfileList.php
+++ b/src/Mutator/ProfileList.php
@@ -241,6 +241,7 @@ final class ProfileList
         Mutator\Unwrap\UnwrapLcFirst::class,
         Mutator\Unwrap\UnwrapStrRepeat::class,
         Mutator\Unwrap\UnwrapStrReplace::class,
+        Mutator\Unwrap\UnwrapStrShuffle::class,
         Mutator\Unwrap\UnwrapStrToLower::class,
         Mutator\Unwrap\UnwrapStrToUpper::class,
         Mutator\Unwrap\UnwrapTrim::class,
@@ -423,6 +424,7 @@ final class ProfileList
         'UnwrapLcFirst' => Mutator\Unwrap\UnwrapLcFirst::class,
         'UnwrapStrRepeat' => Mutator\Unwrap\UnwrapStrRepeat::class,
         'UnwrapStrReplace' => Mutator\Unwrap\UnwrapStrReplace::class,
+        'UnwrapStrShuffle' => Mutator\Unwrap\UnwrapStrShuffle::class,
         'UnwrapStrToLower' => Mutator\Unwrap\UnwrapStrToLower::class,
         'UnwrapStrToUpper' => Mutator\Unwrap\UnwrapStrToUpper::class,
         'UnwrapTrim' => Mutator\Unwrap\UnwrapTrim::class,
diff --git a/src/Mutator/Unwrap/UnwrapStrShuffle.php b/src/Mutator/Unwrap/UnwrapStrShuffle.php
new file mode 100644
index 000000000..380131e9d
--- /dev/null
+++ b/src/Mutator/Unwrap/UnwrapStrShuffle.php
@@ -0,0 +1,72 @@
+<?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\Unwrap;
+
+use Infection\Mutator\Definition;
+use Infection\Mutator\MutatorCategory;
+
+/**
+ * @internal
+ */
+final class UnwrapStrShuffle extends AbstractUnwrapMutator
+{
+    public static function getDefinition(): ?Definition
+    {
+        return new Definition(
+            <<<'TXT'
+Replaces a `str_shuffle` function call with its first operand. For example:
+
+```php
+$x = str_shuffle('Hello!');
+```
+
+Will be mutated to:
+
+```php
+$x = 'Hello!';
+```
+TXT
+            ,
+            MutatorCategory::SEMANTIC_REDUCTION,
+            null
+        );
+    }
+
+    protected function getFunctionName(): string
+    {
+        return 'str_shuffle';
+    }
+}
diff --git a/tests/phpunit/Mutator/Unwrap/UnwrapStrShuffleTest.php b/tests/phpunit/Mutator/Unwrap/UnwrapStrShuffleTest.php
new file mode 100644
index 000000000..53c44ac3e
--- /dev/null
+++ b/tests/phpunit/Mutator/Unwrap/UnwrapStrShuffleTest.php
@@ -0,0 +1,191 @@
+<?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\Tests\Mutator\Unwrap;
+
+use Infection\Tests\Mutator\BaseMutatorTestCase;
+
+final class UnwrapStrShuffleTest extends BaseMutatorTestCase
+{
+    /**
+     * @dataProvider mutationsProvider
+     *
+     * @param string|string[] $expected
+     */
+    public function test_it_can_mutate(string $input, $expected = []): void
+    {
+        $this->doTest($input, $expected);
+    }
+
+    public function mutationsProvider(): iterable
+    {
+        yield 'It mutates correctly when provided with a string' => [
+            <<<'PHP'
+<?php
+
+$a = str_shuffle('Good Afternoon!');
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = 'Good Afternoon!';
+PHP
+        ];
+
+        yield 'It mutates correctly when provided with a constant' => [
+            <<<'PHP'
+<?php
+
+$a = str_shuffle(\Class_With_Const::Const);
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = \Class_With_Const::Const;
+PHP
+        ];
+
+        yield 'It mutates correctly when a backslash is in front of strtolower' => [
+            <<<'PHP'
+<?php
+
+$a = \str_shuffle('Good Afternoon!');
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = 'Good Afternoon!';
+PHP
+        ];
+
+        yield 'It mutates correctly within if statements' => [
+            <<<'PHP'
+<?php
+
+$a = 'Good Afternoon!';
+if (str_shuffle($a) === $a) {
+    return true;
+}
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = 'Good Afternoon!';
+if ($a === $a) {
+    return true;
+}
+PHP
+        ];
+
+        yield 'It mutates correctly when strtolower is wrongly capitalized' => [
+            <<<'PHP'
+<?php
+
+$a = sTr_sHuFfLe('Good Afternoon!');
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = 'Good Afternoon!';
+PHP
+        ];
+
+        yield 'It mutates correctly when strtolower uses another function as input' => [
+            <<<'PHP'
+<?php
+
+$a = str_shuffle($foo->bar());
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = $foo->bar();
+PHP
+        ];
+
+        yield 'It mutates correctly when provided with a more complex situation' => [
+            <<<'PHP'
+<?php
+
+$a = str_shuffle(array_reduce($words, function (string $carry, string $item) {
+    return $carry . substr($item, 0, 1);
+}));
+PHP
+            ,
+            <<<'PHP'
+<?php
+
+$a = array_reduce($words, function (string $carry, string $item) {
+    return $carry . substr($item, 0, 1);
+});
+PHP
+        ];
+
+        yield 'It does not mutate other str* calls' => [
+            <<<'PHP'
+<?php
+
+$a = strtolower('Good Afternoon!');
+PHP
+        ];
+
+        yield 'It does not mutate functions named strtolower' => [
+            <<<'PHP'
+<?php
+
+function str_shuffle($string)
+{
+}
+PHP
+        ];
+
+        yield 'It does not break when provided with a variable function name' => [
+            <<<'PHP'
+<?php
+
+$a = 'str_shuffle';
+
+$b = $a('FooBar');
+PHP
+            ,
+        ];
+    }
+}