SafeAssocList (#2)

* SafeAssocList

* Add Travis

Author: dazet

.travis.yml

@@ -0,0 +1,10 @@
+language: php
+
+php:
+  - 7.4
+
+install:
+  - composer install --dev
+
+script:
+  - ./vendor/bin/phpunit tests

src/SafeAccessorTrait.php

@@ -171,4 +171,15 @@ public function array(string $key): SafeAssocArray
 
         return SafeAssocArray::from($value);
     }
+
+	public function list(string $key): SafeAssocList
+	{
+		$value = $this->value($key, null) ?? [];
+
+		if (!is_array($value)) {
+			throw new InvalidArgumentException("Value of {$key} cannot be array");
+		}
+
+		return SafeAssocList::fromArray($value);
+	}
 }

src/SafeAssocList.php

@@ -0,0 +1,63 @@
+<?php declare(strict_types=1);
+
+namespace GW\Safe;
+
+use Countable;
+use function array_filter;
+use function array_map;
+use function array_values;
+use function count;
+
+final class SafeAssocList implements Countable
+{
+	/** @var SafeAssocArray[] */
+	private array $items;
+
+	private function __construct(SafeAssocArray ...$items)
+	{
+		$this->items = $items;
+	}
+
+	public static function from(SafeAssocArray ...$items): self
+	{
+		return new self(...$items);
+	}
+
+	/** @param array<int, array<string|int, mixed>> $items */
+	public static function fromArray(array $items): self
+	{
+		return self::from(
+			...array_map([SafeAssocArray::class, 'from'], array_values(array_filter($items, 'is_array')))
+		);
+	}
+
+	/** @return SafeAssocArray[] */
+	public function toArray(): array
+	{
+		return $this->items;
+	}
+
+	public function count(): int
+	{
+		return count($this->items);
+	}
+
+	/**
+	 * @template T
+	 * @phpstan-param callable(SafeAssocArray):T $map
+	 * @phpstan-return T[]
+	 */
+	public function map(callable $map): array
+	{
+		return array_map($map, $this->items);
+	}
+
+	/**
+	 * @phpstan-param callable(SafeAssocArray):bool $filter
+	 * @phpstan-return T[]
+	 */
+	public function filter(callable $filter): self
+	{
+		return new self(...array_values(array_filter($this->items, $filter)));
+	}
+}

tests/SafeAssocListTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace tests\GW\Safe;
+
+use GW\Safe\SafeAssocArray;
+use GW\Safe\SafeAssocList;
+use PHPUnit\Framework\TestCase;
+
+class SafeAssocListTest extends TestCase
+{
+	function test_from()
+	{
+		$john = SafeAssocArray::from(['name' => 'John']);
+		$mary = SafeAssocArray::from(['name' => 'Mary']);
+		$list = SafeAssocList::from($john, $mary);
+
+		self::assertEquals([$john, $mary], $list->toArray());
+	}
+
+	function test_to_array()
+	{
+		$arrayList = SafeAssocList::fromArray([['name' => 'John'], ['name' => 'Mary']])->toArray();
+
+		self::assertContainsOnly(SafeAssocArray::class, $arrayList);
+		self::assertEquals('John', $arrayList[0]->string('name'));
+		self::assertEquals('Mary', $arrayList[1]->string('name'));
+		self::assertEquals('???', $arrayList[1]->string('age', '???'));
+	}
+
+	function test_count()
+	{
+		self::assertCount(3, SafeAssocList::fromArray([[], [], []]));
+	}
+
+	function test_filter()
+	{
+		$list = SafeAssocList::fromArray(
+			[
+				['name' => 'John', 'age' => 30],
+				['name' => 'Mary', 'age' => 28],
+				['name' => 'Kevin', 'age' => 8]
+			]
+		)->filter(fn(SafeAssocArray $person): bool => $person->int('age', 0) > 18);
+
+		self::assertCount(2, $list);
+	}
+
+	function test_map()
+	{
+		$names = SafeAssocList::fromArray(
+			[
+				['name' => 'John', 'age' => 30],
+				['name' => 'Mary', 'age' => 28],
+				['age' => 0],
+			]
+		)->map(fn(SafeAssocArray $person): string => $person->string('name', 'unknown'));
+
+		self::assertEquals(['John', 'Mary', 'unknown'], $names);
+	}
+}