Initial commit

Author: bpolaszek

.scrutinizer.yml

@@ -0,0 +1,32 @@
+filter:
+    excluded_paths: [tests/*]
+checks:
+    php:
+        code_rating: true
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+tools:
+    php_analyzer: true
+    php_code_coverage: false
+    php_code_sniffer:
+        config:
+            standard: PSR2
+        filter:
+            paths: ['src']
+    php_loc:
+        enabled: true
+        excluded_dirs: [vendor, tests]
+    php_cpd:
+        enabled: true
+        excluded_dirs: [vendor, tests]

.travis.yml

@@ -0,0 +1,22 @@
+language: php
+
+php:
+  - 5.3
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - 7.1
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer install --no-interaction --prefer-source --dev
+  - travis_retry phpenv rehash
+
+script:
+  - ./vendor/bin/phpcs --standard=psr2 src/
+  - mkdir -p build/logs
+  - ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+
+after_script:
+  - php vendor/bin/coveralls -v

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Benoit POLASZEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+[![Latest Stable Version](https://poser.pugx.org/bentools/iterable-functions/v/stable)](https://packagist.org/packages/bentools/iterable-functions)
+[![License](https://poser.pugx.org/bentools/iterable-functions/license)](https://packagist.org/packages/bentools/iterable-functions)
+[![Build Status](https://img.shields.io/travis/bpolaszek/php-iterable-functions/master.svg?style=flat-square)](https://travis-ci.org/bpolaszek/php-iterable-functions)
+[![Coverage Status](https://coveralls.io/repos/github/bpolaszek/php-iterable-functions/badge.svg?branch=master)](https://coveralls.io/github/bpolaszek/php-iterable-functions?branch=master)
+[![Quality Score](https://img.shields.io/scrutinizer/g/bpolaszek/php-iterable-functions.svg?style=flat-square)](https://scrutinizer-ci.com/g/bpolaszek/php-iterable-functions)
+[![Total Downloads](https://poser.pugx.org/bentools/iterable-functions/downloads)](https://packagist.org/packages/bentools/iterable-functions)
+
+Iterable functions
+==================
+
+Provides additional functions to work with [iterable](https://wiki.php.net/rfc/iterable) variables (even on PHP5.3+).
+
+is_iterable
+-----------
+To check wether or not a PHP variable can be looped over in a `foreach` statement, PHP provides an `is_iterable()` function.
+
+**But this function only works on PHP7.1+**.
+
+This library ships a portage of this function for previous PHP versions.
+
+Usage:
+```php
+var_dump(is_iterable(array('foo', 'bar'))); // true
+var_dump(is_iterable(new DirectoryIterator(__DIR__))); // true
+var_dump(is_iterable('foobar')); // false
+```
+
+iterable_to_array
+-----------------
+
+PHP offers an `iterator_to_array()` function to export any iterator into an array.
+
+**But when you want to transform an `iterable` to an array, the `iterable` itself can already be an array.**
+
+When using `iterator_to_array()` with an array, PHP5 triggers a E_RECOVERABLE_ERROR while PHP7 throws a `TypeError`.
+
+If you need an iterable-agnostic function, try our `iterable_to_array()`:
+
+```php
+var_dump(iterable_to_array(new ArrayIterator(array('foo', 'bar')))); // ['foo', 'bar']
+var_dump(iterable_to_array(array('foo', 'bar'))); // ['foo', 'bar']
+```
+
+Installation
+============
+
+With composer (they'll be autoloaded):
+```
+composer require bentools/iterable-functions
+```
+
+Or manually:
+```php
+require_once '/path/to/this/library/src/iterable-functions.php';
+```
+
+Unit tests
+==========
+```
+./vendor/bin/phpunit
+```

composer.json

@@ -0,0 +1,15 @@
+{
+    "name": "bentools/iterable-functions",
+    "description": "Provides functions for iterable variables: is_iterable(), iterable_to_array()",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "files": ["src/iterable-functions.php"]
+    },
+    "require": {
+        "php": ">=5.3"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "@stable"
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         beStrictAboutTestsThatDoNotTestAnything="true"
+         beStrictAboutOutputDuringTests="true"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         processIsolation="false"
+         stopOnError="false"
+         stopOnFailure="false"
+         verbose="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+           <file>tests/TestIsIterable.php</file>
+           <file>tests/TestIterableToArray.php</file>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/iterable-functions.php

@@ -0,0 +1,27 @@
+<?php
+
+if (!function_exists('is_iterable')) {
+
+    /**
+     * Check wether or not a variable is iterable (i.e array or \Traversable)
+     * @param array|\Traversable $iterable
+     * @return bool
+     */
+    function is_iterable($iterable)
+    {
+        return is_array($iterable) || $iterable instanceof \Traversable;
+    }
+}
+
+if (!function_exists('iterable_to_array')) {
+
+    /**
+     * Copy the iterable into an array. If the iterable is already an array, return it.
+     * @param array|\Traversable $iterable
+     * @return array
+     */
+    function iterable_to_array($iterable)
+    {
+        return is_array($iterable) ? $iterable : iterator_to_array($iterable);
+    }
+}

