This repository was archived by the owner on Mar 6, 2022. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathCodeTransformExtension.php
More file actions
389 lines (336 loc) · 17.6 KB
/
Copy pathCodeTransformExtension.php
File metadata and controls
389 lines (336 loc) · 17.6 KB
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
385
386
387
388
389
<?php
namespace Phpactor\Extension\CodeTransform;
use Phpactor\CodeBuilder\Domain\BuilderFactory;
use Phpactor\CodeBuilder\Domain\Updater;
use Phpactor\CodeBuilder\Util\TextFormat;
use Phpactor\CodeBuilder\Adapter\Twig\TwigExtension;
use Phpactor\CodeBuilder\Adapter\Twig\TwigRenderer;
use Phpactor\CodeBuilder\Domain\TemplatePathResolver\PhpVersionPathResolver;
use Microsoft\PhpParser\Parser;
use Phpactor\CodeBuilder\Adapter\WorseReflection\WorseBuilderFactory;
use Phpactor\CodeBuilder\Adapter\TolerantParser\TolerantUpdater;
use Phpactor\CodeTransform\Adapter\Native\GenerateNew\ClassGenerator;
use Phpactor\CodeTransform\Adapter\TolerantParser\ClassToFile\Transformer\ClassNameFixerTransformer;
use Phpactor\CodeTransform\Adapter\TolerantParser\Refactor\TolerantChangeVisiblity;
use Phpactor\CodeTransform\Adapter\TolerantParser\Refactor\TolerantImportName;
use Phpactor\CodeTransform\Adapter\TolerantParser\Refactor\TolerantExtractExpression;
use Phpactor\CodeTransform\Adapter\WorseReflection\GenerateFromExisting\InterfaceFromExistingGenerator;
use Phpactor\CodeTransform\Adapter\TolerantParser\Refactor\TolerantRenameVariable;
use Phpactor\CodeTransform\Adapter\WorseReflection\Helper\WorseUnresolvableClassNameFinder;
use Phpactor\CodeTransform\Adapter\WorseReflection\Refactor\WorseExtractMethod;
use Phpactor\CodeTransform\Adapter\WorseReflection\Refactor\WorseOverrideMethod;
use Phpactor\CodeTransform\Adapter\WorseReflection\Helper\WorseInterestingOffsetFinder;
use Phpactor\CodeTransform\Adapter\WorseReflection\Refactor\WorseGenerateAccessor;
use Phpactor\CodeTransform\Adapter\WorseReflection\Refactor\WorseGenerateMethod;
use Phpactor\CodeTransform\Adapter\WorseReflection\Transformer\AddMissingProperties;
use Phpactor\CodeTransform\Adapter\WorseReflection\Refactor\WorseExtractConstant;
use Phpactor\CodeTransform\Adapter\WorseReflection\Transformer\ImplementContracts;
use Phpactor\CodeTransform\Adapter\WorseReflection\Transformer\CompleteConstructor;
use Phpactor\CodeTransform\CodeTransform;
use Phpactor\CodeTransform\Domain\Generators;
use Phpactor\CodeTransform\Domain\Helper\InterestingOffsetFinder;
use Phpactor\CodeTransform\Domain\Helper\UnresolvableClassNameFinder;
use Phpactor\CodeTransform\Domain\Refactor\ChangeVisiblity;
use Phpactor\CodeTransform\Domain\Refactor\ExtractConstant;
use Phpactor\CodeTransform\Domain\Refactor\ExtractExpression;
use Phpactor\CodeTransform\Domain\Refactor\ExtractMethod;
use Phpactor\CodeTransform\Domain\Refactor\GenerateAccessor;
use Phpactor\CodeTransform\Domain\Refactor\ImportName;
use Phpactor\CodeTransform\Domain\Refactor\OverrideMethod;
use Phpactor\CodeTransform\Domain\Refactor\RenameVariable;
use Phpactor\CodeTransform\Domain\Refactor\GenerateMethod;
use Phpactor\Extension\CodeTransform\Rpc\TransformHandler;
use Phpactor\Extension\CodeTransform\Rpc\ClassNewHandler;
use Phpactor\Extension\ClassToFile\ClassToFileExtension;
use Phpactor\Extension\Rpc\RpcExtension;
use Phpactor\Extension\CodeTransform\Rpc\ClassInflectHandler;
use Phpactor\Extension\Php\Model\PhpVersionResolver;
use Phpactor\FilePathResolverExtension\FilePathResolverExtension;
use Twig\Environment;
use Twig\Loader\FilesystemLoader;
use Phpactor\CodeTransform\Domain\Transformers;
use Twig\Loader\ChainLoader;
use Phpactor\Container\Container;
use Phpactor\Container\ContainerBuilder;
use Phpactor\Container\Extension;
use Phpactor\Extension\WorseReflection\WorseReflectionExtension;
use Phpactor\MapResolver\Resolver;
use RuntimeException;
class CodeTransformExtension implements Extension
{
public const TAG_FROM_EXISTING_GENERATOR = 'code_transform.from_existing_generator';
public const TAG_TRANSFORMER = 'code_transform.transformer';
public const TAG_NEW_CLASS_GENERATOR = 'code_transform.new_class_generator';
public const SERVICE_CLASS_GENERATORS = 'code_transform.new_class_generators';
public const SERVICE_CLASS_INFLECTORS = 'code_transform.from_existing_generators';
public const PARAM_NEW_CLASS_VARIANTS = 'code_transform.class_new.variants';
public const PARAM_TEMPLATE_PATHS = 'code_transform.template_paths';
public const PARAM_INDENTATION = 'code_transform.indentation';
public const PARAM_GENERATE_ACCESSOR_PREFIX = 'code_transform.refactor.generate_accessor.prefix';
public const PARAM_GENERATE_ACCESSOR_UPPER_CASE_FIRST = 'code_transform.refactor.generate_accessor.upper_case_first';
private const APP_TEMPLATE_PATH = '%application_root%/vendor/phpactor/code-builder/templates';
private const SERVICE_TOLERANT_PARSER = 'code_transform.tolerant_parser';
/**
* {@inheritDoc}
*/
public function configure(Resolver $schema): void
{
$schema->setDefaults([
self::PARAM_NEW_CLASS_VARIANTS => [],
self::PARAM_TEMPLATE_PATHS => [ // Ordered by priority
'%project_config%/templates',
'%config%/templates',
],
self::PARAM_INDENTATION => ' ',
self::PARAM_GENERATE_ACCESSOR_PREFIX => '',
self::PARAM_GENERATE_ACCESSOR_UPPER_CASE_FIRST => false,
]);
$schema->setDescriptions([
self::PARAM_NEW_CLASS_VARIANTS => 'Variants which should be suggested when class-create is invoked',
self::PARAM_TEMPLATE_PATHS => 'Paths in which to look for code templates',
self::PARAM_INDENTATION => 'Indentation chars to use in code generation and transformation',
self::PARAM_GENERATE_ACCESSOR_PREFIX => 'Prefix to use for generated accessors',
self::PARAM_GENERATE_ACCESSOR_UPPER_CASE_FIRST => 'If the first letter of a generated accessor should be made uppercase',
]);
}
public function load(ContainerBuilder $container): void
{
$this->registerTransformers($container);
$this->registerGenerators($container);
$this->registerFinders($container);
if (class_exists(RpcExtension::class)) {
// this shouldn't be here
$this->registerRpc($container);
}
$this->registerUpdater($container);
$this->registerRefactorings($container);
$this->registerTransformerImplementations($container);
$this->registerRenderer($container);
$this->registerGeneratorImplementations($container);
}
private function registerTransformers(ContainerBuilder $container): void
{
$container->register(CodeTransform::class, function (Container $container) {
return CodeTransform::fromTransformers($container->get('code_transform.transformers'));
});
$container->register('code_transform.transformers', function (Container $container) {
$transformers = [];
foreach ($container->getServiceIdsForTag(self::TAG_TRANSFORMER) as $serviceId => $attrs) {
$transformers[$attrs['name']] = $container->get($serviceId);
}
return Transformers::fromArray($transformers);
});
}
private function registerGenerators(ContainerBuilder $container): void
{
$container->register(self::SERVICE_CLASS_GENERATORS, function (Container $container) {
$generators = [];
foreach ($container->getServiceIdsForTag(self::TAG_NEW_CLASS_GENERATOR) as $serviceId => $attrs) {
$generator = $container->get($serviceId);
// if the tagged "service" is an array, then assume it's an
// array of class generators and move on.
if (is_array($generator)) {
$generators = array_merge($generators, $generator);
continue;
}
$this->assertNameAttribute($attrs, $serviceId);
$generators[$attrs['name']] = $generator;
}
return Generators::fromArray($generators);
});
$container->register(self::SERVICE_CLASS_INFLECTORS, function (Container $container) {
$generators = [];
foreach ($container->getServiceIdsForTag(self::TAG_FROM_EXISTING_GENERATOR) as $serviceId => $attrs) {
$this->assertNameAttribute($attrs, $serviceId);
$generators[$attrs['name']] = $container->get($serviceId);
}
return Generators::fromArray($generators);
});
}
private function registerRefactorings(ContainerBuilder $container): void
{
$container->register(ExtractConstant::class, function (Container $container) {
return new WorseExtractConstant(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(Updater::class)
);
});
$container->register(GenerateMethod::class, function (Container $container) {
return new WorseGenerateMethod(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(BuilderFactory::class),
$container->get(Updater::class)
);
});
$container->register(GenerateAccessor::class, function (Container $container) {
return new WorseGenerateAccessor(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(Updater::class),
$container->getParameter(self::PARAM_GENERATE_ACCESSOR_PREFIX),
$container->getParameter(self::PARAM_GENERATE_ACCESSOR_UPPER_CASE_FIRST)
);
});
$container->register(RenameVariable::class, function (Container $container) {
return new TolerantRenameVariable();
});
$container->register(OverrideMethod::class, function (Container $container) {
return new WorseOverrideMethod(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(BuilderFactory::class),
$container->get(Updater::class)
);
});
$container->register(ExtractMethod::class, function (Container $container) {
return new WorseExtractMethod(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(BuilderFactory::class),
$container->get(Updater::class)
);
});
$container->register(ExtractExpression::class, function (Container $container) {
return new TolerantExtractExpression();
});
$container->register(ImportName::class, function (Container $container) {
return new TolerantImportName(
$container->get(Updater::class)
);
});
$container->register(ChangeVisiblity::class, function (Container $container) {
return new TolerantChangeVisiblity();
});
$container->register(UnresolvableClassNameFinder::class, function (Container $container) {
return new WorseUnresolvableClassNameFinder(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR)
);
});
}
private function registerGeneratorImplementations(ContainerBuilder $container): void
{
$container->register('code_transform_extra.class_generator.variants', function (Container $container) {
$generators = [
'default' => new ClassGenerator($container->get('code_transform.renderer')),
];
foreach ($container->getParameter(self::PARAM_NEW_CLASS_VARIANTS) as $variantName => $variant) {
$generators[$variantName] = new ClassGenerator($container->get('code_transform.renderer'), $variant);
}
return $generators;
}, [ CodeTransformExtension::TAG_NEW_CLASS_GENERATOR => [] ]);
$container->register('code_transform_extra.from_existing_generator', function (Container $container) {
return new InterfaceFromExistingGenerator(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get('code_transform.renderer')
);
}, [ CodeTransformExtension::TAG_FROM_EXISTING_GENERATOR => [
'name' => 'interface'
] ]);
}
private function registerUpdater(ContainerBuilder $container): void
{
$container->register(Updater::class, function (Container $container) {
return new TolerantUpdater(
$container->get('code_transform.renderer'),
$container->get(TextFormat::class),
$container->get(self::SERVICE_TOLERANT_PARSER)
);
});
$container->register(BuilderFactory::class, function (Container $container) {
return new WorseBuilderFactory($container->get(WorseReflectionExtension::SERVICE_REFLECTOR));
});
$container->register(self::SERVICE_TOLERANT_PARSER, function (Container $container) {
return new Parser();
});
}
private function registerFinders(ContainerBuilder $container): void
{
$container->register(InterestingOffsetFinder::class, function (Container $container) {
return new WorseInterestingOffsetFinder(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR)
);
});
}
private function registerRenderer(ContainerBuilder $container): void
{
$container->register('code_transform.twig_loader', function (Container $container) {
$resolver = $container->get(FilePathResolverExtension::SERVICE_FILE_PATH_RESOLVER);
$loader = new ChainLoader();
$templatePaths = $container->getParameter(self::PARAM_TEMPLATE_PATHS);
$templatePaths[] = self::APP_TEMPLATE_PATH;
$resolvedTemplatePaths = array_map(function (string $path) use ($resolver) {
return $resolver->resolve($path);
}, $templatePaths);
$phpVersion = $container->get(PhpVersionResolver::class)->resolve();
$paths = (new PhpVersionPathResolver($phpVersion))->resolve($resolvedTemplatePaths);
foreach ($paths as $path) {
$loader->addLoader(new FilesystemLoader($path));
}
return $loader;
});
$container->register('code_transform.renderer', function (Container $container) {
$twig = new Environment($container->get('code_transform.twig_loader'), [
'strict_variables' => true,
]);
$renderer = new TwigRenderer($twig);
$twig->addExtension(new TwigExtension($renderer, $container->get(TextFormat::class)));
return $renderer;
});
$container->register(TextFormat::class, function (Container $container) {
return new TextFormat($container->getParameter(self::PARAM_INDENTATION));
});
}
private function assertNameAttribute($attrs, $serviceId): void
{
if (!isset($attrs['name'])) {
throw new RuntimeException(sprintf(
'Generator "%s" must be registered with the "name" tag',
$serviceId
));
}
}
private function registerRpc(ContainerBuilder $container): void
{
$container->register('code_transform.rpc.handler.class_inflect', function (Container $container) {
return new ClassInflectHandler(
$container->get(self::SERVICE_CLASS_INFLECTORS),
$container->get(ClassToFileExtension::SERVICE_CONVERTER)
);
}, [ RpcExtension::TAG_RPC_HANDLER => ['name' => ClassInflectHandler::NAME] ]);
$container->register('code_transform.rpc.handler.class_new', function (Container $container) {
return new ClassNewHandler(
$container->get(self::SERVICE_CLASS_GENERATORS),
$container->get(ClassToFileExtension::SERVICE_CONVERTER)
);
}, [ RpcExtension::TAG_RPC_HANDLER => ['name' => ClassNewHandler::NAME] ]);
$container->register('code_transform.rpc.handler.transform', function (Container $container) {
return new TransformHandler(
$container->get(CodeTransform::class)
);
}, [ RpcExtension::TAG_RPC_HANDLER => ['name' => TransformHandler::NAME] ]);
}
private function registerTransformerImplementations(ContainerBuilder $container): void
{
$container->register('code_transform.transformer.complete_constructor', function (Container $container) {
return new CompleteConstructor(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(Updater::class)
);
}, [ 'code_transform.transformer' => [ 'name' => 'complete_constructor' ]]);
$container->register('code_transform.transformer.implement_contracts', function (Container $container) {
return new ImplementContracts(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(Updater::class),
$container->get(BuilderFactory::class)
);
}, [ 'code_transform.transformer' => [ 'name' => 'implement_contracts' ]]);
$container->register('code_transform.transformer.fix_namespace_class_name', function (Container $container) {
return new ClassNameFixerTransformer(
$container->get('class_to_file.file_to_class')
);
}, [ 'code_transform.transformer' => [ 'name' => 'fix_namespace_class_name' ]]);
$container->register('code_transform.transformer.add_missing_properties', function (Container $container) {
return new AddMissingProperties(
$container->get(WorseReflectionExtension::SERVICE_REFLECTOR),
$container->get(Updater::class)
);
}, [ 'code_transform.transformer' => [ 'name' => 'add_missing_properties' ]]);
}
}