fix: empty array is considered as no-match

add Equatable to Template for comparing two templates for equality

refs #8

Author: Thorsten Suckow-Homberg

src/Net/Uri/Component/Path/Template.php

@@ -29,6 +29,10 @@
 
 namespace Conjoon\Net\Uri\Component\Path;
 
+use Conjoon\Core\Contract\Equatable;
+use Conjoon\Core\Contract\Stringable;
+use Conjoon\Core\Contract\StringStrategy;
+use Conjoon\Core\Exception\InvalidTypeException;
 use Conjoon\Net\Uri;
 
 /**
@@ -51,7 +55,7 @@
  *    // ["mailFolderId" => "2"]
  *
  */
-class Template
+class Template implements Stringable, Equatable
 {
     /**
      * @var string
@@ -97,7 +101,7 @@ public function match(Uri $uri): ?array
         $uriRegex = $this->getUriTemplateRegex();
         $matches = $uriRegex->match($uri->getPath());
 
-        if (!$matches) {
+        if ($matches === null) {
             return null;
         }
 
@@ -146,4 +150,30 @@ private function getUriTemplateRegex(): TemplateRegex
         }
         return $this->uriTemplateRegex;
     }
+
+
+    /**
+     * @param StringStrategy|null $stringStrategy
+     * @return string
+     */
+    public function toString(StringStrategy $stringStrategy = null): string
+    {
+        return $stringStrategy ? $stringStrategy->toString($this) : $this->templateString;
+    }
+
+
+    /**
+     * @param object $target
+     * @return bool
+     */
+    public function equals(object $target): bool
+    {
+        if (!($target instanceof Template)) {
+            throw new InvalidTypeException(
+                "\"target\" must be an instance of " . static::class . ", is " . get_class($target)
+            );
+        }
+
+        return strtolower($this->toString()) === strtolower($target->toString());
+    }
 }

tests/Net/Uri/Component/Path/TemplateRegexTest.php

@@ -120,6 +120,10 @@ public function testMatch(): void
                 "resourceId" => "123",
                 "subItemId" => "456"
             ],
+        ], [
+            "cArg" => "tpl/resource",
+            "input" => "tpl/resource",
+            "output" => [],
         ]];
 
         foreach ($tests as $test) {

tests/Net/Uri/Component/Path/TemplateTest.php

@@ -29,6 +29,9 @@
 
 namespace Tests\Conjoon\Net\Uri\Component\Path;
 
+use Conjoon\Core\Contract\Equatable;
+use Conjoon\Core\Contract\Stringable;
+use Conjoon\Core\Exception\InvalidTypeException;
 use Conjoon\Net\Uri\Component\Path\Template;
 use Conjoon\Net\Uri;
 use Tests\TestCase;
@@ -38,6 +41,52 @@
  */
 class TemplateTest extends TestCase
 {
+    /**
+     * Tests class & types
+     * @return void
+     */
+    public function testClass(): void
+    {
+        $tpl = new Template("/MailFolder/{mailFolderId}");
+        $this->assertInstanceOf(Stringable::class, $tpl);
+        $this->assertInstanceOf(Equatable::class, $tpl);
+    }
+
+    /**
+     * Tests equals() with InvalidTypeException
+     * @return void
+     */
+    public function testEqualsWithException(): void
+    {
+        $this->expectException(InvalidTypeException::class);
+
+        $tplLft = new Template("/MailFolder/{mailFolderId}");
+
+        $equatable = new class implements Equatable {
+            public function equals(object $target): bool
+            {
+                return true;
+            }
+        };
+
+        $tplLft->equals($equatable);
+    }
+
+
+    /**
+     * Tests equals()
+     * @return void
+     */
+    public function testEquals(): void
+    {
+        $tplLft = new Template("/MailFolder/{mailFolderId}");
+        $tplYes = new Template("/MAILFOLDER/{mailFolderId}");
+        $tplNo = new Template("/SnailFolder/{mailFolderId}");
+
+        $this->assertTrue($tplLft->equals($tplYes));
+        $this->assertFalse($tplLft->equals($tplNo));
+    }
+
     /**
      * Tests getTemplateString()
      *
@@ -94,18 +143,24 @@ public function testMatch(): void
 
         $this->assertSame(
             ["mailFolderId" => "2"],
-            $tpl->match(Uri::create("https://localhost:8080/MailFolder/2?query=value"))
+            $tpl->match(Uri::make("https://localhost:8080/MailFolder/2?query=value"))
         );
 
         $this->assertNull(
-            $tpl->match(Uri::create("https://localhost:8080/path/MailFolder/2?query=value"))
+            $tpl->match(Uri::make("https://localhost:8080/path/MailFolder/2?query=value"))
         );
 
         // relative path
         $tpl = new Template("MailFolder/{mailFolderId}");
         $this->assertSame(
             ["mailFolderId" => "2"],
-            $tpl->match(Uri::create("https://localhost:8080/pathMailFolder/2?query=value"))
+            $tpl->match(Uri::make("https://localhost:8080/pathMailFolder/2?query=value"))
+        );
+
+        $tpl = new Template("/employees");
+        $this->assertSame(
+            [],
+            $tpl->match(Uri::make("https://localhost:8080/employees"))
         );
     }
 }