gbenm/phipes

A simple library for transforming iterables

dev-main 2024-02-04 04:46 UTC

Requires (Dev)

• squizlabs/php_codesniffer: ^3.7

MIT

• Benyamin Galeano

• stream
• filter
• array
• map
• transform
• pipe
• transformer
• collection
• pipeline
• reduce
• iterable

README

Allows chaining transformations of iterables or building reusable pipelines, while also being easily extensible.

Quickstart

Some ways to transform an iterable

// (temporal results) iterate many times over the same iterable
$result = array_filter($someIterable, $isOdd);
$result = array_map($mulByThree, $result);
$result = array_map($addTwo, $result);

// iterate many times over the same iterable
$result = array_map($addTwo, array_map($mulByThree, array_filter($someIterable, $isOdd)));

// imperative way
$result = [];
foreach ($someIterable as $item) {
    if ($isOdd($item)) {
        $result[] = $addTwo($mulByThree($item));
    }
}

Using Phipes

Iterate only once

use Phipes\Pipeline;

// delay computation
$result = Pipeline::for($someIterable)
    ->filter($isOdd)
    ->map($mulByThree)
    ->map($addTwo)
    ->asIterable(); // lazy

$result = Pipeline::for($someIterable)
    ->filter($isOdd)
    ->map($mulByThree)
    ->map($addTwo)
    ->asArray(); // start computing at this point

// Creating a pipeline

$pipeline = Pipeline::builder()
    ->filter($isOdd)
    ->map($mulByThree)
    ->map($addTwo)
    ->build();

$results = $pipeline($someIterable);

$otherResults = $pipeline($someIterable2);

Create a new transformer

// by example the map function
/** @param (callable($value, [$key]): mixed) $fn  */
function map(callable $fn): callable
{
    return function (iterable $iterable) use ($fn): iterable {
        foreach ($iterable as $key => $item) {
            yield $key => call_user_func($fn, $item, $key);
        }
    };
}

// now you can use the pipe method or call the result
$result = Pipeline::for($someIterable)
    ->pipe(map(fn ($v) => $v + 1))
    ->asIterable(); // lazy

// alternative
$result = Pipeline::for($someIterable)
    (map(fn ($v) => $v + 1))
    ->asIterable(); // lazy