tests/TestIsIterable.php

@@ -0,0 +1,43 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class TestIsIterable extends TestCase
+{
+
+    public function testFunctionExists()
+    {
+        $this->assertTrue(function_exists('is_iterable'));
+    }
+
+    public function testArrayIsIterable()
+    {
+        $array = array('foo', 'bar');
+        $this->assertTrue(is_iterable($array));
+    }
+
+    public function testIteratorIsIterable()
+    {
+        $iterator = new DirectoryIterator(__DIR__);
+        $this->assertTrue(is_iterable($iterator));
+    }
+
+    public function testScalarIsNotIterable()
+    {
+        $scalar = 'foobar';
+        $this->assertFalse(is_iterable($scalar));
+    }
+
+    public function testObjectIsNotIterable()
+    {
+        $object = new \stdClass();
+        $this->assertFalse(is_iterable($object));
+    }
+
+    public function testResourceIsNotIterable()
+    {
+        $resource = fopen('php://temp', 'rb');
+        $this->assertFalse(is_iterable($resource));
+    }
+
+}

tests/TestIterableToArray.php

@@ -0,0 +1,79 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class TestIterableToArray extends TestCase
+{
+
+    public function testFunctionExists()
+    {
+        $this->assertTrue(function_exists('iterable_to_array'));
+    }
+
+    public function testIteratorToArray()
+    {
+        $iterator = new ArrayIterator(array('foo', 'bar'));
+        $this->assertEquals(array('foo', 'bar'), iterable_to_array($iterator));
+    }
+
+    public function testArrayToArray()
+    {
+        $array = array('foo', 'bar');
+        $this->assertEquals(array('foo', 'bar'), iterable_to_array($array));
+    }
+
+    public function testScalarToArray()
+    {
+        $scalar = 'foobar';
+        $this->assertTrue($this->triggersError($scalar));
+    }
+
+    public function testObjectToArray()
+    {
+        $object = new stdClass();
+        $this->assertTrue($this->triggersError($object));
+    }
+
+    public function testResourceToArray()
+    {
+        $resource = fopen('php://temp', 'rb');
+        $this->assertTrue($this->triggersError($resource));
+    }
+
+    private function triggersError($input)
+    {
+        return version_compare(PHP_VERSION, '7.0.0') >= 0 ? $this->triggersErrorPHP7($input) : $this->triggersErrorPHP5($input);
+    }
+
+    private function triggersErrorPHP7($input)
+    {
+        $errorOccured = false;
+
+        try {
+            iterable_to_array($input);
+        }
+        catch (\TypeError $e) {
+            $errorOccured = true;
+        }
+
+        return $errorOccured;
+    }
+
+    private function triggersErrorPHP5($input)
+    {
+        $errorOccured = false;
+
+        set_error_handler(function ($errno) {
+            return E_RECOVERABLE_ERROR === $errno;
+        });
+
+        if (false === @iterable_to_array($input)) {
+            $errorOccured = true;
+        }
+
+        restore_error_handler();
+
+        return $errorOccured;
+    }
+
+}