Clean up coordinate formatting

ProfessionalWiki · Oct 1, 2018 · 2063f74 · 2063f74
1 parent 97ca35f
commit 2063f74
Show file tree

Hide file tree

Showing 10 changed files with 71 additions and 59 deletions.
diff --git a/includes/parserhooks/Maps_Coordinates.php b/includes/parserhooks/Maps_Coordinates.php
@@ -1,6 +1,6 @@
 <?php
 
-use DataValues\Geo\Formatters\LatLongFormatter;
+use Maps\MapsFactory;
 
 /**
  * Class for the 'coordinates' parser hooks,
@@ -25,19 +25,11 @@ class MapsCoordinates extends ParserHook {
 	 * @return string
 	 */
 	public function render( array $parameters ) {
-		$options = new \ValueFormatters\FormatterOptions(
-			[
-				LatLongFormatter::OPT_FORMAT => $parameters['format'],
-				LatLongFormatter::OPT_DIRECTIONAL => $parameters['directional'],
-				LatLongFormatter::OPT_PRECISION => 1 / 360000
-			]
+		return MapsFactory::globalInstance()->getCoordinateFormatter()->format(
+			$parameters['location'],
+			$parameters['format'],
+			$parameters['directional']
 		);
-
-		$coordinateFormatter = new LatLongFormatter( $options );
-
-		$output = $coordinateFormatter->format( $parameters['location'] );
-
-		return $output;
 	}
 
 	/**

diff --git a/includes/parserhooks/Maps_Finddestination.php b/includes/parserhooks/Maps_Finddestination.php
@@ -1,7 +1,7 @@
 <?php
 
-use DataValues\Geo\Formatters\LatLongFormatter;
 use DataValues\Geo\Values\LatLongValue;
+use Maps\MapsFactory;
 
 /**
  * Class for the 'finddestination' parser hooks, which can find a
@@ -32,17 +32,11 @@ public function render( array $parameters ) {
 			$parameters['distance']
 		);
 
-		$options = new \ValueFormatters\FormatterOptions(
-			[
-				LatLongFormatter::OPT_FORMAT => $parameters['format'],
-				LatLongFormatter::OPT_DIRECTIONAL => $parameters['directional'],
-				LatLongFormatter::OPT_PRECISION => 1 / 360000
-			]
+		return MapsFactory::globalInstance()->getCoordinateFormatter()->format(
+			new LatLongValue( $destination['lat'], $destination['lon'] ),
+			$parameters['format'],
+			$parameters['directional']
 		);
-
-		$formatter = new LatLongFormatter( $options );
-
-		return $formatter->format( new LatLongValue( $destination['lat'], $destination['lon'] ) );
 	}
 
 	/**

diff --git a/includes/parserhooks/Maps_Geocode.php b/includes/parserhooks/Maps_Geocode.php
@@ -1,8 +1,7 @@
 <?php
 
-use DataValues\Geo\Formatters\LatLongFormatter;
 use Jeroen\SimpleGeocoder\Geocoder;
-use ValueFormatters\FormatterOptions;
+use Maps\MapsFactory;
 
 /**
  * Class for the 'geocode' parser hooks, which can turn
@@ -40,18 +39,10 @@ public function render( array $parameters ) {
 			return 'Geocoding failed'; // TODO: i18n
 		}
 
-		return $this->newCoordinateFormatter( $parameters )->format( $coordinates );
-	}
-
-	private function newCoordinateFormatter( array $parameters ) {
-		return new LatLongFormatter(
-			new FormatterOptions(
-				[
-					LatLongFormatter::OPT_FORMAT => $parameters['format'],
-					LatLongFormatter::OPT_DIRECTIONAL => $parameters['directional'],
-					LatLongFormatter::OPT_PRECISION => 1 / 360000
-				]
-			)
+		return MapsFactory::globalInstance()->getCoordinateFormatter()->format(
+			$coordinates,
+			$parameters['format'],
+			$parameters['directional']
 		);
 	}
 

diff --git a/src/CoordinateFormatter.php b/src/CoordinateFormatter.php
@@ -0,0 +1,29 @@
+<?php
+
+declare( strict_types = 1 );
+
+namespace Maps;
+
+use DataValues\Geo\Formatters\LatLongFormatter;
+use DataValues\Geo\Values\LatLongValue;
+use ValueFormatters\FormatterOptions;
+
+/**
+ * @licence GNU GPL v2+
+ * @author Jeroen De Dauw < [email protected] >
+ */
+class CoordinateFormatter {
+
+	public function format( LatLongValue $latLong, string $format, bool $directional ) {
+		$formatter = new LatLongFormatter( new FormatterOptions(
+			[
+				LatLongFormatter::OPT_FORMAT => $format,
+				LatLongFormatter::OPT_DIRECTIONAL => $directional,
+				LatLongFormatter::OPT_PRECISION => 1 / 360000
+			]
+		) );
+
+		return $formatter->format( $latLong );
+	}
+
+}
diff --git a/src/GeoJson/GeoJsonContent.php b/src/GeoJson/GeoJsonContent.php
@@ -2,7 +2,6 @@
 
 namespace Maps\GeoJson;
 
-use FormatJson;
 use Html;
 use ParserOptions;
 use ParserOutput;

diff --git a/src/GeoJson/GeoJsonContentHandler.php b/src/GeoJson/GeoJsonContentHandler.php
@@ -2,8 +2,6 @@
 
 namespace Maps\GeoJson;
 
-use EditAction;
-
 class GeoJsonContentHandler extends \JsonContentHandler {
 
 	public function __construct( $modelId = GeoJsonContent::CONTENT_MODEL_ID ) {

diff --git a/src/MapsFactory.php b/src/MapsFactory.php
@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Maps;
 
 use FileFetcher\FileFetcher;
@@ -26,10 +28,23 @@ private function __construct( array $settings, MediaWikiServices $mediaWikiServi
 		$this->mediaWikiServices = $mediaWikiServices;
 	}
 
-	public static function newDefault() {
+	public static function newDefault(): self {
 		return new self( $GLOBALS, MediaWikiServices::getInstance() );
 	}
 
+	/**
+	 * Only for legacy code where dependency injection is not possible
+	 */
+	public static function globalInstance(): self {
+		static $instance = null;
+
+		if ( $instance === null ) {
+			$instance = self::newDefault();
+		}
+
+		return $instance;
+	}
+
 	public function newLocationParser(): LocationParser {
 		return LocationParser::newInstance( $this->newGeocoder() );
 	}
@@ -97,4 +112,8 @@ public function getPageContentFetcher(): PageContentFetcher {
 		);
 	}
 
+	public function getCoordinateFormatter(): CoordinateFormatter {
+		return new CoordinateFormatter();
+	}
+
 }
diff --git a/src/Semantic/DataValues/CoordinateValue.php b/src/Semantic/DataValues/CoordinateValue.php
@@ -2,10 +2,10 @@
 
 namespace Maps\Semantic\DataValues;
 
-use DataValues\Geo\Formatters\LatLongFormatter;
 use DataValues\Geo\Parsers\LatLongParser;
 use DataValues\Geo\Values\LatLongValue;
 use InvalidArgumentException;
+use Maps\MapsFactory;
 use MapsDistanceParser;
 use SMW\Query\Language\Description;
 use SMW\Query\Language\ThingDescription;
@@ -159,21 +159,13 @@ public function getShortWikiText( $linked = null ) {
 	 * @return string|null
 	 */
 	private function getFormattedCoord( SMWDIGeoCoord $dataItem, string $format = null ) {
-		$options = new \ValueFormatters\FormatterOptions(
-			[
-				LatLongFormatter::OPT_FORMAT => $format ?? $GLOBALS['smgQPCoodFormat'],
-				LatLongFormatter::OPT_DIRECTIONAL => $GLOBALS['smgQPCoodDirectional'],
-				LatLongFormatter::OPT_PRECISION => 1 / 360000
-			]
-		);
-
-		$coordinateFormatter = new LatLongFormatter( $options );
-
-		return $coordinateFormatter->format(
+		return MapsFactory::globalInstance()->getCoordinateFormatter()->format(
 			new LatLongValue(
 				$dataItem->getLatitude(),
 				$dataItem->getLongitude()
-			)
+			),
+			$format ?? $GLOBALS['smgQPCoodFormat'],
+			$GLOBALS['smgQPCoodDirectional']
 		);
 	}
 

diff --git a/tests/Integration/Semantic/ValueDescriptions/AreaDescriptionTest.php b/tests/Integration/Semantic/ValueDescriptions/AreaDescriptionTest.php
@@ -5,8 +5,6 @@
 use CoordinateValue;
 use Maps\Semantic\ValueDescriptions\AreaDescription;
 use PHPUnit\Framework\TestCase;
-use SMW\DataValueFactory;
-use SMWDataItem;
 use SMWDIGeoCoord;
 
 /**
@@ -75,7 +73,7 @@ public function testGetQueryString() {
 		);
 
 		$this->assertSame(
-			'[[1° 0\' 0", 5° 0\' 0" (10 km)]]',
+			'[[1° 0\' 0.00" N, 5° 0\' 0.00" E (10 km)]]',
 			$area->getQueryString()
 		);
 	}

diff --git a/tests/Unit/Semantic/DataValues/CoordinateValueTest.php b/tests/Unit/Semantic/DataValues/CoordinateValueTest.php
@@ -35,7 +35,7 @@ public function testConstruct() {
 		$this->assertInstanceOf( CoordinateValue::class, $geoValue );
 
 		$this->assertEquals( $geoDI, $geoValue->getDataItem() );
-		$this->assertEquals( '23° 0\' 0", 42° 0\' 0"', $geoValue->getShortWikiText() );
+		$this->assertSame( '23° 0\' 0.00" N, 42° 0\' 0.00" E', $geoValue->getShortWikiText() );
 	}
 
 	/**