I18N: Introduce the Plural_Forms class.

Historically, we've evaluated the plural forms for each language using `create_function()`. This is being deprecated in PHP 7.2, so needs to be replaced.

The `Plural_Forms` class parses the `Plural-Forms` header from the PO file, and internally caches the result of all subsequent plural form tests, allowing it to match the performance of the existing code.

Props rmccue.
Fixes #41562.



git-svn-id: https://develop.svn.wordpress.org/trunk@41722 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Gary Pendergast
2017-10-04 01:29:59 +00:00
parent 3fcfefd05c
commit f3a52234ea
8 changed files with 600 additions and 6 deletions

View File

@@ -1,5 +1,8 @@
<?php
/**
* @group pomo
*/
class Tests_POMO_MO extends WP_UnitTestCase {
function test_mo_simple() {

View File

@@ -1,5 +1,8 @@
<?php
/**
* @group pomo
*/
class Tests_POMO_NOOPTranslations extends WP_UnitTestCase {
function setUp() {
parent::setUp();

View File

@@ -0,0 +1,232 @@
<?php
/**
* @group pomo
*/
class PluralFormsTest extends WP_UnitTestCase {
/**
* Legacy plural form function.
*
* @param int $nplurals
* @param string $expression
*/
protected static function make_plural_form_function($nplurals, $expression) {
$expression = str_replace('n', '$n', $expression);
$func_body = "
\$index = (int)($expression);
return (\$index < $nplurals)? \$index : $nplurals - 1;";
return create_function('$n', $func_body);
}
/**
* Parenthesize plural expression.
*
* Legacy workaround for PHP's flipped precedence order for ternary.
*
* @param string $expression the expression without parentheses
* @return string the expression with parentheses added
*/
protected static function parenthesize_plural_expression($expression) {
$expression .= ';';
$res = '';
$depth = 0;
for ($i = 0; $i < strlen($expression); ++$i) {
$char = $expression[$i];
switch ($char) {
case '?':
$res .= ' ? (';
$depth++;
break;
case ':':
$res .= ') : (';
break;
case ';':
$res .= str_repeat(')', $depth) . ';';
$depth= 0;
break;
default:
$res .= $char;
}
}
return rtrim($res, ';');
}
public static function locales_provider() {
if ( ! class_exists( 'GP_Locales' ) ) {
$filename = download_url( 'https://raw.githubusercontent.com/GlotPress/GlotPress-WP/develop/locales/locales.php' );
if ( is_wp_error( $filename ) ) {
self::markTestSkipped( 'Unable to retrieve GP_Locales file' );
}
require_once $filename;
}
$locales = GP_Locales::locales();
$plural_expressions = array();
foreach ( $locales as $slug => $locale ) {
$plural_expression = $locale->plural_expression;
if ( $plural_expression !== 'n != 1' ) {
$plural_expressions[] = array( $slug, $locale->nplurals, $plural_expression );
}
}
return $plural_expressions;
}
/**
* @dataProvider locales_provider
* @group external-http
*/
public function test_regression( $lang, $nplurals, $expression ) {
$parenthesized = self::parenthesize_plural_expression( $expression );
$old_style = self::make_plural_form_function( $nplurals, $parenthesized );
$pluralForms = new Plural_Forms( $expression );
$generated_old = array();
$generated_new = array();
foreach ( range( 0, 200 ) as $i ) {
$generated_old[] = $old_style( $i );
$generated_new[] = $pluralForms->get( $i );
}
$this->assertSame( $generated_old, $generated_new );
}
public static function simple_provider() {
return array(
array(
// Simple equivalence.
'n != 1',
array(
-1 => 1,
0 => 1,
1 => 0,
2 => 1,
5 => 1,
10 => 1,
),
),
array(
// Ternary
'n ? 1 : 2',
array(
-1 => 1,
0 => 2,
1 => 1,
2 => 1,
),
),
array(
// Comparison
'n > 1 ? 1 : 2',
array(
-2 => 2,
-1 => 2,
0 => 2,
1 => 2,
2 => 1,
3 => 1,
),
),
array(
'n > 1 ? n > 2 ? 1 : 2 : 3',
array(
-2 => 3,
-1 => 3,
0 => 3,
1 => 3,
2 => 2,
3 => 1,
4 => 1,
),
),
);
}
/**
* @dataProvider simple_provider
*/
public function test_simple( $expression, $expected ) {
$pluralForms = new Plural_Forms( $expression );
$actual = array();
foreach ( array_keys( $expected ) as $num ) {
$actual[ $num ] = $pluralForms->get( $num );
}
$this->assertSame( $expected, $actual );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Unknown symbol "#"
*/
public function test_invalid_operator() {
$pluralForms = new Plural_Forms( 'n # 2' );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Unknown operator "&"
*/
public function test_partial_operator() {
$pluralForms = new Plural_Forms( 'n & 1' );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Mismatched parentheses
*/
public function test_mismatched_open_paren() {
$pluralForms = new Plural_Forms( '((n)' );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Mismatched parentheses
*/
public function test_mismatched_close_paren() {
$pluralForms = new Plural_Forms( '(n))' );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Missing starting "?" ternary operator
*/
public function test_missing_ternary_operator() {
$pluralForms = new Plural_Forms( 'n : 2' );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Unknown operator "?"
*/
public function test_missing_ternary_else() {
$pluralForms = new Plural_Forms( 'n ? 1' );
$pluralForms->get( 1 );
}
/**
* @expectedException Exception
* @expectedExceptionMessage Too many values remaining on the stack
*/
public function test_overflow_stack() {
$pluralForms = new Plural_Forms( 'n n' );
$pluralForms->get( 1 );
}
public function test_cache() {
$mock = $this->getMockBuilder( 'Plural_Forms' )
->setMethods(array('execute'))
->setConstructorArgs(array('n != 1'))
->getMock();
$mock->expects($this->once())
->method('execute')
->with($this->identicalTo(2))
->willReturn(1);
$first = $mock->get( 2 );
$second = $mock->get( 2 );
$this->assertEquals( $first, $second );
}
}

View File

@@ -1,5 +1,8 @@
<?php
/**
* @group pomo
*/
class Tests_POMO_PO extends WP_UnitTestCase {
function setUp() {
require_once ABSPATH . '/wp-includes/pomo/po.php';

View File

@@ -1,5 +1,8 @@
<?php
/**
* @group pomo
*/
class Tests_POMO_TranslationEntry extends WP_UnitTestCase {
function test_create_entry() {

View File

@@ -1,4 +1,8 @@
<?php
/**
* @group pomo
*/
class Tests_POMO_Translations extends WP_UnitTestCase {
function test_add_entry() {