Twig/tests/Node/NodeTest.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 PHPUnit\Framework\Attributes\IgnoreDeprecations;
use PHPUnit\Framework\TestCase;
use Twig\Node\NameDeprecation;
use Twig\Node\Node;
use Twig\TwigFilter;
use Twig\TwigFunction;
use Twig\TwigTest;

class NodeTest extends TestCase
{
    public function testToString(): void
    {
        // callable is not a supported type for a Node attribute, but Drupal uses some apparently
        $node = new NodeForTest([], ['value' => static function () { return '1'; }], 1);

        $this->assertEquals(<<<EOF
Twig\Tests\Node\NodeForTest
  attributes:
    value: \Closure
EOF, (string) $node
        );
    }

    public function testToStringWithTwigCallables(): void
    {
        $node = new NodeForTest([], [
            'function' => new TwigFunction('a_function'),
            'filter' => new TwigFilter('a_filter'),
            'test' => new TwigTest('a_test'),
        ], 1);

        $this->assertEquals(<<<EOF
Twig\Tests\Node\NodeForTest
  attributes:
    function: Twig\TwigFunction(a_function)
    filter: Twig\TwigFilter(a_filter)
    test: Twig\TwigTest(a_test)
EOF, (string) $node);
    }

    public function testToStringWithTag(): void
    {
        $node = new NodeForTest();
        $node->setNodeTag('tag');

        $this->assertEquals(<<<EOF
Twig\Tests\Node\NodeForTest
  tag: tag
EOF, (string) $node);
    }

    public function testToStringWithDocumentation(): void
    {
        $node = new NodeForTest();
        $node->setDocumentation("First line\nSecond line");

        $this->assertSame(<<<'EOF'
Twig\Tests\Node\NodeForTest
  documentation: First line\nSecond line
EOF, (string) $node);
    }

    public function testAttributeDeprecationIgnore(): void
    {
        $node = new NodeForTest([], ['foo' => false]);
        $node->deprecateAttribute('foo', new NameDeprecation('foo/bar', '2.0', 'bar'));

        $this->assertFalse($node->getAttribute('foo', false));
    }

    #[IgnoreDeprecations]
    public function testAttributeDeprecationWithoutAlternative(): void
    {
        $node = new NodeForTest([], ['foo' => false]);
        $node->deprecateAttribute('foo', new NameDeprecation('foo/bar', '2.0'));

        $this->expectUserDeprecationMessage('Since foo/bar 2.0: Getting attribute "foo" on a "Twig\Tests\Node\NodeForTest" class is deprecated.');
        $this->assertFalse($node->getAttribute('foo'));
    }

    #[IgnoreDeprecations]
    public function testAttributeDeprecationWithAlternative(): void
    {
        $node = new NodeForTest([], ['foo' => false]);
        $node->deprecateAttribute('foo', new NameDeprecation('foo/bar', '2.0', 'bar'));

        $this->expectUserDeprecationMessage('Since foo/bar 2.0: Getting attribute "foo" on a "Twig\Tests\Node\NodeForTest" class is deprecated, get the "bar" attribute instead.');
        $this->assertFalse($node->getAttribute('foo'));
    }

    public function testNodeDeprecationIgnore(): void
    {
        $node = new NodeForTest(['foo' => $foo = new NodeForTest()]);
        $node->deprecateNode('foo', new NameDeprecation('foo/bar', '2.0'));

        $this->assertSame($foo, $node->getNode('foo', false));
    }

    #[IgnoreDeprecations]
    public function testNodeDeprecationWithoutAlternative(): void
    {
        $node = new NodeForTest(['foo' => $foo = new NodeForTest()]);
        $node->deprecateNode('foo', new NameDeprecation('foo/bar', '2.0'));

        $this->expectUserDeprecationMessage('Since foo/bar 2.0: Getting node "foo" on a "Twig\Tests\Node\NodeForTest" class is deprecated.');
        $this->assertSame($foo, $node->getNode('foo'));
    }

    #[IgnoreDeprecations]
    public function testNodeAttributeDeprecationWithAlternative(): void
    {
        $node = new NodeForTest(['foo' => $foo = new NodeForTest()]);
        $node->deprecateNode('foo', new NameDeprecation('foo/bar', '2.0', 'bar'));

        $this->expectUserDeprecationMessage('Since foo/bar 2.0: Getting node "foo" on a "Twig\Tests\Node\NodeForTest" class is deprecated, get the "bar" node instead.');
        $this->assertSame($foo, $node->getNode('foo'));
    }
}

class NodeForTest extends Node
{
}