MockIterator.php

<?php

namespace DMarynicz\Tests;

use ArrayIterator;
use Iterator;
use PHPUnit\Framework\MockObject\MockObject;

trait MockIterator
{
    /**
     * @param MockObject|Iterator<mixed> $iterator
     * @param array<mixed>               $items
     * @param bool                       $includeCallsToKey
     */
    public function mockIteratorItems(Iterator $iterator, array $items, $includeCallsToKey = false): void
    {
        $arrayIterator = new ArrayIterator($items);

        $iterator
            ->method('current')
            ->willReturnCallback(static function () use ($arrayIterator) {
                return $arrayIterator->current();
            });
        $iterator
            ->method('key')
            ->willReturnCallback(static function () use ($arrayIterator) {
                return $arrayIterator->key();
            });

        $iterator
            ->method('next')
            ->willReturnCallback(static function () use ($arrayIterator): void {
                $arrayIterator->next();
            });

        $iterator
            ->method('rewind')
            ->willReturnCallback(static function () use ($arrayIterator): void {
                $arrayIterator->rewind();
            });

        $iterator
            ->method('valid')
            ->willReturnCallback(static function () use ($arrayIterator): bool {
                return $arrayIterator->valid();
            });
    }
}