Upgrade mediawiki-codesniffer to latest version (45.0.0)

codders · codders · commit 551cc60ae1f3 · 2024-12-06T14:53:05.000+01:00
This repository is currently using version 34 of the Mediawiki coding style phpcs rules. If the code aims to comply with Mediawiki style guidelines, it makes sense that it continues to comply at current versions of the rules. Besides being simply different, the newer versions of the rules introduce, for example, MediaWiki.Usage.NullableType.ExplicitNullableTypes, which enforces compliance with coming deprecation rules in PHP 8.4 concerning nullable types. If the code does not remove the soon-to-be-deprecated form of nullable type declarations, the library will no longer be usable in Mediawiki for PHP 8.4 deployments. Resolves #222 Bug: T379481
diff --git a/composer.json b/composer.json
@@ -45,7 +45,7 @@
 	},
 	"require-dev": {
 		"phpunit/phpunit": "^9.4.1",
-		"mediawiki/mediawiki-codesniffer": "^34 || ^35 || ^36 || ^38",
+		"mediawiki/mediawiki-codesniffer": "45.0.0",
 		"ockcyp/covers-validator": "^1.3.3",
 		"phpstan/phpstan": "^0.12.68 || ^1.0.0",
 		"phpmd/phpmd": "^2.9.1",
@@ -83,5 +83,10 @@
 			"@test",
 			"@cs"
 		]
+	},
+	"config": {
+		"allow-plugins": {
+			"dealerdirect/phpcodesniffer-composer-installer": true
+		}
 	}
 }
diff --git a/phpcs.xml b/phpcs.xml
@@ -12,4 +12,5 @@
 	<rule ref="Generic.Metrics.CyclomaticComplexity" />
 	<rule ref="Generic.Metrics.NestingLevel" />
 	<rule ref="Squiz.Operators.ValidLogicalOperators" />
+	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
 </ruleset>
