-
-
Notifications
You must be signed in to change notification settings - Fork 449
Expand file tree
/
Copy pathConfigurationFactory.php
More file actions
258 lines (210 loc) · 8.26 KB
/
Copy pathConfigurationFactory.php
File metadata and controls
258 lines (210 loc) · 8.26 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
<?php
declare(strict_types=1);
namespace Rector\Configuration;
use Rector\Agentic\TerminalDetector;
use Rector\ChangesReporting\Output\ConsoleOutputFormatter;
use Rector\Configuration\Parameter\SimpleParameterProvider;
use Rector\FileSystem\FilePathFilter;
use Rector\ValueObject\Configuration;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Webmozart\Assert\Assert;
/**
* @see \Rector\Tests\Configuration\ConfigurationFactoryTest
*/
final readonly class ConfigurationFactory
{
public function __construct(
private SymfonyStyle $symfonyStyle,
private OnlyRuleResolver $onlyRuleResolver,
private FilePathFilter $filePathFilter,
) {
}
/**
* @api used in tests
* @param string[] $paths
*/
public function createForTests(array $paths): Configuration
{
$fileExtensions = SimpleParameterProvider::provideArrayParameter(Option::FILE_EXTENSIONS);
return new Configuration(
false,
true,
false,
ConsoleOutputFormatter::NAME,
$fileExtensions,
$paths,
true,
null,
null,
false,
null,
false,
false
);
}
/**
* Needs to run in the start of the life cycle, since the rest of workflow uses it.
*/
public function createFromInput(InputInterface $input): Configuration
{
$isDryRun = (bool) $input->getOption(Option::DRY_RUN);
$shouldClearCache = (bool) $input->getOption(Option::CLEAR_CACHE);
$outputFormat = (string) $input->getOption(Option::OUTPUT_FORMAT);
$showProgressBar = $this->shouldShowProgressBar($input, $outputFormat);
$showDiffs = $this->shouldShowDiffs($input);
$paths = $this->resolvePaths($input);
$fileExtensions = SimpleParameterProvider::provideArrayParameter(Option::FILE_EXTENSIONS);
// filter rule and path
/** @var string[] $onlyRuleInputs */
$onlyRuleInputs = (array) $input->getOption(Option::ONLY);
$onlyRules = array_map(
$this->onlyRuleResolver->resolve(...),
$onlyRuleInputs
);
$onlySuffix = $input->getOption(Option::ONLY_SUFFIX);
if ($onlySuffix !== null) {
$this->symfonyStyle->warning(
'The "--only-suffix" option is deprecated and will be removed. Use "--filter" instead, e.g. --filter="*Controller.php"'
);
}
$rawFilter = $input->getOption(Option::FILTER);
$filters = $rawFilter !== null ? $this->filePathFilter->parsePatterns((string) $rawFilter) : [];
// "--only"/"--only-suffix"/"--filter" narrow the run, so skips outside the scope look falsely unused;
// mark the run as narrowed to disable unused skip reporting and avoid false positives
if ($onlyRules !== [] || $onlySuffix !== null || $filters !== []) {
SimpleParameterProvider::setParameter(Option::IS_RUN_NARROWED, true);
}
$isParallel = SimpleParameterProvider::provideBoolParameter(Option::PARALLEL);
$parallelPort = (string) $input->getOption(Option::PARALLEL_PORT);
$parallelIdentifier = (string) $input->getOption(Option::PARALLEL_IDENTIFIER);
$isDebug = (bool) $input->getOption(Option::DEBUG);
// using debug disables parallel, so emitting exception is straightforward and easier to debug
if ($isDebug) {
$isParallel = false;
}
$maxChanges = $this->resolveMaxChanges($input);
// a global change counter cannot be shared across parallel workers, so enforce the limit in a single process
if ($maxChanges !== null) {
$isParallel = false;
}
$memoryLimit = $this->resolveMemoryLimit($input);
$isReportingWithRealPath = SimpleParameterProvider::provideBoolParameter(Option::ABSOLUTE_FILE_PATH);
$levelOverflows = SimpleParameterProvider::provideArrayParameter(Option::LEVEL_OVERFLOWS);
$showRulesSummary = (bool) $input->getOption(Option::RULES_SUMMARY);
$isComposerBased = (bool) $input->getOption(Option::COMPOSER_BASED);
// "--composer-based" narrows the run the same way "--only" does
if ($isComposerBased) {
SimpleParameterProvider::setParameter(Option::IS_RUN_NARROWED, true);
}
$isPhpOnly = (bool) $input->getOption(Option::PHP);
// "--php" narrows the run the same way "--only" does
if ($isPhpOnly) {
SimpleParameterProvider::setParameter(Option::IS_RUN_NARROWED, true);
}
return new Configuration(
$isDryRun,
$showProgressBar,
$shouldClearCache,
$outputFormat,
$fileExtensions,
$paths,
$showDiffs,
$parallelPort,
$parallelIdentifier,
$isParallel,
$memoryLimit,
$isDebug,
$isReportingWithRealPath,
$onlyRules,
$onlySuffix,
$levelOverflows,
$showRulesSummary,
$isComposerBased,
$isPhpOnly,
$filters,
$maxChanges,
);
}
private function resolveMaxChanges(InputInterface $input): ?int
{
$maxChanges = $input->getOption(Option::MAX_CHANGES);
if ($maxChanges === null) {
return null;
}
$maxChanges = (int) $maxChanges;
Assert::positiveInteger($maxChanges);
return $maxChanges;
}
private function shouldShowProgressBar(InputInterface $input, string $outputFormat): bool
{
$noProgressBar = (bool) $input->getOption(Option::NO_PROGRESS_BAR);
if ($noProgressBar) {
return false;
}
// no interactive terminal, e.g. piped output, CI or an agent - the redraws are just noise
if (! TerminalDetector::isOutputTty()) {
return false;
}
if ($this->symfonyStyle->isVerbose()) {
return false;
}
return $outputFormat === ConsoleOutputFormatter::NAME;
}
private function shouldShowDiffs(InputInterface $input): bool
{
$noDiffs = (bool) $input->getOption(Option::NO_DIFFS);
if ($noDiffs) {
return false;
}
// fallback to parameter
return ! SimpleParameterProvider::provideBoolParameter(Option::NO_DIFFS, false);
}
/**
* @return string[]|mixed[]
*/
private function resolvePaths(InputInterface $input): array
{
$commandLinePaths = (array) $input->getArgument(Option::SOURCE);
// give priority to command line
if ($commandLinePaths !== []) {
// mark the run as narrowed, so unused skip reporting can be disabled to avoid false positives
SimpleParameterProvider::setParameter(Option::IS_RUN_NARROWED, true);
$paths = $commandLinePaths;
} else {
// fallback to parameter
$paths = SimpleParameterProvider::provideArrayParameter(Option::PATHS);
}
$this->setFilesWithoutExtensionParameter($paths);
// extensions read the processed paths from here; without this only the test harness
// sets it, so the parameter is empty in a real run
SimpleParameterProvider::setParameter(Option::SOURCE, $paths);
return $paths;
}
/**
* @param string[] $paths
*/
private function setFilesWithoutExtensionParameter(array $paths): void
{
foreach ($paths as $path) {
if (is_file($path) && pathinfo($path, PATHINFO_EXTENSION) === '') {
$path = realpath($path);
if ($path === false) {
continue;
}
SimpleParameterProvider::addParameter(Option::FILES_WITHOUT_EXTENSION, $path);
}
}
}
private function resolveMemoryLimit(InputInterface $input): string|null
{
$memoryLimit = $input->getOption(Option::MEMORY_LIMIT);
if ($memoryLimit !== null) {
return (string) $memoryLimit;
}
if (! SimpleParameterProvider::hasParameter(Option::MEMORY_LIMIT)) {
return null;
}
return SimpleParameterProvider::provideStringParameter(Option::MEMORY_LIMIT);
}
}