PackageHashNormalizerTest.php

<?php

declare(strict_types=1);

/**
 * Copyright (c) 2018-2022 Andreas Möller
 *
 * For the full copyright and license information, please view
 * the LICENSE.md file that was distributed with this source code.
 *
 * @see https://github.com/ergebnis/json-normalizer
 */

namespace Ergebnis\Json\Normalizer\Test\Unit\Vendor\Composer;

use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\Vendor;

/**
 * @internal
 *
 * @covers \Ergebnis\Json\Normalizer\Vendor\Composer\PackageHashNormalizer
 *
 * @uses \Ergebnis\Json\Normalizer\Json
 */
final class PackageHashNormalizerTest extends AbstractComposerTestCase
{
    public function testNormalizeDoesNotModifyOtherProperty(): void
    {
        $json = Json::fromEncoded(
            <<<'JSON'
{
  "foo": {
    "qux": "quux",
    "bar": "baz"
  }
}
JSON
        );

        $normalizer = new Vendor\Composer\PackageHashNormalizer();

        $normalized = $normalizer->normalize($json);

        self::assertJsonStringEqualsJsonStringNormalized($json->encoded(), $normalized->encoded());
    }

    /**
     * @dataProvider provideProperty
     */
    public function testNormalizeIgnoresEmptyPackageHash(string $property): void
    {
        $json = Json::fromEncoded(
            <<<JSON
{
  "{$property}": {}
}
JSON
        );

        $normalizer = new Vendor\Composer\PackageHashNormalizer();

        $normalized = $normalizer->normalize($json);

        self::assertJsonStringEqualsJsonStringNormalized($json->encoded(), $normalized->encoded());
    }

    /**
     * @dataProvider provideProperty
     */
    public function testNormalizeSortsPackageHashIfPropertyExists(string $property): void
    {
        $json = Json::fromEncoded(
            <<<JSON
{
  "{$property}": {
    "localheinz/test-util": "Provides utilities for tests.",
    "hhvm": "Okay",
    "lib-baz": "Maybe it helps.",
    "localheinz/php-cs-fixer-config": "Provides a configuration factory and multiple rule sets for friendsofphp/php-cs-fixer.",
    "acquia/drupal-environment-detector": "^1.2.0",
    "ext-foo": "Could be useful",
    "composer-plugin-api": "^2.0.0",
    "php": "Because why not, it's great."
  },
  "foo": {
    "qux": "quux",
    "bar": "baz"
  }
}
JSON
        );

        $expected = Json::fromEncoded(
            <<<JSON
{
  "{$property}": {
    "php": "Because why not, it's great.",
    "hhvm": "Okay",
    "ext-foo": "Could be useful",
    "lib-baz": "Maybe it helps.",
    "composer-plugin-api": "^2.0.0",
    "acquia/drupal-environment-detector": "^1.2.0",
    "localheinz/php-cs-fixer-config": "Provides a configuration factory and multiple rule sets for friendsofphp/php-cs-fixer.",
    "localheinz/test-util": "Provides utilities for tests."
  },
  "foo": {
    "qux": "quux",
    "bar": "baz"
  }
}
JSON
        );

        $normalizer = new Vendor\Composer\PackageHashNormalizer();

        $normalized = $normalizer->normalize($json);

        self::assertJsonStringEqualsJsonStringNormalized($expected->encoded(), $normalized->encoded());
    }

    /**
     * @return \Generator<array<string>>
     */
    public function provideProperty(): \Generator
    {
        foreach (self::propertiesWhereKeysOfHashArePackages() as $value) {
            yield $value => [
                $value,
            ];
        }
    }

    /**
     * @return array<int, string>
     */
    private static function propertiesWhereKeysOfHashArePackages(): array
    {
        return [
            'conflict',
            'provide',
            'replace',
            'require',
            'require-dev',
            'suggest',
        ];
    }
}