Maps\Tests\Integration\Parser\DisplayMapTest

Complexity

Total Complexity

31

Size/Duplication

Total Lines	274
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	4	1
A	tearDown()	0	4	1
A	testMapIdIsSet()	0	6	1
A	parse()	0	5	1
A	testServiceSelectionWorks()	0	6	1
A	testSingleCoordinatesAreIncluded()	0	6	1
A	testMultipleCoordinatesAreIncluded()	0	6	1
A	testWhenValidZoomIsSpecified_itGetsUsed()	0	6	1
A	testWhenZoomIsNotSpecifiedAndThereIsOnlyOneLocation_itIsDefaulted()	0	6	1
A	testWhenZoomIsNotSpecifiedAndThereAreMultipleLocations_itIsDefaulted()	0	6	1
A	testWhenZoomIsInvalid_itIsDefaulted()	0	6	1
A	testTagIsRendered()	0	6	1
A	testTagServiceParameterIsUsed()	0	6	1
A	testWhenThereAreNoLocations_locationsArrayIsEmpty()	0	6	1
A	testLocationTitleGetsIncluded()	0	6	1
A	testLocationDescriptionGetsIncluded()	0	6	1
A	testRectangleDisplay()	0	6	1
A	testCircleDisplay()	0	6	1
A	testRectangleFillOpacityIsUsed()	0	6	1
A	testRectangleFillColorIsUsed()	0	6	1
A	testServiceSelectionWorksWhenItIsPrecededByMultipleParameters()	0	8	1
A	testDimensionDefaultsAsInteger()	0	14	1
A	testWhenIconParameterIsProvidedButEmpty_itIsDefaulted()	0	8	1
A	testWhenLocationHasNoTitleAndText_textFieldIsEmptyString()	0	6	1
A	testGeoJsonSourceForFile()	0	10	1
A	skipOn131()	0	5	2
A	testGeoJsonSourceForPage()	0	19	1
A	testGoogleMapsKmlFiltersInvalidFileNames()	0	8	1
A	testLeafletImageLayersIgnoresNotFoundImages()	0	8	1
A	testLeafletImageLayersIgnoresImageUrls()	0	8	1

<?php

declare( strict_types = 1 );

namespace Maps\Tests\Integration\Parser;

use Maps\MediaWiki\Content\GeoJsonContent;
use PHPUnit\Framework\TestCase;

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

	private $originalHeight;
	private $originalWidth;

	public function setUp(): void {
		$this->originalHeight = $GLOBALS['egMapsMapHeight'];
		$this->originalWidth = $GLOBALS['egMapsMapWidth'];
	}

	public function tearDown(): void {
		$GLOBALS['egMapsMapHeight'] = $this->originalHeight;
		$GLOBALS['egMapsMapWidth'] = $this->originalWidth;
	}

	public function testMapIdIsSet() {
		$this->assertContains(
			'id="map_leaflet_',
			$this->parse( '{{#display_map:1,1|service=leaflet}}' )
		);
	}

	private function parse( string $textToParse ): string {
		$parser = new \Parser();

		return $parser->parse( $textToParse, \Title::newMainPage(), new \ParserOptions() )->getText();
	}

	public function testServiceSelectionWorks() {
		$this->assertContains(
			'maps-googlemaps3',
			$this->parse( '{{#display_map:1,1|service=google}}' )
		);
	}

	public function testSingleCoordinatesAreIncluded() {
		$this->assertContains(
			'"lat":1,"lon":1',
			$this->parse( '{{#display_map:1,1}}' )
		);
	}

	public function testMultipleCoordinatesAreIncluded() {
		$result = $this->parse( '{{#display_map:1,1; 4,2}}' );

		$this->assertContains( '"lat":1,"lon":1', $result );
		$this->assertContains( '"lat":4,"lon":2', $result );
	}

	public function testWhenValidZoomIsSpecified_itGetsUsed() {
		$this->assertContains(
			'"zoom":5',
			$this->parse( '{{#display_map:1,1|service=google|zoom=5}}' )
		);
	}

	public function testWhenZoomIsNotSpecifiedAndThereIsOnlyOneLocation_itIsDefaulted() {
		$this->assertContains(
			'"zoom":' . $GLOBALS['egMapsGMaps3Zoom'],
			$this->parse( '{{#display_map:1,1|service=google}}' )
		);
	}

	public function testWhenZoomIsNotSpecifiedAndThereAreMultipleLocations_itIsDefaulted() {
		$this->assertContains(
			'"zoom":false',
			$this->parse( '{{#display_map:1,1;2,2|service=google}}' )
		);
	}

	public function testWhenZoomIsInvalid_itIsDefaulted() {
		$this->assertContains(
			'"zoom":' . $GLOBALS['egMapsGMaps3Zoom'],
			$this->parse( '{{#display_map:1,1|service=google|zoom=tomato}}' )
		);
	}

	public function testTagIsRendered() {
		$this->assertContains(
			'"lat":1,"lon":1',
			$this->parse( '<display_map>1,1</display_map>' )
		);
	}

	public function testTagServiceParameterIsUsed() {
		$this->assertContains(
			'maps-googlemaps3',
			$this->parse( '<display_map service="google">1,1</display_map>' )
		);
	}

	public function testWhenThereAreNoLocations_locationsArrayIsEmpty() {
		$this->assertContains(
			'"locations":[]',
			$this->parse( '{{#display_map:}}' )
		);
	}

	public function testLocationTitleGetsIncluded() {
		$this->assertContains(
			'"title":"title',
			$this->parse( '{{#display_map:1,1~title}}' )
		);
	}

	public function testLocationDescriptionGetsIncluded() {
		$this->assertContains(
			'such description',
			$this->parse( '{{#display_map:1,1~title~such description}}' )
		);
	}

	public function testRectangleDisplay() {
		$this->assertContains(
			'"title":"title',
			$this->parse( '{{#display_map:rectangles=1,1:2,2~title}}' )
		);
	}

	public function testCircleDisplay() {
		$this->assertContains(
			'"title":"title',
			$this->parse( '{{#display_map:circles=1,1:2~title}}' )
		);
	}

	public function testRectangleFillOpacityIsUsed() {
		$this->assertContains(
			'"fillOpacity":"fill opacity"',
			$this->parse( '{{#display_map:rectangles=1,1:2,2~title~text~color~opacity~thickness~fill color~fill opacity}}' )
		);
	}

	public function testRectangleFillColorIsUsed() {
		$this->assertContains(
			'"fillColor":"fill color"',
			$this->parse( '{{#display_map:rectangles=1,1:2,2~title~text~color~opacity~thickness~fill color~fill opacity}}' )
		);
	}

	public function testServiceSelectionWorksWhenItIsPrecededByMultipleParameters() {
		$this->assertContains(
			'maps-googlemaps3',
			$this->parse(
				"{{#display_map:rectangles=\n  1,1:2,2~title~text~color\n| scrollwheelzoom=off\n| service = google}}"
			)
		);
	}

	public function testDimensionDefaultsAsInteger() {
		$GLOBALS['egMapsMapHeight'] = 420;
		$GLOBALS['egMapsMapWidth'] = 230;

		$this->assertContains(
			'height: 420px;',
			$this->parse( '{{#display_map:1,1}}' )
		);

		$this->assertContains(
			'width: 230px;',
			$this->parse( '{{#display_map:1,1}}' )
		);
	}

	// TODO: need DI to test
