StructuredField extends Stringable interface

Author: nyamsprod

CHANGELOG.md

@@ -17,6 +17,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - `Value` Interface is introduced with `Item` being the only available implementation.
 - `MemberOrderedMap::add` and `MemberOrderedMap::remove` methods
 - `ByteSequence::equals` and `Token::equals` to easily compare type instances.
+- `StructuredField` extends the `Stringable` interface
 
 ### Fixed
 

docs/basic-usage.md

@@ -20,11 +20,14 @@ use Bakame\Http\StructuredFields\OrderedList;
 
 $dictionary = Dictionary::fromHttpValue("a=?0,   b,   c=?1; foo=bar");
 echo $dictionary->toHttpValue(); // 'a=?0, b, c;foo=bar'
+echo $dictionary; // 'a=?0, b, c;foo=bar'
 
 $list = OrderedList::fromHttpValue('("foo"; a=1;b=2);lvl=5, ("bar" "baz");lvl=1');
 echo $list->toHttpValue(); // '("foo";a=1;b=2);lvl=5, ("bar" "baz");lvl=1'
+echo $list; // '("foo";a=1;b=2);lvl=5, ("bar" "baz");lvl=1'
 
 $item = Item::fromHttpValue('"foo";a=1;b=2');
 echo $item->toHttpValue(); // "foo";a=1;b=2
+echo $item; // "foo";a=1;b=2
 ```
 

src/ByteSequenceTest.php

@@ -50,4 +50,17 @@ public function it_can_encode_raw_field(): void
         self::assertSame('pretend this is binary content.', $item->decoded());
         self::assertSame($source, $item->encoded());
     }
+
+    /** @test */
+    public function it_can_compare_instances(): void
+    {
+        $decoded = 'pretend this is binary content.';
+        $source = 'cHJldGVuZCB0aGlzIGlzIGJpbmFyeSBjb250ZW50Lg==';
+        $value1 = ByteSequence::fromDecoded($decoded);
+        $value2 = ByteSequence::fromEncoded($source);
+        $value3 = ByteSequence::fromDecoded($source);
+
+        self::assertTrue($value1->equals($value2));
+        self::assertFalse($value1->equals($value3));
+    }
 }

src/Dictionary.php

@@ -117,6 +117,11 @@ public function toHttpValue(): string
         return implode(', ', array_map($formatter, $this->members, array_keys($this->members)));
     }
 
+    public function __toString(): string
+    {
+        return $this->toHttpValue();
+    }
+
     public function count(): int
     {
         return count($this->members);

src/DictionaryTest.php

@@ -122,7 +122,7 @@ public function it_can_prepend_a_new_member(): void
             ->append('a', Item::from(false))
             ->prepend('b', Item::from(true));
 
-        self::assertSame('b, a=?0', $instance->toHttpValue());
+        self::assertSame('b, a=?0', (string) $instance);
     }
 
     /** @test */

src/InnerList.php

@@ -100,6 +100,11 @@ public function toHttpValue(): string
         return '('.implode(' ', array_map(fn (Value $value): string => $value->toHttpValue(), $this->members)).')'.$this->parameters->toHttpValue();
     }
 
+    public function __toString(): string
+    {
+        return $this->toHttpValue();
+    }
+
     public function count(): int
     {
         return count($this->members);

src/InnerListTest.php

@@ -72,6 +72,7 @@ public function it_can_unshift_insert_and_replace(): void
         self::assertCount(3, $container);
         self::assertTrue($container->hasMembers());
         self::assertSame('(:SGVsbG8gV29ybGQ=: 42.0 42)', $container->toHttpValue());
+        self::assertSame('(:SGVsbG8gV29ybGQ=: 42.0 42)', (string) $container);
     }
 
     /** @test */

src/Item.php

@@ -256,6 +256,11 @@ public function toHttpValue(): string
         }.$this->parameters->toHttpValue();
     }
 
+    public function __toString(): string
+    {
+        return $this->toHttpValue();
+    }
+
     /**
      * Serialize the Item decimal value according to RFC8941.
      *

src/ItemTest.php

@@ -46,6 +46,7 @@ public function it_fails_to_instantiate_a_decimal_too_small(): void
     public function it_instantiate_a_decimal(): void
     {
         self::assertSame('42.0', Item::from(42.0)->toHttpValue());
+        self::assertSame('42.0', (string) Item::from(42.0));
     }
 
     /** @test */

src/OrderedList.php

@@ -78,6 +78,11 @@ public function toHttpValue(): string
         return implode(', ', array_map(fn (StructuredField $member): string => $member->toHttpValue(), $this->members));
     }
 
+    public function __toString(): string
+    {
+        return $this->toHttpValue();
+    }
+
     public function count(): int
     {
         return count($this->members);