flattenByN() - Code Metrics - gin0115/pinkcrab_function_constructors - Measure and Improve Code Quality continuously with Scrutinizer

flattenByN() B
last analyzed 2022-05-14 22:12 UTC

↳ Parent: Project
Complexity

Conditions	7
Paths	1
Size

Total Lines	29
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	7
eloc	12
nc	1
nop	1
dl	0
loc	29
rs	8.8333
c	0
b	0
f	0
<?php

/**
 * Array functions.
 *
 * This file is part of PinkCrab Function Constructors.
 *
 * PinkCrab Function Constructors is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 2
 * of the License, or (at your option) any later version.
 *
 * PinkCrab Function Constructors is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with PinkCrab Function Constructors.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 * @author Glynn Quelch <[email protected]>
 * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
 * @package PinkCrab\FunctionConstructors
 * @since 0.0.1
 *
 * @template Number of int|float
 * @phpstan-template Number of int|float
 * @psalm-template Number of int|float
 */

declare(strict_types=1);

namespace PinkCrab\FunctionConstructors\Arrays;

use Closure;
use stdClass;
use PinkCrab\FunctionConstructors\Comparisons as Comp;
filter:
    dependency_paths: ["lib/*"]

/**
 * Returns a Closure for pushing a value to the head of an array
 *
 * @param array<int|string, mixed> $array
 * @return Closure(mixed):array<int|string, mixed>
 */
function pushHead(array $array): Closure
{
    /**
     * @param mixed $value Adds value start of array.
     * @return array New array with value on head.
     */
    return function ($value) use ($array): array {
        array_unshift($array, $value);
        return $array;
    };
}

/**
 * Returns a Closure for pushing a value to the head of an array
 *
 * @param array<int|string, mixed> $array
 * @return Closure(mixed):array<int|string, mixed>
 */
function pushTail(array $array): Closure
{
    /**
     * @param mixed $value Adds value end of array.
     * @return array<int|string, mixed> New array with value on tail.
     */
    return function ($value) use ($array): array {
        $array[] = $value;
        return $array;
    };
}

/**
 * Gets the first value from an array.
 *
 * @param array<int|string, mixed> $array The array.
 * @return mixed Will return the first value is array is not empty, else null.
 */
function head(array $array)
{
    return ! empty($array) ? array_values($array)[0] : null;
}

/**
 * Gets the last value from an array.
 *
 * @param array<int|string, mixed> $array
 * @return mixed Will return the last value is array is not empty, else null.
 */
function tail(array $array)
{
    return ! empty($array) ? array_reverse($array, false)[0] : null;
}


/**
 * Creates a Closure for concatenating arrays with a defined glue.
 *
 * @param string|null $glue The string to join each element. If null, will be no separation between elements.
 * @return Closure(array<int|string, mixed>):string
 *
 */
function toString(?string $glue = null): Closure
{
    /**
     * @param array<int|string, mixed> $array Array join
     * @return string.
     */
    return function (array $array) use ($glue): string {
        return $glue ? \join($glue, $array) : \join($array);
        return $glue ? \join($glue, $array) : /** @scrutinizer ignore-call */ \join($array);
    };
}

/**
 * Creates a Closure for zipping 2 arrays.
 *
 * @param array<mixed> $additional Values with the same key will be paired.
 * @param mixed $default The fallback value if the additional array doesn't have the same length
 * @return Closure(array<mixed>):array<array{mixed, mixed}>
 *
 */
function zip(array $additional, $default = null): Closure
{
    $additional = array_values($additional);
    return function (array $array) use ($additional, $default) {
        $array = array_values($array);
        return array_reduce(
            array_keys($array),
            function ($carry, $key) use ($array, $additional, $default): array {
                $carry[] = array(
                    $array[ $key ],
                    array_key_exists($key, $additional) ? $additional[ $key ] : $default,
                );
                return $carry;
            },
            array()
        );
    };
}


/*
 *                                ********************
 *                                * Filter Compilers *
 *                                ********************
 */


/**
 * Compiles an array if a value is passed.
 * Returns the array if nothing passed.
 *
 * @param mixed[] $inital Sets up the inner value.
 * @return Closure
 */
function arrayCompiler(array $inital = array()): Closure
{
    /**
     * @param mixed $value Adds value to inner array if value set, else returns.
     * @return mixed[]|Closure
     */
    return function ($value = null) use ($inital) {
        if ($value) {
            $inital[] = $value;
        }
        return ! is_null($value) ? arrayCompiler($inital) : $inital;
    };
}

