Convert to class for lazy-autoload and add tests

Author: navarr

.github/workflows/commit.yml

@@ -0,0 +1,98 @@
+name: Continuous Integration
+on: [push]
+
+jobs:
+  phpunit:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [7.4, 8.0, 8.1]
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: xdebug
+          tools: composer:v2
+
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install Dependencies
+        run: composer install
+
+      - name: Test
+        run: vendor/bin/phpunit tests --testdox --coverage-clover coverage.xml
+
+      - name: Upload to CodeCov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          fail_ci_if_error: true
+
+  phpstan:
+    name: Static Analysis Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [7.4, 8.0, 8.1]
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: composer:v2
+
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install Dependencies
+        run: composer install
+
+      - name: Run PHPStan
+        run: vendor/bin/phpstan
+
+  phpcs:
+    name: Code Style (PSR-12)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          tools: composer:v2
+
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install Dependencies
+        run: composer install
+
+      - name: PHP Code Sniffer
+        run: vendor/bin/phpcs
+
+  infection:
+    name: Infection Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [ 7.4, 8.0, 8.1 ]
+    continue-on-error: true
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: xdebug
+          tools: composer:v2
+
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: Check for Mutants
+        run: vendor/bin/infection --threads=$(nproc) --no-progress --logger-github

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+/.phpunit.result.cache

README.md

@@ -1,2 +1,27 @@
-# iterable_to_array
-PHP function iterable_to_array
+# IterableToArray::convert
+
+A simple utility class that handles the boilerplate of converting an iterable into an array.
+
+The goal of this utility is to be an in-place replacement for iterator_to_array whenever one must handle an iterable.
+
+## Installation
+
+    composer require navarr/iterable-to-array
+
+## Usage
+
+```php
+<?php
+
+use Navarr\Utils\IterableToArray
+
+// ...
+
+$array = IterableToArray::convert($iterable);
+
+// This replaces:
+
+$array = is_array($iterable) ? $iterable : iterator_to_array($iterable);
+```
+
+This also has (what should be unnecessary) forward compatibility for a scenario where an object passes the `iterable` type check but is neither an `array` nor a `\Traversable`.

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "navarr/iterable-to-array",
+    "description": "A method for converting an iterable to an array, no matter what type of iterable",
+    "require": {
+        "php": ">=7.4"
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1",
+        "roave/security-advisories": "dev-master",
+        "phpunit/phpunit": "^9.5",
+        "infection/infection": "^0.25.3",
+        "squizlabs/php_codesniffer": "^3.6",
+        "jetbrains/phpstorm-attributes": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Navarr\\Utils\\": "src"
+        }
+    }
+}

infection.json.dist

@@ -0,0 +1,13 @@
+{
+    "source": {
+        "directories": [
+            "src"
+        ]
+    },
+    "phpUnit": {
+        "configDir": "."
+    },
+    "mutators": {
+        "@default": true
+    }
+}

iterable_to_array.func.php

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+    <rule ref="PSR12"/>
+    <file>src</file>
+</ruleset>

phpcs.xml.dist

@@ -0,0 +1,4 @@
+parameters:
+    level: 9
+    paths:
+        - src

phpstan.neon

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <testsuite name="unit">
+        <directory>tests</directory>
+    </testsuite>
+    <coverage cacheDirectory="/tmp">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

phpunit.xml.dist

@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * Copyright (C) 2021 Navarr T. Barnier.  All rights reserved.
+ * Licensed under MIT License.
+ */
+
+declare(strict_types=1);
+
+namespace Navarr\Utils;
+
+use JetBrains\PhpStorm\Pure;
+use Traversable;
+
+use function is_array;
+use function iterator_to_array;
+
+class IterableToArray
+{
+    /**
+     * Converts any iterable into an array
+     *
+     * Designed to reduce boilerplate of testing if an iterable is an array before calling {@see iterator_to_array}
+     *
+     * @template T
+     * @param iterable<T> $iterable <p>
+     * The iterator being copied.
+     * </p>
+     * @param bool $preserve_keys [optional] <p>
+     * Whether to use the iterator element keys as index. If an array is passed, keys are always preserved.
+     * </p>
+     * @return array<T> An array containing the elements of the iterable.
+     */
+    #[Pure]
+    public static function convert(iterable $iterable, bool $preserve_keys = true): array
+    {
+        if (is_array($iterable)) {
+            return $iterable;
+        }
+
+        if ($iterable instanceof Traversable) {
+            return iterator_to_array($iterable, $preserve_keys);
+        }
+
+        // Fallback for supposedly impossible scenario
+        $result = [];
+        foreach ($iterable as $key => $value) {
+            if ($preserve_keys) {
+                $result[$key] = $value;
+                continue;
+            }
+            $result[] = $value;
+        }
+        return $result;
+    }
+}

src/IterableToArray.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * Copyright (C) 2021 Navarr T. Barnier.  All rights reserved.
+ * Licensed under MIT License.
+ */
+
+declare(strict_types=1);
+
+namespace Navarr\Utils;
+
+use ArrayIterator;
+use PHPUnit\Framework\TestCase;
+
+class IterableToArrayTest extends TestCase
+{
+    public function testConvertWithArray()
+    {
+        $array = ['a', 'b'];
+        $this->assertEquals($array, IterableToArray::convert(['a', 'b']));
+    }
+
+    public function testConvertWithIterator()
+    {
+        $iterator = new ArrayIterator(['a', 'b']);
+        $this->assertEquals(['a', 'b'], IterableToArray::convert($iterator));
+    }
+}