File: EnumGeneratorTest.php

package info (click to toggle)
php-zend-code 4.8.0-1%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,644 kB
  • sloc: php: 13,762; xml: 1,931; makefile: 18
file content (201 lines) | stat: -rw-r--r-- 5,899 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<?php

namespace LaminasTest\Code\Generator;

use InvalidArgumentException;
use Laminas\Code\Generator\EnumGenerator\EnumGenerator;
use PHPUnit\Framework\TestCase;
use ReflectionEnum;

use function class_exists;

final class EnumGeneratorTest extends TestCase
{
    /**
     * @dataProvider validOptionSpecifications
     * @psalm-param array{
     *      name: non-empty-string,
     *      pureCases: list<non-empty-string>,
     * }|array{
     *      name: non-empty-string,
     *      backedCases: array{
     *          type: 'int'|'string',
     *          cases: array<non-empty-string, int|non-empty-string>,
     *      },
     * } $options
     */
    public function testGenerateValidEnums(array $options, string $expected): void
    {
        self::assertSame($expected, EnumGenerator::withConfig($options)->generate());
    }

    /**
     * @psalm-return iterable<string, array{
     *     0: array{
     *          name: non-empty-string,
     *          pureCases: list<non-empty-string>,
     *      }|array{
     *          name: non-empty-string,
     *          backedCases: array{
     *              type: 'int'|'string',
     *              cases: array<non-empty-string, int|non-empty-string>,
     *          },
     *      },
     *      1: non-empty-string
     * }>
     */
    public static function validOptionSpecifications(): iterable
    {
        yield 'pure enum without namespace' => [
            [
                'name'      => 'Suit',
                'pureCases' => ['Hearts', 'Diamonds', 'Clubs', 'Spades'],
            ],
            <<<CODE
                enum Suit {
                    case Hearts;
                    case Diamonds;
                    case Clubs;
                    case Spades;
                }
                
                CODE,
        ];

        yield 'pure enum with namespace' => [
            [
                'name'      => 'My\Namespaced\Suit',
                'pureCases' => ['Hearts', 'Diamonds', 'Clubs', 'Spades'],
            ],
            <<<CODE
                namespace My\Namespaced;
                
                enum Suit {
                    case Hearts;
                    case Diamonds;
                    case Clubs;
                    case Spades;
                }
                
                CODE,
        ];

        yield 'backed string enums with namespace' => [
            [
                'name'        => 'My\Namespaced\Suit',
                'backedCases' => [
                    'type'  => 'string',
                    'cases' => ['Hearts' => 'H', 'Diamonds' => 'D', 'Clubs' => 'C', 'Spades' => 'S'],
                ],
            ],
            <<<CODE
                namespace My\Namespaced;
                
                enum Suit: string {
                    case Hearts = 'H';
                    case Diamonds = 'D';
                    case Clubs = 'C';
                    case Spades = 'S';
                }
                
                CODE,
        ];

        yield 'backed integer enums with namespace' => [
            [
                'name'        => 'My\Namespaced\Suit',
                'backedCases' => [
                    'type'  => 'int',
                    'cases' => ['Hearts' => 1, 'Diamonds' => 2, 'Clubs' => 3, 'Spades' => 4],
                ],
            ],
            <<<CODE
                namespace My\Namespaced;
                
                enum Suit: int {
                    case Hearts = 1;
                    case Diamonds = 2;
                    case Clubs = 3;
                    case Spades = 4;
                }
                
                CODE,
        ];
    }

    /** @requires PHP < 8.1 */
    public function testReflectionEnumFailsForUnsupportedPhpVersions(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('This feature only works from PHP 8.1 onwards.');

        EnumGenerator::fromReflection(new ReflectionEnum(new class {
        }));
    }

    /**
     * @requires PHP >= 8.1
     * @dataProvider validEnumSpecifications
     * @psalm-param non-empty-string $enumClass
     * @psalm-param non-empty-string $expected
     */
    public function testReflectionEnumWorks(string $enumClass, string $expected): void
    {
        if (! class_exists($enumClass, false)) {
            eval($expected);
        }

        self::assertTrue(class_exists($enumClass, false));
        self::assertSame($expected, EnumGenerator::fromReflection(new ReflectionEnum($enumClass))->generate());
    }

    /**
     * @psalm-return iterable<string, array{
     *      0: non-empty-string,
     *      1: non-empty-string
     * }>
     */
    public static function validEnumSpecifications(): iterable
    {
        yield 'pure enum reflection' => [
            'TestNamespace\\Environment',
            <<<'PHP'
                namespace TestNamespace;

                enum Environment {
                    case Dev;
                    case Test;
                    case Prod;
                }
                
                PHP,
        ];
        yield 'string backed enum reflection' => [
            'TestNamespace\\Orientation',
            <<<'PHP'
                namespace TestNamespace;

                enum Orientation: string {
                    case North = 'N';
                    case South = 'S';
                    case East = 'E';
                    case West = 'W';
                }
                
                PHP,
        ];
        yield 'int backed enum reflection' => [
            'TestNamespace\\Flags',
            <<<'PHP'
                namespace TestNamespace;

                enum Flags: int {
                    case Public = 1;
                    case Protected = 2;
                    case Private = 3;
                }
                
                PHP,
        ];
    }
}