forked from zircote/swagger-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Generator.php
384 lines (321 loc) · 12.3 KB
/
Generator.php
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<?php declare(strict_types=1);
/**
* @license Apache 2.0
*/
namespace OpenApi;
use Doctrine\Common\Annotations\AnnotationRegistry;
use OpenApi\Analysers\AnalyserInterface;
use OpenApi\Analysers\AttributeAnnotationFactory;
use OpenApi\Analysers\DocBlockAnnotationFactory;
use OpenApi\Analysers\ReflectionAnalyser;
use OpenApi\Annotations\OpenApi;
use OpenApi\Loggers\DefaultLogger;
use Psr\Log\LoggerInterface;
/**
* OpenApi spec generator.
*
* Scans PHP source code and generates OpenApi specifications from the found OpenApi annotations.
*
* This is an object oriented alternative to using the now deprecated `\OpenApi\scan()` function and
* static class properties of the `Analyzer` and `Analysis` classes.
*/
class Generator
{
/**
* Allows Annotation classes to know the context of the annotation that is being processed.
*
* @var Context|null
*/
public static $context;
/** @var string Magic value to differentiate between null and undefined. */
public const UNDEFINED = '@OA\Generator::UNDEFINED🙈';
/** @var string[] */
public const DEFAULT_ALIASES = ['oa' => 'OpenApi\\Annotations'];
/** @var string[] */
public const DEFAULT_NAMESPACES = ['OpenApi\\Annotations\\'];
/** @var array Map of namespace aliases to be supported by doctrine. */
protected $aliases;
/** @var array|null List of annotation namespaces to be autoloaded by doctrine. */
protected $namespaces;
/** @var AnalyserInterface|null The configured analyzer. */
protected $analyser;
/** @var callable[]|null List of configured processors. */
protected $processors = null;
/** @var LoggerInterface|null PSR logger. */
protected $logger = null;
/** @var string */
protected $version = OpenApi::DEFAULT_VERSION;
private $configStack;
public function __construct(?LoggerInterface $logger = null)
{
$this->logger = $logger;
$this->setAliases(self::DEFAULT_ALIASES);
$this->setNamespaces(self::DEFAULT_NAMESPACES);
// kinda config stack to stay BC...
$this->configStack = new class() {
protected $generator;
public function push(Generator $generator): void
{
$this->generator = $generator;
if (class_exists(AnnotationRegistry::class, true)) {
// keeping track of &this->generator allows to 'disable' the loader after we are done;
// no unload, unfortunately :/
$gref = &$this->generator;
AnnotationRegistry::registerLoader(
function (string $class) use (&$gref): bool {
if ($gref) {
foreach ($gref->getNamespaces() as $namespace) {
if (strtolower(substr($class, 0, strlen($namespace))) === strtolower($namespace)) {
$loaded = class_exists($class);
if (!$loaded && $namespace === 'OpenApi\\Annotations\\') {
if (in_array(strtolower(substr($class, 20)), ['definition', 'path'])) {
// Detected an 2.x annotation?
throw new \Exception('The annotation @SWG\\' . substr($class, 20) . '() is deprecated. Found in ' . Generator::$context . "\nFor more information read the migration guide: https://github.com/zircote/swagger-php/blob/master/docs/Migrating-to-v3.md");
}
}
return $loaded;
}
}
}
return false;
}
);
}
}
public function pop(): void
{
$this->generator = null;
}
};
}
public static function isDefault($value): bool
{
return $value === Generator::UNDEFINED;
}
public function getAliases(): array
{
return $this->aliases;
}
public function addAlias(string $alias, string $namespace): Generator
{
$this->aliases[$alias] = $namespace;
return $this;
}
public function setAliases(array $aliases): Generator
{
$this->aliases = $aliases;
return $this;
}
public function getNamespaces(): ?array
{
return $this->namespaces;
}
public function addNamespace(string $namespace): Generator
{
$namespaces = (array) $this->getNamespaces();
$namespaces[] = $namespace;
return $this->setNamespaces(array_unique($namespaces));
}
public function setNamespaces(?array $namespaces): Generator
{
$this->namespaces = $namespaces;
return $this;
}
public function getAnalyser(): AnalyserInterface
{
$this->analyser = $this->analyser ?: new ReflectionAnalyser([new DocBlockAnnotationFactory(), new AttributeAnnotationFactory()]);
$this->analyser->setGenerator($this);
return $this->analyser;
}
public function setAnalyser(?AnalyserInterface $analyser): Generator
{
$this->analyser = $analyser;
return $this;
}
/**
* @return callable[]
*/
public function getProcessors(): array
{
if (null === $this->processors) {
$this->processors = [
new Processors\DocBlockDescriptions(),
new Processors\MergeIntoOpenApi(),
new Processors\MergeIntoComponents(),
new Processors\ExpandClasses(),
new Processors\ExpandInterfaces(),
new Processors\ExpandTraits(),
new Processors\ExpandEnums(),
new Processors\AugmentSchemas(),
new Processors\AugmentProperties(),
new Processors\BuildPaths(),
new Processors\AugmentParameters(),
new Processors\AugmentRefs(),
new Processors\MergeJsonContent(),
new Processors\MergeXmlContent(),
new Processors\OperationId(),
new Processors\CleanUnmerged(),
new Processors\BackportConstants(),
];
}
return $this->processors;
}
/**
* @param null|callable[] $processors
*/
public function setProcessors(?array $processors): Generator
{
$this->processors = $processors;
return $this;
}
public function addProcessor(callable $processor): Generator
{
$processors = $this->getProcessors();
$processors[] = $processor;
$this->setProcessors($processors);
return $this;
}
public function removeProcessor(callable $processor, bool $silent = false): Generator
{
$processors = $this->getProcessors();
if (false === ($key = array_search($processor, $processors, true))) {
if ($silent) {
return $this;
}
throw new \InvalidArgumentException('Processor not found');
}
unset($processors[$key]);
$this->setProcessors($processors);
return $this;
}
/**
* Update/replace an existing processor with a new one.
*
* @param callable $processor The new processor
* @param null|callable $matcher Optional matcher callable to identify the processor to replace.
* If none given, matching is based on the processors class.
*/
public function updateProcessor(callable $processor, ?callable $matcher = null): Generator
{
$matcher = $matcher ?: function ($other) use ($processor) {
$otherClass = get_class($other);
return $processor instanceof $otherClass;
};
$processors = array_map(function ($other) use ($processor, $matcher) {
return $matcher($other) ? $processor : $other;
}, $this->getProcessors());
$this->setProcessors($processors);
return $this;
}
public function getLogger(): ?LoggerInterface
{
return $this->logger ?: new DefaultLogger();
}
public function getVersion(): string
{
return $this->version;
}
public function setVersion(string $version): Generator
{
$this->version = $version;
return $this;
}
public static function scan(iterable $sources, array $options = []): ?OpenApi
{
// merge with defaults
$config = $options + [
'aliases' => self::DEFAULT_ALIASES,
'namespaces' => self::DEFAULT_NAMESPACES,
'analyser' => null,
'analysis' => null,
'processors' => null,
'logger' => null,
'validate' => true,
'version' => OpenApi::DEFAULT_VERSION,
];
return (new Generator($config['logger']))
->setVersion($config['version'])
->setAliases($config['aliases'])
->setNamespaces($config['namespaces'])
->setAnalyser($config['analyser'])
->setProcessors($config['processors'])
->generate($sources, $config['analysis'], $config['validate']);
}
/**
* Run code in the context of this generator.
*
* @param callable $callable Callable in the form of
* `function(Generator $generator, Analysis $analysis, Context $context): mixed`
*
* @return mixed the result of the `callable`
*/
public function withContext(callable $callable)
{
$rootContext = new Context([
'version' => $this->getVersion(),
'logger' => $this->getLogger(),
]);
$analysis = new Analysis([], $rootContext);
$this->configStack->push($this);
try {
return $callable($this, $analysis, $rootContext);
} finally {
$this->configStack->pop();
}
}
/**
* Generate OpenAPI spec by scanning the given source files.
*
* @param iterable $sources PHP source files to scan.
* Supported sources:
* * string - file / directory name
* * \SplFileInfo
* * \Symfony\Component\Finder\Finder
* @param null|Analysis $analysis custom analysis instance
* @param bool $validate flag to enable/disable validation of the returned spec
*/
public function generate(iterable $sources, ?Analysis $analysis = null, bool $validate = true): ?OpenApi
{
$rootContext = new Context([
'version' => $this->getVersion(),
'logger' => $this->getLogger(),
]);
$analysis = $analysis ?: new Analysis([], $rootContext);
$this->configStack->push($this);
try {
$this->scanSources($sources, $analysis, $rootContext);
// post processing
$analysis->process($this->getProcessors());
if ($analysis->openapi) {
$analysis->openapi->openapi = $this->version;
}
// validation
if ($validate) {
$analysis->validate();
}
} finally {
$this->configStack->pop();
}
return $analysis->openapi;
}
protected function scanSources(iterable $sources, Analysis $analysis, Context $rootContext): void
{
$analyser = $this->getAnalyser();
foreach ($sources as $source) {
if (is_iterable($source)) {
$this->scanSources($source, $analysis, $rootContext);
} else {
$resolvedSource = $source instanceof \SplFileInfo ? $source->getPathname() : realpath($source);
if (!$resolvedSource) {
$rootContext->logger->warning(sprintf('Skipping invalid source: %s', $source));
continue;
}
if (is_dir($resolvedSource)) {
$this->scanSources(Util::finder($resolvedSource), $analysis, $rootContext);
} else {
$analysis->addAnalysis($analyser->fromFile($resolvedSource, $rootContext));
}
}
}
}
}