Usage of merge method made consistent

Author: nyamsprod

CHANGELOG.md

@@ -12,7 +12,6 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - `OrderedList::from` named constructor which accepts a variadic list of members items
 - `Token::fromString` named constructor which accepts `string` and `Stringable` object
 - `Parameter::values` returns an array of all the values contained inside the `Parameters` instance
-- `Parameter::merge` accepts any iterable that can be accepted by `Parameter::fromAssociative` as variadic parameter
 - **[BC Break]** `InnerList::fromList` to replace `InnerList::fromMembers`
 - **[BC Break]** `OrderedList::fromList` to replace `OrderedList::fromMembers`
 - **[BC Break]** `Parameter::value` to replace `InnerList::parameter` and `Item::parameter`
@@ -21,6 +20,8 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 
 - `ByteSequence::fromDecoded` named constructor also accepts a `Stringable` object
 - `ByteSequence::fromEncoded` named constructor also accepts a `Stringable` object
+- `Dictionary::merge` accepts any iterable that can be accepted by `Dictionary::fromAssociative` as variadic parameter
+- `Parameter::merge` accepts any iterable that can be accepted by `Parameter::fromAssociative` as variadic parameter
 - **[BC Break]** `OrderedList::__construct` is made private use `OrderedList::from` instead
 - **[BC Break]** `InnerList::__construct` is made private use `InnerList::fromList` instead
 - **[BC Break]** `Token::__construct` is made private use `Token::fromString` instead
@@ -39,6 +40,8 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - **[BC Break]** `Item::value()` replaced by `Item::value` public readonly property
 - **[BC Break]** `Item::parameters()` replaced by `Item::parameters` public readonly property
 - **[BC Break]** `InnerList::parameters()` replaced by `InnerList::parameters` public readonly property
+- **[BC Break]** `InnerList::merge()` use `InnerList::push()` or `InnerList::unshift()` instead
+- **[BC Break]** `OrderedList::merge()` use `OrderedList::push()` or `OrderedList::unshift()` instead
 
 ## [0.1.0] - 2022-03-18
 

README.md

@@ -26,7 +26,7 @@ use Bakame\Http\StructuredFields\Item;
 $field = Item::from("/terms", ['rel' => "copyright", 'anchor' => '#foo']);
 echo $field->toHttpValue();           //display "/terms";rel="copyright";anchor="#foo"
 echo $field->value;                   //display "/terms"
-echo $field->parameter->value('rel'); //display "copyright"
+echo $field->parameters->value('rel'); //display "copyright"
 ```
 
 System Requirements
@@ -160,7 +160,6 @@ At any given time it is possible with each of these objects to:
 - iterate over each contained member and its optional associated key via the `IteratorAggregate` interface;
 - tell whether the container is empty via an `isEmpty` method;
 - know the number of members contained in the container via the `Countable` interface;
-- merge multiple instance of **the same type** using the `merge` method;
 - clear the container using the `clear` method;
 
 ```php
@@ -189,6 +188,7 @@ key to its members as such they expose the following methods:
 - `prepend` always add an element at the beginning of the container, if already present the previous value is removed;
 - `delete` to remove elements based on their associated keys;
 - `keys` to list all existing keys for the ordered maps as an array list;
