MenuTreeParametersTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Menu;

use Drupal\Core\Menu\MenuTreeParameters;
use Drupal\Tests\UnitTestCase;

/**
 * Tests the menu link tree parameters value object.
 *
 * @group Menu
 *
 * @coversDefaultClass \Drupal\Core\Menu\MenuTreeParameters
 */
class MenuTreeParametersTest extends UnitTestCase {
    
    /**
     * Provides test data for testSetMinDepth().
     */
    public static function providerTestSetMinDepth() {
        $data = [];
        // Valid values at the extremes and in the middle.
        $data[] = [
            1,
            1,
        ];
        $data[] = [
            2,
            2,
        ];
        $data[] = [
            9,
            9,
        ];
        // Invalid values are mapped to the closest valid value.
        $data[] = [
            -10000,
            1,
        ];
        $data[] = [
            0,
            1,
        ];
        // … except for those invalid values that reach beyond the maximum depth,
        // because MenuTreeParameters is a value object and hence cannot depend
        // on anything; to know the actual maximum depth, it'd have to depend on the
        // MenuTreeStorage service.
        $data[] = [
            10,
            10,
        ];
        $data[] = [
            100000,
            100000,
        ];
        return $data;
    }
    
    /**
     * Tests setMinDepth().
     *
     * @covers ::setMinDepth
     * @dataProvider providerTestSetMinDepth
     */
    public function testSetMinDepth($min_depth, $expected) : void {
        $parameters = new MenuTreeParameters();
        $parameters->setMinDepth($min_depth);
        $this->assertEquals($expected, $parameters->minDepth);
    }
    
    /**
     * Tests addExpandedParents().
     *
     * @covers ::addExpandedParents
     */
    public function testAddExpanded() : void {
        $parameters = new MenuTreeParameters();
        // Verify default value.
        $this->assertEquals([], $parameters->expandedParents);
        // Add actual menu link plugin IDs to be expanded.
        $parameters->addExpandedParents([
            'foo',
            'bar',
            'baz',
        ]);
        $this->assertEquals([
            'foo',
            'bar',
            'baz',
        ], $parameters->expandedParents);
        // Add additional menu link plugin IDs; they should be merged, not replacing
        // the old ones.
        $parameters->addExpandedParents([
            'qux',
            'foobar',
        ]);
        $this->assertEquals([
            'foo',
            'bar',
            'baz',
            'qux',
            'foobar',
        ], $parameters->expandedParents);
        // Add pre-existing menu link plugin IDs; they should not be added again;
        // this is a set.
        $parameters->addExpandedParents([
            'bar',
            'foobar',
        ]);
        $this->assertEquals([
            'foo',
            'bar',
            'baz',
            'qux',
            'foobar',
        ], $parameters->expandedParents);
    }
    
    /**
     * Tests addCondition().
     *
     * @covers ::addCondition
     */
    public function testAddCondition() : void {
        $parameters = new MenuTreeParameters();
        // Verify default value.
        $this->assertEquals([], $parameters->conditions);
        // Add a condition.
        $parameters->addCondition('expanded', 1);
        $this->assertEquals([
            'expanded' => 1,
        ], $parameters->conditions);
        // Add another condition.
        $parameters->addCondition('has_children', 0);
        $this->assertEquals([
            'expanded' => 1,
            'has_children' => 0,
        ], $parameters->conditions);
        // Add a condition with an operator.
        $parameters->addCondition('provider', [
            'module1',
            'module2',
        ], 'IN');
        $this->assertEquals([
            'expanded' => 1,
            'has_children' => 0,
            'provider' => [
                [
                    'module1',
                    'module2',
                ],
                'IN',
            ],
        ], $parameters->conditions);
        // Add another condition with an operator.
        $parameters->addCondition('id', 1337, '<');
        $this->assertEquals([
            'expanded' => 1,
            'has_children' => 0,
            'provider' => [
                [
                    'module1',
                    'module2',
                ],
                'IN',
            ],
            'id' => [
                1337,
                '<',
            ],
        ], $parameters->conditions);
        // It's impossible to add two conditions on the same field; in that case,
        // the old condition will be overwritten.
        $parameters->addCondition('provider', 'other_module');
        $this->assertEquals([
            'expanded' => 1,
            'has_children' => 0,
            'provider' => 'other_module',
            'id' => [
                1337,
                '<',
            ],
        ], $parameters->conditions);
    }
    
    /**
     * Tests onlyEnabledLinks().
     *
     * @covers ::onlyEnabledLinks
     */
    public function testOnlyEnabledLinks() : void {
        $parameters = new MenuTreeParameters();
        $parameters->onlyEnabledLinks();
        $this->assertEquals(1, $parameters->conditions['enabled']);
    }
    
    /**
     * Tests setTopLevelOnly().
     *
     * @covers ::setTopLevelOnly
     */
    public function testSetTopLevelOnly() : void {
        $parameters = new MenuTreeParameters();
        $parameters->setTopLevelOnly();
        $this->assertEquals(1, $parameters->maxDepth);
    }
    
    /**
     * Tests excludeRoot().
     *
     * @covers ::excludeRoot
     */
    public function testExcludeRoot() : void {
        $parameters = new MenuTreeParameters();
        $parameters->excludeRoot();
        $this->assertEquals(1, $parameters->minDepth);
    }
    
    /**
     * @covers ::serialize
     * @covers ::unserialize
     */
    public function testSerialize() : void {
        $parameters = new MenuTreeParameters();
        $parameters->setRoot(1);
        $parameters->setMinDepth('2');
        $parameters->setMaxDepth('9');
        $parameters->addExpandedParents([
            '',
            'foo',
        ]);
        $parameters->setActiveTrail([
            '',
            'bar',
        ]);
        $after_serialize = unserialize(serialize($parameters));
        $this->assertSame('1', $after_serialize->root);
        $this->assertSame(2, $after_serialize->minDepth);
        $this->assertSame(9, $after_serialize->maxDepth);
        $this->assertSame([
            '',
            'foo',
        ], $after_serialize->expandedParents);
        $this->assertSame([
            'bar',
        ], $after_serialize->activeTrail);
    }

}