Fix encoder documentation

Author: nyamsprod

BaseUri.php

@@ -527,6 +527,8 @@ final protected static function formatPathWithEmptyBaseQuery(string $path): stri
      * Normalizes a URI for comparison; this URI string representation is not suitable for usage as per RFC guidelines.
      *
      * @deprecated since version 7.6.0
+     *
+     * @codeCoverageIgnore
      */
     #[Deprecated(message:'no longer used by the isSameDocument method', since:'league/uri-interfaces:7.6.0')]
     final protected function normalize(Psr7UriInterface|UriInterface $uri): string
@@ -544,6 +546,8 @@ final protected function normalize(Psr7UriInterface|UriInterface $uri): string
      * Remove dot segments from the URI path as per RFC specification.
      *
      * @deprecated since version 7.6.0
+     *
+     * @codeCoverageIgnore
      */
     #[Deprecated(message:'no longer used by the isSameDocument method', since:'league/uri-interfaces:7.6.0')]
     final protected function removeDotSegments(string $path): string
@@ -588,6 +592,8 @@ final protected function removeDotSegments(string $path): string
      * @return array{0:string, 1:string|null}
      *
      * @deprecated since version 7.6.0
+     *
+     * @codeCoverageIgnore
      */
     #[Deprecated(message:'no longer used by the isSameDocument method', since:'league/uri-interfaces:7.6.0')]
     final protected function resolvePathAndQuery(Psr7UriInterface|UriInterface $uri): array

UriTemplate.php

@@ -103,7 +103,7 @@ public function getDefaultVariables(): array
     public function withDefaultVariables(iterable $defaultVariables): self
     {
         $defaultVariables = $this->filterVariables($defaultVariables);
-        if ($defaultVariables == $this->defaultVariables) {
+        if ($this->defaultVariables->equals($defaultVariables)) {
             return $this;
         }
 

UriTemplate/ExpressionTest.php

@@ -19,6 +19,7 @@
 use PHPUnit\Framework\TestCase;
 
 #[CoversClass(Expression::class)]
+#[CoversClass(Operator::class)]
 final class ExpressionTest extends TestCase
 {
     #[DataProvider('providesValidNotation')]

UriTemplate/TemplateTest.php

@@ -180,4 +180,10 @@ public function testExpandOrFailIfAtLeastOneVariableIsMissing(): void
 
         Template::new('{var}{baz}')->expandOrFail(['var' => 'bar']);
     }
+
+    #[Test]
+    public function it_can_expand_with_expand_or_fail_when_all_variables_are_present(): void
+    {
+        self::assertSame('barfoo', Template::new('{var}{baz}')->expandOrFail(['var' => 'bar', 'baz' => 'foo']));
+    }
 }

UriTemplate/VariableBag.php

@@ -97,6 +97,12 @@ public function isNotEmpty(): bool
         return [] !== $this->variables;
     }
 
+    public function equals(mixed $value): bool
+    {
+        return $value instanceof self
+            && $this->variables === $value->variables;
+    }
+
     /**
      * Fetches the variable value if none found returns null.
      *

UriTemplate/VariableBagTest.php

@@ -16,6 +16,7 @@
 use ArrayIterator;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 use stdClass;
 use TypeError;
@@ -172,4 +173,36 @@ public function testItCanReplaceItsValueWithThatOfAnotherInstance(): void
         self::assertEquals($expected, $bag->replace($defaultBag));
         self::assertEquals($defaultBag, $defaultBag->replace($bag));
     }
+
+    #[Test]
+    public function it_can_evaluate_if_the_bag_is_identical(): void
+    {
+        $bag = new VariableBag([
+            'foo' => 'bar',
+            'yolo' => 42,
+            'list' => 'this is a list',
+        ]);
+
+        self::assertFalse($bag->equals(new ArrayIterator()));
+        self::assertFalse($bag->equals(new stdClass()));
+        self::assertFalse($bag->equals('bag'));
+        self::assertFalse($bag->equals(new VariableBag()));
+        self::assertTrue($bag->equals($bag));
+    }
+
+    #[Test]
+    public function it_can_filter_its_content(): void
+    {
+        $bag = new VariableBag([
+            'foo' => 'bar',
+            'yolo' => 42,
+            'list' => 'this is a list',
+        ]);
+        self::assertCount(3, $bag);
+
+        $newBag = $bag->filter(fn ($value, $key) => 'foo' === $key);
+
+        self::assertFalse($newBag->equals($bag));
+        self::assertCount(1, $newBag);
+    }
 }