+- `merge` merge multiple instances of iterable structure as associative constructs;
 
 ```php
 use Bakame\Http\StructuredFields\Dictionary;

phpstan.neon

@@ -9,4 +9,6 @@ parameters:
     ignoreErrors:
         - message: '#Method Bakame\\Http\\StructuredFields\\Parameters::merge\(\) has parameter \$others with no value type specified in iterable type iterable.#'
           path: src/Parameters.php
+        - message: '#Method Bakame\\Http\\StructuredFields\\Dictionary::merge\(\) has parameter \$others with no value type specified in iterable type iterable.#'
+          path: src/Dictionary.php
     reportUnmatchedIgnoredErrors: true

src/Dictionary.php

@@ -253,11 +253,13 @@ public function prepend(string $key, InnerList|Item|ByteSequence|Token|bool|int|
 
     /**
      * Merge multiple instances.
+     *
+     * iterable<array-key, InnerList|Item|Token|ByteSequence|float|int|bool|string> ...$others
      */
-    public function merge(self ...$others): void
+    public function merge(iterable ...$others): void
     {
         foreach ($others as $other) {
-            $this->members = [...$this->members, ...$other->members];
+            $this->members = [...$this->members, ...self::fromAssociative($other)->members];
         }
     }
 }

src/InnerList.php

@@ -184,15 +184,4 @@ public function clear(): void
     {
         $this->members = [];
     }
-
-    /**
-     * Merge multiple instances.
-     */
-    public function merge(self ...$others): void
-    {
-        foreach ($others as $other) {
-            $this->members = [...$this->members, ...$other->members];
-            $this->parameters->merge($other->parameters);
-        }
-    }
 }

src/InnerListTest.php

@@ -114,48 +114,6 @@ public function it_fails_to_return_an_member_with_invalid_index(): void
         $instance->get(3);
     }
 
-    /**
-     * @test
-     */
-    public function it_can_merge_one_or_more_instances(): void
-    {
-        $instance1 = InnerList::fromList([false], ['foo' => 'bar']);
-        $instance2 = InnerList::from(true);
-        $instance3 = InnerList::fromList([42], ['foo' => 'baz']);
-        $expected = InnerList::fromList([false, true, 42], ['foo' => 'baz']);
-
-        $instance1->merge($instance2, $instance3);
-
-        self::assertCount(3, $instance1);
-        self::assertSame($expected->toHttpValue(), $instance1->toHttpValue());
-    }
-
-    /**
-     * @test
-     */
-    public function it_can_merge_without_argument_and_not_throw(): void
-    {
-        $instance = InnerList::from(false);
-        $instance->merge();
-        self::assertCount(1, $instance);
-    }
-
-    /**
-     * @test
-     */
-    public function it_can_merge_two_or_more_instances_to_yield_different_result(): void
-    {
-        $instance1 = InnerList::fromList([false], ['foo' => 'bar']);
-        $instance2 = InnerList::from(true);
-        $instance3 = InnerList::fromList([42], ['foo' => 'baz']);
-        $expected = InnerList::fromList([42, true, false], ['foo' => 'bar']);
-
-        $instance3->merge($instance2, $instance1);
-
-        self::assertCount(3, $instance3);
-        self::assertSame($expected->toHttpValue(), $instance3->toHttpValue());
-    }
-
     /**
      * @test
      */
@@ -189,19 +147,4 @@ public function it_fails_to_access_unknown_parameter_values(): void
         $instance = InnerList::fromList([false], ['foo' => 'bar']);
         $instance->parameters->value('bar');
     }
-
-    /**
-     * @test
-     */
-    public function it_can_exchange_parameters(): void
-    {
-        $instance = InnerList::from(false, true, 42, 'forty-two');
-
-        self::assertCount(0, $instance->parameters);
-        $instance->parameters->clear();
-        $instance->parameters->merge(['foo' => 'bar']);
-
-        self::assertCount(1, $instance->parameters);
-        self::assertSame('bar', $instance->parameters->value('foo'));
-    }
 }

src/OrderedList.php

@@ -195,14 +195,4 @@ public function clear(): void
     {
         $this->members = [];
     }
-
-    /**
-     * Merge multiple instances.
-     */
-    public function merge(self ...$others): void
-    {
-        foreach ($others as $other) {
-            $this->members = [...$this->members, ...$other->members];
-        }
-    }
 }

src/OrderedListTest.php

@@ -115,48 +115,6 @@ public function it_fails_to_return_an_member_with_invalid_index(): void
         $instance->get(3);
     }
 
-    /**
-     * @test
-     */
-    public function it_can_merge_one_or_more_instances(): void
-    {
-        $instance1 = OrderedList::fromList([Item::from(false)]);
-        $instance2 = OrderedList::fromList([Item::from(true)]);
-        $instance3 = OrderedList::fromList([Item::from(42)]);
-        $expected = OrderedList::fromList([Item::from(false), Item::from(true), Item::from(42)]);
-
-        $instance1->merge($instance2, $instance3);
-
-        self::assertCount(3, $instance1);
-        self::assertSame($expected->toHttpValue(), $instance1->toHttpValue());
-    }
-
-    /**
-     * @test
-     */
-    public function it_can_merge_two_or_more_instances_to_yield_different_result(): void
-    {
-        $instance1 = OrderedList::fromList([Item::from(false)]);
-        $instance2 = OrderedList::fromList([Item::from(true)]);
-        $instance3 = OrderedList::fromList([Item::from(42)]);
-        $expected = OrderedList::fromList([Item::from(42), Item::from(true), Item::from(false)]);
-
-        $instance3->merge($instance2, $instance1);
-
-        self::assertCount(3, $instance3);
-        self::assertSame($expected->toHttpValue(), $instance3->toHttpValue());
-    }
-
-    /**
-     * @test
-     */
-    public function it_can_merge_without_argument_and_not_throw(): void
-    {
-        $instance = OrderedList::fromList([Item::from(false)]);
-        $instance->merge();
-        self::assertCount(1, $instance);
-    }
-
     /**
      * @test
      */