CollectionTest.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @since         CakePHP(tm) v 3.0.0
 * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 */
namespace Cake\Test\TestCase\Utility;

use Cake\TestSuite\TestCase;
use Cake\Utility\Collection;

class CollectionTest extends TestCase {

/**
 * Tests that it is possible to convert an array into a collection
 *
 * @return void
 */
	public function testArrayIsWrapped() {
		$items = [1, 2, 3];
		$collection = new Collection($items);
		$this->assertEquals($items, iterator_to_array($collection));
	}

/**
 * Tests that it is possible to convert an iterator into a collection
 *
 * @return void
 */
	public function testIteratorIsWrapped() {
		$items = new \ArrayObject([1, 2, 3]);
		$collection = new Collection($items);
		$this->assertEquals(iterator_to_array($items), iterator_to_array($collection));
	}

/**
 * Test running a method over all elements in the collection
 *
 * @return void
 */
	public function testEeach() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->at(0))
			->method('__invoke')
			->with(1, 'a');
		$callable->expects($this->at(1))
			->method('__invoke')
			->with(2, 'b');
		$callable->expects($this->at(2))
			->method('__invoke')
			->with(3, 'c');
		$collection->each($callable);
	}

/**
 * Tests that it is possible to chain filter() as it returns a collection object
 *
 * @return void
 */
	public function testFilterChaining() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->once())
			->method('__invoke')
			->with(3, 'c');
		$filtered = $collection->filter(function ($value, $key, $iterator) {
			return $value > 2;
		});

		$this->assertInstanceOf('\Cake\Utility\Collection', $filtered);
		$filtered->each($callable);
	}

/**
 * Tests reject
 *
 * @return void
 */
	public function testReject() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$result = $collection->reject(function ($v, $k, $items) use ($collection) {
			$this->assertSame($collection, $items);
			return $v > 2;
		});
		$this->assertEquals(['a' => 1, 'b' => 2], iterator_to_array($result));
		$this->assertInstanceOf('\Cake\Utility\Collection', $result);
	}

/**
 * Tests every when the callback returns true for all elements
 *
 * @return void
 */
	public function testEveryReturnTrue() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->at(0))
			->method('__invoke')
			->with(1, 'a')
			->will($this->returnValue(true));
		$callable->expects($this->at(1))
			->method('__invoke')
			->with(2, 'b')
			->will($this->returnValue(true));
		$callable->expects($this->at(2))
			->method('__invoke')
			->with(3, 'c')
			->will($this->returnValue(true));
		$this->assertTrue($collection->every($callable));
	}

/**
 * Tests every when the callback returns false for one of the elements
 *
 * @return void
 */
	public function testEveryReturnFalse() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->at(0))
			->method('__invoke')
			->with(1, 'a')
			->will($this->returnValue(true));
		$callable->expects($this->at(1))
			->method('__invoke')
			->with(2, 'b')
			->will($this->returnValue(false));
		$callable->expects($this->exactly(2))->method('__invoke');
		$this->assertFalse($collection->every($callable));
	}

/**
 * Tests some() when one of the calls return true
 *
 * @return void
 */
	public function testSomeReturnTrue() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->at(0))
			->method('__invoke')
			->with(1, 'a')
			->will($this->returnValue(false));
		$callable->expects($this->at(1))
			->method('__invoke')
			->with(2, 'b')
			->will($this->returnValue(true));
		$callable->expects($this->exactly(2))->method('__invoke');
		$this->assertTrue($collection->some($callable));
	}

/**
 * Tests some() when none of the calls return true
 *
 * @return void
 */
	public function testSomeReturnFalse() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->at(0))
			->method('__invoke')
			->with(1, 'a')
			->will($this->returnValue(false));
		$callable->expects($this->at(1))
			->method('__invoke')
			->with(2, 'b')
			->will($this->returnValue(false));
		$callable->expects($this->at(2))
			->method('__invoke')
			->with(3, 'c')
			->will($this->returnValue(false));
		$this->assertFalse($collection->some($callable));
	}

/**
 * Tests contains
 *
 * @return void
 */
	public function testContains() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$this->assertTrue($collection->contains(2));
		$this->assertTrue($collection->contains(1));
		$this->assertFalse($collection->contains(10));
		$this->assertFalse($collection->contains('2'));
	}

/**
 * Tests map
 *
 * @return void
 */
	public function testMap() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$map = $collection->map(function($v, $k, $it) use ($collection) {
			$this->assertSame($collection, $it);
			return $v * $v;
		});
		$this->assertInstanceOf('\Cake\Utility\Iterator\ReplaceIterator', $map);
		$this->assertEquals(['a' => 1, 'b' => 4, 'c' => 9], iterator_to_array($map));
	}

/**
 * Tests reduce
 *
 * @return void
 */
	public function testReduce() {
		$items = ['a' => 1, 'b' => 2, 'c' => 3];
		$collection = new Collection($items);
		$callable = $this->getMock('stdClass', ['__invoke']);
		$callable->expects($this->at(0))
			->method('__invoke')
			->with(10, 1, 'a')
			->will($this->returnValue(11));
		$callable->expects($this->at(1))
			->method('__invoke')
			->with(11, 2, 'b')
			->will($this->returnValue(13));
		$callable->expects($this->at(2))
			->method('__invoke')
			->with(13, 3, 'c')
			->will($this->returnValue(16));
		$this->assertEquals(16, $collection->reduce($callable, 10));
	}
}