Remove MemberContainer::values method

Author: nyamsprod

CHANGELOG.md

@@ -16,8 +16,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 
 ### Fixed
 
-- **[BC Break]** `Parameters::values` decode `ByteSequence` and `Token` classes.
-- **[BC Break]** `Parameters::values` no longer throw on invalid state; value is skipped from returned array.
+- None.
 
 ### Deprecated
 
@@ -34,6 +33,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - **[BC Break]** `::sanitize` method is removed use `Parameters::clear` method instead if needed.
 - **[BC Break]** `isEmpty` method is removed use `hasMembers` method instead.
 - **[BC Break]** `Parameters::value` use `Item::value` method instead.
+- **[BC Break]** `Parameters::values` use `Parameters::getIterator` instead.
 
 ## [0.5.0] - 2022-05-13
 

docs/containers.md

@@ -29,7 +29,6 @@ At any given time it is possible with each of these objects to:
 - access container members via the `ArrayAccess` interface;
 - tell whether the container contains or not members with the `hasMembers` methods from the `Container` interface;
 - clear its content using the `clear` method from the `Container` interface;
-- unwrap Item value using the `values`, `value` methods from the `Container` interface;
 
 getter methods:
 

docs/ordered-maps.md

@@ -65,7 +65,6 @@ use Bakame\Http\StructuredFields;
 
 $parameters = StructuredFields\Parameters::fromAssociative(['b' => true, 'foo' => 'bar']);
 $parameters->keys();       // returns ['b', 'foo']
-$parameters->values();     // returns [true, 'bar']
 $parameters->get('b');     // returns Item::from(true)
 $parameters['b'];          // returns Item::from(true)
 $parameters['b']->value(); // returns true

src/Dictionary.php

@@ -5,7 +5,6 @@
 namespace Bakame\Http\StructuredFields;
 
 use Iterator;
-use Throwable;
 use function array_key_exists;
 use function array_keys;
 use function array_map;
@@ -139,44 +138,6 @@ public function has(string|int $offset): bool
         return is_string($offset) && array_key_exists($offset, $this->members);
     }
 
-    /**
-     * Returns all containers Item values.
-     *
-     * @return array<string, array<int, float|int|bool|string>|float|int|bool|string>
-     */
-    public function values(): array
-    {
-        $result = [];
-        foreach ($this->members as $offset => $item) {
-            $value = $this->value($offset);
-            if (null !== $value) {
-                $result[$offset] = $value;
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Returns the Item value of a specific key if it exists and is valid otherwise returns null.
-     *
-     * @return array<int, float|int|bool|string>|float|int|bool|string|null
-     */
-    private function value(string|int $offset): array|float|int|bool|string|null
-    {
-        try {
-            $member = $this->get($offset);
-        } catch (Throwable) {
-            return null;
-        }
-
-        if ($member instanceof Item) {
-            return $member->value();
-        }
-
-        return $member->values();
-    }
-
     /**
      * Returns the item or the inner-list is attached to the given key otherwise throw.
      *

src/DictionaryTest.php

@@ -273,20 +273,14 @@ public function it_can_access_the_item_value(): void
             ['token', $token],
         ]);
 
-        self::assertSame([
-            'foobar' => 'foobar',
-            'zero' => 0,
-            'false' => false,
-            'token' => 'token',
-        ], $structuredField->values());
-
         self::assertInstanceOf(Item::class, $structuredField->get('false'));
         self::assertFalse($structuredField->get('false')->value());
     }
 
     /** @test */
     public function it_will_strip_invalid_state_object_via_values_methods(): void
     {
+        $this->expectException(StructuredFieldError::class);
         $bar = Item::from(Token::fromString('bar'));
         $bar->parameters->set('baz', 42);
         $innerList = InnerList::from('foobar');
@@ -296,9 +290,6 @@ public function it_will_strip_invalid_state_object_via_values_methods(): void
             ->set('c', $innerList);
 
         $structuredField->get('a')->parameters['baz']->parameters->set('error', 'error');
-
-        self::assertArrayNotHasKey('a', $structuredField->values());
-        self::assertEquals(['b' => false, 'c' => [0 => 'foobar']], $structuredField->values());
-        self::assertSame([0 => 'foobar'], $structuredField->values()['c']);
+        $structuredField->toHttpValue();
     }
 }

src/InnerList.php

@@ -5,7 +5,6 @@
 namespace Bakame\Http\StructuredFields;
 
 use Iterator;
-use Throwable;
 use function array_filter;
 use function array_map;
 use function array_splice;
@@ -114,24 +113,6 @@ private function filterIndex(int $index): int|null
         };
     }
 
