LanguageInstallationManagerMigratedRemarksTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Language\ComponentTranslation\CustomizingLanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\Catalog\TranslationCatalog;
use ILIAS\Language\ComponentTranslation\LanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\LanguageFileDirectoryManager;
use ILIAS\Language\ComponentTranslation\LocalChangeComments;
use ILIAS\Language\ComponentTranslation\MainLanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\MigratedLanguageFileSync;
use ILIAS\Language\Setup\InstalledLanguageRepository;
use ILIAS\Language\Setup\LanguageDataNotSavedException;
use ILIAS\Language\Setup\LanguageInstallationManager;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
 
class LanguageInstallationManagerMigratedRemarksTest extends LanguageInstallationManagerMigratedModulesTestCase
{
    private function callMigratedModuleRemarks(
        array $shipped_migrated_modules,
        array $customized_remarks = [],
        array $shipped_line_comments = [],
        array $overlay_only_modules = []
    ): array {
        $manager = $this->manager();
        $method = new ReflectionMethod(LanguageInstallationManager::class, 'migratedModuleRemarks');
 
        return $method->invoke(
            $manager,
            'de',
            $shipped_migrated_modules,
            $customized_remarks,
            $shipped_line_comments,
            $this->root . '/client-data',
            $overlay_only_modules
        );
    }
 
    private function seedOverlayWithRemark(string $identifier, string $value, string $remark): void
    {
        $catalog = new TranslationCatalog();
        $entry = new \ILIAS\Language\ComponentTranslation\Catalog\TranslationEntry(self::MODULE, $identifier);
        $entry->translate($value);
        LocalChangeComments::setRemark($entry, $remark);
        $catalog->add($entry);
        MigratedPoFixture::writePair($this->overlayBase(), $catalog);
    }
 
    public function testMigratedModuleRemarksMergesLngDataOverlayAndCustomizingWithCustomizingWinning(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->seedOverlayWithRemark('greeting', 'Hallo', 'Overlay-Bemerkung');
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'DB-Bemerkung'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks(
            [self::MODULE => ['greeting' => 'Hallo']],
            [self::MODULE => ['greeting' => 'Customizing-Bemerkung']]
        );
 
        $this->assertSame(['greeting' => 'Customizing-Bemerkung'], $remarks[self::MODULE]);
    }
 
    public function testMigratedModuleRemarksOverlayWinsOverLngDataWithoutACustomizingRemark(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->seedOverlayWithRemark('greeting', 'Hallo', 'Overlay-Bemerkung');
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'DB-Bemerkung'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Hallo']]);
 
        $this->assertSame(['greeting' => 'Overlay-Bemerkung'], $remarks[self::MODULE]);
    }
 
    public function testMigratedModuleRemarksFallsBackToLngDataWithoutAnOverlayOrCustomizingRemark(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'DB-Bemerkung'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Hallo']]);
 
        $this->assertSame(['greeting' => 'DB-Bemerkung'], $remarks[self::MODULE]);
    }
 
    public function testMigratedModuleRemarksOfAnOverlayOnlyModuleIgnoreLngData(): void
    {
        $this->shipPo(['greeting' => 'Hallo', 'farewell' => 'Tschüss']);
        $this->seedOverlayWithRemark('greeting', 'Hallo', 'Overlay-Bemerkung');
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'DB-Bemerkung'],
            ['module' => self::MODULE, 'identifier' => 'farewell', 'remarks' => 'DB-Bemerkung 2'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks(
            [self::MODULE => ['greeting' => 'Hallo', 'farewell' => 'Tschüss']],
            [self::MODULE => ['customized' => 'Customizing-Bemerkung']],
            [],
            [self::MODULE]
        );
 
        $this->assertSame(['greeting' => 'Overlay-Bemerkung', 'customized' => 'Customizing-Bemerkung'], $remarks[self::MODULE]);
    }
 
    public function testMigratedModuleRemarksIsEmptyWithoutAnyRemarkAnywhere(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->collation_rows = [];
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Hallo']]);
 
        $this->assertSame([], $remarks[self::MODULE] ?? []);
    }
 
    public function testMigratedModuleRemarksExcludesALngDataRemarkThatMatchesTheShippedLineComment(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'Alter Zeilenkommentar'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks(
            [self::MODULE => ['greeting' => 'Hallo']],
            [],
            [self::MODULE => ['greeting' => 'Alter Zeilenkommentar']]
        );
 
        $this->assertArrayNotHasKey('greeting', $remarks[self::MODULE] ?? []);
    }
 
    public function testMigratedModuleRemarksExcludesALngDataRemarkThatMatchesTheShippedPoNote(): void
    {
        $catalog = new TranslationCatalog();
        $entry = new \ILIAS\Language\ComponentTranslation\Catalog\TranslationEntry(self::MODULE, 'greeting');
        $entry->translate('Hallo');
        $entry->addExtractedComment('PO-Notiz');
        $catalog->add($entry);
        MigratedPoFixture::writePo($this->root . '/components/pilot/lang/pilot_de.po', $catalog);
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'PO-Notiz'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Hallo']]);
 
        $this->assertArrayNotHasKey('greeting', $remarks[self::MODULE] ?? []);
    }
 
