🛀 test overhaul

Author: codemasher

phpstan-baseline.neon

@@ -102,6 +102,12 @@ parameters:
 			count: 1
 			path: examples/intervention-image.php
 
+		-
+			rawMessage: 'Function parseHexValue() return type has no value type specified in iterable type array.'
+			identifier: missingType.iterableValue
+			count: 1
+			path: examples/qrcode-interactive.php
+
 		-
 			rawMessage: 'Method RandomDotsSVGOutput::collectModules() should return array<int, mixed> but returns array<int|string, list<string>>.'
 			identifier: return.type
@@ -234,24 +240,12 @@ parameters:
 			count: 1
 			path: src/QRCode.php
 
-		-
-			rawMessage: 'Method chillerlan\QRCodeTest\Common\MaskPatternTest::assertMask() has parameter $expected with no value type specified in iterable type array.'
-			identifier: missingType.iterableValue
-			count: 1
-			path: tests/Common/MaskPatternTest.php
-
 		-
 			rawMessage: 'Method chillerlan\QRCodeTest\Common\MaskPatternTest::maskPatternProvider() return type has no value type specified in iterable type array.'
 			identifier: missingType.iterableValue
 			count: 1
 			path: tests/Common/MaskPatternTest.php
 
-		-
-			rawMessage: 'Method chillerlan\QRCodeTest\Common\MaskPatternTest::testMask() has parameter $expected with no value type specified in iterable type array.'
-			identifier: missingType.iterableValue
-			count: 1
-			path: tests/Common/MaskPatternTest.php
-
 		-
 			rawMessage: 'Parameter #1 $string of static method chillerlan\QRCode\Data\QRDataModeInterface::validateString() expects string, string|false given.'
 			identifier: argument.type

tests/Common/BitBufferTest.php

@@ -13,7 +13,7 @@
 
 use chillerlan\QRCode\QRCodeException;
 use chillerlan\QRCode\Common\{BitBuffer, Mode};
-use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\{Test, TestWith};
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -27,28 +27,21 @@ protected function setUp():void{
 		$this->bitBuffer = new BitBuffer;
 	}
 
