Installer::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces() - Code Metrics - Inspection of "Merge pull request #1070 from WyriHaximus/renovate..." - WyriHaximus/php-test-utilities - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1e95b8...e09157 )

by Cees-Jan

created 2025-08-18 16:43 UTC

addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces() A

↳ Parent: Installer

Complexity

Conditions	6
Paths	7

Size

Total Lines	20
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	10
c	1
b	0
f	0
nc	7
nop	1
dl	0
loc	20
rs	9.2222

<?php

declare(strict_types=1);

namespace WyriHaximus\TestUtilities\Composer;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;
use Exception;

use function array_key_exists;
use function array_keys;
use function dirname;
use function file_exists;
use function file_get_contents;
use function file_put_contents;
use function hash;
use function hash_equals;
use function is_array;
use function is_string;
use function json_decode;
use function json_encode;
use function preg_replace;

use const DIRECTORY_SEPARATOR;
use const JSON_PRETTY_PRINT;
use const JSON_UNESCAPED_SLASHES;
use const PHP_INT_MAX;

final class Installer implements PluginInterface, EventSubscriberInterface
{
    /** @return array<string, array<string|int>> */
    public static function getSubscribedEvents(): array
    {
        return [ScriptEvents::PRE_AUTOLOAD_DUMP => ['findEventListeners', PHP_INT_MAX]];
    }

    public function activate(Composer $composer, IOInterface $io): void
    {
        // does nothing, see getSubscribedEvents() instead.
    }

    public function deactivate(Composer $composer, IOInterface $io): void
    {
        // does nothing, see getSubscribedEvents() instead.
    }

    public function uninstall(Composer $composer, IOInterface $io): void
    {
        // does nothing, see getSubscribedEvents() instead.
    }

    /**
     * Called before every dump autoload, generates a fresh PHP class.
     *
     * @phpstan-ignore shipmonk.deadMethod
     */
    public static function findEventListeners(Event $event): void
    {
        $rootPackagePath = dirname(self::getVendorDir($event->getComposer())) . DIRECTORY_SEPARATOR;
        if (! file_exists($rootPackagePath . '/composer.json')) {
            return;
        }

        $jsonRaw = file_get_contents($rootPackagePath . '/composer.json');
        if (! is_string($jsonRaw)) {

            return;
        }

        $json = json_decode($jsonRaw, true);
        if (! is_array($json)) {
            return;
        }

        if (array_key_exists('name', $json) && $json['name'] === 'wyrihaximus/test-utilities') {
            self::addMakeOnInstallOrUpdate($event->getIO(), $rootPackagePath);

            return;
        }

        if (! array_key_exists('require-dev', $json)) {
            return;
        }

        if (! is_array($json['require-dev'])) {
            return;
        }

        foreach (array_keys($json['require-dev']) as $package) {
            if ($package === 'wyrihaximus/test-utilities') {
                self::addMakeOnInstallOrUpdate($event->getIO(), $rootPackagePath);

                return;
            }
        }
    }

    private static function addMakeOnInstallOrUpdate(IOInterface $io, string $rootPackagePath): void
    {
        $io->write('<info>wyrihaximus/test-utilities:</info> Adding <fg=cyan>make on-install-or-update || true</> to scripts');
        $composerJsonString = file_get_contents($rootPackagePath . '/composer.json');
        if (! is_string($composerJsonString)) {

            $io->write('<error>wyrihaximus/test-utilities:</error> Unable to read <fg=cyan>composer.json</> aborting');

            return;
        }

        $composerJson     = json_decode($composerJsonString, true);
        $composerJsonHash = hash('sha512', (string) json_encode($composerJson, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
        if (is_array($composerJson) && array_key_exists('scripts', $composerJson) && is_array($composerJson['scripts'])) {
            if (array_key_exists('post-install-cmd', $composerJson['scripts'])) {
                $composerJson['scripts']['post-install-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-install-cmd']);
            }

            if (array_key_exists('post-update-cmd', $composerJson['scripts'])) {
                $composerJson['scripts']['post-update-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-update-cmd']);
            }
        }

        $replacementComposerJsonString = json_encode($composerJson, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
        if (is_string($replacementComposerJsonString)) {

            $replacementComposerJsonHash = hash('sha512', $replacementComposerJsonString);
            if (! hash_equals($composerJsonHash, $replacementComposerJsonHash)) {
                $replacementComposerJsonString = preg_replace('/^(  +?)\\1(?=[^ ])/m', '$1', $replacementComposerJsonString);
                if (is_string($replacementComposerJsonString)) {

                    $io->write('<info>wyrihaximus/test-utilities:</info> Writing new <fg=cyan>composer.json</>');
                    file_put_contents($rootPackagePath . '/composer.json', $replacementComposerJsonString);
                }
            }
        }

        if (is_array($composerJson) && array_key_exists('scripts', $composerJson) && is_array($composerJson['scripts'])) {
            if (array_key_exists('post-install-cmd', $composerJson['scripts'])) {
                $composerJson['scripts']['post-install-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-install-cmd']);
            }

            if (array_key_exists('post-update-cmd', $composerJson['scripts'])) {
                $composerJson['scripts']['post-update-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-update-cmd']);
            }
        }

