correctly implemented pluck and keyBy

Author: transistive

src/Types/AbstractCypherSequence.php

@@ -24,14 +24,18 @@
 use const INF;
 use function is_array;
 use function is_callable;
+use function is_numeric;
 use function is_object;
+use function is_string;
 use Iterator;
 use JsonSerializable;
+use function method_exists;
 use OutOfBoundsException;
 use const PHP_INT_MAX;
 use function property_exists;
 use ReturnTypeWillChange;
 use function sprintf;
+use UnexpectedValueException;
 
 /**
  * Abstract immutable sequence with basic functional methods.
@@ -281,7 +285,7 @@ public function sorted(?callable $comparator = null): self
      *
      * @psalm-mutation-free
      */
-    public function keyBy(string $key): ArrayList
+    public function pluck(string $key): ArrayList
     {
         return new ArrayList(function () use ($key) {
             foreach ($this as $value) {
@@ -294,6 +298,28 @@ public function keyBy(string $key): ArrayList
         });
     }
 
+    /**
+     * Uses the values found at the provided key as the key for the new Map.
+     *
+     * @return Map<mixed>
+     *
+     * @psalm-mutation-free
+     */
+    public function keyBy(string $key): Map
+    {
+        return new Map(function () use ($key) {
+            foreach ($this as $value) {
+                if (is_array($value) && array_key_exists($key, $value) && $this->isStringable($value[$key])) {
+                    yield $value[$key] => $value;
+                } elseif (is_object($value) && property_exists($value, $key) && $this->isStringable($value->$key)) {
+                    yield $value->$key => $value;
+                } else {
+                    throw new UnexpectedValueException('Cannot convert the value to a string');
+                }
+            }
+        });
+    }
+
     /**
      * Joins the values within the sequence together with the provided glue. If the glue is null, it will be an empty string.
      */
@@ -497,4 +523,14 @@ public function preload(): void
             $this->next();
         }
     }
+
+    /**
+     * @param mixed $key
+     *
+     * @psalm-mutation-free
+     */
+    protected function isStringable($key): bool
+    {
+        return is_string($key) || is_numeric($key) || (is_object($key) && method_exists($key, '__toString'));
+    }
 }

src/Types/CypherMap.php

@@ -230,6 +230,8 @@ public function getAsWGS843DPoint(string $key, $default = null): WGS843DPoint
      * @param iterable<Value> $iterable
      *
      * @return self<Value>
+     *
+     * @pure
      */
     public static function fromIterable(iterable $iterable): CypherMap
     {
@@ -239,8 +241,16 @@ public static function fromIterable(iterable $iterable): CypherMap
     /**
      * @psalm-mutation-free
      */
-    public function keyBy(string $key): CypherList
+    public function pluck(string $key): CypherList
+    {
+        return CypherList::fromIterable(parent::pluck($key));
+    }
+
+    /**
+     * @psalm-mutation-free
+     */
+    public function keyBy(string $key): CypherMap
     {
-        return CypherList::fromIterable(parent::keyBy($key));
+        return CypherMap::fromIterable(parent::keyBy($key));
     }
 }

src/Types/Map.php

@@ -22,13 +22,9 @@
 use function is_array;
 use function is_callable;
 use function is_iterable;
-use function is_numeric;
-use function is_object;
-use function is_string;
 use Laudis\Neo4j\Databags\Pair;
 use Laudis\Neo4j\Exception\RuntimeTypeException;
 use Laudis\Neo4j\TypeCaster;
-use function method_exists;
 use OutOfBoundsException;
 use function sprintf;
 use stdClass;
@@ -52,7 +48,7 @@ public function __construct($iterable = [])
         if (is_array($iterable)) {
             $i = 0;
             foreach ($iterable as $key => $value) {
-                if (!$this->stringable($key)) {
+                if (!$this->isStringable($key)) {
                     $key = (string) $i;
                 }
                 /** @var string $key */
@@ -72,7 +68,7 @@ public function __construct($iterable = [])
                 $it = is_callable($iterable) ? $iterable() : $iterable;
                 /** @var mixed $key */
                 foreach ($it as $key => $value) {
-                    if ($this->stringable($key)) {
+                    if ($this->isStringable($key)) {
                         yield (string) $key => $value;
                     } else {
                         yield (string) $i => $value;
@@ -521,14 +517,4 @@ public static function fromIterable(iterable $iterable): Map
     {
         return new self($iterable);
     }
-
-    /**
-     * @param mixed $key
-     *
-     * @psalm-mutation-free
-     */
-    private function stringable($key): bool
-    {
-        return is_string($key) || is_numeric($key) || (is_object($key) && method_exists($key, '__toString'));
-    }
 }

tests/Unit/CypherListTest.php

@@ -398,7 +398,7 @@ public function testKeyBy(): void
             $object,
             ['x' => 'arrayX', 'y' => 'wrong'],
             'wrong',
-        ])->keyBy('x');
+        ])->pluck('x');
 
         self::assertEquals(['stdClassX', 'arrayX'], $list->toArray());
     }

tests/Unit/CypherMapTest.php

@@ -493,7 +493,7 @@ public function testKeyBy(): void
             'x' => $object,
             'y' => ['x' => 'arrayX', 'y' => 'wrong'],
             'z' => 'wrong',
-        ])->keyBy('x');
+        ])->pluck('x');
 
         self::assertEquals(['stdClassX', 'arrayX'], $list->toArray());
     }