Feat: iterable_values() (#33)

Author: simPod

Diff for: README.md

@@ -128,6 +128,25 @@ foreach (iterable_filter($generator(), $filter) as $item) {
 }
 ```
 
+iterable_values()
+--------------
+
+Works like an `array_values` with an `array` or a `Traversable`.
+
+```php
+use function BenTools\IterableFunctions\iterable_values;
+
+$generator = function () {
+    yield 'a' => 'a';
+    yield 'b' => 'b';
+};
+
+foreach (iterable_values($generator()) as $key => $value) {
+    var_dump($key); // 0, 1
+    var_dump($value); // a, b
+}
+```
+
 Iterable fluent interface
 =========================
 

Diff for: src/IterableObject.php

@@ -70,6 +70,14 @@ public function map(callable $mapper): self
         return new self(array_map($mapper, $this->iterable));
     }
 
+    /**
+     * @return self<int, TValue>
+     */
+    public function values(): self
+    {
+        return new self(new WithoutKeysTraversable($this->iterable));
+    }
+
     /** @return Traversable<TKey, TValue> */
     public function getIterator(): Traversable
     {

Diff for: src/WithoutKeysTraversable.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BenTools\IterableFunctions;
+
+use Generator;
+use IteratorAggregate;
+
+/**
+ * @internal
+ *
+ * @template TKey
+ * @template TValue
+ * @implements IteratorAggregate<TKey, TValue>
+ */
+final class WithoutKeysTraversable implements IteratorAggregate
+{
+    /** @var iterable<TKey, TValue> */
+    private $iterable;
+
+    /**
+     * @param iterable<TKey, TValue> $iterable
+     */
+    public function __construct(iterable $iterable)
+    {
+        $this->iterable = $iterable;
+    }
+
+    /**
+     * @return Generator<TValue>
+     */
+    public function getIterator(): Generator
+    {
+        foreach ($this->iterable as $value) {
+            yield $value;
+        }
+    }
+}

Diff for: src/iterable-functions.php

@@ -114,6 +114,22 @@ function iterable_reduce(iterable $iterable, callable $reduce, $initial = null)
     return $initial;
 }
 
+/**
+ * Yields iterable values (leaving out keys).
+ *
+ * @param iterable<TValue> $iterable
+ *
+ * @return iterable<int, TValue>
+ *
+ * @template TValue
+ */
+function iterable_values(iterable $iterable): iterable
+{
+    $withoutKeys = iterable($iterable)->values();
+
+    return is_array($iterable) ? $withoutKeys->asArray() : $withoutKeys;
+}
+
 /**
  * @param iterable<TKey, TValue>|null $iterable
  *

Diff for: tests/IterableObjectTest.php

@@ -116,3 +116,11 @@ static function (string $value) {
         })($input),
     ];
 });
+
+it('strips key through values()', function (): void {
+    $input = ['x' => 'zero', 'y' => 'one', 'z' => 'two'];
+
+    $iterableObject = iterable($input)->values();
+    assertInstanceOf(IterableObject::class, $iterableObject);
+    assertEquals(['zero', 'one', 'two'], $iterableObject->asArray());
+});

Diff for: tests/IterableValuesTest.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BenTools\IterableFunctions\Tests;
+
+use ArrayIterator;
+use PHPUnit\Framework\Assert;
+
+use function BenTools\IterableFunctions\iterable_values;
+use function it;
+use function PHPUnit\Framework\assertSame;
+
+it(
+    'gets only values of array',
+    function (): void {
+        $iterable = ['b' => true];
+
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (iterable_values($iterable) as $key => $value) {
+        }
+
+        if (! isset($key, $value)) {
+            Assert::fail('No values were returned');
+        }
+
+        assertSame(0, $key);
+        assertSame(true, $value);
+    }
+);
+
+it(
+    'gets values of Traversable object',
+    function (): void {
+        $iterable = new ArrayIterator(['b' => true]);
+
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (iterable_values($iterable) as $key => $value) {
+        }
+
+        if (! isset($key, $value)) {
+            Assert::fail('No values were returned');
+        }
+
+        assertSame(0, $key);
+        assertSame(true, $value);
+    }
+);