summaryrefslogtreecommitdiff
blob: 21cbc9d0da685957d451029e4c4aba7c2614ef81 (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php

namespace SMW\Tests\Util;

use SMW\DIWikiPage;

use SMWDataValue as DataValue;
use SMWDataItem as DataItem;
use SMWQueryResult as QueryResult;

use Closure;
use RuntimeException;

/**
 * @license GNU GPL v2+
 * @since   2.0
 *
 * @author mwjames
 */
class QueryResultValidator extends \PHPUnit_Framework_Assert {

	private $dataValueValidationMethod = null;

	/**
	 * @since 2.0
	 *
	 * @param  mixed $expected
	 * @param  QueryResult $queryResult
	 *
	 * @throws RuntimeException
	 */
	public function assertThatQueryResultContains( $expected, QueryResult $queryResult ) {

		if ( $expected instanceOf DataValue ) {
			return $this->assertThatDataValueIsSet( $expected, $queryResult );
		}

		if ( $expected instanceOf DataItem ) {
			return $this->assertThatDataItemIsSet( $expected, $queryResult );
		}

		throw new RuntimeException( "Expected object is unknown or not registered" );
	}

	/**
	 * @since 2.0
	 *
	 * @param  DataValue $expectedDataValue
	 * @param  QueryResult $queryResult
	 */
	public function assertThatDataValueIsSet( DataValue $expectedDataValue, QueryResult $queryResult ) {

		if ( $this->dataValueValidationMethod === null ) {
			$this->useWikiValueForDataValueValidation();
		}

		$assertThatDataValueIsSet = false;
		$this->assertEmpty( $queryResult->getErrors() );

		while ( $resultArray = $queryResult->getNext() ) {
			foreach ( $resultArray as $result ) {
				while ( ( $dataValue = $result->getNextDataValue() ) !== false ) {
					if ( call_user_func_array( $this->dataValueValidationMethod, array( $expectedDataValue, $dataValue ) ) ) {
						$assertThatDataValueIsSet = true;
					}
				}
			}
		}

		$this->assertTrue( $assertThatDataValueIsSet, 'Asserts that the expected DataValue is set' );
	}

	/**
	 * @since 2.0
	 *
	 * @param  DataItem $expectedDataItem
	 * @param  QueryResult $queryResult
	 */
	public function assertThatDataItemIsSet( DataItem $expectedDataItem, QueryResult $queryResult ) {

		$assertThatDataItemIsSet = false;
		$this->assertEmpty( $queryResult->getErrors() );

		while ( $resultArray = $queryResult->getNext() ) {
			foreach ( $resultArray as $result ) {
				while ( ( $dataItem = $result->getNextDataItem() ) !== false ) {
					$this->assertEquals( $expectedDataItem, $dataItem );
					$assertThatDataItemIsSet = true;
				}
			}
		}

		$this->assertTrue( $assertThatDataItemIsSet, 'Asserts that the expected DataItem is set'  );
	}

	/**
	 * @since 2.0
	 *
	 * @param  mixed $expected
	 * @param  QueryResult $queryResult
	 */
	public function assertThatQueryResultHasSubjects( $expectedSubjects, QueryResult $queryResult ) {

		$expectedSubjects = is_array( $expectedSubjects ) ? $expectedSubjects : array( $expectedSubjects );
		$expectedToCount  = count( $expectedSubjects );
		$actualComparedToCount = 0;

		$assertThatQueryResultHasSubjects = false;

		$this->assertEmpty( $queryResult->getErrors() );

		foreach ( $queryResult->getResults() as $resultSubject ) {
			foreach ( $expectedSubjects as $expectedSubject ) {

				if ( $expectedSubject instanceOf DIWikiPage && $expectedSubject->equals( $resultSubject ) ) {
					$actualComparedToCount++;
					$assertThatQueryResultHasSubjects = true;
				}
			}
		}

		if ( $expectedToCount > 0 ) {
			$this->assertTrue( $assertThatQueryResultHasSubjects, 'Asserts that a subject is set' );
			$this->assertEquals( $expectedToCount, $actualComparedToCount, 'Asserts that all listed subjects are set' );
		}
	}

	/**
	 * @since 2.0
	 *
	 * @param  Closure $validationMethod
	 *
	 * @return QueryResultValidator
	 */
	public function registerCustomMethodForDataValueValidation( Closure $validationMethod ) {
		$this->dataValueValidationMethod = $validationMethod;
		return $this;
	}

	/**
	 * @since 2.0
	 *
	 * @return QueryResultValidator
	 */
	public function useWikiValueForDataValueValidation() {

		$this->dataValueValidationMethod = function( DataValue $expectedDataValue, DataValue $dataValue ) {
			return $expectedDataValue->getWikiValue() === $dataValue->getWikiValue();
		};

		return $this;
	}

}