    public function testMigratedModuleRemarksExcludesALngDataRemarkThatMatchesTheShippedTranslatorNote(): void
    {
        $catalog = new TranslationCatalog();
        $entry = new \ILIAS\Language\ComponentTranslation\Catalog\TranslationEntry(self::MODULE, 'greeting');
        $entry->translate('Hallo');
        $entry->addTranslatorNote('Eigene Notiz');
        $catalog->add($entry);
        MigratedPoFixture::writePo($this->root . '/components/pilot/lang/pilot_de.po', $catalog);
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'Eigene Notiz'],
        ];
        $overlay = MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Hallo']);
        LocalChangeComments::setRemark($overlay->find(self::MODULE, 'greeting'), ' Eigene Notiz ');
        MigratedPoFixture::writePair($this->overlayBase(), $overlay);
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Hallo']]);
 
        $this->assertArrayNotHasKey('greeting', $remarks[self::MODULE] ?? []);
    }
 
    public function testMigratedModuleRemarksDropsAnOverlayRemarkTheShippedPoHasAsNoteNow(): void
    {
        $catalog = new TranslationCatalog();
        foreach (['greeting' => 'Merk', 'other' => 'Notiz'] as $identifier => $note) {
            $entry = new \ILIAS\Language\ComponentTranslation\Catalog\TranslationEntry(self::MODULE, $identifier);
            $entry->translate('Wert');
            $entry->addExtractedComment($note);
            $catalog->add($entry);
        }
        MigratedPoFixture::writePo($this->root . '/components/pilot/lang/pilot_de.po', $catalog);
        $overlay = MigratedPoFixture::catalog(self::MODULE, ['greeting' => 'Wert', 'other' => 'Wert']);
        LocalChangeComments::setRemark($overlay->find(self::MODULE, 'greeting'), '  Merk ');
        LocalChangeComments::setRemark($overlay->find(self::MODULE, 'other'), 'Eigene Bemerkung');
        MigratedPoFixture::writePair($this->overlayBase(), $overlay);
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Wert', 'other' => 'Wert']]);
 
        $this->assertSame(['other' => 'Eigene Bemerkung'], $remarks[self::MODULE]);
    }
 
    public function testAMergedValueAndRemarkLeaveTheOverlayWithTheUpdateAfterTheBuild(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $directories = new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), $this->directory);
        MigratedLanguageFileSync::sync($directories, $this->root, 'de', self::MODULE, ['greeting' => 'Servus'], $this->root . '/client-data', false, null, ['greeting' => 'Merk']);
        $this->assertSame('Merk', MigratedLanguageFileSync::loadRemarks($directories, 'de', self::MODULE, $this->root . '/client-data', $this->root)['greeting'] ?? null, 'precondition');
 
        mkdir($this->root . '/backup');
        $result = \ILIAS\Language\ComponentTranslation\ShippedPoMerger::merge($directories, $this->root, 'de', $this->root . '/client-data', $this->root . '/backup');
        $this->assertSame([], $result['skipped'], 'precondition');
        MigratedPoFixture::build($directories, $this->root);
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertFileDoesNotExist($this->overlayBase() . '.po');
        $shipped = MigratedPoFixture::readPo($this->root . '/components/pilot/lang/pilot_de.po')->find(self::MODULE, 'greeting');
        $this->assertSame('Servus', $shipped?->getTranslation());
        $this->assertSame(['Merk'], $shipped->getTranslatorComments());
        $this->assertSame('Servus', $this->lngModules()[self::MODULE]['greeting']);
        $this->assertSame('Servus', (new \ILIAS\Language\ComponentTranslation\TranslationGettextRepository())->getText(self::MODULE, 'de', 'greeting', $this->root . '/client-data'));
    }
 
    public function testMigratedModuleRemarksExcludesADatedNewVariableMarkerRemark(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => '28 08 2012 new variable'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks([self::MODULE => ['greeting' => 'Hallo']]);
 
        $this->assertArrayNotHasKey('greeting', $remarks[self::MODULE] ?? []);
    }
 
    public function testMigratedModuleRemarksKeepsALngDataRemarkThatDiffersFromEveryShippedComment(): void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->collation_rows = [
            ['module' => self::MODULE, 'identifier' => 'greeting', 'remarks' => 'Echte Admin-Bemerkung'],
        ];
 
        $remarks = $this->callMigratedModuleRemarks(
            [self::MODULE => ['greeting' => 'Hallo']],
            [],
            [self::MODULE => ['greeting' => 'Ganz anderer Zeilenkommentar']]
        );
 
        $this->assertSame('Echte Admin-Bemerkung', $remarks[self::MODULE]['greeting'] ?? null);
    }
}