ilSkinStyleLessFileTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once('libs/composer/vendor/autoload.php');

class ilSkinStyleLessFileTest extends ilSystemStyleBaseFSTest
{
    public function testConstructAndRead(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));
        $this->assertCount(14, $file->getItems());
    }

    public function testReadCorrectTypes(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $this->assertCount(2, $file->getCategories());
        $this->assertCount(6, $file->getVariablesIds());
        $this->assertCount(6, $file->getCommentsIds());
    }

    public function testGetVariableByName(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $expected_variable11 = new ilSystemStyleLessVariable(
            'variable11',
            'value11',
            'comment variable 11',
            'Category 1',
            []
        );
        $expected_variable12 = new ilSystemStyleLessVariable(
            'variable12',
            'value12',
            'comment variable 12',
            'Category 1',
            []
        );
        $expected_variable13 = new ilSystemStyleLessVariable(
            'variable13',
            '@variable11',
            'comment variable 13',
            'Category 1',
            ['variable11']
        );

        $expected_variable21 = new ilSystemStyleLessVariable(
            'variable21',
            '@variable11',
            'comment variable 21',
            'Category 2',
            ['variable11']
        );
        $expected_variable22 = new ilSystemStyleLessVariable(
            'variable22',
            'value21',
            'comment variable 22',
            'Category 2',
            []
        );
        $expected_variable23 = new ilSystemStyleLessVariable(
            'variable23',
            '@variable21',
            'comment variable 23',
            'Category 2',
            ['variable21']
        );

        $this->assertEquals($expected_variable11, $file->getVariableByName('variable11'));
        $this->assertEquals($expected_variable12, $file->getVariableByName('variable12'));
        $this->assertEquals($expected_variable13, $file->getVariableByName('variable13'));

        $this->assertEquals($expected_variable21, $file->getVariableByName('variable21'));
        $this->assertEquals($expected_variable22, $file->getVariableByName('variable22'));
        $this->assertEquals($expected_variable23, $file->getVariableByName('variable23'));
    }

    public function testGetCategory(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $expected_category1 = new ilSystemStyleLessCategory('Category 1', 'Comment Category 1');
        $expected_category2 = new ilSystemStyleLessCategory('Category 2', 'Comment Category 2');
        $expected_categories = [$expected_category1, $expected_category2];

        $this->assertEquals($expected_categories, $file->getCategories());
    }

    public function testGetItems(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $expected_category1 = new ilSystemStyleLessCategory('Category 1', 'Comment Category 1');
        $expected_comment2 = new ilSystemStyleLessComment('// Random Section 1');
        $expected_comment3 = new ilSystemStyleLessComment('');
        $expected_variable11 = new ilSystemStyleLessVariable(
            'variable11',
            'value11',
            'comment variable 11',
            'Category 1',
            []
        );
        $expected_variable12 = new ilSystemStyleLessVariable(
            'variable12',
            'value12',
            'comment variable 12',
            'Category 1',
            []
        );
        $expected_variable13 = new ilSystemStyleLessVariable(
            'variable13',
            '@variable11',
            'comment variable 13',
            'Category 1',
            ['variable11']
        );
        $expected_comment4 = new ilSystemStyleLessComment('');
        $expected_category2 = new ilSystemStyleLessCategory('Category 2', 'Comment Category 2');
        $expected_comment6 = new ilSystemStyleLessComment('');
        $expected_comment8 = new ilSystemStyleLessComment('');
        $expected_variable21 = new ilSystemStyleLessVariable(
            'variable21',
            '@variable11',
            'comment variable 21',
            'Category 2',
            ['variable11']
        );
        $expected_variable22 = new ilSystemStyleLessVariable(
            'variable22',
            'value21',
            'comment variable 22',
            'Category 2',
            []
        );
        $expected_variable23 = new ilSystemStyleLessVariable(
            'variable23',
            '@variable21',
            'comment variable 23',
            'Category 2',
            ['variable21']
        );

        $expected_items = [$expected_category1,
                           $expected_comment2,
                           $expected_comment3,
                           $expected_variable11,
                           $expected_variable12,
                           $expected_variable13,
                           $expected_comment4,
                           $expected_category2,
                           $expected_comment6,
                           $expected_comment7,
                           $expected_comment8,
                           $expected_variable21,
                           $expected_variable22,
                           $expected_variable23
        ];

        $this->assertEquals($expected_items, $file->getItems());
    }

    public function testGetContent(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));
        $expected_content = file_get_contents($this->container->getLessVariablesFilePath($this->style->getId()));
        $this->assertEquals($expected_content, $file->getContent());
    }

    public function testReadWriteDouble(): void
    {
        $expected_content = file_get_contents($this->container->getLessVariablesFilePath($this->style->getId()));

        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));
        $file->write();
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));
        $file->write();
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $this->assertEquals($expected_content, $file->getContent());
    }

    public function testReadWriteDoubleFullLess(): void
    {
        $expected_content = file_get_contents($this->container->getSkinDirectory() . 'full.less');

        $file = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'full.less');
        $file->write();
        $file = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'full.less');
        $file->write();
        $file = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'full.less');

        $this->assertEquals($expected_content, $file->getContent());
    }

    public function testChangeVariable(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));
        $variable = $file->getVariableByName('variable11');
        $variable->setValue('newvalue11');

        $expected_category1 = new ilSystemStyleLessCategory('Category 1', 'Comment Category 1');
        $expected_comment2 = new ilSystemStyleLessComment('// Random Section 1');
        $expected_comment3 = new ilSystemStyleLessComment('');
        $expected_variable11 = new ilSystemStyleLessVariable(
            'variable11',
            'newvalue11',
            'comment variable 11',
            'Category 1',
            []
        );
        $expected_variable12 = new ilSystemStyleLessVariable(
            'variable12',
            'value12',
            'comment variable 12',
            'Category 1',
            []
        );
        $expected_variable13 = new ilSystemStyleLessVariable(
            'variable13',
            '@variable11',
            'comment variable 13',
            'Category 1',
            ['variable11']
        );
        $expected_comment4 = new ilSystemStyleLessComment('');
        $expected_category2 = new ilSystemStyleLessCategory('Category 2', 'Comment Category 2');
        $expected_comment6 = new ilSystemStyleLessComment('');
        $expected_comment8 = new ilSystemStyleLessComment('');
        $expected_variable21 = new ilSystemStyleLessVariable(
            'variable21',
            '@variable11',
            'comment variable 21',
            'Category 2',
            ['variable11']
        );
        $expected_variable22 = new ilSystemStyleLessVariable(
            'variable22',
            'value21',
            'comment variable 22',
            'Category 2',
            []
        );
        $expected_variable23 = new ilSystemStyleLessVariable(
            'variable23',
            '@variable21',
            'comment variable 23',
            'Category 2',
            ['variable21']
        );

        $expected_items = [$expected_category1,
                           $expected_comment2,
                           $expected_comment3,
                           $expected_variable11,
                           $expected_variable12,
                           $expected_variable13,
                           $expected_comment4,
                           $expected_category2,
                           $expected_comment6,
                           $expected_comment7,
                           $expected_comment8,
                           $expected_variable21,
                           $expected_variable22,
                           $expected_variable23
        ];

        $this->assertEquals($expected_items, $file->getItems());
    }

    public function testAddAndWriteItems(): void
    {
        $empty_less = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'empty.less');

        $expected_category1 = new ilSystemStyleLessCategory('Category 1', 'Comment Category 1');
        $expected_comment2 = new ilSystemStyleLessComment('// Random Section 1');
        $expected_comment3 = new ilSystemStyleLessComment('');
        $expected_variable11 = new ilSystemStyleLessVariable(
            'variable11',
            'value11',
            'comment variable 11',
            'Category 1',
            []
        );
        $expected_variable12 = new ilSystemStyleLessVariable(
            'variable12',
            'value12',
            'comment variable 12',
            'Category 1',
            []
        );
        $expected_variable13 = new ilSystemStyleLessVariable(
            'variable13',
            '@variable11',
            'comment variable 13',
            'Category 1',
            ['variable11']
        );
        $expected_comment4 = new ilSystemStyleLessComment('');
        $expected_category2 = new ilSystemStyleLessCategory('Category 2', 'Comment Category 2');
        $expected_comment6 = new ilSystemStyleLessComment('');
        $expected_comment8 = new ilSystemStyleLessComment('');
        $expected_variable21 = new ilSystemStyleLessVariable(
            'variable21',
            '@variable11',
            'comment variable 21',
            'Category 2',
            ['variable11']
        );
        $expected_variable22 = new ilSystemStyleLessVariable(
            'variable22',
            'value21',
            'comment variable 22',
            'Category 2',
            []
        );
        $expected_variable23 = new ilSystemStyleLessVariable(
            'variable23',
            '@variable21',
            'comment variable 23',
            'Category 2',
            ['variable21']
        );

        $expected_items = [$expected_category1,
                           $expected_comment2,
                           $expected_comment3,
                           $expected_variable11,
                           $expected_variable12,
                           $expected_variable13,
                           $expected_comment4,
                           $expected_category2,
                           $expected_comment6,
                           $expected_comment7,
                           $expected_comment8,
                           $expected_variable21,
                           $expected_variable22,
                           $expected_variable23
        ];

        foreach ($expected_items as $item) {
            $empty_less->addItem($item);
        }
        $empty_less->write();

        $new_less = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'empty.less');
        $this->assertEquals($expected_items, $new_less->getItems());
    }

    public function testGetVariableReferences(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $this->assertEquals(['variable13', 'variable21'], $file->getReferencesToVariable('variable11'));
        $this->assertEquals([], $file->getReferencesToVariable('variable12'));
        $this->assertEquals([], $file->getReferencesToVariable('variable13'));

        $this->assertEquals(['variable23'], $file->getReferencesToVariable('variable21'));
        $this->assertEquals([], $file->getReferencesToVariable('variable22'));
        $this->assertEquals([], $file->getReferencesToVariable('variable23'));
    }

    public function testGetRefAndCommentAsString(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $this->assertEquals(
            'comment variable 11</br>Usage: variable13; variable21; ',
            $file->getRefAndCommentAsString('variable11', 'Usage:')
        );
        $this->assertEquals('comment variable 12', $file->getRefAndCommentAsString('variable12', 'Usage:'));
        $this->assertEquals('comment variable 13', $file->getRefAndCommentAsString('variable13', 'Usage:'));

        $this->assertEquals('comment variable 21</br>Usage: variable23; ', $file->getRefAndCommentAsString('variable21', 'Usage:'));
        $this->assertEquals('comment variable 22', $file->getRefAndCommentAsString('variable22', 'Usage:'));
        $this->assertEquals('comment variable 23', $file->getRefAndCommentAsString('variable23', 'Usage:'));
    }

    public function testGetVariableReferencesAsString(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getLessVariablesFilePath($this->style->getId()));

        $this->assertEquals('variable13; variable21; ', $file->getReferencesToVariableAsString('variable11'));
        $this->assertEquals('', $file->getReferencesToVariableAsString('variable12'));
        $this->assertEquals('', $file->getReferencesToVariableAsString('variable13'));

        $this->assertEquals('variable23; ', $file->getReferencesToVariableAsString('variable21'));
        $this->assertEquals('', $file->getReferencesToVariableAsString('variable22'));
        $this->assertEquals('', $file->getReferencesToVariableAsString('variable23'));
    }

    public function testReadCorrectTypesEdgeCases(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'edge-cases.less');

        $this->assertCount(3, $file->getCategories());
        $this->assertCount(7, $file->getVariablesIds());
        $this->assertCount(4, $file->getCommentsIds());
    }

    public function testGetItemsEdgeCases(): void
    {
        $file = new ilSystemStyleLessFile($this->container->getSkinDirectory() . 'edge-cases.less');

        $expected_comment1 = new ilSystemStyleLessComment('// No Category to start');
        $expected_comment2 = new ilSystemStyleLessComment('');

        $expected_variable11 = new ilSystemStyleLessVariable(
            'variableNoCategory1',
            'value11',
            'comment variable 11',
            '',
            []
        );
        $expected_variable12 = new ilSystemStyleLessVariable('variableNoCategory1NoComment', 'value12', '', '', []);

        $expected_category1 = new ilSystemStyleLessCategory('Category 1 no valid section', '');

        $expected_variable21 = new ilSystemStyleLessVariable(
            'variableNoValidSection1',
            'value21',
            '',
            'Category 1 no valid section',
            []
        );
        $expected_variable22 = new ilSystemStyleLessVariable(
            'variableNoValidSection2',
            'value22',
            'comment',
            'Category 1 no valid section',
            []
        );

        $expected_comment3 = new ilSystemStyleLessComment('');

        $expected_category2 = new ilSystemStyleLessCategory('Category 2', 'Comment Category 2');

        $expected_variable31 = new ilSystemStyleLessVariable(
            'regular',
            'value',
            'Hard references id',
            'Category 2',
            []
        );
        $expected_variable32 = new ilSystemStyleLessVariable(
            'variable21',
            'floor((@regular * 1.6)) * lighten(@regular, 20%)',
            'Hard references',
            'Category 2',
            ['regular']
        );

        $expected_comment4 = new ilSystemStyleLessComment('');

        $expected_category3 = new ilSystemStyleLessCategory('Category 3', 'No Section Between');
        $expected_variable41 = new ilSystemStyleLessVariable('variable3', 'value3', '', 'Category 3', []);

        $expected_items = [$expected_comment1,
                           $expected_comment2,
                           $expected_variable11,
                           $expected_variable12,
                           $expected_category1,
                           $expected_variable21,
                           $expected_variable22,
                           $expected_comment3,
                           $expected_category2,
                           $expected_variable31,
                           $expected_variable32,
                           $expected_comment4,
                           $expected_category3,
                           $expected_variable41
        ];

        $this->assertEquals($expected_items, $file->getItems());
    }
}