wiki.techinc.nl/tests/phpunit/includes/libs/normal/UtfNormalTest.php

<?php
/**
 * Implements the conformance test at:
 * http://www.unicode.org/Public/UNIDATA/NormalizationTest.txt
 *
 * Copyright © 2004 Brion Vibber <brion@pobox.com>
 * https://www.mediawiki.org/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @group UtfNormal
 * @group large
 */

class UtfNormalTest extends PHPUnit_Framework_TestCase {

	protected static $testedChars = array();

	public static function provideNormalizationTest() {
		global $IP;
		$in = fopen( "$IP/tests/phpunit/data/normal/NormalizationTest.txt", "rt" );

		$testCases = array();
		while ( false !== ( $line = fgets( $in ) ) ) {
			list( $data, $comment ) = explode( '#', $line );
			if ( $data === '' ) continue;
			$matches = array();
			if ( preg_match( '/@Part([\d])/', $data, $matches ) ) {
				continue;
			}

			$columns = array_map( "hexSequenceToUtf8", explode( ";", $data ) );
			array_unshift( $columns, '' );

			self::$testedChars[$columns[1]] = true;
			$testCases[] = array( $columns, $comment );
		}
		fclose( $in );

		return array( array( $testCases ) );
	}

	function assertStringEquals( $a, $b, $desc ) {
		$this->assertEquals( 0, strcmp( $a, $b ), $desc );
	}

	function assertNFC( $c, $desc ) {
		$this->assertStringEquals( $c[2], UtfNormal::toNFC( $c[1] ), $desc );
		$this->assertStringEquals( $c[2], UtfNormal::toNFC( $c[2] ), $desc );
		$this->assertStringEquals( $c[2], UtfNormal::toNFC( $c[3] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::toNFC( $c[4] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::toNFC( $c[5] ), $desc );
	}

	function assertNFD( $c, $desc ) {
		$this->assertStringEquals( $c[3], UtfNormal::toNFD( $c[1] ), $desc );
		$this->assertStringEquals( $c[3], UtfNormal::toNFD( $c[2] ), $desc );
		$this->assertStringEquals( $c[3], UtfNormal::toNFD( $c[3] ), $desc );
		$this->assertStringEquals( $c[5], UtfNormal::toNFD( $c[4] ), $desc );
		$this->assertStringEquals( $c[5], UtfNormal::toNFD( $c[5] ), $desc );
	}

	function assertNFKC( $c, $desc ) {
		$this->assertStringEquals( $c[4], UtfNormal::toNFKC( $c[1] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::toNFKC( $c[2] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::toNFKC( $c[3] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::toNFKC( $c[4] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::toNFKC( $c[5] ), $desc );
	}

	function assertNFKD( $c, $desc ) {
		$this->assertStringEquals( $c[5], UtfNormal::toNFKD( $c[1] ), $desc );
		$this->assertStringEquals( $c[5], UtfNormal::toNFKD( $c[2] ), $desc );
		$this->assertStringEquals( $c[5], UtfNormal::toNFKD( $c[3] ), $desc );
		$this->assertStringEquals( $c[5], UtfNormal::toNFKD( $c[4] ), $desc );
		$this->assertStringEquals( $c[5], UtfNormal::toNFKD( $c[5] ), $desc );
	}

	function assertCleanUp( $c, $desc ) {
		$this->assertStringEquals( $c[2], UtfNormal::cleanUp( $c[1] ), $desc );
		$this->assertStringEquals( $c[2], UtfNormal::cleanUp( $c[2] ), $desc );
		$this->assertStringEquals( $c[2], UtfNormal::cleanUp( $c[3] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::cleanUp( $c[4] ), $desc );
		$this->assertStringEquals( $c[4], UtfNormal::cleanUp( $c[5] ), $desc );
	}

	/**
	 * The data provider for this intentionally returns all the
	 * test cases as one since PHPUnit is too slow otherwise
	 *
	 * @dataProvider provideNormalizationTest
	 */
	function testNormals( $testCases ) {
		foreach ( $testCases as $case ) {
			$c = $case[0];
			$desc = $case[1];
			$this->assertNFC( $c, $desc );
			$this->assertNFD( $c, $desc );
			$this->assertNFKC( $c, $desc );
			$this->assertNFKD( $c, $desc );
			$this->assertCleanUp( $c, $desc );
		}
	}

	public static function provideUnicodeData() {
		global $IP;
		$in = fopen( "$IP/tests/phpunit/data/normal/UnicodeData.txt", "rt" );
		$testCases = array();
		while ( false !== ( $line = fgets( $in ) ) ) {
			$cols = explode( ';', $line );
			$char = codepointToUtf8( hexdec( $cols[0] ) );
			$desc = $cols[0] . ": " . $cols[1];
			if ( $char < "\x20" || $char >= UTF8_SURROGATE_FIRST && $char <= UTF8_SURROGATE_LAST ) {
				# Can't check NULL with the ICU plugin, as null bytes fail in C land.
				# Skip other control characters, as we strip them for XML safety.
				# Surrogates are illegal on their own or in UTF-8, ignore.
				continue;
			}
			if ( empty( self::$testedChars[$char] ) ) {
				$testCases[] = array( $char, $desc );
			}
		}
		fclose( $in );

		return array( array( $testCases ) );
	}

	/**
	 * The data provider for this intentionally returns all the
	 * test cases as one since PHPUnit is too slow otherwise
	 *
	 * @depends testNormals
	 * @dataProvider provideUnicodeData
	 */
	public function testInvariant( $testCases ) {
		foreach ( $testCases as $case ) {
			$char = $case[0];
			$desc = $case[1];
			$this->assertStringEquals( $char, UtfNormal::toNFC( $char ), $desc );
			$this->assertStringEquals( $char, UtfNormal::toNFD( $char ), $desc );
			$this->assertStringEquals( $char, UtfNormal::toNFKC( $char ), $desc );
			$this->assertStringEquals( $char, UtfNormal::toNFKD( $char ), $desc );
			$this->assertStringEquals( $char, UtfNormal::cleanUp( $char ), $desc );
		}
	}
}