BC break on Item::value return type

Author: nyamsprod

CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 
 All Notable changes to `bakame/http-strucured-fields` will be documented in this file
+ 
+## [Next] - TBD
+
+### Added
+
+- None
+
+### Fixed
+
+- **[BC Break]** `Item::value` method returns the Item (returns value can be `float|int|string|bool|ByteSequence|Token`).
+
+### Deprecated
+
+- None
+
+### Removed
+
+- None
 
 ## [0.6.0] - 2022-11-12
 

docs/item.md

@@ -98,8 +98,8 @@ $item = StructuredFields\Item::fromPair([
 $item->value();    // returns "hello world"
 $item->isString(); // returns true
 $item->parameters()["a"]->isByteSequence(); // returns true
-$item->parameters()["a"]->value(); // returns the decoded value 'Hello World'
-echo $item->toHttpValue();       // returns "hello world";a=:SGVsbG8gV29ybGQ=:
+$item->parameters()["a"]->value(); // returns StructuredFields\ByteSequence::fromDecoded('Hello World');
+echo $item->toHttpValue();         // returns "hello world";a=:SGVsbG8gV29ybGQ=:
 ```
 
 `Item::fromPair` is an alternative to the `Item::from` named constructor, it expects
@@ -117,9 +117,9 @@ Once instantiated, accessing `Item` properties is done via:
 ```php
 use Bakame\Http\StructuredFields;
 
-$item = StructuredFields\Item::from(StructuredFields\ByteSequence::fromEncoded("SGVsbG8gV29ybGQ=")]);
+$item = StructuredFields\Item::from(StructuredFields\ByteSequence::fromEncoded("SGVsbG8gV29ybGQ="));
 $item->isByteSequence(); // returns true
-echo $item->value();     // returns the decoded value 'Hello World'
+echo $item->value();     // returns StructuredFields\ByteSequence::fromEncoded("SGVsbG8gV29ybGQ=");
 ```
 
 **Of note: to instantiate a decimal number type a float MUST be used as the first argument of `Item::from`.**

src/InnerListTest.php

@@ -130,7 +130,7 @@ public function it_successfully_parse_a_http_field(): void
         self::assertSame('hello)world', $instance->get(0)->value());
         self::assertSame(42, $instance->get(1)->value());
         self::assertSame(42.0, $instance->get(2)->value());
-        self::assertSame('doe', $instance->get(2)->parameters()['john']->value());
+        self::assertEquals(Token::fromString('doe'), $instance->get(2)->parameters()['john']->value());
     }
 
     /** @test */
@@ -194,7 +194,7 @@ public function it_can_access_the_item_value(): void
         $structuredField = InnerList::fromList($input);
 
         self::assertFalse($structuredField[2]->value());
-        self::assertSame('token', $structuredField[-1]->value());
+        self::assertEquals($token, $structuredField[-1]->value());
     }
 
     /** @test */

src/Item.php

@@ -290,13 +290,9 @@ private function serializeDecimal(float $value): string
     /**
      * Returns the underlying value decoded.
      */
-    public function value(): string|int|float|bool
+    public function value(): Token|ByteSequence|int|float|string|bool
     {
-        return match (true) {
-            $this->value instanceof Token => $this->value->value,
-            $this->value instanceof ByteSequence => $this->value->decoded(),
-            default => $this->value,
-        };
+        return $this->value;
     }
 
     public function withValue(Token|ByteSequence|int|float|string|bool $value): self

src/ItemTest.php

@@ -81,9 +81,11 @@ public function it_instantiates_a_token(): void
     /** @test */
     public function it_instantiates_a_binary(): void
     {
-        self::assertSame('foobar', Item::from(ByteSequence::fromDecoded('foobar'))->value());
-        self::assertSame('foobar', Item::fromDecodedByteSequence('foobar')->value());
-        self::assertSame('foobar', Item::fromEncodedByteSequence('Zm9vYmFy')->value());
+        $byteSequence = ByteSequence::fromDecoded('foobar');
+
+        self::assertEquals($byteSequence, Item::from(ByteSequence::fromDecoded('foobar'))->value());
+        self::assertEquals($byteSequence, Item::fromDecodedByteSequence('foobar')->value());
+        self::assertEquals($byteSequence, Item::fromEncodedByteSequence('Zm9vYmFy')->value());
     }
 
     /** @test */