diff --git a/src/Formatters/GlobeCoordinateFormatter.php b/src/Formatters/GlobeCoordinateFormatter.php
@@ -30,7 +30,7 @@ class GlobeCoordinateFormatter implements ValueFormatter {
 	 */
 	private $formatter;
 
-	public function __construct( FormatterOptions $options = null ) {
+	public function __construct( ?FormatterOptions $options = null ) {
 		$this->formatter = new LatLongFormatter( $options );
 	}
 
diff --git a/src/Formatters/LatLongFormatter.php b/src/Formatters/LatLongFormatter.php
@@ -93,9 +93,10 @@ class LatLongFormatter implements ValueFormatter {
 
 	private const DEFAULT_PRECISION = 1 / 3600;
 
+	/** @var FormatterOptions */
 	private $options;
 
-	public function __construct( FormatterOptions $options = null ) {
+	public function __construct( ?FormatterOptions $options = null ) {
 		$this->options = $options ?? new FormatterOptions();
 
 		$this->defaultOption( self::OPT_NORTH_SYMBOL, 'N' );
@@ -211,7 +212,6 @@ private function formatLongitude( float $longitude, float $precision ): string {
 
 	private function makeDirectionalIfNeeded( string $coordinate, string $positiveSymbol,
 		string $negativeSymbol ): string {
-
 		if ( $this->options->getOption( self::OPT_DIRECTIONAL ) ) {
 			return $this->makeDirectional( $coordinate, $positiveSymbol, $negativeSymbol );
 		}
@@ -221,7 +221,6 @@ private function makeDirectionalIfNeeded( string $coordinate, string $positiveSy
 
 	private function makeDirectional( string $coordinate, string $positiveSymbol,
 		string $negativeSymbol ): string {
-
 		$isNegative = substr( $coordinate, 0, 1 ) === '-';
 
 		if ( $isNegative ) {
diff --git a/src/GlobeMath.php b/src/GlobeMath.php
@@ -59,7 +59,7 @@ public function normalizeGlobeCoordinate( GlobeCoordinateValue $value ): GlobeCo
 	 *
 	 * @return LatLongValue
 	 */
-	public function normalizeGlobeLatLong( LatLongValue $value, string $globe = null ): LatLongValue {
+	public function normalizeGlobeLatLong( LatLongValue $value, ?string $globe = null ): LatLongValue {
 		switch ( $this->normalizeGlobe( $globe ) ) {
 			case GlobeCoordinateValue::GLOBE_EARTH:
 			case self::GLOBE_MOON:
diff --git a/src/PackagePrivate/DmPrecisionDetector.php b/src/PackagePrivate/DmPrecisionDetector.php
@@ -6,6 +6,7 @@
 
 class DmPrecisionDetector extends PrecisionDetector {
 
+	/** @var DmsPrecisionDetector the precision detector */
 	private $dmsPrecisionDetector;
 
 	public function __construct() {
diff --git a/src/PackagePrivate/LatLongPrecisionParser.php b/src/PackagePrivate/LatLongPrecisionParser.php
@@ -11,10 +11,13 @@
 
 class LatLongPrecisionParser {
 
+	/** @var ?ParserOptions the parser options */
 	private $options;
+
+	/** @var ?array array of parsers in use */
 	private $parsers;
 
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$this->options = $options;
 	}
 
diff --git a/src/PackagePrivate/PreciseLatLong.php b/src/PackagePrivate/PreciseLatLong.php
@@ -8,7 +8,9 @@
 
 class PreciseLatLong {
 
+	/** @var LatLongValue the latitude/longitude value */
 	private $latLong;
+	/** @var Precision the precision */
 	private $precision;
 
 	public function __construct( LatLongValue $latLong, Precision $precision ) {
diff --git a/src/PackagePrivate/Precision.php b/src/PackagePrivate/Precision.php
@@ -6,6 +6,7 @@
 
 class Precision {
 
+	/** @var float the precision in degrees */
 	private $precision;
 
 	public function __construct( float $precisionInDegrees ) {
diff --git a/src/PackagePrivate/PrecisionParser.php b/src/PackagePrivate/PrecisionParser.php
@@ -6,7 +6,10 @@
 
 class PrecisionParser {
 
+	/** @var ValueParser Parser for latitude/longitude */
 	private $latLongParser;
+
+	/** @var PrecisionDetector */
 	private $precisionDetector;
 
 	public function __construct( ValueParser $latLongParser, PrecisionDetector $precisionDetector ) {
diff --git a/src/Parsers/DdCoordinateParser.php b/src/Parsers/DdCoordinateParser.php
@@ -34,7 +34,7 @@ class DdCoordinateParser extends LatLongParserBase {
 	/**
 	 * @param ParserOptions|null $options
 	 */
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$options = $options ?: new ParserOptions();
 		$options->defaultOption( self::OPT_DEGREE_SYMBOL, '°' );
 
@@ -107,7 +107,7 @@ protected function areValidCoordinates( array $normalizedCoordinateSegments ): b
 			}
 		}
 
-		return ( 1 === $match );
+		return ( $match === 1 );
 	}
 
 	/**
diff --git a/src/Parsers/DmCoordinateParser.php b/src/Parsers/DmCoordinateParser.php
@@ -29,7 +29,7 @@ class DmCoordinateParser extends DdCoordinateParser {
 	/**
 	 * @param ParserOptions|null $options
 	 */
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$options = $options ?: new ParserOptions();
 		$options->defaultOption( self::OPT_MINUTE_SYMBOL, "'" );
 
@@ -151,7 +151,7 @@ protected function parseCoordinate( string $coordinateSegment ): float {
 			);
 		}
 
-		list( $degrees, $minutes ) = $exploded;
+		[ $degrees, $minutes ] = $exploded;
 
 		$minutes = substr( $minutes, 0, -1 );
 
diff --git a/src/Parsers/DmsCoordinateParser.php b/src/Parsers/DmsCoordinateParser.php
@@ -27,9 +27,9 @@ class DmsCoordinateParser extends DmCoordinateParser {
 	public const OPT_SECOND_SYMBOL = 'second';
 
 	/**
-	 * @param ParserOptions|null $options
+	 * @param ?ParserOptions $options
 	 */
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$options = $options ?: new ParserOptions();
 		$options->defaultOption( self::OPT_SECOND_SYMBOL, '"' );
 
diff --git a/src/Parsers/FloatCoordinateParser.php b/src/Parsers/FloatCoordinateParser.php
@@ -71,7 +71,7 @@ protected function areValidCoordinates( array $normalizedCoordinateSegments ): b
 			}
 		}
 
-		return ( 1 === $match );
+		return ( $match === 1 );
 	}
 
 	/**
diff --git a/src/Parsers/GlobeCoordinateParser.php b/src/Parsers/GlobeCoordinateParser.php
@@ -33,10 +33,13 @@ class GlobeCoordinateParser implements ValueParser {
 	 */
 	public const OPT_GLOBE = 'globe';
 
+	/** @var ParserOptions the parser options */
 	private $options;
+
+	/** @var ?LatLongPrecisionParser the latitude/longitude parser */
 	private $latLongPrecisionParser;
 
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$this->options = $options ?: new ParserOptions();
 
 		$this->options->defaultOption( ValueParser::OPT_LANG, 'en' );
@@ -71,6 +74,9 @@ public function parse( $value ): GlobeCoordinateValue {
 		);
 	}
 
+	/**
+	 * @return LatLongPrecisionParser
+	 */
 	private function getParser() {
 		if ( $this->latLongPrecisionParser === null ) {
 			$this->latLongPrecisionParser = new LatLongPrecisionParser( $this->options );
diff --git a/src/Parsers/LatLongParser.php b/src/Parsers/LatLongParser.php
@@ -66,7 +66,7 @@ class LatLongParser implements ValueParser {
 	 */
 	private $options;
 
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$this->options = $options ?: new ParserOptions();
 		$this->options->defaultOption( ValueParser::OPT_LANG, 'en' );
 	}
diff --git a/src/Parsers/LatLongParserBase.php b/src/Parsers/LatLongParserBase.php
@@ -38,7 +38,7 @@ abstract class LatLongParserBase implements ValueParser {
 	 */
 	private $options;
 
-	public function __construct( ParserOptions $options = null ) {
+	public function __construct( ?ParserOptions $options = null ) {
 		$this->options = $options ?: new ParserOptions();
 
 		$this->options->defaultOption( ValueParser::OPT_LANG, 'en' );
@@ -94,7 +94,7 @@ public function parse( $value ): LatLongValue {
 			throw new ParseException( 'Not a valid geographical coordinate', $rawValue, static::FORMAT_NAME );
 		}
 
-		list( $latitude, $longitude ) = $normalizedCoordinateSegments;
+		[ $latitude, $longitude ] = $normalizedCoordinateSegments;
 
 		return new LatLongValue(
 			$this->getParsedCoordinate( $latitude ),
@@ -183,6 +183,10 @@ protected function resolveDirection( string $coordinateSegment ): string {
 		return $coordinateSegment;
 	}
 
+	/**
+	 * @param string $optionName
+	 * @return mixed
+	 */
 	protected function getOption( string $optionName ) {
 		return $this->options->getOption( $optionName );
 	}
diff --git a/src/Values/GlobeCoordinateValue.php b/src/Values/GlobeCoordinateValue.php
@@ -19,10 +19,13 @@
  */
 class GlobeCoordinateValue implements DataValue {
 
+	/**
+	 * @var LatLongValue
+	 */
 	private $latLong;
 
 	/**
-	 * @var float|null
+	 * @var ?float
 	 */
 	private $precision;
 
@@ -40,12 +43,12 @@ class GlobeCoordinateValue implements DataValue {
 
 	/**
 	 * @param LatLongValue $latLong
-	 * @param float|int|null $precision in degrees, e.g. 0.01.
-	 * @param string|null $globe IRI, defaults to 'http://www.wikidata.org/entity/Q2'.
+	 * @param ?float $precision in degrees, e.g. 0.01.
+	 * @param ?string $globe IRI, defaults to 'http://www.wikidata.org/entity/Q2'.
 	 *
 	 * @throws IllegalValueException
 	 */
-	public function __construct( LatLongValue $latLong, float $precision = null, string $globe = null ) {
+	public function __construct( LatLongValue $latLong, ?float $precision = null, ?string $globe = null ) {
 		$this->assertIsPrecision( $precision );
 
 		if ( $globe === null ) {
@@ -143,7 +146,7 @@ public function __serialize(): array {
 	 * @throws InvalidArgumentException
 	 */
 	public function unserialize( $value ) {
-		$this->__unserialize( json_decode( $value) );
+		$this->__unserialize( json_decode( $value ) );
 	}
 
 	public function __unserialize( array $data ): void {
diff --git a/src/Values/LatLongValue.php b/src/Values/LatLongValue.php
@@ -21,7 +21,10 @@
  */
 class LatLongValue implements DataValue {
 
+	/** @var float */
 	private $latitude;
+
+	/** @var float */
 	private $longitude;
 
 	/**
@@ -82,7 +85,7 @@ public function getHash(): string {
 	public function getSerializationForHash(): string {
 		$data = $this->serialize();
 		return 'C:' . strlen( static::class ) . ':"' . static::class .
-		       '":' . strlen( $data ) . ':{' . $data . '}';
+			'":' . strlen( $data ) . ':{' . $data . '}';
 	}
 
 	public function getCopy(): self {
diff --git a/tests/unit/GlobeMathTest.php b/tests/unit/GlobeMathTest.php
@@ -51,14 +51,14 @@ public function latLongProvider() {
 		// west to east. For other globes see http://planetarynames.wr.usgs.gov/TargetCoordinates
 		return [
 			// Yes, there really are nine ways to describe the same point
-			[ 0, 0,    0,    0 ],
-			[ 0, 0,    0,  360 ],
-			[ 0, 0,    0, -360 ],
-			[ 0, 0,  360,    0 ],
-			[ 0, 0, -360,    0 ],
-			[ 0, 0,  180,  180 ],
-			[ 0, 0,  180, -180 ],
-			[ 0, 0, -180,  180 ],
+			[ 0, 0, 0, 0 ],
+			[ 0, 0, 0, 360 ],
+			[ 0, 0, 0, -360 ],
+			[ 0, 0, 360, 0 ],
+			[ 0, 0, -360, 0 ],
+			[ 0, 0, 180, 180 ],
+			[ 0, 0, 180, -180 ],
+			[ 0, 0, -180, 180 ],
 			[ 0, 0, -180, -180 ],
 
 			// Earth (default) vs. other globes
@@ -68,21 +68,21 @@ public function latLongProvider() {
 			[ 0, 350, 0, 350, 'Vulcan' ],
 
 			// Make sure the methods do not simply return true
-			[ 0, 0,   0,  180, null, false ],
-			[ 0, 0,   0, -180, null, false ],
-			[ 0, 0, 180,    0, null, false ],
-			[ 0, 0, 180,  360, null, false ],
+			[ 0, 0, 0, 180, null, false ],
+			[ 0, 0, 0, -180, null, false ],
+			[ 0, 0, 180, 0, null, false ],
+			[ 0, 0, 180, 360, null, false ],
 
 			// Dark side of the Moon, erm Earth
-			[ 0, -180,    0,  180 ],
-			[ 0, -180,    0, -180 ],
-			[ 0, -180,  180,    0 ],
-			[ 0, -180, -180,    0 ],
+			[ 0, -180, 0, 180 ],
+			[ 0, -180, 0, -180 ],
+			[ 0, -180, 180, 0 ],
+			[ 0, -180, -180, 0 ],
 			[ 0, -180, -360, -180 ],
 
 			// Half way to the north pole
-			[ 45, 0,  45, -360 ],
-			[ 45, 0, 135,  180 ],
+			[ 45, 0, 45, -360 ],
+			[ 45, 0, 135, 180 ],
 			[ 45, 0, 135, -180 ],
 
 			// North pole is a special case, drop longitude
@@ -91,9 +91,9 @@ public function latLongProvider() {
 			[ 90, 0, -270, 180 ],
 			[ 90, 0, -90, 0, null, false ],
 			// Same for south pole
-			[ -90,  0,  -90,  123 ],
-			[ -90,  0,  270,    0 ],
-			[ -90,  0,  270, -180 ],
+			[ -90, 0, -90, 123 ],
+			[ -90, 0, 270, 0 ],
+			[ -90, 0, 270, -180 ],
 
 			// Make sure we cover all cases in the code
 			[ 10, 10, 10, 10 ],
diff --git a/tests/unit/Values/GlobeCoordinateValueTest.php b/tests/unit/Values/GlobeCoordinateValueTest.php
@@ -302,7 +302,6 @@ public function nonNumericStringProvider() {
 		yield [ [ 'latitude' => '1.23a', 'longitude' => '3.45b' ] ];
 	}
 
-
 	/**
 	 * @dataProvider withPrecisionProvider
 	 */

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@`
`45`	`45`	`},`
`46`	`46`	`"require-dev": {`
`47`	`47`	`"phpunit/phpunit": "^9.4.1",`
`48`		`- "mediawiki/mediawiki-codesniffer": "^34 \|\| ^35 \|\| ^36 \|\| ^38",`
	`48`	`+ "mediawiki/mediawiki-codesniffer": "45.0.0",`
`49`	`49`	`"ockcyp/covers-validator": "^1.3.3",`
`50`	`50`	`"phpstan/phpstan": "^0.12.68 \|\| ^1.0.0",`
`51`	`51`	`"phpmd/phpmd": "^2.9.1",`
`@@ -83,5 +83,10 @@`
`83`	`83`	`"@test",`
`84`	`84`	`"@cs"`
`85`	`85`	`]`
	`86`	`+ },`
	`87`	`+ "config": {`
	`88`	`+ "allow-plugins": {`
	`89`	`+ "dealerdirect/phpcodesniffer-composer-installer": true`
	`90`	`+ }`
`86`	`91`	`}`
`87`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class GlobeCoordinateFormatter implements ValueFormatter {`
`30`	`30`	`*/`
`31`	`31`	`private $formatter;`
`32`	`32`
`33`		`- public function __construct( FormatterOptions $options = null ) {`
	`33`	`+ public function __construct( ?FormatterOptions $options = null ) {`
`34`	`34`	`$this->formatter = new LatLongFormatter( $options );`
`35`	`35`	`}`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public function normalizeGlobeCoordinate( GlobeCoordinateValue $value ): GlobeCo`
`59`	`59`	`*`
`60`	`60`	`* @return LatLongValue`
`61`	`61`	`*/`
`62`		`- public function normalizeGlobeLatLong( LatLongValue $value, string $globe = null ): LatLongValue {`
	`62`	`+ public function normalizeGlobeLatLong( LatLongValue $value, ?string $globe = null ): LatLongValue {`
`63`	`63`	`switch ( $this->normalizeGlobe( $globe ) ) {`
`64`	`64`	`case GlobeCoordinateValue::GLOBE_EARTH:`
`65`	`65`	`case self::GLOBE_MOON:`