BlockTest.php

<?php

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Twig\Tests\Node;

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

use Twig\Environment;
use Twig\Loader\ArrayLoader;
use Twig\Node\BlockNode;
use Twig\Node\TextNode;
use Twig\Test\NodeTestCase;

class BlockTest extends NodeTestCase
{
    public function testConstructor()
    {
        $body = new TextNode('foo', 1);
        $node = new BlockNode('foo', $body, 1);

        $this->assertEquals($body, $node->getNode('body'));
        $this->assertEquals('foo', $node->getAttribute('name'));
    }

    public static function provideTests(): iterable
    {
        $tests = [];

        // block without docs
        $tests[] = [new BlockNode('foo', new TextNode('foo', 1), 1), <<<EOF
// line 1
/**
 * @return iterable<null|scalar|\Stringable>
 */
public function block_foo(array \$context, array \$blocks = []): iterable
{
    \$macros = \$this->macros;
    yield "foo";
    yield from [];
}
EOF, new Environment(new ArrayLoader()),
        ];

        // block with docs
        $blockWithDocs = new BlockNode('foo', new TextNode('foo', 1), 1);
        $blockWithDocs->setAttribute('docs', 'The foo block description');
        $tests[] = [$blockWithDocs, <<<EOF
// line 1
/**
 * The foo block description
 * @return iterable<null|scalar|\Stringable>
 */
public function block_foo(array \$context, array \$blocks = []): iterable
{
    \$macros = \$this->macros;
    yield "foo";
    yield from [];
}
EOF, new Environment(new ArrayLoader()),
        ];

        // block with multiline docs
        $blockWithMultilineDocs = new BlockNode('foo', new TextNode('foo', 1), 1);
        $blockWithMultilineDocs->setAttribute('docs', "First line\nSecond line");
        $tests[] = [$blockWithMultilineDocs, <<<EOF
// line 1
/**
 * First line
 * Second line
 * @return iterable<null|scalar|\Stringable>
 */
public function block_foo(array \$context, array \$blocks = []): iterable
{
    \$macros = \$this->macros;
    yield "foo";
    yield from [];
}
EOF, new Environment(new ArrayLoader()),
        ];

        return $tests;
    }
}