-    /**
-     * Returns all containers Item values.
-     *
-     * @return array<int, float|int|bool|string>
-     */
-    public function values(): array
-    {
-        $result = [];
-        foreach ($this->members as $offset => $item) {
-            try {
-                $result[$offset] = $this->get($offset)->value();
-            } catch (Throwable) {
-            }
-        }
-
-        return $result;
-    }
-
     public function get(string|int $offset): Item
     {
         if (!is_int($offset)) {

src/InnerListTest.php

@@ -208,20 +208,19 @@ public function it_can_access_the_item_value(): void
         $input = ['foobar', 0, false, $token];
         $structuredField = InnerList::fromList($input);
 
-        self::assertSame(['foobar', 0, false, 'token'], $structuredField->values());
-
         self::assertFalse($structuredField[2]->value());
         self::assertSame('token', $structuredField[-1]->value());
     }
 
     /** @test */
     public function it_will_strip_invalid_state_object_via_values_methods(): void
     {
+        $this->expectException(ForbiddenStateError::class);
         $bar = Item::from(Token::fromString('bar'));
         $bar->parameters->set('baz', 42);
         $structuredField = InnerList::from(false, $bar);
         $structuredField[1]->parameters['baz']->parameters->set('error', 'error');
 
-        self::assertEquals([false], $structuredField->values());
+        $structuredField->toHttpValue();
     }
 }

src/MemberContainer.php

@@ -61,9 +61,4 @@ public function offsetSet(mixed $offset, mixed $value): void;
      * @param TKey $offset
      */
     public function offsetUnset(mixed $offset): void;
-
-    /**
-     * @return array<TKey, array<array-key, string|int|float|bool>|string|int|float|bool>
-     */
-    public function values(): array;
 }

src/OrderedList.php

@@ -5,7 +5,6 @@
 namespace Bakame\Http\StructuredFields;
 
 use Iterator;
-use Throwable;
 use function array_filter;
 use function array_map;
 use function array_splice;
@@ -132,44 +131,6 @@ private function filterIndex(int|string $index): int|null
         };
     }
 
-    /**
-     * Returns all containers Item values.
-     *
-     * @return array<int, array<int, float|int|bool|string>|float|int|bool|string>
-     */
-    public function values(): array
-    {
-        $result = [];
-        foreach ($this->members as $offset => $item) {
-            $value = $this->value($offset);
-            if (null !== $value) {
-                $result[$offset] = $value;
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Returns the Item value of a specific key if it exists and is valid otherwise returns null.
-     *
-     * @return array<int, float|int|bool|string>|float|int|bool|string|null
-     */
-    private function value(string|int $offset): array|float|int|bool|string|null
-    {
-        try {
-            $member = $this->get($offset);
-        } catch (Throwable) {
-            return null;
-        }
-
-        if ($member instanceof Item) {
-            return $member->value();
-        }
-
-        return $member->values();
-    }
-
     public function get(string|int $offset): Item|InnerList
     {
         if (!is_int($offset)) {

src/OrderedListTest.php

@@ -188,22 +188,21 @@ public function it_can_access_the_item_value(): void
         $input = ['foobar', 0, false, $token, $innerList];
         $structuredField = OrderedList::fromList($input);
 
-        self::assertSame(['foobar', 0, false, 'token', [0 => 'test']], $structuredField->values());
         self::assertInstanceOf(Item::class, $structuredField[2]);
         self::assertFalse($structuredField[2]->value());
 
         self::assertInstanceOf(InnerList::class, $structuredField[-1]);
-        self::assertSame([0 => 'test'], $structuredField[-1]->values());
     }
 
     /** @test */
     public function it_will_strip_invalid_state_object_via_values_methods(): void
     {
+        $this->expectException(ForbiddenStateError::class);
         $bar = Item::from(Token::fromString('bar'));
         $bar->parameters->set('baz', 42);
         $structuredField = OrderedList::from(false, $bar);
         $structuredField[1]->parameters['baz']->parameters->set('error', 'error');
 
-        self::assertEquals([false], $structuredField->values());
+        $structuredField->toHttpValue();
     }
 }