EntityDumpIteratorTest::newDataValueDeserializer() - Code Metrics - Inspection of "Remove IDE fail" - JeroenDeDauw/JsonDumpReader - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 71bd60...6cfb4f )

by Jeroen De

created 2018-08-10 16:49 UTC

EntityDumpIteratorTest::newDataValueDeserializer() A

↳ Parent: EntityDumpIteratorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare( strict_types = 1 );

namespace Tests\Wikibase\JsonDumpReader;

use DataValues\BooleanValue;
use DataValues\Deserializers\DataValueDeserializer;
use DataValues\Geo\Values\GlobeCoordinateValue;
use DataValues\MonolingualTextValue;
use DataValues\MultilingualTextValue;
use DataValues\NumberValue;
use DataValues\QuantityValue;
use DataValues\StringValue;
use DataValues\TimeValue;
use DataValues\UnknownValue;
use Iterator;
use PHPUnit\Framework\TestCase;
use Wikibase\DataModel\DeserializerFactory;
use Wikibase\DataModel\Entity\BasicEntityIdParser;
use Wikibase\DataModel\Entity\EntityIdValue;
use Wikibase\JsonDumpReader\Iterator\EntityDumpIterator;
use Wikibase\JsonDumpReader\JsonDumpFactory;
use Wikibase\JsonDumpReader\Reader\ExtractedDumpReader;

