FlexMigrator::patchRootComposerJson() - Code Metrics - Inspection of "Merge branch 'next-24090/cherry-pick' into '6.5.0...." - shopware/platform - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 6.5.0.0 ( 85bd4e...fe6596 )

by Christian

created 2023-03-08 09:49 UTC

FlexMigrator::patchRootComposerJson() A

↳ Parent: FlexMigrator

Complexity

Conditions	3
Paths	4

Size

Total Lines	55
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	31
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	55
rs	9.424

How to fix Long Method

<?php
declare(strict_types=1);

namespace App\Services;

use Shopware\Core\Framework\Log\Package;
use Symfony\Component\Filesystem\Filesystem;

/**
 * @internal
 */
#[Package('core')]
class FlexMigrator
{
    private const REMOVE_FILES = [
        '.dockerignore',
        'Dockerfile',
        'PLATFORM_COMMIT_SHA',
        'README.md',
        'config/services.xml',
        'config/services_test.xml',
        'easy-coding-standard.php',
        'license.txt',
        'phpstan.neon',
        'phpunit.xml.dist',
        'psalm.xml',
        'public/index.php',
        'src/TestBootstrap.php',
        'var/plugins.json',
    ];

    private const REMOVE_DIRECTORIES = [
        '.github',
        '.gitlab-ci',
        'gitlab-ci.yml',
        'bin',
        'config/etc',
        'config/services',
        'public/recovery',
        'files/update',
    ];

    private const ENV_DEFAULT = <<<EOT
###> symfony/lock ###
# Choose one of the stores below
# postgresql+advisory://db_user:db_password@localhost/db_name
LOCK_DSN=flock
###< symfony/lock ###
###> symfony/messenger ###
# Choose one of the transports below
# MESSENGER_TRANSPORT_DSN=doctrine://default
# MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages
# MESSENGER_TRANSPORT_DSN=redis://localhost:6379/messages
###< symfony/messenger ###
###> symfony/mailer ###
# MAILER_DSN=null://null
###< symfony/mailer ###
###> shopware/core ###
APP_ENV=prod
APP_URL=http://127.0.0.1:8000
APP_SECRET=7628a40c75b25f8a1f14b3812c3b250b
INSTANCE_ID=41322ddd2b70bd29ef65d402f025c785
BLUE_GREEN_DEPLOYMENT=0
DATABASE_URL=mysql://root:root@localhost/shopware
# With Shopware 6.4.17.0 the MAILER_DSN variable will be used in this template instead of MAILER_URL
MAILER_URL=null://null
###< shopware/core ###
###> shopware/elasticsearch ###
OPENSEARCH_URL=http://localhost:9200
SHOPWARE_ES_ENABLED=0
SHOPWARE_ES_INDEXING_ENABLED=0
SHOPWARE_ES_INDEX_PREFIX=sw
SHOPWARE_ES_THROW_EXCEPTION=1
###< shopware/elasticsearch ###
###> shopware/storefront ###
STOREFRONT_PROXY_URL=http://localhost
SHOPWARE_HTTP_CACHE_ENABLED=1
SHOPWARE_HTTP_DEFAULT_TTL=7200
###< shopware/storefront ###
EOT;

    /**
     * Delete all files and directories that are not needed anymore
     */
    public function cleanup(string $projectDir): void
    {
        $fs = new Filesystem();

        foreach (self::REMOVE_FILES as $file) {
            $path = $projectDir . '/' . $file;
            if ($fs->exists($path)) {
                $fs->remove($path);
            }
        }

        foreach (self::REMOVE_DIRECTORIES as $directory) {
            $path = $projectDir . '/' . $directory;

            if ($fs->exists($path)) {
                $fs->remove($path);
            }
        }

        $fs->mkdir($projectDir . '/bin');
    }