        $replacementComposerJsonString = json_encode($composerJson, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
        if (is_string($replacementComposerJsonString)) {

            $replacementComposerJsonHash = hash('sha512', $replacementComposerJsonString);
            if (! hash_equals($composerJsonHash, $replacementComposerJsonHash)) {
                $replacementComposerJsonString = preg_replace('/^(  +?)\\1(?=[^ ])/m', '$1', $replacementComposerJsonString);
                if (is_string($replacementComposerJsonString)) {

                    $io->write('<info>wyrihaximus/test-utilities:</info> Writing new <fg=cyan>composer.json</>');
                    file_put_contents($rootPackagePath . '/composer.json', $replacementComposerJsonString);
                }
            }
        }

        $io->write('<info>wyrihaximus/test-utilities:</info> Finished <fg=cyan>make on-install-or-update || true</> to scripts');
    }

    /**
     * @param array<int, string> $scriptsSection
     *
     * @return array<int, string>
     */
    private static function addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces(array $scriptsSection): array
    {
        foreach ($scriptsSection as $script) {
            if ($script === 'make on-install-or-update || true') {
                return $scriptsSection;
            }
        }

        $scripts = [];
        foreach ($scriptsSection as $script) {
            if ($script === 'composer normalize' || $script === 'composer update --lock --no-scripts') {
                continue;
            }

            $scripts[] = $script;
        }

        $scripts[] = 'make on-install-or-update || true';

        return $scripts;
    }

    /** @return non-empty-string */

