UnwrapArrayIntersectAssocTest.php

<?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\Tests\Mutator\Unwrap;

use Infection\Tests\Mutator\AbstractMutatorTestCase;

/**
 * @internal
 */
final class UnwrapArrayIntersectAssocTest extends AbstractMutatorTestCase
{
    /**
     * @dataProvider provideMutationCases
     */
    public function test_mutator($input, $expected = null): void
    {
        $this->doTest($input, $expected);
    }

    public function provideMutationCases(): \Generator
    {
        yield 'It mutates correctly when provided with an array' => [
            <<<'PHP'
<?php

$a = array_intersect_assoc(['A', 1, 'C'], ['D']);
PHP
            ,
            [
                <<<'PHP'
<?php

$a = ['A', 1, 'C'];
PHP
                ,
                <<<'PHP'
<?php

$a = ['D'];
PHP
                ,
            ],
        ];

        yield 'It mutates correctly when provided with a constant' => [
            <<<'PHP'
<?php

$a = array_intersect_assoc(\Class_With_Const::Const, ['D']);
PHP
            ,
            [
                <<<'PHP'
<?php

$a = \Class_With_Const::Const;
PHP
                ,
                <<<'PHP'
<?php

$a = ['D'];
PHP
                ,
            ],
        ];

        yield 'It mutates correctly when a backslash is in front of array_intersect_assoc' => [
            <<<'PHP'
<?php

$a = \array_intersect_assoc(['A', 1, 'C'], ['D']);
PHP
            ,
            [
                <<<'PHP'
<?php

$a = ['A', 1, 'C'];
PHP
                ,
                <<<'PHP'
<?php

$a = ['D'];
PHP
                ,
            ],
        ];

        yield 'It mutates correctly within if statements' => [
            <<<'PHP'
<?php

$a = ['A', 1, 'C'];
if (array_intersect_assoc($a, ['D']) === $a) {
    return true;
}
PHP
            ,
            [
                <<<'PHP'
<?php

$a = ['A', 1, 'C'];
if ($a === $a) {
    return true;
}
PHP
                ,
                <<<'PHP'
<?php

$a = ['A', 1, 'C'];
if (['D'] === $a) {
    return true;
}
PHP
                ,
            ],
        ];

        yield 'It mutates correctly when array_intersect_assoc is wrongly capitalized' => [
            <<<'PHP'
<?php

$a = aRrAy_InTeRsEcT_aSsOc(['A', 1, 'C'], ['D']);
PHP
            ,
            [
                <<<'PHP'
<?php

$a = ['A', 1, 'C'];
PHP
                ,
                <<<'PHP'
<?php

$a = ['D'];
PHP
                ,
            ],
        ];

        yield 'It mutates correctly when array_intersect_assoc uses functions as input' => [
            <<<'PHP'
<?php

$a = array_intersect_assoc($foo->bar(), $foo->baz());
PHP
            ,
            [
                <<<'PHP'
<?php

$a = $foo->bar();
PHP
                ,
                <<<'PHP'
<?php

$a = $foo->baz();
PHP
                ,
            ],
        ];

        yield 'It mutates correctly when provided with a more complex situation' => [
            <<<'PHP'
<?php

$a = array_map('strtolower', array_intersect_assoc(['A', 1, 'C'], ['D']));
PHP
            ,
            [
                <<<'PHP'
<?php

$a = array_map('strtolower', ['A', 1, 'C']);
PHP
                ,
                <<<'PHP'
<?php

$a = array_map('strtolower', ['D']);
PHP
            ],
        ];

        yield 'It mutates correctly when only one parameter is present' => [
            <<<'PHP'
<?php

$a = array_intersect_assoc(['A', 1, 'C']);
PHP
            ,
            <<<'PHP'
<?php

$a = ['A', 1, 'C'];
PHP
        ];

        yield 'It mutates correctly when more than two parameters are present' => [
            <<<'PHP'
<?php

$a = array_intersect_assoc(['A', 1, 'C'], ['D'], ['E', 'F']);
PHP
            ,
            [
                <<<'PHP'
<?php

$a = ['A', 1, 'C'];
PHP
                ,
                <<<'PHP'
<?php

$a = ['D'];
PHP
                ,
                <<<'PHP'
<?php

$a = ['E', 'F'];
PHP
            ],
        ];

        yield 'It does not mutate other array_ calls' => [
            <<<'PHP'
<?php

$a = array_map('strtolower', ['A', 'B', 'C']);
PHP
        ];

        yield 'It does not mutate functions named array_intersect_assoc' => [
            <<<'PHP'
<?php

function array_intersect_assoc($array, $array1, $array2)
{
}
PHP
        ];

        yield 'It does not break when provided with a variable function name' => [
            <<<'PHP'
<?php

$a = 'array_intersect_assoc';

$b = $a([1,2,3], [3,4,5]);
PHP
            ,
        ];
    }
}