Innmind / Immutable

tests/SetTest.php

<?php
declare(strict_types = 1);

namespace Tests\Innmind\Immutable;

use Innmind\Immutable\{
    Set,
    Map,
    Str,
    Sequence,
};
use PHPUnit\Framework\TestCase;

class SetTest extends TestCase
{
    public function testInterface()
    {
        $this->assertInstanceOf(\Countable::class, Set::of());
    }

    public function testOf()
    {
        $this->assertTrue(
            Set::of(1, 1, 2, 3)->equals(

1 of type integer is incompatible with the type Innmind\Immutable\V expected by parameter $values of Innmind\Immutable\Set::of().

                Set::of()
                    ->add(1)
                    ->add(2)
                    ->add(3),
            ),
        );
    }

    public function testDefer()
    {
        $loaded = false;
        $set = Set::defer((static function() use (&$loaded) {
            yield 1;
            yield 2;
            yield 3;
            $loaded = true;
        })());

        $this->assertInstanceOf(Set::class, $set);
        $this->assertFalse($loaded);
        $this->assertSame([1, 2, 3], $set->toList());
        $this->assertTrue($loaded);
    }

    public function testLazy()
    {
        $loaded = false;
        $set = Set::lazy(static function() use (&$loaded) {
            yield 1;
            yield 2;
            yield 3;
            $loaded = true;
        });

        $this->assertInstanceOf(Set::class, $set);
        $this->assertFalse($loaded);
        $this->assertSame([1, 2, 3], $set->toList());
        $this->assertTrue($loaded);
    }

    public function testMixed()
    {
        $set = Set::mixed(1, '2', 3, 1);

        $this->assertInstanceOf(Set::class, $set);
        $this->assertSame([1, '2', 3], $set->toList());
    }

    public function testInts()
    {
        $set = Set::ints(1, 2, 3, 1);

        $this->assertInstanceOf(Set::class, $set);
        $this->assertSame([1, 2, 3], $set->toList());
    }

    public function testFloats()
    {
        $set = Set::floats(1, 2, 3.2, 1);

        $this->assertInstanceOf(Set::class, $set);
        $this->assertSame([1.0, 2.0, 3.2], $set->toList());
    }

    public function testStrings()
    {
        $set = Set::strings('1', '2', '3', '1');

        $this->assertInstanceOf(Set::class, $set);
        $this->assertSame(['1', '2', '3'], $set->toList());
    }

    public function testObjects()
    {
        $a = new \stdClass;
        $b = new \stdClass;
        $c = new \stdClass;
        $set = Set::objects($a, $b, $c, $a);

        $this->assertInstanceOf(Set::class, $set);
        $this->assertSame([$a, $b, $c], $set->toList());
    }

    public function testAdd()
    {
        $this->assertSame(0, Set::of()->size());

        $s = Set::of()->add(42);

        $this->assertSame(1, $s->size());
        $this->assertSame(1, $s->count());
        $s->add(24);
        $this->assertSame(1, $s->size());
        $s = $s->add(24);
        $this->assertInstanceOf(Set::class, $s);
        $this->assertSame(2, $s->size());
        $s = $s->add(24);
        $this->assertSame(2, $s->size());
        $this->assertSame([42, 24], $s->toList());

        $this->assertSame(
            [1, 2, 3],
            Set::ints(1)(2)(3)->toList(),
        );
    }

    public function testIntersect()
    {
        $s = Set::of()
            ->add(24)
            ->add(42)
            ->add(66);

        $s2 = $s->intersect(Set::of()->add(42));
        $this->assertNotSame($s, $s2);
        $this->assertInstanceOf(Set::class, $s2);
        $this->assertSame([24, 42, 66], $s->toList());
        $this->assertSame([42], $s2->toList());
    }

    public function testContains()
    {
        $s = Set::of();

        $this->assertFalse($s->contains(42));
        $s = $s->add(42);
        $this->assertTrue($s->contains(42));
    }

    public function testRemove()
    {
        $s = Set::of()
            ->add(24)
            ->add(42)
            ->add(66)
            ->add(90)
            ->add(114);

        $s2 = $s->remove(42);
        $this->assertNotSame($s, $s2);
        $this->assertInstanceOf(Set::class, $s2);
        $this->assertSame([24, 42, 66, 90, 114], $s->toList());
        $this->assertSame([24, 66, 90, 114], $s2->toList());
        $this->assertSame([42, 66, 90, 114], $s->remove(24)->toList());
        $this->assertSame([24, 42, 90, 114], $s->remove(66)->toList());
        $this->assertSame([24, 42, 66, 114], $s->remove(90)->toList());
        $this->assertSame([24, 42, 66, 90], $s->remove(114)->toList());
    }

