🔥 v6.0 third pass: test clean-up (again)

Author: codemasher

phpunit.xml.dist

@@ -37,5 +37,7 @@
 		<const name="TEST_IS_CI" value="true"/>
 		<!-- limit the maximum version for the reader test to speed up things -->
 		<const name="READER_TEST_MAX_VERSION" value="40"/>
+		<!-- the QR version to display the matrix in when called from the shortcut method in QRMatrixDebugTrait -->
+		<const name="MATRIX_DEBUG_VERSION" value="7"/>
 	</php>
 </phpunit>

tests/Common/BitBufferTest.php

@@ -10,8 +10,8 @@
 
 namespace chillerlan\QRCodeTest\Common;
 
-use chillerlan\QRCode\Common\{BitBuffer, Mode};
 use chillerlan\QRCode\QRCodeException;
+use chillerlan\QRCode\Common\{BitBuffer, Mode};
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
@@ -32,13 +32,15 @@ public static function bitProvider():array{
 			'alphanum' => [Mode::ALPHANUM, 32],
 			'byte'     => [Mode::BYTE, 64],
 			'kanji'    => [Mode::KANJI, 128],
+			'hanzi'    => [Mode::HANZI, 208],
 		];
 	}
 
 	#[DataProvider('bitProvider')]
-	public function testPut(int $data, int $value):void{
+	public function testPut(int $data, int $expected):void{
 		$this->bitBuffer->put($data, 4);
-		$this::assertSame($value, $this->bitBuffer->getBuffer()[0]);
+
+		$this::assertSame($expected, $this->bitBuffer->getBuffer()[0]);
 		$this::assertSame(4, $this->bitBuffer->getLength());
 	}
 

tests/Common/ECICharsetTest.php

@@ -10,8 +10,8 @@
 
 namespace chillerlan\QRCodeTest\Common;
 
-use chillerlan\QRCode\Common\ECICharset;
 use chillerlan\QRCode\QRCodeException;
+use chillerlan\QRCode\Common\ECICharset;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 

tests/Common/EccLevelTest.php

@@ -10,9 +10,8 @@
 
 namespace chillerlan\QRCodeTest\Common;
 
-use chillerlan\QRCode\Common\EccLevel;
-use chillerlan\QRCode\Common\MaskPattern;
 use chillerlan\QRCode\QRCodeException;
+use chillerlan\QRCode\Common\{EccLevel, MaskPattern};
 use PHPUnit\Framework\TestCase;
 
 /**

tests/Common/MaskPatternTest.php

@@ -13,11 +13,11 @@
 
 namespace chillerlan\QRCodeTest\Common;
 
-use chillerlan\QRCode\Common\MaskPattern;
 use chillerlan\QRCode\QRCodeException;
-use Closure;
+use chillerlan\QRCode\Common\MaskPattern;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Closure;
 
 /**
  * @see https://github.com/zxing/zxing/blob/f4f3c2971dc794346d8b6e14752200008cb90716/core/src/test/java/com/google/zxing/qrcode/encoder/MaskUtilTestCase.java

tests/Common/ModeTest.php

@@ -10,8 +10,8 @@
 
 namespace chillerlan\QRCodeTest\Common;
 
-use chillerlan\QRCode\Common\Mode;
 use chillerlan\QRCode\QRCodeException;
+use chillerlan\QRCode\Common\Mode;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 

tests/Common/VersionTest.php

@@ -10,9 +10,8 @@
 
 namespace chillerlan\QRCodeTest\Common;
 
-use chillerlan\QRCode\Common\EccLevel;
-use chillerlan\QRCode\Common\Version;
 use chillerlan\QRCode\QRCodeException;
+use chillerlan\QRCode\Common\{EccLevel, Version};
 use PHPUnit\Framework\TestCase;
 
 /**

tests/Data/AlphaNumTest.php

@@ -11,14 +11,18 @@
 namespace chillerlan\QRCodeTest\Data;
 
 use chillerlan\QRCode\Data\AlphaNum;
+use chillerlan\QRCode\Data\QRDataModeInterface;
 
 /**
  * Tests the AlphaNum class
  */
 final class AlphaNumTest extends DataInterfaceTestAbstract{
 
-	protected static string $FQN      = AlphaNum::class;
-	protected static string $testdata = '0 $%*+-./:';
+	protected const testData = '0 $%*+-./:';
+
+	protected static function getDataModeInterface(string $data):QRDataModeInterface{
+		return new AlphaNum($data);
+	}
 
 	/**
 	 * isAlphaNum() should pass on the 45 defined characters and fail on anything else (e.g. lowercase)

tests/Data/ByteTest.php

@@ -11,14 +11,18 @@
 namespace chillerlan\QRCodeTest\Data;
 
 use chillerlan\QRCode\Data\Byte;
+use chillerlan\QRCode\Data\QRDataModeInterface;
 
 /**
  * Tests the Byte class
  */
 final class ByteTest extends DataInterfaceTestAbstract{
 
-	protected static string $FQN      = Byte::class;
-	protected static string $testdata = '[¯\_(ツ)_/¯]';
+	protected const testData = '[¯\_(ツ)_/¯]';
+
+	protected static function getDataModeInterface(string $data):QRDataModeInterface{
+		return new Byte($data);
+	}
 
 	/**
 	 * isByte() passses any binary string and only fails on empty strings

tests/Data/DataInterfaceTestAbstract.php

@@ -11,21 +11,13 @@
 namespace chillerlan\QRCodeTest\Data;
 
 use chillerlan\QRCode\Common\{EccLevel, MaskPattern, Mode, Version};
-use PHPUnit\Framework\Attributes\DataProvider;
 use chillerlan\QRCode\Data\{QRCodeDataException, QRData, QRDataModeInterface, QRMatrix};
 use chillerlan\QRCode\QROptions;
 use chillerlan\QRCodeTest\QRMaxLengthTrait;
-use Exception,  Generator;
+use Exception, Generator;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
-
-use function array_map;
-use function hex2bin;
-use function mb_strlen;
-use function mb_substr;
-use function sprintf;
-use function str_repeat;
-use function strlen;
-use function substr;
+use function array_map, hex2bin, mb_strlen, mb_substr, sprintf, str_repeat, strlen, substr;
 
 /**
  * The data interface test abstract
@@ -35,26 +27,15 @@ abstract class DataInterfaceTestAbstract extends TestCase{
 
 	protected QRData              $QRData;
 	protected QRDataModeInterface $dataMode;
-	protected static string       $FQN;
-	protected static string       $testdata;
+
+	protected const testData = '';
 
 	protected function setUp():void{
-		$this->QRData = new QRData(new QROptions);
+		$this->QRData   = new QRData(new QROptions);
+		$this->dataMode = static::getDataModeInterface(static::testData);
 	}
 
-	/**
-	 * Verifies the QRData instance
-	 */
-	public function testInstance():void{
-		$this::assertInstanceOf(QRData::class, $this->QRData);
-	}
-
-	/**
-	 * Verifies the QRDataModeInterface instance
-	 */
-	public function testDataModeInstance():void{
-		$this::assertInstanceOf(QRDataModeInterface::class, new static::$FQN(static::$testdata));
-	}
+	abstract protected static function getDataModeInterface(string $data):QRDataModeInterface;
 
 	/**
 	 * @return int[][]
@@ -70,7 +51,7 @@ public static function maskPatternProvider():array{
 	public function testInitMatrix(int $pattern):void{
 		$maskPattern = new MaskPattern($pattern);
 
-		$this->QRData->setData([new static::$FQN(static::$testdata)]);
+		$this->QRData->setData([$this->dataMode]);
 
 		$matrix = $this->QRData->writeMatrix()->setFormatInfo($maskPattern)->mask($maskPattern);
 
@@ -85,18 +66,16 @@ abstract public static function stringValidateProvider():array;
 	 */
 	#[DataProvider('stringValidateProvider')]
 	public function testValidateString(string $string, bool $expected):void{
-		/** @noinspection PhpUndefinedMethodInspection */
-		$this::assertSame($expected, static::$FQN::validateString($string));
+		$this::assertSame($expected, $this->dataMode::validateString($string));
 	}
 
 	/**
-	 * Tests if a binary string is properly validated as false
+	 * Tests if a random binary string is properly validated as false
 	 *
 	 * @see https://github.com/chillerlan/php-qrcode/issues/182
 	 */
 	public function testBinaryStringInvalid():void{
-		/** @noinspection PhpUndefinedMethodInspection */
-		$this::assertFalse(static::$FQN::validateString(hex2bin('01015989f47dff8e852122117e04c90b9f15defc1c36477b1fe1')));
+		$this::assertFalse($this->dataMode::validateString(hex2bin('01015989f47dff8e852122117e04c90b9f15defc1c36477b1fe1')));
 	}
 
 	/**
@@ -114,16 +93,14 @@ public function testDecodeSegment(int $version):void{
 		$options          = new QROptions;
 		$options->version = $version;
 
-		// invoke a datamode interface
-		$this->dataMode = new static::$FQN(static::$testdata);
 		// invoke a QRData instance and write data
 		$this->QRData = new QRData($options, [$this->dataMode]);
 		// get the filled bitbuffer
 		$bitBuffer = $this->QRData->getBitBuffer();
 		// read the first 4 bits
 		$this::assertSame($this->dataMode::DATAMODE, $bitBuffer->read(4));
 		// decode the data
-		$this::assertSame(static::$testdata, $this->dataMode::decodeSegment($bitBuffer, $options->version));
+		$this::assertSame(static::testData, $this->dataMode::decodeSegment($bitBuffer, $options->version));
 	}
 
 	/**
@@ -139,15 +116,17 @@ public function testDecodeSegment(int $version):void{
 	 */
 	public static function maxLengthProvider():Generator{
 		$eccLevels = array_map(fn(int $ecc):EccLevel => new EccLevel($ecc), [EccLevel::L, EccLevel::M, EccLevel::Q, EccLevel::H]);
-		$str       = str_repeat(static::$testdata, 1000);
-		$mb        = (static::$FQN::DATAMODE === Mode::KANJI || static::$FQN::DATAMODE === Mode::HANZI);
+		$str       = str_repeat(static::testData, 1000);
+		/** @phan-suppress-next-line PhanAbstractStaticMethodCallInStatic */
+		$dataMode  = static::getDataModeInterface(static::testData)::DATAMODE;
+		$mb        = ($dataMode === Mode::KANJI || $dataMode === Mode::HANZI);
 
 		for($v = 1; $v <= 40; $v++){
 			$version = new Version($v);
 
 			foreach($eccLevels as $eccLevel){
 				// maximum characters per ecc/mode
-				$len  = static::getMaxLengthForMode(static::$FQN::DATAMODE, $version, $eccLevel);
+				$len  = static::getMaxLengthForMode($dataMode, $version, $eccLevel);
 				// a string that contains the maximum amount of characters for the given mode
 				$val  = ($mb) ? mb_substr($str, 0, $len) : substr($str, 0, $len);
 				// same as above but character count exceeds
@@ -171,8 +150,10 @@ public function testMaxLength(Version $version, EccLevel $eccLevel, string $str)
 		$options           = new QROptions;
 		$options->version  = $version->getVersionNumber();
 		$options->eccLevel = $eccLevel->getLevel();
-		$this->dataMode    = new static::$FQN($str);
+
+		$this->dataMode    = static::getDataModeInterface($str);
 		$this->QRData      = new QRData($options, [$this->dataMode]);
+
 		$bitBuffer         = $this->QRData->getBitBuffer();
 
 		$this::assertSame($this->dataMode::DATAMODE, $bitBuffer->read(4));
@@ -187,8 +168,10 @@ public function testGetMinimumVersion(Version $version, EccLevel $eccLevel, stri
 		$options           = new QROptions;
 		$options->version  = Version::AUTO;
 		$options->eccLevel = $eccLevel->getLevel();
-		$this->dataMode    = new static::$FQN($str);
+
+		$this->dataMode    = static::getDataModeInterface($str);
 		$this->QRData      = new QRData($options, [$this->dataMode]);
+
 		$bitBuffer         = $this->QRData->getBitBuffer();
 
 		$this::assertLessThanOrEqual($eccLevel->getMaxBitsForVersion($version), $this->QRData->estimateTotalBitLength());
@@ -214,7 +197,7 @@ public function testMaxLengthOverflowException(Version $version, EccLevel $eccLe
 		$options->eccLevel = $eccLevel->getLevel();
 
 		/** @phan-suppress-next-line PhanNoopNew */
-		new QRData($options, [new static::$FQN($str1)]);
+		new QRData($options, [static::getDataModeInterface($str1)]);
 	}
 
 	/**
@@ -224,7 +207,7 @@ public function testGetMinimumVersionException():void{
 		$this->expectException(QRCodeDataException::class);
 		$this->expectExceptionMessage('data exceeds');
 
-		$this->QRData->setData([new static::$FQN(str_repeat(static::$testdata, 1337))]);
+		$this->QRData->setData([static::getDataModeInterface(str_repeat(static::testData, 1337))]);
 	}
 
 	/**
@@ -234,8 +217,7 @@ public function testInvalidDataException():void{
 		$this->expectException(QRCodeDataException::class);
 		$this->expectExceptionMessage('invalid data');
 
-		/** @phan-suppress-next-line PhanNoopNew */
-		new static::$FQN('##');
+		static::getDataModeInterface('##');
 	}
 
 	/**
@@ -245,8 +227,7 @@ public function testInvalidDataOnEmptyException():void{
 		$this->expectException(QRCodeDataException::class);
 		$this->expectExceptionMessage('invalid data');
 
-		/** @phan-suppress-next-line PhanNoopNew */
-		new static::$FQN('');
+		static::getDataModeInterface('');
 	}
 
 }