ComponentLanguageFileDirectoryTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Language\ComponentTranslation;
 
use ILIAS\Component\Component;
use PHPUnit\Framework\TestCase;
 
class ComponentLanguageFileDirectoryTest extends TestCase
{
    public function testGetPathReturnsTheSameValueOnRepeatedCallsAndMatchesTheUncachedComputation(): void
    {
        // a real (non-mock) class defined here, so ReflectionClass::getFileName() resolves to this file - deterministic
        // and computable below without ComponentLanguageFileDirectory's internals
        $component = new class () implements Component {
            public function init(
                array|\ArrayAccess &$define,
                array|\ArrayAccess &$implement,
                array|\ArrayAccess &$use,
                array|\ArrayAccess &$contribute,
                array|\ArrayAccess &$seek,
                array|\ArrayAccess &$provide,
                array|\ArrayAccess &$pull,
                array|\ArrayAccess &$internal,
            ): void {
            }
        };
 
        $directory = new ComponentLanguageFileDirectory($component, 'tst', 'lang/');
 
        // independently reproduces getPath()'s computation from __DIR__ of this file
        $ilias_root = (string) realpath(__DIR__ . '/../../../../../');
        self::assertNotSame('', $ilias_root, 'Could not resolve the ILIAS root from this test file - did it move?');
        $expected_base_directory = str_replace($ilias_root . '/', '', __DIR__);
        $expected_path = $expected_base_directory . '/lang/';
 
        $first_call = $directory->getPath();
        $second_call = $directory->getPath();
        $third_call = $directory->getPath();
 
        self::assertSame($expected_path, $first_call);
        self::assertSame($first_call, $second_call);
        self::assertSame($first_call, $third_call);
    }
 
    public function testGetPathAppendsTheConfiguredPathInsideComponentToTheBaseDirectory(): void
    {
        $component = new class () implements Component {
            public function init(
                array|\ArrayAccess &$define,
                array|\ArrayAccess &$implement,
                array|\ArrayAccess &$use,
                array|\ArrayAccess &$contribute,
                array|\ArrayAccess &$seek,
                array|\ArrayAccess &$provide,
                array|\ArrayAccess &$pull,
                array|\ArrayAccess &$internal,
            ): void {
            }
        };
 
        $directory = new ComponentLanguageFileDirectory($component, 'tst', 'custom/lang/path/');
 
        self::assertStringEndsWith('/custom/lang/path/', $directory->getPath());
    }
 
    private function anyComponent(): Component
    {
        return new class () implements Component {
            public function init(
                array|\ArrayAccess &$define,
                array|\ArrayAccess &$implement,
                array|\ArrayAccess &$use,
                array|\ArrayAccess &$contribute,
                array|\ArrayAccess &$seek,
                array|\ArrayAccess &$provide,
                array|\ArrayAccess &$pull,
                array|\ArrayAccess &$internal,
            ): void {
            }
        };
    }
 
    public function testDefaultShippedFileNamePatternIsPrefixUnderscore(): void
    {
        $directory = new ComponentLanguageFileDirectory($this->anyComponent(), 'tos');
 
        self::assertSame('tos_%s', $directory->getShippedFileNamePattern());
    }
 
    public function testACustomShippedFileNamePatternIsUsedAsGiven(): void
    {
        $directory = new ComponentLanguageFileDirectory($this->anyComponent(), 'tos', 'lang/', 'ilias_%s');
 
        self::assertSame('ilias_%s', $directory->getShippedFileNamePattern());
    }
 
    public function testAnInvalidCustomShippedFileNamePatternIsRejectedByTheConstructor(): void
    {
        $this->expectException(\InvalidArgumentException::class);
 
        new ComponentLanguageFileDirectory($this->anyComponent(), 'tos', 'lang/', 'no-placeholder-at-all');
    }
}