WMDE\IterableFunction\Tests\Unit\IterableCombineTest::newGeneratorAggregate()

Complexity

Conditions	1
Paths	1

Size

Total Lines

11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	IterableCombineTest.php$0 ➔ __construct()	0	3	1
A	IterableCombineTest.php$0 ➔ getIterator()	0	3	1

<?php

declare( strict_types = 1 );

namespace WMDE\IterableFunction\Tests\Unit;

use IteratorAggregate;
use PHPUnit\Framework\TestCase;

/**
 * @license GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class IterableCombineTest extends TestCase {

	public function testTakesDifferentIterableTypes() {
		$combinedValues = iterable_merge(
			[ 1, 2 ],
			new \ArrayIterator( [ 3, 4 ] ),
			$this->newGeneratorAggregate( [ 5, 6 ] )
		);

		$this->assertCount( 6, $combinedValues );

$combinedValues is of type object<Generator>, but the function expects a object<Countable>|object<PHPUnit\Framework\iterable>.

	}

	private function newGeneratorAggregate( iterable $values ): \IteratorAggregate {
		return new class( $values ) implements IteratorAggregate {
			private $values;
			public function __construct( iterable $values ) {
				$this->values = $values;
			}
			public function getIterator() {
				yield from $this->values;
			}
		};
	}

	public function testNumericKeysDoNotOverrideEachOther() {
		$combinedValues = iterable_merge(
			[ 1, 2 ],
			[ 3, 4 ]
		);

		$this->assertSame( [ 1, 2, 3, 4 ], iterator_to_array( $combinedValues ) );
	}

	public function testStringKeysNotOverrideEachOther() {
		$combinedValues = iterable_merge(
			[ 'key' => 1 ],
			[ 'key' => 2 ],
			[ 'such' => 3 ]
		);

		$this->assertSame( [ 'key' => 2, 'such' => 3 ], iterator_to_array( $combinedValues ) );
	}

	/**
	 * @dataProvider arrayInputsProvider
	 */
	public function testEquivalencyWithArrayMergeAfterIteratorToArray( array ...$arrays ) {
		$this->assertSame(
			array_merge( ...$arrays ),
			iterator_to_array( iterable_merge( ...$arrays ) )
		);
	}

	public function arrayInputsProvider() {
		yield 'empty arrays' => [
			[],
			[]
		];

		yield 'numeric indexed arrays' => [
			[ 'a', 'b' ],
			[ 'c', 'd' ]
		];

		yield 'special numeric indexes' => [
			[ 10 => 'a', 'b' ],
			[ 'c', 20 => 'd' ]
		];

		yield 'string indexes mixed with numeric ones' => [
			[ 'foo' => 'a', 'b' ],
			[ 'c', 'bar' => 'd' ]
		];

		yield 'duplicate keys' => [
			[ 'foo' => 'a', 'b', 42 => 'x' ],
			[ 'c', 'foo' => 'd', 42 => 'y' ]
		];

		yield 'one array' => [
			[ 'c', 'foo' => 'd', 42 => 'y' ]
		];

		yield 'three arrays' => [
			[ 'such' ],
			[ 'foo' => 'bar' ],
			[ 42 ]
		];
	}

	public function testNoArgumentsResultInEmptyGenerator() {
		$this->assertSame( [], iterator_to_array( iterable_merge() ) );
	}

}