packages/sql-faker/tests/Unit/Generation/Derivation/TokenGeneratorTest.php

1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\SqlFaker\Generation\Derivation;
6
7use Faker\Factory;
8use PHPUnit\Framework\Attributes\CoversClass;
9use PHPUnit\Framework\Attributes\UsesClass;
10use PHPUnit\Framework\TestCase;
11use SqlFaker\Generation\Candidate\ChoiceLexemeGenerator;
12use SqlFaker\Generation\Candidate\FixedLexemeGenerator;
13use SqlFaker\Generation\Candidate\MatchingLexemeGenerator;
14use SqlFaker\Generation\Candidate\RegisteredLexemeGenerator;
15use SqlFaker\Generation\Candidate\SequenceLexemeGenerator;
16use SqlFaker\Generation\Candidate\ValueLexemeGenerator;
17use SqlFaker\Generation\Candidate\VersionCase;
18use SqlFaker\Generation\Candidate\VersionedLexemeGenerator;
19use SqlFaker\Generation\Derivation\CompletionCosts;
20use SqlFaker\Generation\Derivation\Derivation;
21use SqlFaker\Generation\Derivation\DerivationTrace;
22use SqlFaker\Generation\Derivation\TerminationAnalyzer;
23use SqlFaker\Generation\Derivation\TerminationCost;
24use SqlFaker\Generation\Derivation\TokenGenerator;
25use SqlFaker\Generation\Exception\GenerationException;
26use SqlFaker\Generation\Exception\LexicalException;
27use SqlFaker\Generation\Lexeme\Lexeme;
28use SqlFaker\Generation\Lexeme\LexemeBoundary;
29use SqlFaker\Generation\Lexeme\LexemeCandidates;
30use SqlFaker\Generation\Lexeme\LexemeGenerator;
31use SqlFaker\Generation\Lexeme\LexemeInput;
32use SqlFaker\Generation\Lexeme\LexemeSequence;
33use SqlFaker\Generation\Lexeme\OutputPart;
34use SqlFaker\Generation\Lexeme\ResolvedOutput;
35use SqlFaker\Generation\Lexeme\SpacingConstraint;
36use SqlFaker\Generation\Lexeme\SpacingRule;
37use SqlFaker\Generation\Output\CandidateResolver;
38use SqlFaker\Generation\Output\CombinedSpacingRule;
39use SqlFaker\Generation\Output\ReverseLexemeGenerator;
40use SqlFaker\Generation\Output\SqlSerializer;
41use SqlFaker\Generation\Plan\GenerationPlan;
42use SqlFaker\Generation\Token\ProductionOccurrence;
43use SqlFaker\Generation\Token\RewriteRule;
44use SqlFaker\Generation\Token\TerminalOccurrence;
45use SqlFaker\Generation\Token\TerminalSequence;
46use SqlFaker\Generation\Token\TokenRewriter;
47use SqlFaker\Grammar\Model\Grammar;
48use SqlFaker\Grammar\Model\NonTerminal;
49use SqlFaker\Grammar\Model\Production;
50use SqlFaker\Grammar\Model\ProductionRule;
51use SqlFaker\Grammar\Model\Terminal;
52use SqlFaker\MySql\Generation\Spacing\KeywordPhraseSpacingRule;
53
54#[CoversClass(TokenGenerator::class)]
55#[UsesClass(RewriteRule::class)]
56#[UsesClass(ProductionOccurrence::class)]
57#[UsesClass(TerminalSequence::class)]
58#[UsesClass(TokenRewriter::class)]
59#[UsesClass(TerminalOccurrence::class)]
60#[UsesClass(CandidateResolver::class)]
61#[UsesClass(ReverseLexemeGenerator::class)]
62#[UsesClass(ResolvedOutput::class)]
63#[UsesClass(OutputPart::class)]
64#[UsesClass(SqlSerializer::class)]
65#[UsesClass(VersionCase::class)]
66#[UsesClass(VersionedLexemeGenerator::class)]
67#[UsesClass(KeywordPhraseSpacingRule::class)]
68#[UsesClass(CombinedSpacingRule::class)]
69#[UsesClass(LexemeBoundary::class)]
70#[UsesClass(SpacingRule::class)]
71#[UsesClass(SpacingConstraint::class)]
72#[UsesClass(Lexeme::class)]
73#[UsesClass(LexemeGenerator::class)]
74#[UsesClass(ValueLexemeGenerator::class)]
75#[UsesClass(LexemeSequence::class)]
76#[UsesClass(RegisteredLexemeGenerator::class)]
77#[UsesClass(LexemeCandidates::class)]
78#[UsesClass(SequenceLexemeGenerator::class)]
79#[UsesClass(ChoiceLexemeGenerator::class)]
80#[UsesClass(FixedLexemeGenerator::class)]
81#[UsesClass(MatchingLexemeGenerator::class)]
82#[UsesClass(LexemeInput::class)]
83#[UsesClass(CompletionCosts::class)]
84#[UsesClass(Derivation::class)]
85#[UsesClass(DerivationTrace::class)]
86#[UsesClass(GenerationPlan::class)]
87#[UsesClass(TerminationAnalyzer::class)]
88#[UsesClass(TerminationCost::class)]
89#[UsesClass(Grammar::class)]
90#[UsesClass(NonTerminal::class)]
91#[UsesClass(Production::class)]
92#[UsesClass(ProductionRule::class)]
93#[UsesClass(Terminal::class)]
94#[UsesClass(GenerationException::class)]
95#[UsesClass(LexicalException::class)]
96#[UsesClass(\SqlFaker\Generation\Plan\ProductionPattern::class)]
97#[UsesClass(\SqlFaker\Generation\Output\BoundaryCompletion::class)]
98#[UsesClass(\SqlFaker\Generation\Derivation\CompletionState::class)]
99#[UsesClass(\SqlFaker\Generation\Derivation\CompletionFrontier::class)]
100#[UsesClass(\SqlFaker\Generation\Derivation\ConstrainedCompletion::class)]
101#[UsesClass(\SqlFaker\Generation\Value\ValueChoices::class)]
102#[UsesClass(\SqlFaker\Generation\Derivation\CompletionMemo::class)]
103#[UsesClass(\SqlFaker\Generation\Derivation\CompletionReduction::class)]
104#[UsesClass(\SqlFaker\Generation\Derivation\ConstraintDependencies::class)]
105#[UsesClass(\SqlFaker\Generation\Choice\BytePlanCompiler::class)]
106#[UsesClass(\SqlFaker\Generation\Derivation\Completion\PatternProductions::class)]
107#[UsesClass(\SqlFaker\Generation\Derivation\Completion\CompletionWitness::class)]
108final class TokenGeneratorTest extends TestCase
109{
110    public function testGenerateCanChooseNullableChildrenWhenAnotherSiblingProvidesOutput(): void
111    {
112        $grammar = new Grammar('root', [
113            'root' => new ProductionRule('root', [new Production([new NonTerminal('optional'), new Terminal('UNKNOWN')])]),
114            'optional' => new ProductionRule('optional', [new Production([])]),
115        ]);
116        $generator = new TokenGenerator($grammar, Factory::create(), static fn (string $name): bool => false);
117        $sequence = $generator->generate('root', GenerationPlan::all()->requiringNonEmpty());
118        self::assertSame(['UNKNOWN'], $sequence->names());
119        self::assertCount(2, $sequence->productions);
120    }
121
122    public function testGenerateReservesVisibleOutputWithoutConsultingLexicalHandlerAvailability(): void
123    {
124        $grammar = new Grammar('root', [
125            'root' => new ProductionRule('root', [new Production([new Terminal('EOF')]), new Production([new Terminal('UNKNOWN')])]),
126        ]);
127        $generator = new TokenGenerator($grammar, Factory::create(), static fn (string $name): bool => $name === 'EOF');
128        self::assertSame(['UNKNOWN'], $generator->generate('root', GenerationPlan::all()->requiringNonEmpty())->names());
129    }
130}
131