packages/sql-fixture/tests/Unit/Plan/Parsing/RelationCursorTest.php

1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\Plan\Parsing;
6
7use PHPUnit\Framework\Attributes\CoversClass;
8use PHPUnit\Framework\TestCase;
9use SqlFixture\Plan\Parsing\RelationCursor as Subject;
10use SqlFixture\Plan\RelationKind;
11
12#[CoversClass(Subject::class)]
13#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\ColumnRef::class)]
14#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\FixturePlan::class)]
15#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\PlanParser::class)]
16#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\PlanPrinter::class)]
17#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\PlanSyntaxException::class)]
18#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Relation::class)]
19#[\PHPUnit\Framework\Attributes\UsesClass(RelationKind::class)]
20#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\RelationSide::class)]
21#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Parsing\PlanStatements::class)]
22#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Parsing\RelationReader::class)]
23#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\PlanStructureException::class)]
24#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Printing\PlanTables::class)]
25#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Printing\RelationGroups::class)]
26#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Printing\StatementPrinter::class)]
27#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Validation\PlanValidation::class)]
28#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Validation\TableName::class)]
29#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\EmptyPlanException::class)]
30#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\EmptyTableNameException::class)]
31#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\MissingEndpointColumnsException::class)]
32#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\InvalidTableNameException::class)]
33#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\UnbalancedBracketsException::class)]
34#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\UnexpectedPlanTokenException::class)]
35#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\UnsupportedManyToManyException::class)]
36#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\CompositeArityMismatchException::class)]
37#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\DuplicateColumnBindingException::class)]
38#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\CyclicDependencyException::class)]
39#[\PHPUnit\Framework\Attributes\UsesClass(\SqlFixture\Plan\Exception\UnboundedSelfReferenceException::class)]
40final class RelationCursorTest extends TestCase
41{
42    public function testReadIdentifierConsumesQuotedNames(): void
43    {
44        $cursor = new Subject('`order items`.id');
45        self::assertSame('order items', $cursor->readIdentifier('table'));
46        self::assertSame('.', $cursor->peek());
47    }
48
49    public function testReadOperatorConsumesDirection(): void
50    {
51        $cursor = new Subject('>?');
52        self::assertSame(RelationKind::ManyToOne, $cursor->readOperator());
53        self::assertSame('?', $cursor->peek());
54    }
55
56    public function testReadOptionalMarkerLeavesUnmarkedInputAlone(): void
57    {
58        $cursor = new Subject('?a');
59        self::assertTrue($cursor->readOptionalMarker());
60        self::assertFalse($cursor->readOptionalMarker());
61        self::assertSame('a', $cursor->peek());
62    }
63
64    public function testSkipWhitespaceStopsBeforeIdentifier(): void
65    {
66        $cursor = new Subject(" \t\n        a");
67        $cursor->skipWhitespace();
68        self::assertSame('a', $cursor->peek());
69    }
70
71    public function testExpectEndAcceptsAnExhaustedStatement(): void
72    {
73        $cursor = new Subject('a');
74        self::assertSame('a', $cursor->readIdentifier('table'));
75        $cursor->expectEnd();
76        self::assertNull($cursor->peek());
77    }
78
79    public function testPeekDoesNotAdvance(): void
80    {
81        $cursor = new Subject('ab');
82        self::assertSame('a', $cursor->peek());
83        self::assertSame(0, $cursor->offset);
84    }
85}
86