-	/**
-	 * @phpstan-return array<string, array{0: int, 1: int}>
-	 */
-	public static function bitProvider():array{
-		return [
-			'number'   => [Mode::NUMBER, 16],
-			'alphanum' => [Mode::ALPHANUM, 32],
-			'byte'     => [Mode::BYTE, 64],
-			'kanji'    => [Mode::KANJI, 128],
-			'hanzi'    => [Mode::HANZI, 208],
-		];
-	}
-
-	#[DataProvider('bitProvider')]
-	public function testPut(int $data, int $expected):void{
+	#[Test]
+	#[TestWith([Mode::NUMBER, 16], 'number')]
+	#[TestWith([Mode::ALPHANUM, 32], 'alphanum')]
+	#[TestWith([Mode::BYTE, 64], 'byte')]
+	#[TestWith([Mode::KANJI, 128], 'kanji')]
+	#[TestWith([Mode::HANZI, 208], 'hanzi')]
+	public function put(int $data, int $expected):void{
 		$this->bitBuffer->put($data, 4);
 
 		$this::assertSame($expected, $this->bitBuffer->getBuffer()[0]);
 		$this::assertSame(4, $this->bitBuffer->getLength());
 	}
 
-	public function testReadException():void{
+	#[Test]
+	public function readException():void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid $numBits');
 

tests/Common/ECICharsetTest.php

@@ -13,20 +13,15 @@
 
 use chillerlan\QRCode\QRCodeException;
 use chillerlan\QRCode\Common\ECICharset;
-use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\{DataProvider, Test, TestWith};
 use PHPUnit\Framework\TestCase;
 
 final class ECICharsetTest extends TestCase{
 
-	/**
-	 * @phpstan-return array<int, array{0: int}>
-	 */
-	public static function invalidIdProvider():array{
-		return [[-1], [1000000]];
-	}
-
-	#[DataProvider('invalidIdProvider')]
-	public function testInvalidDataException(int $id):void{
+	#[Test]
+	#[TestWith([-1])]
+	#[TestWith([1000000])]
+	public function invalidDataException(int $id):void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid charset id:');
 
@@ -46,8 +41,9 @@ public static function encodingProvider():array{
 		return $params;
 	}
 
+	#[Test]
 	#[DataProvider('encodingProvider')]
-	public function testGetName(int $id, string|null $name = null):void{
+	public function getName(int $id, string|null $name = null):void{
 		$eciCharset = new ECICharset($id);
 
 		$this::assertSame($id, $eciCharset->getID());

tests/Common/EccLevelTest.php

@@ -13,44 +13,51 @@
 
 use chillerlan\QRCode\QRCodeException;
 use chillerlan\QRCode\Common\{EccLevel, MaskPattern};
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 /**
  * EccLevel coverage test
  */
 final class EccLevelTest extends TestCase{
 
-	public function testConstructInvalidEccException():void{
+	#[Test]
+	public function constructInvalidEccException():void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid ECC level');
 
 		new EccLevel(69);
 	}
 
-	public function testToString():void{
+	#[Test]
+	public function eccToString():void{
 		$ecc = new EccLevel(EccLevel::L);
 
 		$this::assertSame('L', (string)$ecc);
 	}
 
-	public function testGetLevel():void{
+	#[Test]
+	public function getLevel():void{
 		$ecc = new EccLevel(EccLevel::L);
 
 		$this::assertSame(EccLevel::L, $ecc->getLevel());
 	}
 
-	public function testGetOrdinal():void{
+	#[Test]
+	public function getOrdinal():void{
 		$ecc = new EccLevel(EccLevel::L);
 
 		$this::assertSame(0, $ecc->getOrdinal());
 	}
 
-	public function testGetformatPattern():void{
+	#[Test]
+	public function getformatPattern():void{
 		$ecc = new EccLevel(EccLevel::Q);
 
 		$this::assertSame(0b010010010110100, $ecc->getformatPattern(new MaskPattern(4)));
 	}
 
+	#[Test]
 	public function getMaxBits():void{
 		$ecc = new EccLevel(EccLevel::Q);
 

tests/Common/MaskPatternTest.php

@@ -16,7 +16,7 @@
 
 use chillerlan\QRCode\QRCodeException;
 use chillerlan\QRCode\Common\MaskPattern;
-use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\{DataProvider, Test};
 use PHPUnit\Framework\TestCase;
 use Closure;
 
@@ -100,8 +100,9 @@ public static function maskPatternProvider():array{
 	 *
 	 * @param int[][] $expected
 	 */
+	#[Test]
 	#[DataProvider('maskPatternProvider')]
-	public function testMask(int $pattern, array $expected):void{
+	public function mask(int $pattern, array $expected):void{
 		$maskPattern = new MaskPattern($pattern);
 
 		$this::assertTrue($this->assertMask($maskPattern->getMask(), $expected));
@@ -126,14 +127,16 @@ private function assertMask(Closure $mask, array $expected):bool{
 	/**
 	 * Tests if an exception is thrown on an incorrect mask pattern
 	 */
-	public function testInvalidMaskPatternException():void{
+	#[Test]
+	public function invalidMaskPatternException():void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid mask pattern');
 
 		new MaskPattern(42);
 	}
 
-	public function testPenaltyRule1():void{
+	#[Test]
+	public function penaltyRule1():void{
 		// horizontal
 		$this::assertSame(0, MaskPattern::testRule1([[false, false, false, false]], 1, 4));
 		$this::assertSame(3, MaskPattern::testRule1([[false, false, false, false, false, true]], 1, 6));
@@ -144,14 +147,16 @@ public function testPenaltyRule1():void{
 		$this::assertSame(4, MaskPattern::testRule1([[false], [false], [false], [false], [false], [false]], 6, 1));
 	}
 
-	public function testPenaltyRule2():void{
+	#[Test]
+	public function penaltyRule2():void{
 		$this::assertSame(0, MaskPattern::testRule2([[false]], 1, 1));
 		$this::assertSame(0, MaskPattern::testRule2([[false, false], [false, true]], 2, 2));
 		$this::assertSame(3, MaskPattern::testRule2([[false, false], [false, false]], 2, 2));
 		$this::assertSame(12, MaskPattern::testRule2([[false, false, false], [false, false, false], [false, false, false]], 3, 3)); // phpcs:ignore
 	}
 
-	public function testPenaltyRule3():void{
+	#[Test]
+	public function penaltyRule3():void{
 		// horizontal
 		$this::assertSame(40, MaskPattern::testRule3([[false, false, false, false, true, false, true, true, true, false, true]], 1, 11)); // phpcs:ignore
 		$this::assertSame(40, MaskPattern::testRule3([[true, false, true, true, true, false, true, false, false, false, false]], 1, 11)); // phpcs:ignore
@@ -162,7 +167,8 @@ public function testPenaltyRule3():void{
 		$this::assertSame(0, MaskPattern::testRule3([[true], [false], [true], [true], [true], [false], [true]], 7, 1));
 	}
 
-	public function testPenaltyRule4():void{
+	#[Test]
+	public function penaltyRule4():void{
 		$this::assertSame(100, MaskPattern::testRule4([[false]], 1, 1));
 		$this::assertSame(0, MaskPattern::testRule4([[false, true]], 1, 2));
 		$this::assertSame(30, MaskPattern::testRule4([[false, true, true, true, true, false]], 1, 6));

tests/Common/ModeTest.php

@@ -13,7 +13,7 @@
 
 use chillerlan\QRCode\QRCodeException;
 use chillerlan\QRCode\Common\Mode;
-use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\{Test, TestWith};
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -22,34 +22,29 @@
 final class ModeTest extends TestCase{
 
 	/**
-	 * version breakpoints for numeric mode
-	 *
-	 * @phpstan-return array<int, array{0: int, 1: int}>
+	 * Tests the version breakpoints for numeric mode
 	 */
-	public static function versionProvider():array{
-		return [
-			[ 1, 10],
-			[ 9, 10],
-			[10, 12],
-			[26, 12],
-			[27, 14],
-			[40, 14],
-		];
-	}
-
-	#[DataProvider('versionProvider')]
-	public function testGetLengthBitsForVersionBreakpoints(int $version, int $expected):void{
+	#[Test]
+	#[TestWith([ 1, 10], '10 low')]
+	#[TestWith([ 9, 10], '10 high')]
+	#[TestWith([10, 12], '12 low')]
+	#[TestWith([26, 12], '12 high')]
+	#[TestWith([27, 14], '14 low')]
+	#[TestWith([40, 14], '14 high')]
+	public function getLengthBitsForVersionBreakpoints(int $version, int $expected):void{
 		$this::assertSame($expected, Mode::getLengthBitsForVersion(Mode::NUMBER, $version));
 	}
 
-	public function testGetLengthBitsForVersionInvalidModeException():void{
+	#[Test]
+	public function getLengthBitsForVersionInvalidModeException():void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid mode given');
 
 		Mode::getLengthBitsForVersion(42, 69);
 	}
 
-	public function testGetLengthBitsForVersionInvalidVersionException():void{
+	#[Test]
+	public function getLengthBitsForVersionInvalidVersionException():void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid version number');
 

tests/Common/VersionTest.php

@@ -13,6 +13,7 @@
 
 use chillerlan\QRCode\QRCodeException;
 use chillerlan\QRCode\Common\{EccLevel, Version};
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -26,37 +27,45 @@ protected function setUp():void{
 		$this->version = new Version(7);
 	}
 
-	public function testToString():void{
+	#[Test]
+	public function versionToString():void{
 		$this::assertSame('7', (string)$this->version);
 	}
 
-	public function testGetVersionNumber():void{
+	#[Test]
+	public function getVersionNumber():void{
 		$this::assertSame(7, $this->version->getVersionNumber());
 	}
 
-	public function testGetDimension():void{
+	#[Test]
+	public function getDimension():void{
 		$this::assertSame(45, $this->version->getDimension());
 	}
 
-	public function testGetVersionPattern():void{
+	#[Test]
+	public function getVersionPattern():void{
 		$this::assertSame(0b000111110010010100, $this->version->getVersionPattern());
 		// no pattern for version < 7
 		$this::assertNull((new Version(6))->getVersionPattern());
 	}
 
-	public function testGetAlignmentPattern():void{
+	#[Test]
+	public function getAlignmentPattern():void{
 		$this::assertSame([6, 22, 38], $this->version->getAlignmentPattern());
 	}
 
-	public function testGetRSBlocks():void{
+	#[Test]
+	public function getRSBlocks():void{
 		$this::assertSame([18, [[2, 14], [4, 15]]], $this->version->getRSBlocks(new EccLevel(EccLevel::Q)));
 	}
 
-	public function testGetTotalCodewords():void{
+	#[Test]
+	public function getTotalCodewords():void{
 		$this::assertSame(196, $this->version->getTotalCodewords());
 	}
 
-	public function testConstructInvalidVersion():void{
+	#[Test]
+	public function constructInvalidVersion():void{
 		$this->expectException(QRCodeException::class);
 		$this->expectExceptionMessage('invalid version given');
 

tests/Data/AlphaNumTest.php

@@ -11,8 +11,7 @@
 
 namespace chillerlan\QRCodeTest\Data;
 
-use chillerlan\QRCode\Data\AlphaNum;
-use chillerlan\QRCode\Data\QRDataModeInterface;
+use chillerlan\QRCode\Data\{AlphaNum, QRDataModeInterface};
 
 /**
  * Tests the AlphaNum class