/**
 * Creates a typed array compiler.
 * All values which do not pass the validator are not added.
 *
 * @param Closure(mixed):bool $validator Used to validate values before adding to array.
 * @param mixed[] $inital The inital data to start with
 * @return Closure
 */
function arrayCompilerTyped(callable $validator, array $inital = array()): Closure
{
    // Ensure all is validated from initial.
    $inital = array_filter($inital, $validator);

    /**
     * @param mixed $value
     * @return mixed[]|Closure
     */
    return function ($value = null) use ($validator, $inital) {
        if (! is_null($value) && $validator($value)) {
            $inital[] = $value;
        }
        return ! is_null($value) ? arrayCompilerTyped($validator, $inital) : $inital;
    };
}



/*
 *                                ********************
 *                                * Filter Functions *
 *                                ********************
 */


/**
 * Created a Closure for filtering an array.
 *
 * @param callable $callable The function to apply to the array.
 * @return Closure(array<int|string, mixed>):array<int|string, mixed>
 */
function filter(callable $callable): Closure
{
    /**
     * @param array<int|string, mixed> $source Array to filter
     * @return array<int|string, mixed> Filtered array.
     */
    return function (array $source) use ($callable): array {
        return array_filter($source, $callable);
    };
}

/**
 * Create a Closure for filtering an array by a key.
 *
 * @param callable $callable The function to apply to the array.
 * @return Closure(array<int|string, mixed>):array<int|string, mixed>
 */
function filterKey(callable $callable): Closure
{
    /**
     * @param array<int|string, mixed> $source Array to filter
     * @return array<int|string, mixed> Filtered array.
     */
    return function (array $source) use ($callable): array {
        return array_filter($source, $callable, \ARRAY_FILTER_USE_KEY);
    };
}


/**
 * Creates a Closure for running an array through various callbacks for all true response.
 * Wrapper for creating a AND group of callbacks and running through array filter.
 *
 * @param callable ...$callables
 * @return Closure(array<int|string, mixed>):array<int|string, mixed>
 */
function filterAnd(callable ...$callables): Closure
{
    /**
     * @param array<int|string, mixed> $source Array to filter
     * @return array<int|string, mixed> Filtered array.
     */
    return function (array $source) use ($callables): array {
        return array_filter($source, Comp\groupAnd(...$callables));
        return array_filter($source, /** @scrutinizer ignore-call */ Comp\groupAnd(...$callables));
    };
}

/**
 * Creates a Closure for running an array through various callbacks for any true response.
 * Wrapper for creating a OR group of callbacks and running through array filter.
 *
 * @param callable ...$callables
 * @return Closure(array<int|string, mixed>):array<int|string, mixed>
 */
function filterOr(callable ...$callables): Closure
{
    /**
     * @param array<int|string, mixed> $source Array to filter
     * @return array<int|string, mixed> Filtered array.
     */
    return function (array $source) use ($callables): array {
        return array_filter($source, Comp\groupOr(...$callables));
        return array_filter($source, /** @scrutinizer ignore-call */ Comp\groupOr(...$callables));
    };
}

/**
 * Creates a Closure for running array filter and getting the first value.
 *
 * @param callable $func
 * @return Closure(array<int|string, mixed>):?mixed
 */
function filterFirst(callable $func): Closure
{
    /**
     * @param array<int|string, mixed> $array The array to filter
     * @return mixed|null The first element from the filtered array or null if filter returns empty
     */
    return function (array $array) use ($func) {
        return head(array_filter($array, $func));
    };
}

/**
 * Creates a Closure for running array filter and getting the last value.
 *
 * @param callable $func
 * @return Closure(array<int|string, mixed>):?mixed
 */
function filterLast(callable $func): Closure
{
    /**
     * @param array<int|string, mixed> $array The array to filter
     * @return mixed|null The last element from the filtered array.
     */
    return function (array $array) use ($func) {
        return tail(array_filter($array, $func));
    };
}

/**
 * Creates a Closure which takes an array, applies a filter, then maps the
 * results of the map.
 *
 *
 * @param callable(mixed):bool $filter Function to of filter contents
 * @param callable(mixed):mixed $map Function to map results of filter function.
 * @return Closure(array<int|string, mixed>):array<int|string, mixed>
 */
