Merge pull request #31 from boesing/feature/factories

feat: add factories to create ordered lists or maps

src/MapFactoryInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boesing\TypedArrays;
+
+interface MapFactoryInterface
+{
+    /**
+     * @template TKey of string
+     * @template TValue
+     * @param array<TKey,TValue> $data
+     * @return MapInterface<TKey,TValue>
+     */
+    public function createMap(array $data): MapInterface;
+}

src/OrderedListFactoryInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boesing\TypedArrays;
+
+interface OrderedListFactoryInterface
+{
+    /**
+     * @param list<TValue> $values
+     *
+     * @return OrderedListInterface<TValue>
+     *
+     * @template TValue
+     */
+    public function createOrderedList(array $values): OrderedListInterface;
+}

src/TypedArrayFactory.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boesing\TypedArrays;
+
+final class TypedArrayFactory implements OrderedListFactoryInterface, MapFactoryInterface
+{
+    public function createMap(array $data): MapInterface
+    {
+        return new GenericMap($data);
+    }
+
+    public function createOrderedList(array $values): OrderedListInterface
+    {
+        return new GenericOrderedList($values);
+    }
+}

tests/TypedArrayFactoryTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boesing\TypedArrays;
+
+use PHPUnit\Framework\TestCase;
+
+final class TypedArrayFactoryTest extends TestCase
+{
+    /** @var TypedArrayFactory */
+    private $factory;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->factory = new TypedArrayFactory();
+    }
+
+    public function testCanCreateMapInstance(): void
+    {
+        $map = $this->factory->createMap(['foo' => 'bar']);
+
+        self::assertEquals(['foo' => 'bar'], $map->toNativeArray());
+    }
+
+    public function testCanCreateOrderedListInstance(): void
+    {
+        $list = $this->factory->createOrderedList(['foo', 'bar']);
+        self::assertEquals(['foo', 'bar'], $list->toNativeArray());
+    }
+}