//	public function testWhenLocationHasVisitedIconModifier_itIsUsed() {
//		$this->assertContains(
//			'"visitedicon":"VisitedIcon.png"',
//			$this->parse( '{{#display_map:1,1~title~text~icon~group~inline label~VisitedIcon.png}}' )
//		);
//	}
//
//	public function testWhenLocationHasVisitedIconModifierWithNamespacePrefix_thePrefixGetsRemoved() {
//		$this->assertContains(MapsMapperTest
//			'"visitedicon":"VisitedIcon.png"',
//			$this->parse( '{{#display_map:1,1~title~text~icon~group~inline label~File:VisitedIcon.png}}' )
//		);
//	}
//
//	public function testWhenVisitedIconParameterIsProvidedWithNamespacePrefix_thePrefixGetsRemoved() {
//		$this->assertContains(
//			'"visitedicon":"VisitedIcon.png"',
//			$this->parse( '{{#display_map:1,1|visitedicon=File:VisitedIcon.png}}' )
//		);
//	}
//
//	public function testWhenLocationHasIconModifierWithNamespacePrefix_thePrefixGetsRemoved() {
//		$this->assertContains(
//			'"icon":"Icon.png"',
//			$this->parse( '{{#display_map:1,1~title~text~File:Icon.png}}' )
//		);
//	}

	public function testWhenIconParameterIsProvidedButEmpty_itIsDefaulted() {
		$this->assertContains(
			'"icon":"","inlineLabel":"Ghent',
			$this->parse(
				"{{#display_map:Gent, Belgie~The city Ghent~Ghent is awesome~ ~ ~Ghent}}"
			)
		);
	}

	public function testWhenLocationHasNoTitleAndText_textFieldIsEmptyString() {
		$this->assertContains(
			'"text":""',
			$this->parse( '{{#display_map:1,1}}' )
		);
	}

	public function testGeoJsonSourceForFile() {
		$this->skipOn131();

		$this->assertContains(
			'"GeoJsonSource":null,',
			$this->parse(
				"{{#display_map:geojson=404}}"
			)
		);
	}

	private function skipOn131() {
		if ( version_compare( $GLOBALS['wgVersion'], '1.32c', '<' ) ) {
			$this->markTestSkipped();
		}
	}

	public function testGeoJsonSourceForPage() {
		$this->skipOn131();

		$page = new \WikiPage( \Title::newFromText( 'GeoJson:TestPageSource' ) );
		$page->doEditContent(
			new GeoJsonContent( json_encode( [
				'type' => 'FeatureCollection',
				'features' => []
			] ) ),
			''
		);

		$this->assertContains(
			'"GeoJsonSource":"TestPageSource",',
			$this->parse(
				"{{#display_map:geojson=TestPageSource}}"
			)
		);
	}

	public function testGoogleMapsKmlFiltersInvalidFileNames() {
		$this->assertContains(
			'"kml":["ValidFile.kml"],',
			$this->parse(
				"{{#display_map:service=google|kml=, ,ValidFile.kml ,}}"
			)
		);
	}

	public function testLeafletImageLayersIgnoresNotFoundImages() {
		$this->assertContains(
			'"imageLayers":[]',
			$this->parse(
				"{{#display_map:image layers=404.png}}"
			)
		);
	}

	public function testLeafletImageLayersIgnoresImageUrls() {
		$this->assertContains(
			'"imageLayers":[]',
			$this->parse(
				"{{#display_map:image layers=https://user-images.githubusercontent.com/62098559/76514021-3fa9be80-647d-11ea-82ae-715420a5c432.png}}"
			)
		);
	}

}