humbug / php-scoper

src/Scoper/Composer/InstalledPackagesScoper.php

<?php

declare(strict_types=1);

/*
 * This file is part of the humbug/php-scoper package.
 *
 * Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
 *                    Pádraic Brady <padraic.brady@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Humbug\PhpScoper\Scoper\Composer;

use Humbug\PhpScoper\Scoper\Scoper;
use InvalidArgumentException;
use stdClass;
use function array_map;
use function gettype;
use function is_array;
use function preg_match as native_preg_match;
use function Safe\json_decode;
use function Safe\json_encode;
use function Safe\sprintf;
use const JSON_PRETTY_PRINT;
use const JSON_THROW_ON_ERROR;

final class InstalledPackagesScoper implements Scoper
{
    private const COMPOSER_INSTALLED_FILE_PATTERN = '/composer(\/|\\\\)installed\.json$/';

    private Scoper $decoratedScoper;
    private AutoloadPrefixer $autoloadPrefixer;

    public function __construct(
        Scoper $decoratedScoper,
        AutoloadPrefixer $autoloadPrefixer
    ) {
        $this->decoratedScoper = $decoratedScoper;
        $this->autoloadPrefixer = $autoloadPrefixer;
    }

    /**
     * Scopes PHP and JSON files related to Composer.
     */
    public function scope(string $filePath, string $contents): string
    {
        if (1 !== native_preg_match(self::COMPOSER_INSTALLED_FILE_PATTERN, $filePath)) {
            return $this->decoratedScoper->scope($filePath, $contents);
        }

        $decodedJson = self::decodeContents($contents);

        if (!isset($decodedJson->packages) || !is_array($decodedJson->packages)) {
            throw new InvalidArgumentException('Expected the decoded JSON to contain the list of installed packages');
        }

        $decodedJson->packages = $this->prefixLockPackages($decodedJson->packages);

        return json_encode(
            $decodedJson,
            JSON_PRETTY_PRINT,
        );
    }

    private static function decodeContents(string $contents): stdClass
    {
        $decodedJson = json_decode($contents, false, 512, JSON_THROW_ON_ERROR);

        if ($decodedJson instanceof stdClass) {
            return $decodedJson;
        }

        throw new InvalidArgumentException(
            sprintf(

The function Safe\sprintf() has been deprecated: The Safe version of this function is no longer needed in PHP 8.0+

                'Expected the decoded JSON to be an stdClass instance, got "%s" instead',
                gettype($decodedJson),
            ),
        );
    }

    /**
     * @param array<string, stdClass> $packages
     *
     * @return array<string, stdClass>
     */
    private function prefixLockPackages(array $packages): array
    {
        return array_map(
            fn (stdClass $package) => $this->autoloadPrefixer->prefixPackageAutoloadStatements($package),
            $packages,
        );
    }
}