IdentifierTranspilerTest.php

<?php

/**
 * PackageFactory.ComponentEngine - Universal View Components for PHP
 *   Copyright (C) 2022 Contributors of PackageFactory.ComponentEngine
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace PackageFactory\ComponentEngine\Test\Unit\Target\Php\Transpiler\Identifier;

use PackageFactory\ComponentEngine\Module\ModuleId;
use PackageFactory\ComponentEngine\Parser\Ast\EnumDeclarationNode;
use PackageFactory\ComponentEngine\Parser\Ast\ExpressionNode;
use PackageFactory\ComponentEngine\Parser\Ast\IdentifierNode;
use PackageFactory\ComponentEngine\Target\Php\Transpiler\Expression\ExpressionTranspiler;
use PackageFactory\ComponentEngine\Test\Unit\TypeSystem\Scope\Fixtures\DummyScope;
use PackageFactory\ComponentEngine\Target\Php\Transpiler\Identifier\IdentifierTranspiler;
use PackageFactory\ComponentEngine\TypeSystem\Type\EnumType\EnumStaticType;
use PackageFactory\ComponentEngine\TypeSystem\Type\StringType\StringType;
use PHPUnit\Framework\TestCase;

final class IdentifierTranspilerTest extends TestCase
{
    /**
     * @test
     * @return void
     */
    public function transpilesIdentifierNodes(): void
    {
        $identifierTranspiler = new IdentifierTranspiler(
            scope: new DummyScope()
        );
        $identifierNode = IdentifierNode::fromString('foo');

        $expectedTranspilationResult = '$this->foo';
        $actualTranspilationResult = $identifierTranspiler->transpile(
            $identifierNode
        );

        $this->assertEquals(
            $expectedTranspilationResult,
            $actualTranspilationResult
        );
    }

    /**
     * @test
     * @return void
     */
    public function transpilesIdentifierNodesReferringToEnums(): void
    {
        $identifierTranspiler = new IdentifierTranspiler(
            scope: new DummyScope([
                'SomeEnum' => EnumStaticType::fromModuleIdAndDeclaration(
                    ModuleId::fromString("module-a"),
                    EnumDeclarationNode::fromString(
                        'enum SomeEnum { A B C }'
                    )
                )
            ])
        );
        $identifierNode = IdentifierNode::fromString('SomeEnum');

        $expectedTranspilationResult = 'SomeEnum';
        $actualTranspilationResult = $identifierTranspiler->transpile(
            $identifierNode
        );

        $this->assertEquals(
            $expectedTranspilationResult,
            $actualTranspilationResult
        );
    }

    public static function identifierInParenthesisExamples(): mixed
    {
        // @todo find a better place for these tests, as we actually test the ExpressionNode
        return [
            '(foo)' => ['(foo)', '$this->foo'],
            '((foo))' => ['((foo))', '$this->foo'],
            '(((foo)))' => ['(((foo)))', '$this->foo']
        ];
    }

    /**
     * @dataProvider identifierInParenthesisExamples
     * @test
     */
    public function identifierInParenthesis(string $expression, string $expectedTranspilationResult): void
    {
        $expressionTranspiler = new ExpressionTranspiler(
            scope: new DummyScope([
                "foo" => StringType::get()
            ])
        );

        $actualTranspilationResult = $expressionTranspiler->transpile(
            ExpressionNode::fromString($expression)
        );

        $this->assertEquals(
            $expectedTranspilationResult,
            $actualTranspilationResult
        );
    }
}