    public function testDiff()
    {
        $s = Set::of()
            ->add(24)
            ->add(42)
            ->add(66);

        $s2 = $s->diff(Set::of()->add(42));
        $this->assertNotSame($s, $s2);
        $this->assertInstanceOf(Set::class, $s2);
        $this->assertSame([24, 42, 66], $s->toList());
        $this->assertSame([24, 66], $s2->toList());
    }

    public function testEquals()
    {
        $s = Set::of()
            ->add(24)
            ->add(42)
            ->add(66);

        $this->assertTrue(
            $s->equals(
                Set::of()
                    ->add(24)
                    ->add(66)
                    ->add(42),
            ),
        );
        $this->assertTrue(Set::of()->equals(Set::of()));
        $this->assertFalse(
            $s->equals(
                Set::of()
                    ->add(24)
                    ->add(66),
            ),
        );
    }

    public function testFilter()
    {
        $s = Set::of()
            ->add(1)
            ->add(2)
            ->add(3)
            ->add(4);

        $s2 = $s->filter(static function(int $v) {
            return $v % 2 === 0;
        });
        $this->assertNotSame($s, $s2);
        $this->assertInstanceOf(Set::class, $s2);
        $this->assertSame([1, 2, 3, 4], $s->toList());
        $this->assertSame([2, 4], $s2->toList());
    }

    public function testForeach()
    {
        $s = Set::of()
            ->add(1)
            ->add(2)
            ->add(3)
            ->add(4);
        $count = 0;

        $s->foreach(function(int $v) use (&$count) {
            $this->assertSame(++$count, $v);
        });
        $this->assertSame(4, $count);
    }

    public function testGroupBy()
    {
        $s = Set::of()
            ->add(1)
            ->add(2)
            ->add(3)
            ->add(4);

        $m = $s->groupBy(static function(int $v) {
            return $v % 2;
        });
        $this->assertInstanceOf(Map::class, $m);
        $this->assertSame([1, 0], $m->keys()->toList());
        $this->assertSame([1, 3], $this->get($m, 1)->toList());
        $this->assertSame([2, 4], $this->get($m, 0)->toList());
    }

    public function testMap()
    {
        $s = Set::of()
            ->add(1)
            ->add(2)
            ->add(3)
            ->add(4);

        $s2 = $s->map(static function(int $v) {
            return $v**2;
        });
        $this->assertNotSame($s, $s2);
        $this->assertInstanceOf(Set::class, $s2);
        $this->assertSame([1, 2, 3, 4], $s->toList());
        $this->assertSame([1, 4, 9, 16], $s2->toList());
    }

    public function testFlatMap()
    {
        $set = Set::of(1, 2, 3, 4);

1 of type integer is incompatible with the type Innmind\Immutable\V expected by parameter $values of Innmind\Immutable\Set::of().

        $set2 = $set->flatMap(static fn($i) => Set::of($i, $i + 2));

$i + 2 of type integer is incompatible with the type Innmind\Immutable\V expected by parameter $values of Innmind\Immutable\Set::of().

        $this->assertNotSame($set, $set2);
        $this->assertSame([1, 2, 3, 4], $set->toList());
        $this->assertSame([1, 3, 2, 4, 5, 6], $set2->toList());
    }

    public function testPartition()
    {
        $s = Set::of()
            ->add(1)
            ->add(2)
            ->add(3)
            ->add(4);

        $s2 = $s->partition(static function(int $v) {
            return $v % 2 === 0;
        });
        $this->assertNotSame($s, $s2);
        $this->assertInstanceOf(Map::class, $s2);
        $this->assertSame([1, 2, 3, 4], $s->toList());
        $this->assertInstanceOf(Set::class, $this->get($s2, true));
        $this->assertInstanceOf(Set::class, $this->get($s2, false));
        $this->assertSame([2, 4], $this->get($s2, true)->toList());
        $this->assertSame([1, 3], $this->get($s2, false)->toList());
    }

    public function testSort()
    {
        $s = Set::of()
            ->add(1)
            ->add(2)
            ->add(3)
            ->add(4);

        $s2 = $s->sort(static function(int $a, int $b) {
            return ($a < $b) ? 1 : -1;
        });
        $this->assertInstanceOf(Sequence::class, $s2);
        $this->assertSame([1, 2, 3, 4], $s->toList());
        $this->assertSame([4, 3, 2, 1], $s2->toList());
    }

    public function testMerge()
    {
        $s = Set::of()
            ->add(24)
            ->add(42)
            ->add(66);

        $this->assertTrue(
            $s
                ->merge(
                    Set::of()
                        ->add(24)
                        ->add(42)
                        ->add(66),
                )
                ->equals($s),
        );
        $this->assertSame(
            [24, 42, 66, 90, 114],
            $s->merge(
                Set::of()
                    ->add(90)
                    ->add(114),
            )->toList(),
        );
        $this->assertSame([24, 42, 66], $s->toList());
    }