function filterMap(callable $filter, callable $map): Closure
{
    /**
     * @param array<int|string, mixed> $array The array to filter then map.
     * @return array<int|string, mixed>
     */
    return function (array $array) use ($filter, $map): array {
        return array_map($map, array_filter($array, $filter));
    };
}

/**
 * Runs an array through a filters, returns the total count of true
 *
 * @param callable $function
 * @return Closure(array<int|string, mixed>):int
 */
function filterCount(callable $function): Closure
{
    /**
     * @param array<int|string, mixed> $array
     * @return int Count
     */
    return function (array $array) use ($function) {
        return count(array_filter($array, $function));
    };
}

/**
 * Returns a Closure for partitioning an array based
 * on the results of a filter type function.
 * Callable will be cast to a bool, if truthy will be listed under 1 key, else 0 for falsey
 *
 * @param callable(mixed):(bool|int) $function
 * @return Closure(mixed[]):array{0:mixed[], 1:mixed[]}
 */
function partition(callable $function): Closure
{
    /**
     * @param mixed[] $array
     * @return array{0:mixed[], 1:mixed[]}
     */
    return function (array $array) use ($function): array {
        return array_reduce(
            $array,
            /**
             * @param array{0:mixed[], 1:mixed[]} $carry
             * @param mixed $element
             * @return array{0:mixed[], 1:mixed[]}
             */
            function ($carry, $element) use ($function): array {
                $key             = (bool) $function($element) ? 1 : 0;
                $carry[ $key ][] = $element;
                return $carry;
            },
            array( array(), array() )
        );
    };
}





/*
 *                           *****************
 *                           * Map Functions *
 *                           *****************
 */



/**
 * Returns a Closure which can be passed an array.
 *
 * @param callable(mixed):mixed $func Callback to apply to each element in array.
 * @return Closure(mixed[]):mixed[]
 */
function map(callable $func): Closure
{
    /**
     * @param mixed[] $array The array to map
     * @return mixed[]
     */
    return function (array $array) use ($func): array {
        return array_map($func, $array);
    };
}

/**
 * Returns a Closure for mapping of an arrays keys.
 * Setting the key to an existing index will overwrite the current value at same index.
 *
 * @param callable $func
 * @return Closure(mixed[]):mixed[]
 */
function mapKey(callable $func): Closure
{
    /**
     * @param mixed[] $array The array to map
     * @return mixed[]
     */
    return function (array $array) use ($func): array {
        return array_reduce(
            array_keys($array),
            function ($carry, $key) use ($func, $array) {
                $carry[ $func($key) ] = $array[ $key ];
                return $carry;
            },
            array()
        );
    };
}

/**
 * Returns a Closure for mapping an array with additional data.
 *
 * @param callable(mixed ...$a):mixed $func
 * @param mixed ...$data
 * @return Closure(mixed[]):mixed[]
 */
function mapWith(callable $func, ...$data): Closure
{
    /**
     * @param mixed[] $array The array to map
     * @return mixed[]
     */
    return function (array $array) use ($func, $data): array {
        return array_map(
            function ($e) use ($data, $func) {
                return $func($e, ...$data);
            },
            $array
        );
    };
}

/**
 * Returns a Closure for flattening and mapping an array
 *
 * @param callable(mixed):mixed $function The function to map the element. (Will no be called if resolves to array)
 * @param int|null $n Depth of nodes to flatten. If null will flatten to n
 * @return Closure(mixed[]):mixed[]
 */
function flatMap(callable $function, ?int $n = null): Closure
{
    /**
     * @param mixed[] $array
     * @return mixed[]
     */
    return function (array $array) use ($n, $function): array {
        return array_reduce(
            $array,
            /**
             * @param mixed[] $carry
             * @param mixed $element
             * @return mixed[]
             */
            function (array $carry, $element) use ($n, $function): array {
                if (is_array($element) && (is_null($n) || $n > 0)) {
                    $carry = array_merge($carry, flatMap($function, $n ? $n - 1 : null)($element));
                } else {
                    $carry[] = is_array($element) ? $element : $function($element);
                }
                return $carry;
            },
            array()
        );
    };
}

/*
 *                         **********************
 *                         * General Operations *
 *                         **********************
 */


/**
 * Creates a Closure for grouping an array.
 *
 * @param callable(mixed):(string|int) $function The function to group by.
 * @return Closure(mixed):mixed[]
 */