/**
 * @covers \Wikibase\JsonDumpReader\Iterator\EntityDumpIterator
 * @covers \Wikibase\JsonDumpReader\JsonDumpFactory
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class EntityDumpIteratorTest extends TestCase {

	private function newIteratorForFile( $filePath, callable $onError = null ) {
		return ( new JsonDumpFactory() )->newEntityDumpIterator(
			new ExtractedDumpReader( $filePath ),
			$this->newCurrentEntityDeserializer(),
			$onError
		);
	}

	private function newCurrentEntityDeserializer() {
		$factory = new DeserializerFactory(
			$this->newDataValueDeserializer(),
			new BasicEntityIdParser()
		);

		return $factory->newEntityDeserializer();
	}

	private function newDataValueDeserializer() {
		$dataValueClasses = [
			'boolean' => BooleanValue::class,
			'number' => NumberValue::class,
			'string' => StringValue::class,
			'unknown' => UnknownValue::class,
			'globecoordinate' => GlobeCoordinateValue::class,
			'monolingualtext' => MonolingualTextValue::class,
			'multilingualtext' => MultilingualTextValue::class,
			'quantity' => QuantityValue::class,
			'time' => TimeValue::class,
			'wikibase-entityid' => EntityIdValue::class,
		];

		return new DataValueDeserializer( $dataValueClasses );
	}

	private function assertFindsEntities( array $expectedIds, Iterator $dumpIterator, $message = '' ) {
		$actualIds = [];

		foreach ( $dumpIterator as $entity ) {
			$actualIds[] = $entity->getId()->getSerialization();
		}

		$this->assertEquals( $expectedIds, $actualIds, $message );
	}

	public function testGivenFileWithNoEntities_noEntitiesAreReturned() {
		$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getEmptyDumpPath() );

		$this->assertFindsEntities( [], $iterator );
	}

	public function testGivenFileWithOneEntity_oneEntityIsFound() {
		$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getOneItemDumpPath() );

		$this->assertFindsEntities( [ 'Q1' ], $iterator );
	}

	public function testGivenFileWithFiveEntities_fiveEntityAreFound() {
		$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getFiveEntitiesDumpPath() );

		$this->assertFindsEntities( [ 'Q1', 'Q8', 'P16', 'P19', 'P22' ], $iterator );
	}

	public function testGivenFileWithInvalidEntity_noEntityIsFound() {
		$iterator = $this->newIteratorForFile( __DIR__ . '/../data/invalid-item.json' );
		$this->assertFindsEntities( [], $iterator );
	}

	public function testGivenFileWithInvalidEntities_validEntitiesAreFound() {
		$iterator = $this->newIteratorForFile( __DIR__ . '/../data/3valid-2invalid.json' );
		$this->assertFindsEntities( [ 'Q1', 'P16', 'P22' ], $iterator );
	}

	public function testCanDoMultipleIterations() {
		$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getFiveEntitiesDumpPath() );

		$this->assertFindsEntities( [ 'Q1', 'Q8', 'P16', 'P19', 'P22' ], $iterator, 'first iteration' );
		$this->assertFindsEntities( [ 'Q1', 'Q8', 'P16', 'P19', 'P22' ], $iterator, 'second iteration' );
	}

	public function testInitialPosition() {
		$reader = new ExtractedDumpReader( ( new \JsonDumpData() )->getFiveEntitiesDumpPath() );

		$iterator = new EntityDumpIterator(
			( new JsonDumpFactory() )->newObjectDumpIterator( $reader ),
			$this->newCurrentEntityDeserializer()
		);

		$iterator->rewind();
		$this->assertSame( 'Q1', $iterator->current()->getId()->getSerialization() );

		$iterator->next();
		$this->assertSame( 'Q8', $iterator->current()->getId()->getSerialization() );

		$newReader = new ExtractedDumpReader(
			( new \JsonDumpData() )->getFiveEntitiesDumpPath(),
			$reader->getPosition()
		);

		$newIterator = new EntityDumpIterator(
			( new JsonDumpFactory() )->newObjectDumpIterator( $newReader ),
			$this->newCurrentEntityDeserializer()
		);

		$this->assertFindsEntities( [ 'P16', 'P19', 'P22' ], $newIterator );
	}

	public function testGivenFileWithInvalidEntities_errorsAreReported() {
		$errors = [];

		$iterator = $this->newIteratorForFile(
			__DIR__ . '/../data/3valid-2invalid.json',
			function( $errorMessage ) use ( &$errors ) {
				$errors[] = $errorMessage;
			}
		);

		$iterator->rewind();
		while ( $iterator->valid() ) {
			$iterator->next();
		}

		$this->assertContainsOnly( 'string', $errors );
		$this->assertCount( 2, $errors );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	public function testGivenFileWithInvalidJsonLine_errorIsRecorded() {
		$errors = [];

		$iterator = $this->newIteratorForFile(
			__DIR__ . '/../data/invalid-json.json',
			function( $errorMessage ) use ( &$errors ) {
				$errors[] = $errorMessage;
			}
		);

		iterator_to_array( $iterator );

		$this->assertContainsOnly( 'string', $errors );
		$this->assertCount( 1, $errors );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

}

1			<?php
2
3			declare( strict_types = 1 );
4
5			namespace Tests\Wikibase\JsonDumpReader;
6
7			use DataValues\BooleanValue;
8			use DataValues\Deserializers\DataValueDeserializer;
9			use DataValues\Geo\Values\GlobeCoordinateValue;
10			use DataValues\MonolingualTextValue;
11			use DataValues\MultilingualTextValue;
12			use DataValues\NumberValue;
13			use DataValues\QuantityValue;
14			use DataValues\StringValue;
15			use DataValues\TimeValue;
16			use DataValues\UnknownValue;
17			use Iterator;
18			use PHPUnit\Framework\TestCase;
19			use Wikibase\DataModel\DeserializerFactory;
20			use Wikibase\DataModel\Entity\BasicEntityIdParser;
21			use Wikibase\DataModel\Entity\EntityIdValue;
22			use Wikibase\JsonDumpReader\Iterator\EntityDumpIterator;
23			use Wikibase\JsonDumpReader\JsonDumpFactory;
24			use Wikibase\JsonDumpReader\Reader\ExtractedDumpReader;
25
26			/**
27			* @covers \Wikibase\JsonDumpReader\Iterator\EntityDumpIterator
28			* @covers \Wikibase\JsonDumpReader\JsonDumpFactory
29			*
30			* @licence GNU GPL v2+
31			* @author Jeroen De Dauw < [email protected] >
32			*/
33			class EntityDumpIteratorTest extends TestCase {
34
35			private function newIteratorForFile( $filePath, callable $onError = null ) {
36			return ( new JsonDumpFactory() )->newEntityDumpIterator(
37			new ExtractedDumpReader( $filePath ),
38			$this->newCurrentEntityDeserializer(),
39			$onError
40			);
41			}
42
43			private function newCurrentEntityDeserializer() {
44			$factory = new DeserializerFactory(
45			$this->newDataValueDeserializer(),
46			new BasicEntityIdParser()
47			);
48
49			return $factory->newEntityDeserializer();
50			}
51
52			private function newDataValueDeserializer() {
53			$dataValueClasses = [
54			'boolean' => BooleanValue::class,
55			'number' => NumberValue::class,
56			'string' => StringValue::class,
57			'unknown' => UnknownValue::class,
58			'globecoordinate' => GlobeCoordinateValue::class,
59			'monolingualtext' => MonolingualTextValue::class,
60			'multilingualtext' => MultilingualTextValue::class,
61			'quantity' => QuantityValue::class,
62			'time' => TimeValue::class,
63			'wikibase-entityid' => EntityIdValue::class,
64			];
65
66			return new DataValueDeserializer( $dataValueClasses );
67			}
68
69			private function assertFindsEntities( array $expectedIds, Iterator $dumpIterator, $message = '' ) {
70			$actualIds = [];
71
72			foreach ( $dumpIterator as $entity ) {
73			$actualIds[] = $entity->getId()->getSerialization();
74			}
75
76			$this->assertEquals( $expectedIds, $actualIds, $message );
77			}
78
79			public function testGivenFileWithNoEntities_noEntitiesAreReturned() {
80			$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getEmptyDumpPath() );
81
82			$this->assertFindsEntities( [], $iterator );
83			}
84
85			public function testGivenFileWithOneEntity_oneEntityIsFound() {
86			$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getOneItemDumpPath() );
87
88			$this->assertFindsEntities( [ 'Q1' ], $iterator );
89			}
90
91			public function testGivenFileWithFiveEntities_fiveEntityAreFound() {
92			$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getFiveEntitiesDumpPath() );
93
94			$this->assertFindsEntities( [ 'Q1', 'Q8', 'P16', 'P19', 'P22' ], $iterator );
95			}
96
97			public function testGivenFileWithInvalidEntity_noEntityIsFound() {
98			$iterator = $this->newIteratorForFile( __DIR__ . '/../data/invalid-item.json' );
99			$this->assertFindsEntities( [], $iterator );
100			}
101
102			public function testGivenFileWithInvalidEntities_validEntitiesAreFound() {
103			$iterator = $this->newIteratorForFile( __DIR__ . '/../data/3valid-2invalid.json' );
104			$this->assertFindsEntities( [ 'Q1', 'P16', 'P22' ], $iterator );
105			}
106
107			public function testCanDoMultipleIterations() {
108			$iterator = $this->newIteratorForFile( ( new \JsonDumpData() )->getFiveEntitiesDumpPath() );
109
110			$this->assertFindsEntities( [ 'Q1', 'Q8', 'P16', 'P19', 'P22' ], $iterator, 'first iteration' );
111			$this->assertFindsEntities( [ 'Q1', 'Q8', 'P16', 'P19', 'P22' ], $iterator, 'second iteration' );
112			}
113
114			public function testInitialPosition() {
115			$reader = new ExtractedDumpReader( ( new \JsonDumpData() )->getFiveEntitiesDumpPath() );
116
117			$iterator = new EntityDumpIterator(
118			( new JsonDumpFactory() )->newObjectDumpIterator( $reader ),
119			$this->newCurrentEntityDeserializer()
120			);
121
122			$iterator->rewind();
123			$this->assertSame( 'Q1', $iterator->current()->getId()->getSerialization() );
124
125			$iterator->next();
126			$this->assertSame( 'Q8', $iterator->current()->getId()->getSerialization() );
127
128			$newReader = new ExtractedDumpReader(
129			( new \JsonDumpData() )->getFiveEntitiesDumpPath(),
130			$reader->getPosition()
131			);
132
133			$newIterator = new EntityDumpIterator(
134			( new JsonDumpFactory() )->newObjectDumpIterator( $newReader ),
135			$this->newCurrentEntityDeserializer()
136			);
137
138			$this->assertFindsEntities( [ 'P16', 'P19', 'P22' ], $newIterator );
139			}
140
141			public function testGivenFileWithInvalidEntities_errorsAreReported() {
142			$errors = [];
143
144			$iterator = $this->newIteratorForFile(
145			__DIR__ . '/../data/3valid-2invalid.json',
146			function( $errorMessage ) use ( &$errors ) {
147			$errors[] = $errorMessage;
148			}
149			);
150
151			$iterator->rewind();
152			while ( $iterator->valid() ) {
153			$iterator->next();
154			}
155
156			$this->assertContainsOnly( 'string', $errors );
157			$this->assertCount( 2, $errors );
			0 ignored issues – show Documentation introduced 2018-08-10 16:14 UTC by Report Bug Copy Issue Report `$errors` is of type `array`, but the function expects a `object<Countable>\|object...nit\Framework\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
158			}
159
160			public function testGivenFileWithInvalidJsonLine_errorIsRecorded() {
161			$errors = [];
162
163			$iterator = $this->newIteratorForFile(
164			__DIR__ . '/../data/invalid-json.json',
165			function( $errorMessage ) use ( &$errors ) {
166			$errors[] = $errorMessage;
167			}
168			);
169
170			iterator_to_array( $iterator );
171
172			$this->assertContainsOnly( 'string', $errors );
173			$this->assertCount( 1, $errors );
			0 ignored issues – show Documentation introduced 2018-08-10 16:14 UTC by Report Bug Copy Issue Report `$errors` is of type `array`, but the function expects a `object<Countable>\|object...nit\Framework\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
174			}
175
176			}

JeroenDeDauw / JsonDumpReader

Push — master ( 71bd60...6cfb4f )

EntityDumpIteratorTest::newDataValueDeserializer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like