MediaTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\GlobalScreen\Scope\Layout;
 
use PHPUnit\Framework\TestCase;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\MetaContent;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\Media\Css;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\Media\InlineCss;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\Media\Js;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\Media\AbstractCollection;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\Media\DeliverPhpFilter;
use ILIAS\GlobalScreen\Scope\Layout\MetaContent\Media\VersionParameterFilter;
 
require_once('./vendor/composer/vendor/autoload.php');
 
final class MediaTest extends TestCase
{
    private const VERSION = AbstractCollection::VERSION_PARAMETER;
    public string $version;
    public MetaContent $meta_content;
 
    protected function setUp(): void
    {
        parent::setUp();
        $this->version = '1.2.3.4.5.6.7.8.9';
        $this->meta_content = new MetaContent(
            $this->version,
            true,
            false,
            true,
            true
        );
    }
 
    public function testAddCssFile(): void
    {
        $path = '/path/to/file.css';
        $this->meta_content->addCss($path);
        $collection = $this->meta_content->getCss();
 
        $iterator_to_array = iterator_to_array($collection->getItems());
        $first_item = array_shift($iterator_to_array);
        $this->assertInstanceOf(Css::class, $first_item);
        $this->assertSame($path . '?' . self::VERSION . '=' . $this->version, $first_item->getContent());
        $this->assertSame(MetaContent::MEDIA_SCREEN, $first_item->getMedia());
    }
 
    public function testAddCssFileWithQuery(): void
    {
        $path = '/path/to/file.css?my=query';
        $this->meta_content->addCss($path);
        $collection = $this->meta_content->getCss();
 
        $iterator_to_array = iterator_to_array($collection->getItems());
        $first_item = array_shift($iterator_to_array);
        $this->assertInstanceOf(Css::class, $first_item);
        $this->assertSame($path . '&' . self::VERSION . '=' . $this->version, $first_item->getContent());
        $this->assertSame(MetaContent::MEDIA_SCREEN, $first_item->getMedia());
    }
 
    public function testAddInlineCss(): void
    {
        $css = 'body {background-color:red;}';
        $this->meta_content->addInlineCss($css);
        $collection = $this->meta_content->getInlineCss();
 
        $first_item = iterator_to_array($collection->getItems())[0];
        $this->assertInstanceOf(InlineCss::class, $first_item);
        $this->assertSame($css, $first_item->getContent());
        $this->assertSame(MetaContent::MEDIA_SCREEN, $first_item->getMedia());
    }
 
    public function testAddJsFile(): void
    {
        $path = '/path/to/file.js';
        $this->meta_content->addJs($path);
        $collection = $this->meta_content->getJs();
 
        $iterator_to_array = iterator_to_array($collection->getItems());
        $first_item = $iterator_to_array[$path];
        $this->assertInstanceOf(Js::class, $first_item);
        $this->assertSame($path . '?' . self::VERSION . '=' . $this->version, $first_item->getContent());
        $this->assertSame(2, $first_item->getBatch());
    }
 
    public function testAddJsFileWithQuery(): void
    {
        $path = '/path/to/file.js';
        $path_with_query = $path . '?my=query';
        $this->meta_content->addJs($path_with_query);
        $collection = $this->meta_content->getJs();
 
        $first_item = iterator_to_array($collection->getItems())[$path];
        $this->assertInstanceOf(Js::class, $first_item);
        $this->assertSame($path_with_query . '&' . self::VERSION . '=' . $this->version, $first_item->getContent());
        $this->assertSame(2, $first_item->getBatch());
    }
 
    public function testDeliverPhpCssIsExcludedFromVersionParameter(): void
    {
        $this->meta_content->addVersionParameterFilter(new DeliverPhpFilter());
        $path = '/ilias/public/deliver.php/HczLCgMhDIXhd8m6NDGjUYdhnsRNqk43vVGlUErfvXY2/-/style.css';
        $this->meta_content->addCss($path);
        $collection = $this->meta_content->getCss();
 
        $items = iterator_to_array($collection->getItems());
        $first_item = array_shift($items);
        $this->assertInstanceOf(Css::class, $first_item);
        $this->assertSame($path, $first_item->getContent());
    }
 
    public function testDeliverPhpJsIsExcludedFromVersionParameter(): void
    {
        $this->meta_content->addVersionParameterFilter(new DeliverPhpFilter());
        $path = '/ilias/public/deliver.php/HczLCgMhDIXhd8m6NDGjUYdhnsRNqk43vVGlUErfvXY2/-/script.js';
        $this->meta_content->addJs($path);
        $collection = $this->meta_content->getJs();
 
        $first_item = iterator_to_array($collection->getItems())[$path];
        $this->assertInstanceOf(Js::class, $first_item);
        $this->assertSame($path, $first_item->getContent());
    }
 
    public function testFilterDoesNotAffectUnrelatedUrls(): void
    {
        $this->meta_content->addVersionParameterFilter(new DeliverPhpFilter());
        $path = '/path/to/file.css';
        $this->meta_content->addCss($path);
        $collection = $this->meta_content->getCss();
 
        $items = iterator_to_array($collection->getItems());
        $first_item = array_shift($items);
        $this->assertInstanceOf(Css::class, $first_item);
        $this->assertSame($path . '?' . self::VERSION . '=' . $this->version, $first_item->getContent());
    }
 
    public function testCustomVersionParameterFilter(): void
    {
        $custom_filter = new class () implements VersionParameterFilter {
            public function shouldAppend(string $content): bool
            {
                return !str_contains($content, '/no-version/');
            }
        };
        $this->meta_content->addVersionParameterFilter($custom_filter);
 
        $excluded = '/no-version/file.js';
        $included = '/path/to/file.js';
        $this->meta_content->addJs($excluded);
        $this->meta_content->addJs($included);
 
        $items = iterator_to_array($this->meta_content->getJs()->getItems());
        $this->assertEquals($excluded, $items[$excluded]->getContent());
        $this->assertEquals(
            $included . '?' . self::VERSION . '=' . $this->version,
            $items[$included]->getContent()
        );
    }
 
    public function testFiltersViaConstructorAreApplied(): void
    {
        $meta_content = new MetaContent(
            $this->version,
            true,
            false,
            true,
            true,
            [new DeliverPhpFilter()]
        );
        $path = '/ilias/public/deliver.php/SIGNED/-/style.css';
        $meta_content->addCss($path);
 
        $items = iterator_to_array($meta_content->getCss()->getItems());
        $first_item = array_shift($items);
        $this->assertEquals($path, $first_item->getContent());
    }
}