function groupBy(callable $function): Closure
{
    /**
     * @param mixed[] $array The array to be grouped
     * @return mixed[] Grouped array.
     */
    return function (array $array) use ($function): array {
        return array_reduce(
            $array,
            /**
             * @param mixed[] $carry
             * @param mixed $element
             * @return mixed[]
             */
            function ($carry, $item) use ($function): array {
                $carry[ call_user_func($function, $item) ][] = $item;
                return $carry;
            },
            array()
        );
    };
}

/**
 * Creates a Closure for chunking an array to set a limit.
 *
 * @param int $count The max size of each chunk. Must not be less than 1!
 * @param bool $preserveKeys Should inital keys be kept. Default false.
 * @return Closure(mixed[]):mixed[]
 */
function chunk(int $count, bool $preserveKeys = false): Closure
{
    /**
     * @param mixed[] $array Array to chunk
     * @return mixed[]
     */
    return function (array $array) use ($count, $preserveKeys): array {
        return array_chunk($array, max(1, $count), $preserveKeys);
    };
}

/**
 * Create callback for extracting a single column from an array.
 *
 * @param string $column Column to retrieve.
 * @param string $key Use column for assigning as the index. defaults to numeric keys if null.
 * @return Closure(mixed[]):mixed[]
 */
function column(string $column, ?string $key = null): Closure
{
    /**
     * @param mixed[] $array
     * @return mixed[]
     */
    return function (array $array) use ($column, $key): array {
        return array_column($array, $column, $key);
    };
}

/**
 * Returns a Closure for flattening an array to a defined depth
 *
 * @param int|null $n Depth of nodes to flatten. If null will flatten to n
 * @return Closure(mixed[] $var): mixed[]
 */
function flattenByN(?int $n = null): Closure
{
    /**
     * @param mixed[] $array Array to flatten
     * @return mixed[]
     */
    return function (array $array) use ($n): array {
        return array_reduce(
            $array,
            /**
             * @param array<int|string, mixed> $carry
             * @param mixed|mixed[] $element
             * @return array<int|string, mixed>
             */
            function (array $carry, $element) use ($n): array {
                // Remove empty arrays.
                if (is_array($element) && empty($element)) {
                    return $carry;
                }
                // If the element is an array and we are still flattening, call again
                if (is_array($element) && (is_null($n) || $n > 0)) { // @phpstan-ignore-line
                    $carry = array_merge($carry, flattenByN($n ? $n - 1 : null)($element));
                } else {
                    // Else just add the element.
                    $carry[] = $element;
                }
                return $carry;
            },
            array()
        );
    };
}

/**
 * Returns a closure for recursively changing values in an array.
 *
 * @param mixed[] ...$with The array values to replace with
 * @return Closure(mixed[]):mixed[]
 */
function replaceRecursive(array ...$with): Closure
{
    /**
     * @param mixed[] $array The array to have elements replaced from.
     * @return mixed[] Array with replacements.
     */
    return function (array $array) use ($with): array {
        return array_replace_recursive($array, ...$with);
    };
}

/**
 * Returns a Closure for changing all values in a flat array, based on key.
 *
 * @param mixed[] ...$with Array with values to replace with, must have matching key with base array.
 * @return Closure(mixed[]):mixed[]
 */
function replace(array ...$with): Closure
{
    /**
     * @param mixed[] $array The array to have elements replaced from.
     * @return mixed[] Array with replacements.
     */
    return function (array $array) use ($with): array {
        return array_replace($array, ...$with);
    };
}

/**
 * Returns a Closure for doing array_sum with the results of a function/expression.
 *
 * @param callable(mixed):Number $function The function to return the value for array sum
 * @return Closure(mixed[]):Number
 */
function sumWhere(callable $function): Closure
{
    /**
     * @param mixed[] $array Array to do sum() on.
     * @return Number The total.
     */
    return function (array $array) use ($function) {
        return array_sum(array_map($function, $array));
    };
}

/**
 * Creates a closure for casting an array to an object.
 * Assumed all properties are public
 * None existing properties will be set as dynamic properties.
 *
 * @param object|null $object The object to cast to, defaults to stdClass
 * @return Closure(mixed[]):object
 */
function toObject(?object $object = null): Closure
{
    $object = $object ?? new stdClass();

    /**
     * @param mixed[] $array
     * @return object
     */
    return function (array $array) use ($object): object {
        foreach ($array as $key => $value) {
            $key            = is_string($key) ? $key : (string) $key;
            $object->{$key} = $value;
        }
        return $object;
    };
}