    private static function getVendorDir(Composer $composer): string
    {
        $vendorDir = $composer->getConfig()->get('vendor-dir');
        if ($vendorDir === '' || ! file_exists($vendorDir)) {
            throw new Exception('vendor-dir must be a string');
        }

        return $vendorDir;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace WyriHaximus\TestUtilities\Composer;
6
7			use Composer\Composer;
8			use Composer\EventDispatcher\EventSubscriberInterface;
9			use Composer\IO\IOInterface;
10			use Composer\Plugin\PluginInterface;
11			use Composer\Script\Event;
12			use Composer\Script\ScriptEvents;
13			use Exception;
14
15			use function array_key_exists;
16			use function array_keys;
17			use function dirname;
18			use function file_exists;
19			use function file_get_contents;
20			use function file_put_contents;
21			use function hash;
22			use function hash_equals;
23			use function is_array;
24			use function is_string;
25			use function json_decode;
26			use function json_encode;
27			use function preg_replace;
28
29			use const DIRECTORY_SEPARATOR;
30			use const JSON_PRETTY_PRINT;
31			use const JSON_UNESCAPED_SLASHES;
32			use const PHP_INT_MAX;
33
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
53			{
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)) {
			0 ignored issues – show introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The condition `is_string($jsonRaw)` is always `true`. Loading history...
71			return;
72			}
73
74			$json = json_decode($jsonRaw, true);
75			if (! is_array($json)) {
76			return;
77			}
78
79			if (array_key_exists('name', $json) && $json['name'] === 'wyrihaximus/test-utilities') {
80			self::addMakeOnInstallOrUpdate($event->getIO(), $rootPackagePath);
81
82			return;
83			}
84
85			if (! array_key_exists('require-dev', $json)) {
86			return;
87			}
88
89			if (! is_array($json['require-dev'])) {
90			return;
91			}
92
93			foreach (array_keys($json['require-dev']) as $package) {
94			if ($package === 'wyrihaximus/test-utilities') {
95			self::addMakeOnInstallOrUpdate($event->getIO(), $rootPackagePath);
96
97			return;
98			}
99			}
100			}
101
102			private static function addMakeOnInstallOrUpdate(IOInterface $io, string $rootPackagePath): void
103			{
104			$io->write('<info>wyrihaximus/test-utilities:</info> Adding <fg=cyan>make on-install-or-update \|\| true</> to scripts');
105			$composerJsonString = file_get_contents($rootPackagePath . '/composer.json');
106			if (! is_string($composerJsonString)) {
			0 ignored issues – show introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The condition `is_string($composerJsonString)` is always `true`. Loading history...
107			$io->write('<error>wyrihaximus/test-utilities:</error> Unable to read <fg=cyan>composer.json</> aborting');
108
109			return;
110			}
111
112			$composerJson = json_decode($composerJsonString, true);
113			$composerJsonHash = hash('sha512', (string) json_encode($composerJson, JSON_UNESCAPED_SLASHES \| JSON_PRETTY_PRINT));
114			if (is_array($composerJson) && array_key_exists('scripts', $composerJson) && is_array($composerJson['scripts'])) {
115			if (array_key_exists('post-install-cmd', $composerJson['scripts'])) {
116			$composerJson['scripts']['post-install-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-install-cmd']);
117			}
118
119			if (array_key_exists('post-update-cmd', $composerJson['scripts'])) {
120			$composerJson['scripts']['post-update-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-update-cmd']);
121			}
122			}
123
124			$replacementComposerJsonString = json_encode($composerJson, JSON_UNESCAPED_SLASHES \| JSON_PRETTY_PRINT);
125			if (is_string($replacementComposerJsonString)) {
			0 ignored issues – show introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The condition `is_string($replacementComposerJsonString)` is always `true`. Loading history...
126			$replacementComposerJsonHash = hash('sha512', $replacementComposerJsonString);
127			if (! hash_equals($composerJsonHash, $replacementComposerJsonHash)) {
128			$replacementComposerJsonString = preg_replace('/^( +?)\\1(?=[^ ])/m', '$1', $replacementComposerJsonString);
129			if (is_string($replacementComposerJsonString)) {
			0 ignored issues – show introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The condition `is_string($replacementComposerJsonString)` is always `true`. Loading history...
130			$io->write('<info>wyrihaximus/test-utilities:</info> Writing new <fg=cyan>composer.json</>');
131			file_put_contents($rootPackagePath . '/composer.json', $replacementComposerJsonString);
132			}
133			}
134			}
135
136			if (is_array($composerJson) && array_key_exists('scripts', $composerJson) && is_array($composerJson['scripts'])) {
137			if (array_key_exists('post-install-cmd', $composerJson['scripts'])) {
138			$composerJson['scripts']['post-install-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-install-cmd']);
139			}
140
141			if (array_key_exists('post-update-cmd', $composerJson['scripts'])) {
142			$composerJson['scripts']['post-update-cmd'] = self::addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces($composerJson['scripts']['post-update-cmd']);
143			}
144			}
145
146			$replacementComposerJsonString = json_encode($composerJson, JSON_UNESCAPED_SLASHES \| JSON_PRETTY_PRINT);
147			if (is_string($replacementComposerJsonString)) {
			0 ignored issues – show introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The condition `is_string($replacementComposerJsonString)` is always `true`. Loading history...
148			$replacementComposerJsonHash = hash('sha512', $replacementComposerJsonString);
149			if (! hash_equals($composerJsonHash, $replacementComposerJsonHash)) {
150			$replacementComposerJsonString = preg_replace('/^( +?)\\1(?=[^ ])/m', '$1', $replacementComposerJsonString);
151			if (is_string($replacementComposerJsonString)) {
			0 ignored issues – show introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The condition `is_string($replacementComposerJsonString)` is always `true`. Loading history...
152			$io->write('<info>wyrihaximus/test-utilities:</info> Writing new <fg=cyan>composer.json</>');
153			file_put_contents($rootPackagePath . '/composer.json', $replacementComposerJsonString);
154			}
155			}
156			}
157
158			$io->write('<info>wyrihaximus/test-utilities:</info> Finished <fg=cyan>make on-install-or-update \|\| true</> to scripts');
159			}
160
161			/**
162			* @param array<int, string> $scriptsSection
163			*
164			* @return array<int, string>
165			*/
166			private static function addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces(array $scriptsSection): array
167			{
168			foreach ($scriptsSection as $script) {
169			if ($script === 'make on-install-or-update \|\| true') {
170			return $scriptsSection;
171			}
172			}
173
174			$scripts = [];
175			foreach ($scriptsSection as $script) {
176			if ($script === 'composer normalize' \|\| $script === 'composer update --lock --no-scripts') {
177			continue;
178			}
179
180			$scripts[] = $script;
181			}
182
183			$scripts[] = 'make on-install-or-update \|\| true';
184
185			return $scripts;
186			}
187
188			/** @return non-empty-string */
			0 ignored issues – show Documentation Bug introduced 2025-08-18 16:47 UTC by Report Bug Copy Issue Report The doc comment `non-empty-string` at position `0` could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string. Loading history...
189			private static function getVendorDir(Composer $composer): string
190			{
191			$vendorDir = $composer->getConfig()->get('vendor-dir');
192			if ($vendorDir === '' \|\| ! file_exists($vendorDir)) {
193			throw new Exception('vendor-dir must be a string');
194			}
195
196			return $vendorDir;
197			}
198			}
199

WyriHaximus / php-test-utilities

GitHub Access Token became invalid

Push — master ( 1e95b8...e09157 )

addMakeOnInstallOrUpdateToScriptsSectionAndRemoveCommandsItReplaces() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like