Sorted arrays

CHANGELOG.md

@@ -6,7 +6,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- The configuration that is written is now sorted by its keys.
+  This new feature is enabled by default. Sorting can be disabled by 
+  calling `setSortingEnabled(false);` on the `ConfigResource` class.
 
 ### Changed
 

README.md

@@ -92,6 +92,9 @@ service serves the purpose of providing the necessary dependencies for `ConfigRe
 methods such as `patch()` and `replace()`.  The service returned by the service manager is bound to
 the file specified in the `config_file` key.
 
+The config that is written is sorted by its keys. To disable this, use`setSortingEnabled` and provide 
+`false` as a parameter.
+
 #### ZF\Configuration\ConfigResourceFactory
 
 `ZF\Configuration\ConfigResourceFactory` is a factory service that provides consumers with the

src/ConfigResource.php

@@ -32,6 +32,13 @@ class ConfigResource
      */
     protected $opcacheEnabled = false;
 
+    /**
+     * Whether or not sorting of the config is enabled.
+     *
+     * @var bool
+     */
+    protected $sortingEnabled = true;
+
     /**
      * @var ConfigWriter
      */
@@ -51,6 +58,16 @@ public function __construct(array $config, $fileName, ConfigWriter $writer)
         $this->writer   = $writer;
     }
 
+    /**
+     * Enables or disables the sorting of the config data.
+     *
+     * @param bool $enabled
+     */
+    public function setSortingEnabled($enabled)
+    {
+        $this->sortingEnabled = (bool)$enabled;
+    }
+
     /**
      * Allow patching one or more key/value pairs
      *
@@ -90,12 +107,7 @@ public function patch($data, $tree = false)
         }
         $localConfig = ArrayUtils::merge($localConfig, $patchValues);
 
-        // Write to configuration file
-        $this->writer->toFile($this->fileName, $localConfig);
-        $this->invalidateCache($this->fileName);
-
-        // Reseed configuration
-        $this->config = $localConfig;
+        $this->overWrite($localConfig);
 
         // Return written values
         return $data;
@@ -120,15 +132,7 @@ public function patchKey($key, $value)
         }
         $config = $this->replaceKey($key, $value, $config);
 
-        // Write to configuration file
-        $this->writer->toFile($this->fileName, $config);
-        $this->invalidateCache($this->fileName);
-
-        // Reseed configuration
-        $this->config = $config;
-
-        // Return written values
-        return $config;
+        return $this->overWrite($config);
     }
 
     /**
@@ -141,7 +145,12 @@ public function patchKey($key, $value)
      */
     public function overWrite(array $data)
     {
+        if ($this->sortingEnabled) {
+            $this->sortKeysRecursively($data);
+        }
+
         $this->writer->toFile($this->fileName, $data);
+
         $this->invalidateCache($this->fileName);
 
         // Reseed configuration
@@ -240,13 +249,8 @@ public function deleteKey($keys)
         }
 
         $this->deleteByKey($config, $keys);
-        $this->writer->toFile($this->fileName, $config);
-        $this->invalidateCache($this->fileName);
 
-        // Reseed configuration
-        $this->config = $config;
-
-        return $config;
+        return $this->overWrite($config);
     }
 
     /**
@@ -349,4 +353,21 @@ protected function invalidateCache($filename)
 
         opcache_invalidate($filename, true);
     }
+
+    /**
+     * Sorts the provided array recursively based on its keys.
+     *
+     * @param array $data The array of data to sort.
+     * @return void
+     */
+    protected function sortKeysRecursively(array &$data)
+    {
+        foreach ($data as &$value) {
+            if (is_array($value)) {
+                $this->sortKeysRecursively($value);
+            }
+        }
+
+        ksort($data);
+    }
 }

test/ConfigResourceTest.php

@@ -402,4 +402,80 @@ public function testDeleteNonexistentKeyShouldDoNothing()
         $test = include $this->file;
         $this->assertEquals($expected, $test);
     }
+
+    public function testDataIsSortedByKey()
+    {
+        // Arrange
+        $config = [
+            'z' => 1,
+            'a' => 2,
+        ];
+
+        $configResource = new ConfigResource($config, $this->file, new PhpArray());
+
+        // Act
+        $configResource->overWrite($config);
+
+        // Assert
+        $test = include $this->file;
+
+        self::assertEquals(2, current($test));
+        self::assertEquals(1, next($test));
+    }
+
+    public function testDataIsSortedRecursivelyByKey()
+    {
+        // Arrange
+        $config = [
+            'z' => [
+                'z' => 1,
+                'a' => 2,
+            ],
+            'a' => [
+                'z' => 1,
+                'a' => 2,
+            ],
+        ];
+
+        $configResource = new ConfigResource($config, $this->file, new PhpArray());
+
+        // Act
+        $configResource->overWrite($config);
+
+        // Assert
+        $test = include $this->file;
+
+        $firstKey = key($test);
+        $firstVal = current($test[$firstKey]);
+        self::assertEquals('a', $firstKey);
+        self::assertEquals('2', $firstVal);
+
+        next($test);
+
+        $secondKey = key($test);
+        $secondVal = current($test[$secondKey]);
+        self::assertEquals('z', $secondKey);
+        self::assertEquals('2', $secondVal);
+    }
+
+    public function testDataIsNotSortedByKeyWhenSortingIsDisabled()
+    {
+        // Arrange
+        $config = [
+            'z' => 1,
+            'a' => 2,
+        ];
+
+        $configResource = new ConfigResource($config, $this->file, new PhpArray());
+
+        // Act
+        $configResource->setSortingEnabled(false);
+        $configResource->overWrite($config);
+
+        // Assert
+        $test = include $this->file;
+
+        self::assertEquals(1, current($test));
+        self::assertEquals(2, next($test));
+    }
 }