Merge branch 'collection'

Author: lkrms

src/Concept/LooselyTypedCollection.php

@@ -4,85 +4,17 @@
 
 use Lkrms\Concern\TCollection;
 use Lkrms\Contract\ICollection;
-use Lkrms\Contract\IImmutable;
-use LogicException;
 
 /**
- * Base class for collections of objects of a strictly enforced type
- *
- * Extend {@see LooselyTypedCollection} instead if performance concerns outweigh
- * type safety.
+ * Base class for collections of items of a given type
  *
  * @template TKey of array-key
- * @template TValue of object
+ * @template TValue
  *
  * @implements ICollection<TKey,TValue>
  */
-abstract class TypedCollection implements ICollection, IImmutable
+abstract class TypedCollection implements ICollection
 {
-    /**
-     * @var class-string<TValue>
-     */
-    protected const ITEM_CLASS = \stdClass::class;
-
     /** @use TCollection<TKey,TValue> */
-    use TCollection {
-        push as private _push;
-        unshift as private _unshift;
-        offsetSet as private _offsetSet;
-    }
-
-    /**
-     * @param TValue[] $items
-     */
-    public function __construct($items = [])
-    {
-        foreach ($items as $item) {
-            if (!is_object($item) || !is_a($item, static::ITEM_CLASS)) {
-                $this->throwItemTypeException($item);
-            }
-        }
-        $this->Items = $items;
-    }
-
-    public function push(...$item)
-    {
-        foreach ($item as $_item) {
-            if (!is_object($_item) || !is_a($_item, static::ITEM_CLASS)) {
-                $this->throwItemTypeException($_item);
-            }
-        }
-        return $this->_push(...$item);
-    }
-
-    public function unshift(...$item)
-    {
-        foreach ($item as $_item) {
-            if (!is_object($_item) || !is_a($_item, static::ITEM_CLASS)) {
-                $this->throwItemTypeException($_item);
-            }
-        }
-        return $this->_unshift(...$item);
-    }
-
-    public function offsetSet($offset, $value): void
-    {
-        if (!is_object($value) || !is_a($value, static::ITEM_CLASS)) {
-            $this->throwItemTypeException($value);
-        }
-        $this->_offsetSet($offset, $value);
-    }
-
-    /**
-     * @param mixed $item
-     * @return never
-     */
-    private function throwItemTypeException($item)
-    {
-        throw new LogicException(sprintf(
-            'Not a subclass of %s: %s',
-            static::ITEM_CLASS,
-            is_object($item) ? get_class($item) : gettype($item)
-        ));
-    }
+    use TCollection;
 }

src/Concept/TypedCollection.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Concept;
+
+use Lkrms\Concern\TList;
+use Lkrms\Contract\IList;
+
+/**
+ * Base class for lists of items of a given type
+ *
+ * @template TValue
+ *
+ * @implements IList<TValue>
+ */
+abstract class TypedList implements IList
+{
+    /** @use TList<TValue> */
+    use TList;
+}

src/Concept/TypedList.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Concern;
+
+trait Immutable
+{
+    /**
+     * Clone the object
+     *
+     * @return static
+     */
+    protected function clone()
+    {
+        $clone = clone $this;
+        return $clone;
+    }
+
+    /**
+     * Apply a value to a clone of the object if the current value differs
+     *
+     * @param mixed $value
+     * @return static
+     */
+    protected function withPropertyValue(string $property, $value)
+    {
+        if (isset($this->$property) && $value === $this->$property) {
+            return $this;
+        }
+
+        $clone = $this->clone();
+        $clone->$property = $value;
+        return $clone;
+    }
+}

src/Concern/HasMutator.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Concern;
+
+use LogicException;
+
+/**
+ * @template TKey of array-key
+ * @template TValue
+ */
+trait ImmutableArrayAccess
+{
+    /**
+     * @param TKey|null $offset
+     * @param TValue $value
+     */
+    public function offsetSet($offset, $value): void
+    {
+        throw new LogicException(sprintf('%s is immutable', static::class));
+    }
+
+    /**
+     * @param TKey $offset
+     */
+    public function offsetUnset($offset): void
+    {
+        throw new LogicException(sprintf('%s is immutable', static::class));
+    }
+}