    public function testReduce()
    {
        $s = Set::of()
            ->add(4)
            ->add(3)
            ->add(2);

        $v = $s->reduce(
            42,

42 of type integer is incompatible with the type Innmind\Immutable\R expected by parameter $carry of Innmind\Immutable\Set::reduce().

            static function(float $carry, int $value): float {
                return $carry / $value;
            },
        );

        $this->assertSame(1.75, $v);
        $this->assertSame([4, 3, 2], $s->toList());
    }

    public function testVariableSet()
    {
        $this->assertSame(
            ['foo', 42, 42.1, true, []],
            Set::of()
                ->add('foo')
                ->add(42)
                ->add(42.1)
                ->add(true)
                ->add([])
                ->toList(),
        );
    }

    public function testEmpty()
    {
        $this->assertTrue(Set::of()->empty());
        $this->assertFalse(Set::of(1)->empty());

1 of type integer is incompatible with the type Innmind\Immutable\V expected by parameter $values of Innmind\Immutable\Set::of().

    }

    public function testFind()
    {
        $sequence = Set::ints(1, 2, 3);

        $this->assertSame(
            1,
            $sequence->find(static fn($i) => $i === 1)->match(
                static fn($i) => $i,
                static fn() => null,
            ),
        );
        $this->assertSame(
            2,
            $sequence->find(static fn($i) => $i === 2)->match(
                static fn($i) => $i,
                static fn() => null,
            ),
        );
        $this->assertSame(
            3,
            $sequence->find(static fn($i) => $i === 3)->match(
                static fn($i) => $i,
                static fn() => null,
            ),
        );

        $this->assertNull(
            $sequence->find(static fn($i) => $i === 0)->match(
                static fn($i) => $i,
                static fn() => null,
            ),
        );
    }

    public function testMatches()
    {
        $set = Set::ints(1, 2, 3);

        $this->assertTrue($set->matches(static fn($i) => $i % 1 === 0));
        $this->assertFalse($set->matches(static fn($i) => $i % 2 === 0));
    }

    public function testAny()
    {
        $set = Set::ints(1, 2, 3);

        $this->assertTrue($set->any(static fn($i) => $i === 2));
        $this->assertFalse($set->any(static fn($i) => $i === 0));
    }

    public function testToList()
    {
        $this->assertSame(
            [1, 2, 3],
            Set::ints(1, 2, 3)->toList(),
        );
    }

    public function testPossibilityToCleanupResourcesWhenGeneratorStoppedBeforeEnd()
    {
        $cleanupCalled = false;
        $endReached = false;
        $started = 0;
        $set = Set::lazy(static function($registerCleanup) use (&$cleanupCalled, &$endReached, &$started) {
            ++$started;
            $file = \fopen(__FILE__, 'r');
            $registerCleanup(static function() use ($file, &$cleanupCalled) {
                \fclose($file);
                $cleanupCalled = true;
            });

            while (!\feof($file)) {
                $line = \fgets($file);

                yield $line;
            }

            $endReached = true;
            \fclose($file);
        });

        $line = $set
            ->map(static fn($line) => \trim($line))
            ->filter(static fn($line) => $line !== '')
            ->find(static fn($line) => \substr($line, -2) === '()')
            ->match(
                static fn($line) => $line,
                static fn() => null,
            );

        $this->assertSame('public function testInterface()', $line);
        $this->assertSame(1, $started);
        $this->assertTrue($cleanupCalled);
        $this->assertFalse($endReached);
    }

    public function testCleanupIsNotCalledWhenReachingTheEndOfTheGenerator()
    {
        $cleanupCalled = false;
        $endReached = false;
        $started = 0;
        $set = Set::lazy(static function($registerCleanup) use (&$cleanupCalled, &$endReached, &$started) {
            ++$started;
            $file = \fopen(__FILE__, 'r');
            $registerCleanup(static function() use ($file, &$cleanupCalled) {
                \fclose($file);
                $cleanupCalled = true;
            });

            while (!\feof($file)) {
                $line = \fgets($file);

                yield $line;
            }

            $endReached = true;
            \fclose($file);
        });

        $line = $set
            ->filter(static fn($line) => \is_string($line))
            ->map(static fn($line) => \trim($line))
            ->filter(static fn($line) => $line !== '')
            ->find(static fn($line) => $line === 'unknown')
            ->match(
                static fn($line) => $line,
                static fn() => null,
            );

        $this->assertNull($line);
        $this->assertSame(1, $started);
        $this->assertFalse($cleanupCalled);
        $this->assertTrue($endReached);
    }

    public function get($map, $index)
    {
        return $map->get($index)->match(
            static fn($value) => $value,
            static fn() => null,
        );
    }
}