summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/Mock/IteratorMockBuilder.php
blob: 721f4b366eaab641888310aa37a2e3efeb26d0ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<?php

namespace SMW\Tests\Utils\Mock;

use RuntimeException;

/**
 * Convenience mock builder for Iterator classes
 * @group semantic-mediawiki
 *
 * @license GNU GPL v2+
 * @since 2.0
 *
 * @author mwjames
 */
class IteratorMockBuilder extends \PHPUnit_Framework_TestCase {

	private $iteratorClass;
	private $items = [];
	private $methods = [];
	private $counter = 0;

	/**
	 * @since  2.0
	 *
	 * @param string $iteratorClass
	 *
	 * @return IteratorMockBuilder
	 */
	public function setClass( $iteratorClass ) {
		$this->iteratorClass = $iteratorClass;
		return $this;
	}

	/**
	 * @since  2.0
	 *
	 * @param array $items
	 *
	 * @return IteratorMockBuilder
	 */
	public function with( array $items ) {
		$this->items = $items;
		return $this;
	}

	/**
	 * @since  2.5
	 *
	 * @param array $methods
	 *
	 * @return IteratorMockBuilder
	 */
	public function setMethods( array $methods ) {
		$this->methods = $methods;
		return $this;
	}

	/**
	 * @note When other methods called before the actual current/next then
	 * set the counter to ensure the starting point matches the expected
	 * InvokeCount.
	 *
	 * @since  2.5
	 *
	 * @param integer $num
	 *
	 * @return IteratorMockBuilder
	 */
	public function incrementInvokedCounterBy( $num ) {
		$this->counter += $num;
		return $this;
	}

	/**
	 * @since  2.0
	 *
	 * @return PHPUnit_Framework_MockObject_MockObject
	 * @throws RuntimeException
	 */
	public function getMockForIterator() {

		$instance = $this->getMockBuilder( $this->iteratorClass )
			->disableOriginalConstructor()
			->setMethods( $this->methods )
			->getMock();

		if ( !$instance instanceof \Iterator ) {
			throw new RuntimeException( "Instance is not an Iterator" );
		}

		$instance->expects( $this->at( $this->counter++ ) )
			->method( 'rewind' );

		foreach ( $this->items as $key => $value ) {

			$instance->expects( $this->at( $this->counter++ ) )
				->method( 'valid' )
				->will( $this->returnValue( true ) );

			$instance->expects( $this->at( $this->counter++ ) )
				->method( 'current' )
				->will( $this->returnValue( $value ) );

			$instance->expects( $this->at( $this->counter++ ) )
				->method( 'next' );
		}

		$instance->expects( $this->at( $this->counter++ ) )
			->method( 'valid' )
			->will( $this->returnValue( false ) );

		return $instance;
	}

	/**
	 * @since  2.0
	 *
	 * @return integer
	 */
	public function getLastCounter() {
		return $this->counter;
	}

}