Merge pull request #144 from anlutro/fix-get-default-array

fix behavior of Settings::get when $key is an array and defaults are set

Author: anlutro

src/ArrayUtil.php

@@ -61,7 +61,12 @@ protected static function getArray(array $input, $keys, $default = null)
 		$output = array();
 
 		foreach ($keys as $key) {
-			static::set($output, $key, static::get($input, $key, $default));
+			if ($default) {
+				$keyDefault = static::get($default, $key);
+			} else {
+				$keyDefault = null;
+			}
+			static::set($output, $key, static::get($input, $key, $keyDefault));
 		}
 
 		return $output;

src/SettingStore.php

@@ -114,8 +114,10 @@ public function setCache($cache, $ttl = null, $forgetOnWrite = null)
 	 */
 	public function get($key, $default = null)
 	{
-		if ($default === NULL && !is_array($key)) {
+		if ($default === NULL) {
 			$default = ArrayUtil::get($this->defaults, $key);
+		} elseif (is_array($key) && is_array($default)) {
+			$default = array_merge(ArrayUtil::get($this->defaults, $key, []), $default);
 		}
 
 		$this->load();

tests/functional/AbstractFunctionalTest.php

@@ -7,56 +7,68 @@
 
 abstract class AbstractFunctionalTest extends TestCase
 {
-	protected abstract function createStore(array $data = array());
+	protected $defaults;
+
+	protected abstract function createStore(array $data = null);
+
+	protected function getStore(array $data = null)
+	{
+		$store = $this->createStore($data);
+		if ($this->defaults) {
+			$store->setDefaults($this->defaults);
+		}
+		return $store;
+	}
 
 	public function tearDown(): void
 	{
 		m::close();
+		$this->defaults = [];
 	}
 
 	protected function assertStoreEquals($store, $expected, $message = '')
 	{
 		$this->assertEquals($expected, $store->all(), $message);
 		$store->save();
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$this->assertEquals($expected, $store->all(), $message);
 	}
 
 	protected function assertStoreKeyEquals($store, $key, $expected, $message = '')
 	{
 		$this->assertEquals($expected, $store->get($key), $message);
 		$store->save();
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$this->assertEquals($expected, $store->get($key), $message);
 	}
 
 	/** @test */
 	public function store_is_initially_empty()
 	{
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$this->assertEquals(array(), $store->all());
 	}
 
 	/** @test */
 	public function written_changes_are_saved()
 	{
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$store->set('foo', 'bar');
 		$this->assertStoreKeyEquals($store, 'foo', 'bar');
 	}
 
 	/** @test */
 	public function nested_keys_are_nested()
 	{
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$store->set('foo.bar', 'baz');
 		$this->assertStoreEquals($store, array('foo' => array('bar' => 'baz')));
 	}
 
 	/** @test */
 	public function cannot_set_nested_key_on_non_array_member()
 	{
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$store->set('foo', 'bar');
 		$this->expectException('UnexpectedValueException');
 		$this->expectExceptionMessage('Non-array segment encountered');
@@ -66,7 +78,7 @@ public function cannot_set_nested_key_on_non_array_member()
 	/** @test */
 	public function can_forget_key()
 	{
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$store->set('foo', 'bar');
 		$store->set('bar', 'baz');
 		$this->assertStoreEquals($store, array('foo' => 'bar', 'bar' => 'baz'));
@@ -78,7 +90,7 @@ public function can_forget_key()
 	/** @test */
 	public function can_forget_nested_key()
 	{
-		$store = $this->createStore();
+		$store = $this->getStore();
 		$store->set('foo.bar', 'baz');
 		$store->set('foo.baz', 'bar');
 		$store->set('bar.foo', 'baz');
@@ -119,9 +131,18 @@ public function can_forget_nested_key()
 	/** @test */
 	public function can_forget_all()
 	{
-		$store = $this->createStore(array('foo' => 'bar'));
+		$store = $this->getStore(array('foo' => 'bar'));
 		$this->assertStoreEquals($store, array('foo' => 'bar'));
 		$store->forgetAll();
 		$this->assertStoreEquals($store, array());
 	}
+
+	/** @test */
+	public function defaults_are_respected()
+	{
+		$this->defaults = ['foo' => 'default', 'bar' => 'default'];
+		$store = $this->getStore(array('foo' => 'bar'));
+		$this->assertStoreEquals($store, ['foo' => 'bar']);
+		$this->assertStoreKeyEquals($store, ['foo', 'bar'], ['foo' => 'bar', 'bar' => 'default']);
+	}
 }

tests/functional/DatabaseTest.php

@@ -29,7 +29,7 @@ public function tearDown(): void
 		parent::tearDown();
 	}
 
-	protected function createStore(array $data = array())
+	protected function createStore(array $data = null)
 	{
 		if ($data) {
 			$store = $this->createStore();

tests/unit/ArrayUtilTest.php

@@ -17,6 +17,7 @@ public function getReturnsCorrectValue(array $data, $key, $expected)
 	public function getGetData()
 	{
 		return array(
+			// $data, $key, $expected
 			array(array(), 'foo', null),
 			array(array('foo' => 'bar'), 'foo', 'bar'),
 			array(array('foo' => 'bar'), 'bar', null),
@@ -47,6 +48,26 @@ public function getGetData()
 		);
 	}
 
+	/**
+	 * @test
+	 * @dataProvider getGetWithDefaultsData
+	 */
+	public function getWithDefaultsReturnsCorrectValue(array $data, $key, $default, $expected)
+	{
+		$this->assertEquals($expected, ArrayUtil::get($data, $key, $default));
+	}
+
+	public function getGetWithDefaultsData()
+	{
+		return [
+			// $data, $key, $default, $expected
+			[[], 'foo', 'default', 'default'],
+			[['foo' => 'value'], 'foo', 'default', 'value'],
+			[[], ['foo'], ['foo' => 'default'], ['foo' => 'default']],
+			[['foo' => 'value'], ['foo'], ['foo' => 'default'], ['foo' => 'value']],
+		];
+	}
+
 	/**
 	 * @test
 	 * @dataProvider getSetData