Type: mergeDefaults() are disabled by default (BC break) [Closes #28, Closes #31]

Author: dg

readme.md

@@ -176,7 +176,7 @@ The parameter can also be a schema, so we can write:
 Expect::arrayOf(Expect::bool())
 ```
 
-The default value is an empty array. If you specify a default value, it will be merged with the passed data. This can be disabled using `mergeDefaults(false)`.
+The default value is an empty array. If you specify a default value and call `mergeDefaults()`, it will be merged with the passed data.
 
 
 Enumeration: anyOf()

src/Schema/Elements/Type.php

@@ -25,7 +25,7 @@ final class Type implements Schema
 	/** @var array{?float, ?float} */
 	private array $range = [null, null];
 	private ?string $pattern = null;
-	private bool $merge = true;
+	private bool $merge = false;
 
 
 	public function __construct(string $type)
@@ -46,11 +46,12 @@ public function nullable(): self
 	}
 
 
-	/**
-	 * Controls whether the default value is merged with the input array (enabled by default).
-	 */
+	/** @deprecated mergeDefaults is disabled by default */
 	public function mergeDefaults(bool $state = true): self
 	{
+		if ($state === true) {
+			trigger_error(__METHOD__ . '() is deprecated and will be removed in the next major version.', E_USER_DEPRECATED);
+		}
 		$this->merge = $state;
 		return $this;
 	}

tests/Schema/Expect.array.phpt

@@ -34,13 +34,13 @@ test('without default value', function () {
 });
 
 
-test('not merging', function () {
+test('not merging default value', function () {
 	$schema = Expect::array([
 		'key1' => 'val1',
 		'key2' => 'val2',
 		'val3',
 		'arr' => ['item'],
-	])->mergeDefaults(false);
+	]);
 
 	Assert::same([], (new Processor)->process($schema, []));
 
@@ -51,13 +51,13 @@ test('not merging', function () {
 });
 
 
-test('merging', function () {
-	$schema = Expect::array([
+test('merging default value', function () {
+	$schema = @Expect::array([ // mergeDefaults() is deprecated
 		'key1' => 'val1',
 		'key2' => 'val2',
 		'val3',
 		'arr' => ['item'],
-	]);
+	])->mergeDefaults(true);
 
 	Assert::same([
 		'key1' => 'val1',
@@ -129,12 +129,12 @@ test('merging', function () {
 });
 
 
-test('merging & other items validation', function () {
-	$schema = Expect::array([
+test('merging default value & other items validation', function () {
+	$schema = @Expect::array([ // mergeDefaults() is deprecated
 		'key1' => 'val1',
 		'key2' => 'val2',
 		'val3',
-	])->items('string');
+	])->mergeDefaults(true)->items('string');
 
 	Assert::same([
 		'key1' => 'val1',
@@ -167,7 +167,7 @@ test('merging & other items validation', function () {
 });
 
 
-test('merging & other items validation', function () {
+test('merging default value & other items validation', function () {
 	$schema = Expect::array()->items('string');
 
 	Assert::same([
@@ -202,11 +202,9 @@ test('merging & other items validation', function () {
 
 
 test('items() & scalar', function () {
-	$schema = Expect::array([
-		'a' => 'defval',
-	])->items('string');
+	$schema = Expect::array()->items('string');
 
-	Assert::same(['a' => 'defval'], (new Processor)->process($schema, []));
+	Assert::same([], (new Processor)->process($schema, []));
 
 	checkValidationErrors(function () use ($schema) {
 		(new Processor)->process($schema, [1, 2, 3]);
@@ -230,16 +228,14 @@ test('items() & scalar', function () {
 		(new Processor)->process($schema, ['b' => null]);
 	}, ["The item 'b' expects to be string, null given."]);
 
-	Assert::same(['a' => 'defval', 'b' => 'val'], (new Processor)->process($schema, ['b' => 'val']));
+	Assert::same(['b' => 'val'], (new Processor)->process($schema, ['b' => 'val']));
 });
 
 
 test('items() & structure', function () {
-	$schema = Expect::array([
-		'a' => 'defval',
-	])->items(Expect::structure(['k' => Expect::string()]));
+	$schema = Expect::array([])->items(Expect::structure(['k' => Expect::string()]));
 
-	Assert::same(['a' => 'defval'], (new Processor)->process($schema, []));
+	Assert::same([], (new Processor)->process($schema, []));
 
 	checkValidationErrors(function () use ($schema) {
 		(new Processor)->process($schema, ['a' => 'val']);
@@ -262,7 +258,7 @@ test('items() & structure', function () {
 	}, ["Unexpected item 'b\u{a0}›\u{a0}a', did you mean 'k'?"]);
 
 	Assert::equal(
-		['a' => 'defval', 'b' => (object) ['k' => 'val']],
+		['b' => (object) ['k' => 'val']],
 		(new Processor)->process($schema, ['b' => ['k' => 'val']]),
 	);
 });

tests/Schema/Expect.list.phpt

@@ -35,8 +35,8 @@ test('without default value', function () {
 });
 
 
-test('not merging', function () {
-	$schema = Expect::list([1, 2, 3])->mergeDefaults(false);
+test('not merging default value', function () {
+	$schema = Expect::list([1, 2, 3]);
 
 	Assert::same([], (new Processor)->process($schema, []));
 
@@ -46,8 +46,8 @@ test('not merging', function () {
 });
 
 
-test('merging', function () {
-	$schema = Expect::list([1, 2, 3]);
+test('merging default value', function () {
+	$schema = @Expect::list([1, 2, 3])->mergeDefaults(true); // mergeDefaults() is deprecated
 
 	Assert::same([1, 2, 3], (new Processor)->process($schema, []));
 
@@ -57,8 +57,8 @@ test('merging', function () {
 });
 
 
-test('merging & other items validation', function () {
-	$schema = Expect::list([1, 2, 3])->items('string');
+test('merging default value & other items validation', function () {
+	$schema = @Expect::list([1, 2, 3])->mergeDefaults(true)->items('string'); // mergeDefaults() is deprecated
 
 	Assert::same([1, 2, 3], (new Processor)->process($schema, []));