MigratedLanguageFileSyncPluralHelpersTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Language\Tests\ComponentTranslation;
 
use ILIAS\Language\ComponentTranslation\MigratedLanguageFileSync;
use PHPUnit\Framework\TestCase;
 
class MigratedLanguageFileSyncPluralHelpersTest extends TestCase
{
    public function testCollapsesEveryFormToTheIdentifierWithTheDefaultFormsValue(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge NEU'];
 
        $this->assertSame(['item' => 'Einträge NEU'], MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testAFormMissingFromEntriesFallsBackToItsShippedValue(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item [1]' => 'Einträge NEU']; // form 0 not submitted at all
 
        $this->assertSame(['item' => 'Einträge NEU'], MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testThePluralIdentifierIsPlacedAtThePositionOfItsFirstFormKey(): void
    {
        $shipped = ['before' => 'A', 'item [0]' => 'Eintrag', 'item [1]' => 'Einträge', 'after' => 'B'];
 
        $this->assertSame(
            ['before', 'item', 'after'],
            array_keys(MigratedLanguageFileSync::collapsePluralForms($shipped, $shipped))
        );
    }
 
    public function testAFormIndexOutsideTheShippedFormCountIsIgnored(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge NEU', 'item [5]' => 'Geister-Form'];
 
        $collapsed = MigratedLanguageFileSync::collapsePluralForms($entries, $shipped);
 
        $this->assertSame(['item' => 'Einträge NEU'], $collapsed);
    }
 
    public function testAPlainValueNextToFormsIsDroppedInFavourOfTheForms(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item' => 'Veraltet', 'item [0]' => 'Eintrag', 'item [1]' => 'Einträge NEU'];
 
        $this->assertSame(['item' => 'Einträge NEU'], MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testEntriesUnrelatedToAnyPluralMessageAreKeptAsIs(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge', 'plain' => 'X'];
        $entries = ['plain' => 'Y', 'other' => 'Z'];
 
        $this->assertSame(['plain' => 'Y', 'other' => 'Z'], MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testWithoutAnyPluralMessageInShippedEntriesIsAnIdentity(): void
    {
        $shipped = ['plain' => 'X'];
        $entries = ['plain' => 'Y', 'other [0]' => 'looks like a form but is not one'];
 
        $this->assertSame($entries, MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testAnIdentifierShippedBothAsItsOwnEntryAndWithFormKeysIsNotTreatedAsPlural(): void
    {
        $shipped = ['item' => 'Eigener Wert', 'item [0]' => 'Form 0', 'item [1]' => 'Form 1'];
 
        $this->assertSame($shipped, MigratedLanguageFileSync::collapsePluralForms($shipped, $shipped));
    }
 
    public function testCollapsesToTheLastFormForAThreeFormLanguage(): void
    {
        $shipped = ['item [0]' => 'jeden', 'item [1]' => 'dva', 'item [2]' => 'mnoho'];
        $entries = ['item [0]' => 'jeden', 'item [1]' => 'dva', 'item [2]' => 'mnoho NEU'];
 
        $this->assertSame(['item' => 'mnoho NEU'], MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testCollapsesToTheClosestNonEmptyFormWhenTheLastFormIsEmpty(): void
    {
        $shipped = ['item [0]' => 'jeden', 'item [1]' => 'dva', 'item [2]' => 'mnoho'];
        $entries = ['item [0]' => 'jeden', 'item [1]' => 'dva', 'item [2]' => ''];
 
        $this->assertSame(['item' => 'dva'], MigratedLanguageFileSync::collapsePluralForms($entries, $shipped));
    }
 
    public function testAPlainValueOfAPluralIdentifierBecomesItsDefaultForm(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item' => 'Alter DB-Wert'];
 
        $this->assertSame(['item [1]' => 'Alter DB-Wert'], MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped));
    }
 
    public function testAPlainValueOfAThreeFormLanguagesPluralIdentifierBecomesTheLastForm(): void
    {
        $shipped = ['item [0]' => 'jeden', 'item [1]' => 'dva', 'item [2]' => 'mnoho'];
        $entries = ['item' => 'Alter DB-Wert'];
 
        $this->assertSame(['item [2]' => 'Alter DB-Wert'], MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped));
    }
 
    public function testAPlainValueOfASingleFormLanguagesPluralIdentifierBecomesFormZero(): void
    {
        $shipped = ['item [0]' => 'Eintrag']; // nplurals=1
        $entries = ['item' => 'Alter DB-Wert'];
 
        $this->assertSame(['item [0]' => 'Alter DB-Wert'], MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped));
    }
 
    public function testAPlainValueIsDroppedWhenItsDefaultFormKeyIsAlreadyPresent(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item' => 'Alter DB-Wert', 'item [1]' => 'Neue Form 1'];
 
        $this->assertSame(['item [1]' => 'Neue Form 1'], MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped));
    }
 
    public function testAPlainValueIsStillMappedWhenOnlyANonDefaultFormIsAlreadyPresent(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item' => 'Alter DB-Wert', 'item [0]' => 'Neue Form 0'];
 
        $this->assertSame(
            ['item [0]' => 'Neue Form 0', 'item [1]' => 'Alter DB-Wert'],
            MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped)
        );
    }
 
    public function testEntriesWithNoPlainPluralIdentifierAreUnaffected(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['plain' => 'X', 'item [0]' => 'A', 'item [1]' => 'B'];
 
        $this->assertSame($entries, MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped));
    }
 
    public function testPreservesNonStringValueTypes(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
        $entries = ['item' => true];
 
        $this->assertSame(['item [1]' => true], MigratedLanguageFileSync::mapLegacyPluralValues($entries, $shipped));
    }
 
    public function testPluralMessageOfResolvesAFormKeyToItsIdentifier(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
 
        $this->assertSame('item', MigratedLanguageFileSync::pluralMessageOf('item [1]', $shipped));
    }
 
    public function testPluralMessageOfResolvesTheBareIdentifierToo(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
 
        $this->assertSame('item', MigratedLanguageFileSync::pluralMessageOf('item', $shipped));
    }
 
    public function testPluralMessageOfIsNullForAnOrdinaryIdentifier(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge', 'plain' => 'X'];
 
        $this->assertNull(MigratedLanguageFileSync::pluralMessageOf('plain', $shipped));
    }
 
    public function testPluralMessageOfIsNullForAKeyThatMerelyLooksLikeAFormKey(): void
    {
        $shipped = ['plain [0]' => 'X']; // shipped as its own entry, not via other forms
        $shipped['plain'] = 'irrelevant';
 
        $this->assertNull(MigratedLanguageFileSync::pluralMessageOf('plain [0]', $shipped));
    }
 
    public function testPluralMessageOfIsNullForAnUnknownIdentifier(): void
    {
        $this->assertNull(MigratedLanguageFileSync::pluralMessageOf('unknown [0]', []));
        $this->assertNull(MigratedLanguageFileSync::pluralMessageOf('unknown', []));
    }
 
    public function testDefaultFormKeyOfMapsThePlainIdentifierToItsLastFormKey(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
 
        $this->assertSame('item [1]', MigratedLanguageFileSync::defaultFormKeyOf('item', $shipped));
    }
 
    public function testDefaultFormKeyOfMapsToTheLastFormOfAThreeFormLanguage(): void
    {
        $shipped = ['item [0]' => 'jeden', 'item [1]' => 'dva', 'item [2]' => 'mnoho'];
 
        $this->assertSame('item [2]', MigratedLanguageFileSync::defaultFormKeyOf('item', $shipped));
    }
 
    public function testDefaultFormKeyOfIsNullForAFormKeyItself(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge'];
 
        $this->assertNull(MigratedLanguageFileSync::defaultFormKeyOf('item [0]', $shipped));
        $this->assertNull(MigratedLanguageFileSync::defaultFormKeyOf('item [1]', $shipped));
    }
 
    public function testDefaultFormKeyOfIsNullForASingularKey(): void
    {
        $shipped = ['item [0]' => 'Eintrag', 'item [1]' => 'Einträge', 'item_singular' => 'Ein Eintrag'];
 
        $this->assertNull(MigratedLanguageFileSync::defaultFormKeyOf('item_singular', $shipped));
    }
 
    public function testDefaultFormKeyOfIsNullForAnUnknownIdentifier(): void
    {
        $this->assertNull(MigratedLanguageFileSync::defaultFormKeyOf('unknown', []));
    }
 
    public function testDefaultFormKeyOfIsNullForAnIdentifierShippedBothAsItsOwnEntryAndWithFormKeys(): void
    {
        $shipped = ['item' => 'Eigener Wert', 'item [0]' => 'Form 0', 'item [1]' => 'Form 1'];
 
        $this->assertNull(MigratedLanguageFileSync::defaultFormKeyOf('item', $shipped));
    }
}