Merge pull request #60 from localheinz/feature/extra

Enhancement: Adjust ConfigHashNormalizer to also sort extra section
ergebnis · Apr 24, 2018 · 5dd2a43 · 5dd2a43
2 parents 90d6827 + 89fb7ed
commit 5dd2a43
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -92,8 +92,13 @@ the `BinNormalizer` will sort the elements of the `bin` section by value in asce
 
 ### `ConfigHashNormalizer`
 
-If `composer.json` contains any configuration in the `config` section, 
-the `ConfigHashNormalizer` will sort the `config` section by key in ascending order.
+If `composer.json` contains any configuration in the 
+
+* `config`
+* `extra` 
+
+sections, the `ConfigHashNormalizer` will sort the content of these sections 
+by key in ascending order.
 
 :bulb: Find out more about the `config` section at https://getcomposer.org/doc/06-config.md.  
 

diff --git a/src/Normalizer/ConfigHashNormalizer.php b/src/Normalizer/ConfigHashNormalizer.php
@@ -17,6 +17,14 @@
 
 final class ConfigHashNormalizer implements NormalizerInterface
 {
+    /**
+     * @var string[]
+     */
+    private static $properties = [
+        'config',
+        'extra',
+    ];
+
     public function normalize(string $json): string
     {
         $decoded = \json_decode($json);
@@ -28,19 +36,26 @@ public function normalize(string $json): string
             ));
         }
 
-        if (!\property_exists($decoded, 'config')) {
+        $objectProperties = \array_intersect_key(
+            \get_object_vars($decoded),
+            \array_flip(self::$properties)
+        );
+
+        if (!\count($objectProperties)) {
             return $json;
         }
 
-        $config = (array) $decoded->config;
+        foreach ($objectProperties as $name => $value) {
+            $config = (array) $decoded->{$name};
 
-        if (!\count($config)) {
-            return $json;
-        }
+            if (!\count($config)) {
+                return $json;
+            }
 
-        \ksort($config);
+            \ksort($config);
 
-        $decoded->config = $config;
+            $decoded->{$name} = $config;
+        }
 
         return \json_encode($decoded);
     }

diff --git a/test/Unit/Normalizer/ConfigHashNormalizerTest.php b/test/Unit/Normalizer/ConfigHashNormalizerTest.php
@@ -33,11 +33,16 @@ public function testNormalizeDoesNotModifyOtherProperty(): void
         $this->assertSame($json, $normalizer->normalize($json));
     }
 
-    public function testNormalizeIgnoresEmptyConfigHash(): void
+    /**
+     * @dataProvider providerProperty
+     *
+     * @param string $property
+     */
+    public function testNormalizeIgnoresEmptyConfigHash(string $property): void
     {
-        $json = <<<'JSON'
+        $json = <<<JSON
 {
-  "config": {}
+  "${property}": {}
 }
 JSON;
 
@@ -46,11 +51,16 @@ public function testNormalizeIgnoresEmptyConfigHash(): void
         $this->assertSame($json, $normalizer->normalize($json));
     }
 
-    public function testNormalizeSortsConfigHashIfPropertyExists(): void
+    /**
+     * @dataProvider providerProperty
+     *
+     * @param string $property
+     */
+    public function testNormalizeSortsConfigHashIfPropertyExists(string $property): void
     {
-        $json = <<<'JSON'
+        $json = <<<JSON
 {
-  "config": {
+  "${property}": {
     "sort-packages": true,
     "preferred-install": "dist"
   },
@@ -61,9 +71,9 @@ public function testNormalizeSortsConfigHashIfPropertyExists(): void
 }
 JSON;
 
-        $normalized = <<<'JSON'
+        $normalized = <<<JSON
 {
-  "config": {
+  "${property}": {
     "preferred-install": "dist",
     "sort-packages": true
   },
@@ -78,4 +88,21 @@ public function testNormalizeSortsConfigHashIfPropertyExists(): void
 
         $this->assertSame(\json_encode(\json_decode($normalized)), $normalizer->normalize($json));
     }
+
+    public function providerProperty(): \Generator
+    {
+        foreach ($this->properties() as $value) {
+            yield $value => [
+                $value,
+            ];
+        }
+    }
+
+    private function properties(): array
+    {
+        return [
+            'config',
+            'extra',
+        ];
+    }
 }