    public function patchRootComposerJson(string $projectDir): void
    {
        $composerJsonPath = $projectDir . '/composer.json';

        /** @var array{require: array<string, string>, config?: array{platform?: string, "allow-plugins": array<string, bool>}} $composerJson */
        $composerJson = json_decode((string) file_get_contents($composerJsonPath), true, \JSON_THROW_ON_ERROR);

        $composerJson['require']['symfony/flex'] = '^2';
        $composerJson['require']['symfony/runtime'] = '^5.0|^6.0';

        // Remove old recovery
        unset($composerJson['require']['shopware/recovery']);

        if (!isset($composerJson['config'])) {
            $composerJson['config'] = [];
        }

        if (!isset($composerJson['config']['allow-plugins'])) {
            $composerJson['config']['allow-plugins'] = [];
        }

        $composerJson['config']['allow-plugins']['symfony/flex'] = true;
        $composerJson['config']['allow-plugins']['symfony/runtime'] = true;

        unset($composerJson['config']['platform']);

        $composerJson['scripts'] = [
            'auto-scripts' => [
                'assets:install' => 'symfony-cmd',
            ],
            'post-install-cmd' => [
                '@auto-scripts',
            ],
            'post-update-cmd' => [
                '@auto-scripts',
            ],
        ];

        $composerJson['extra']['symfony'] = [
            'allow-contrib' => true,
            'endpoint' => [
                'https://raw.githubusercontent.com/shopware/recipes/flex/main/index.json',
                'flex://defaults',
            ],
        ];

        $composerJson['require-dev'] = [
            'fakerphp/faker' => '^1.20',
            'maltyxx/images-generator' => '^1.0',
            'mbezhanov/faker-provider-collection' => '^2.0',
            'symfony/stopwatch' => '^5.0|^6.0',
            'symfony/web-profiler-bundle' => '^5.0|^6.0',
        ];

        file_put_contents($composerJsonPath, json_encode($composerJson, \JSON_THROW_ON_ERROR | \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
    }

    public function copyNewTemplateFiles(string $projectDir): void
    {
        $fs = new Filesystem();

        $fs->mirror(__DIR__ . '/../Resources/flex-config/', $projectDir);
    }

    public function migrateEnvFile(string $projectDir): void
    {
        $envPath = $projectDir . '/.env';

        if (!file_exists($envPath)) {
            file_put_contents($envPath, self::ENV_DEFAULT);

            return;
        }

        rename($envPath, $envPath . '.local');
        file_put_contents($envPath, self::ENV_DEFAULT);
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace App\Services;
5
6			use Shopware\Core\Framework\Log\Package;
7			use Symfony\Component\Filesystem\Filesystem;
8
9			/**
10			* @internal
11			*/
12			#[Package('core')]
13			class FlexMigrator
14			{
15			private const REMOVE_FILES = [
16			'.dockerignore',
17			'Dockerfile',
18			'PLATFORM_COMMIT_SHA',
19			'README.md',
20			'config/services.xml',
21			'config/services_test.xml',
22			'easy-coding-standard.php',
23			'license.txt',
24			'phpstan.neon',
25			'phpunit.xml.dist',
26			'psalm.xml',
27			'public/index.php',
28			'src/TestBootstrap.php',
29			'var/plugins.json',
30			];
31
32			private const REMOVE_DIRECTORIES = [
33			'.github',
34			'.gitlab-ci',
35			'gitlab-ci.yml',
36			'bin',
37			'config/etc',
38			'config/services',
39			'public/recovery',
40			'files/update',
41			];
42
43			private const ENV_DEFAULT = <<<EOT
44			###> symfony/lock ###
45			# Choose one of the stores below
46			# postgresql+advisory://db_user:db_password@localhost/db_name
47			LOCK_DSN=flock
48			###< symfony/lock ###
49			###> symfony/messenger ###
50			# Choose one of the transports below
51			# MESSENGER_TRANSPORT_DSN=doctrine://default
52			# MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages
53			# MESSENGER_TRANSPORT_DSN=redis://localhost:6379/messages
54			###< symfony/messenger ###
55			###> symfony/mailer ###
56			# MAILER_DSN=null://null
57			###< symfony/mailer ###
58			###> shopware/core ###
59			APP_ENV=prod
60			APP_URL=http://127.0.0.1:8000
61			APP_SECRET=7628a40c75b25f8a1f14b3812c3b250b
62			INSTANCE_ID=41322ddd2b70bd29ef65d402f025c785
63			BLUE_GREEN_DEPLOYMENT=0
64			DATABASE_URL=mysql://root:root@localhost/shopware
65			# With Shopware 6.4.17.0 the MAILER_DSN variable will be used in this template instead of MAILER_URL
66			MAILER_URL=null://null
67			###< shopware/core ###
68			###> shopware/elasticsearch ###
69			OPENSEARCH_URL=http://localhost:9200
70			SHOPWARE_ES_ENABLED=0
71			SHOPWARE_ES_INDEXING_ENABLED=0
72			SHOPWARE_ES_INDEX_PREFIX=sw
73			SHOPWARE_ES_THROW_EXCEPTION=1
74			###< shopware/elasticsearch ###
75			###> shopware/storefront ###
76			STOREFRONT_PROXY_URL=http://localhost
77			SHOPWARE_HTTP_CACHE_ENABLED=1
78			SHOPWARE_HTTP_DEFAULT_TTL=7200
79			###< shopware/storefront ###
80			EOT;
81
82			/**
83			* Delete all files and directories that are not needed anymore
84			*/
85			public function cleanup(string $projectDir): void
86			{
87			$fs = new Filesystem();
88
89			foreach (self::REMOVE_FILES as $file) {
90			$path = $projectDir . '/' . $file;
91			if ($fs->exists($path)) {
92			$fs->remove($path);
93			}
94			}
95
96			foreach (self::REMOVE_DIRECTORIES as $directory) {
97			$path = $projectDir . '/' . $directory;
98
99			if ($fs->exists($path)) {
100			$fs->remove($path);
101			}
102			}
103
104			$fs->mkdir($projectDir . '/bin');
105			}
106
107			public function patchRootComposerJson(string $projectDir): void
108			{
109			$composerJsonPath = $projectDir . '/composer.json';
110
111			/** @var array{require: array<string, string>, config?: array{platform?: string, "allow-plugins": array<string, bool>}} $composerJson */
112			$composerJson = json_decode((string) file_get_contents($composerJsonPath), true, \JSON_THROW_ON_ERROR);
113
114			$composerJson['require']['symfony/flex'] = '^2';
115			$composerJson['require']['symfony/runtime'] = '^5.0\|^6.0';
116
117			// Remove old recovery
118			unset($composerJson['require']['shopware/recovery']);
119
120			if (!isset($composerJson['config'])) {
121			$composerJson['config'] = [];
122			}
123
124			if (!isset($composerJson['config']['allow-plugins'])) {
125			$composerJson['config']['allow-plugins'] = [];
126			}
127
128			$composerJson['config']['allow-plugins']['symfony/flex'] = true;
129			$composerJson['config']['allow-plugins']['symfony/runtime'] = true;
130
131			unset($composerJson['config']['platform']);
132
133			$composerJson['scripts'] = [
134			'auto-scripts' => [
135			'assets:install' => 'symfony-cmd',
136			],
137			'post-install-cmd' => [
138			'@auto-scripts',
139			],
140			'post-update-cmd' => [
141			'@auto-scripts',
142			],
143			];
144
145			$composerJson['extra']['symfony'] = [
146			'allow-contrib' => true,
147			'endpoint' => [
148			'https://raw.githubusercontent.com/shopware/recipes/flex/main/index.json',
149			'flex://defaults',
150			],
151			];
152
153			$composerJson['require-dev'] = [
154			'fakerphp/faker' => '^1.20',
155			'maltyxx/images-generator' => '^1.0',
156			'mbezhanov/faker-provider-collection' => '^2.0',
157			'symfony/stopwatch' => '^5.0\|^6.0',
158			'symfony/web-profiler-bundle' => '^5.0\|^6.0',
159			];
160
161			file_put_contents($composerJsonPath, json_encode($composerJson, \JSON_THROW_ON_ERROR \| \JSON_PRETTY_PRINT \| \JSON_UNESCAPED_SLASHES));
162			}
163
164			public function copyNewTemplateFiles(string $projectDir): void
165			{
166			$fs = new Filesystem();
167
168			$fs->mirror(__DIR__ . '/../Resources/flex-config/', $projectDir);
169			}
170
171			public function migrateEnvFile(string $projectDir): void
172			{
173			$envPath = $projectDir . '/.env';
174
175			if (!file_exists($envPath)) {
176			file_put_contents($envPath, self::ENV_DEFAULT);
177
178			return;
179			}
180
181			rename($envPath, $envPath . '.local');
182			file_put_contents($envPath, self::ENV_DEFAULT);
183			}
184			}
185

shopware / platform

Push — 6.5.0.0 ( 85bd4e...fe6596 )

FlexMigrator::patchRootComposerJson() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like