WyriHaximus /
php-test-utilities
| Total Complexity | 44 |
| Total Lines | 177 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 0 | Features | 1 |
Complex classes like Installer often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Installer, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 34 | final class Installer implements PluginInterface, EventSubscriberInterface |
||
| 35 | { |
||
| 36 | /** @return array<string, array<string|int>> */ |
||
| 37 | public static function getSubscribedEvents(): array |
||
| 38 | { |
||
| 39 | return [ScriptEvents::PRE_AUTOLOAD_DUMP => ['findEventListeners', PHP_INT_MAX]]; |
||
| 40 | } |
||
| 41 | |||
| 42 | public function activate(Composer $composer, IOInterface $io): void |
||
| 43 | { |
||
| 44 | // does nothing, see getSubscribedEvents() instead. |
||
| 45 | } |
||
| 46 | |||
| 47 | public function deactivate(Composer $composer, IOInterface $io): void |
||
| 48 | { |
||
| 49 | // does nothing, see getSubscribedEvents() instead. |
||
| 50 | } |
||
| 51 | |||
| 52 | public function uninstall(Composer $composer, IOInterface $io): void |
||
| 54 | // does nothing, see getSubscribedEvents() instead. |
||
| 55 | } |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Called before every dump autoload, generates a fresh PHP class. |
||
| 59 | * |
||
| 60 | * @phpstan-ignore shipmonk.deadMethod |
||
| 61 | */ |
||
| 62 | public static function findEventListeners(Event $event): void |
||
| 63 | { |
||
| 64 | $rootPackagePath = dirname(self::getVendorDir($event->getComposer())) . DIRECTORY_SEPARATOR; |
||
| 65 | if (! file_exists($rootPackagePath . '/composer.json')) { |
||
| 66 | return; |
||
| 67 | } |
||
| 68 | |||
| 69 | $jsonRaw = file_get_contents($rootPackagePath . '/composer.json'); |
||
| 70 | if (! is_string($jsonRaw)) { |
||
|
introduced
by
|
|||
| 71 | return; |
||
| 72 | } |
||
| 73 | |||
| 74 | $json = json_decode($jsonRaw, true); |
||
| 75 | if (! is_array($json)) { |
||
| 76 | return; |
||
| 77 | } |
||
| 78 | |||
| 79 | if (! array_key_exists('require-dev', $json)) { |
||
| 80 | return; |
||
| 81 | } |
||
| 82 | |||
| 83 | if (! is_array($json['require-dev'])) { |
||
| 84 | return; |
||
| 85 | } |
||
| 86 | |||
| 87 | $hasMakefiles = false; |
||
| 88 | foreach (array_keys($json['require-dev']) as $package) { |
||
| 89 | if ($package === 'wyrihaximus/makefiles') { |
||
| 90 | $hasMakefiles = true; |
||
| 91 | break; |
||
| 92 | } |
||
| 93 | } |
||
| 94 | |||
| 95 | if (! $hasMakefiles) { |
||
| 96 | return; |
||
| 97 | } |
||
| 98 | |||
| 99 | unset($hasMakefiles); |
||
| 100 | |||
| 101 | if (array_key_exists('name', $json) && $json['name'] === 'wyrihaximus/test-utilities') { |
||
| 102 | self::addMakeOnInstallOrUpdate($event->getIO(), $rootPackagePath); |
||
| 103 | |||
| 104 | return; |
||
| 105 | } |
||
| 106 | |||
| 107 | foreach (array_keys($json['require-dev']) as $package) { |
||
| 108 | if ($package === 'wyrihaximus/test-utilities') { |
||
| 109 | self::addMakeOnInstallOrUpdate($event->getIO(), $rootPackagePath); |
||
| 110 | |||
| 111 | return; |
||
| 112 | } |
||
| 113 | } |
||
| 114 | } |
||
| 115 | |||
| 116 | private static function addMakeOnInstallOrUpdate(IOInterface $io, string $rootPackagePath): void |
||
| 173 | } |
||
| 174 | |||
| 175 | /** |
||
| 176 | * @param array<int, string> $scriptsSection |
||
| 177 | * |
||
| 178 | * @return array<int, string> |
||
| 179 | */ |
||
| 180 | private static function addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces(array $scriptsSection): array |
||
| 181 | { |
||
| 182 | foreach ($scriptsSection as $script) { |
||
| 183 | if ($script === 'make on-install-or-update || true') { |
||
| 184 | return $scriptsSection; |
||
| 185 | } |
||
| 186 | } |
||
| 187 | |||
| 188 | $scripts = []; |
||
| 189 | foreach ($scriptsSection as $script) { |
||
| 190 | if ($script === 'composer normalize' || $script === 'composer update --lock --no-scripts') { |
||
| 191 | continue; |
||
| 192 | } |
||
| 193 | |||
| 194 | $scripts[] = $script; |
||
| 195 | } |
||
| 196 | |||
| 197 | $scripts[] = 'make on-install-or-update || true'; |
||
| 198 | |||
| 199 | return $scripts; |
||
| 200 | } |
||
| 201 | |||
| 202 | /** @return non-empty-string */ |
||
| 203 | private static function getVendorDir(Composer $composer): string |
||
| 211 | } |
||
| 212 | } |
||
| 213 |
Loading history...