/**
 * Creates a closure for encoding json with defined flags/depth
 *
 * @param int $flags json_encode flags (default = 0)
 * @param int $depth Nodes deep to encode (default = 512)
 * @return \Closure(mixed):?string
 * @constants JSON_FORCE_OBJECT, JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP,
 *            JSON_HEX_APOS, JSON_INVALID_UTF8_IGNORE,
 *            JSON_INVALID_UTF8_SUBSTITUTE, JSON_NUMERIC_CHECK,
 *            JSON_PARTIAL_OUTPUT_ON_ERROR, JSON_PRESERVE_ZERO_FRACTION,
 *            JSON_PRETTY_PRINT, JSON_UNESCAPED_LINE_TERMINATORS,
 *            JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE, JSON_THROW_ON_ERROR
 */
function toJson(int $flags = 0, int $depth = 512): Closure
{
    /**
     * @param mixed $data
     * @return string|null
     */
    return function ($data) use ($flags, $depth): ?string {
        return \json_encode($data, $flags, max(1, $depth)) ?: null;
    };
}


/*
 *                         ****************
 *                         *  Array Sort  *
 *                         ****************
 */


/**
 * Returns a Closure for doing regular SORT against an array.
 * Doesn't maintain keys.
 *
 * @param int $flag Uses php stock sort constants or numerical values.
 * @return Closure(mixed[]):mixed[]
 */
function sort(int $flag = SORT_REGULAR): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($flag) {
        \sort($array, $flag);
        return $array;
    };
}

/**
 * Returns a Closure for doing regular Reverse SORT against an array.
 * Doesn't maintain keys.
 *
 * @param int $flag Uses php stock sort constants or numerical values.
 * @return Closure(mixed[]):mixed[]
 */
function rsort(int $flag = SORT_REGULAR): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($flag) {
        \rsort($array, $flag);
        return $array;
    };
}


/**
 * Returns a Closure for sorting an array by key in ascending order.
 *
 * @param int $flag Uses php stock sort constants or numerical values.
 * @return Closure(mixed[]):mixed[]
 */
function ksort(int $flag = SORT_REGULAR): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($flag) {
        \ksort($array, $flag);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array by key in descending (reverse) order.
 *
 * @param int $flag Uses php stock sort constants or numerical values.
 * @return Closure(mixed[]):mixed[]
 */
function krsort(int $flag = SORT_REGULAR): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($flag) {
        \krsort($array, $flag);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array by value in ascending order.
 * Maintain keys.
 *
 * @param int $flag Uses php stock sort constants or numerical values.
 * @return Closure(mixed[]):mixed[]
 */
function asort(int $flag = SORT_REGULAR): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($flag) {
        \asort($array, $flag);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array by value in descending (reverse) order.
 * Maintain keys.
 *
 * @param int $flag Uses php stock sort constants or numerical values.
 * @return Closure(mixed[]):mixed[]
 */
function arsort(int $flag = SORT_REGULAR): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($flag) {
        \arsort($array, $flag);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array using a "natural order" algorithm
 *
 * @return Closure(mixed[]):mixed[]
 */
function natsort(): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) {
        \natsort($array);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array using a case insensitive "natural order" algorithm
 *
 * @return Closure(mixed[]):mixed[]
 */
function natcasesort(): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) {
        \natcasesort($array);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array by key using a custom comparison function
 *
 * @param callable(mixed $a, mixed $b): int $function
 * @return Closure(mixed[]):mixed[]
 */
function uksort(callable $function): Closure
{
    /**
     *  @param mixed[] $array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($function) {
        \uksort($array, $function);
        return $array;
    };
}

/**
 * Returns a Closure for sorting an array using a custom comparison function
 * Maintain keys.
 *
 * @param callable(mixed $a, mixed $b): int $function
 * @return Closure(mixed[]):mixed[]
 */
function uasort(callable $function): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($function) {
        \uasort($array, $function);
        return $array;
    };
}


/**
 * Returns a Closure for sorting an array using a custom comparison function
 * Doesn't maintain keys.
 *
 * @param callable(mixed $a, mixed $b): int $function
 * @return Closure(mixed[]):mixed[]
 */
function usort(callable $function): Closure
{
    /**
     *  @param mixed[]$array The array to sort
     *  @return mixed[] The sorted array (new array)
     */
    return function (array $array) use ($function) {
        \usort($array, $function);
        return $array;
    };
}

gin0115 / pinkcrab_function_constructors

flattenByN() B last analyzed 2022-05-14 22:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

flattenByN() B
last analyzed 2022-05-14 22:12 UTC
