conversions.php ➔ mixed_to_iterator() - Code Metrics - Inspection of "Feature/code coverage" - zicht/itertools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

unknown

created 2017-01-31 17:08 UTC

conversions.php ➔ mixed_to_iterator() C

↳ Parent: Project

Complexity

Conditions	8
Paths	64

Size

Total Lines	35
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	8

Importance

Changes

Metric	Value
cc	8
eloc	14
nc	64
nop	1
dl	0
loc	35
ccs	13
cts	13
cp	1
crap	8
rs	5.3846
c	0
b	0
f	0

<?php
/**
 * @author Boudewijn Schoon <[email protected]>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Itertools\conversions;

use Doctrine\Common\Collections\Collection;
use Zicht\Itertools\lib\StringIterator;

/**
 * Transforms anything into an Iterator or throws an InvalidArgumentException
 *
 * > mixedToIterator([1, 2, 3])
 * 1 2 3
 *
 * > mixedToIterator('foo')
 * f o o
 *
 * @param array|string|\Iterator $iterable
 * @return \Iterator
 */
function mixed_to_iterator($iterable)
{
    // NULL is often used to indicate that nothing is there,
    // for robustness we will deal with NULL as it is an empty array
    if (is_null($iterable)) {
        $iterable = new \ArrayIterator([]);
    }

    // an array is *not* an instance of Traversable (as it is not an
    // object and hence can not 'implement Traversable')
    if (is_array($iterable)) {
        $iterable = new \ArrayIterator($iterable);
    }

    // a string is considered iterable in Python
    if (is_string($iterable)) {
        $iterable = new StringIterator($iterable);
    }

    // a doctrine Collection (i.e. Array or Persistent) is also an iterator
    if ($iterable instanceof Collection) {
        $iterable = $iterable->getIterator();
    }

    if ($iterable instanceof \Traversable and !($iterable instanceof \Iterator)) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
        $iterable = new \IteratorIterator($iterable);
    }

    // by now it should be an Iterator, otherwise throw an exception
    if (!($iterable instanceof \Iterator)) {
        throw new \InvalidArgumentException('Argument $ITERABLE must be a Traversable');
    }

    return $iterable;
}

/**
 * Try to transforms something into a Closure.
 *
 * When $CLOSURE is null the returned Closure behaves like an identity function,
 * i.e. it will return the value that it is given.
 *
 * @param null|array|\Closure $closure
 * @return \Closure
 */
function mixed_to_closure($closure)
{
    if (is_null($closure)) {
        return function ($value) {
            return $value;
        };
    }

    if (!($closure instanceof \Closure)) {

        // A \Closure is always callable, but a callable is not always a \Closure.
        // Checking within this if statement is a slight optimization, preventing an unnecessary function wrap
        if (is_callable($closure)) {
            $closure = function () use ($closure) {
                return call_user_func_array($closure, func_get_args());
            };
        } else {
            throw new \InvalidArgumentException('Argument $CLOSURE must be a Closure');
        }
    }

    return $closure;
}

/**
 * Try to transforms something into a Closure that gets a value from $STRATEGY.
 *
 * When $STRATEGY is null the returned Closure behaves like an identity function,
 * i.e. it will return the value that it is given.
 *
 * When $STRATEGY is a string the returned Closure tries to find a properties,
 * methods, or array indexes named by the string.  Multiple property, method,
 * or index names can be separated by a dot.
 * - 'getId'
 * - 'getData.key'
 *
 * When $STRATEGY is callable it is converted into a Closure (see mixedToClosure).
 *
 * @param null|string|\Closure $strategy
 * @return \Closure
 */
function mixed_to_value_getter($strategy)
{
    if (is_string($strategy)) {
        $keyParts = explode('.', $strategy);
        $strategy = function ($value) use ($keyParts) {
            foreach ($keyParts as $keyPart) {
                if (is_object($value)) {
                    // property_exists does not distinguish between public, protected, or private properties, hence we need to use reflection
                    $reflection = new \ReflectionObject($value);
                    if ($reflection->hasProperty($keyPart)) {
                        $property = $reflection->getProperty($keyPart);
                        if ($property->isPublic()) {
                            $value = $property->getValue($value);
                            continue;
                        }
                    }
                }

                if (is_callable([$value, $keyPart])) {
                    $value = call_user_func([$value, $keyPart]);
                    continue;
                }

                if (is_array($value) && array_key_exists($keyPart, $value)) {
                    $value = $value[$keyPart];
                    continue;
                }

                if (is_object($value) && method_exists($value, '__get')) {
                    $value = $value->$keyPart;
                    continue;
                }

                // no match found
                $value = null;
                break;
            }

            return $value;
        };
    }

    return mixed_to_closure($strategy);
}

/**
 * Transforms anything into an Iterator or throws an InvalidArgumentException
 *
 * @param array|string|\Iterator $iterable
 * @return \Iterator
 * @deprecated Use mixed_to_iterator() instead, will be removed in version 3.0
 */
function mixedToIterator($iterable)
{
    return mixed_to_iterator($iterable);
}


/**
 * Try to transforms something into a Closure.
 *
 * @param null|\Closure $closure
 * @return \Closure
 * @deprecated Use mixed_to_closure() instead, will be removed in version 3.0
 */
function mixedToClosure($closure)
{
    return mixed_to_closure($closure);
}


/**
 * Try to transforms something into a Closure that gets a value from $STRATEGY.
 *
 * @param null|string|\Closure $strategy
 * @return \Closure
 * @deprecated Use mixed_to_closure() instead, will be removed in version 3.0
 */
function mixedToValueGetter($strategy)
{
    return mixed_to_value_getter($strategy);
}


zicht / itertools

Pull Request — master (#18)

conversions.php ➔ mixed_to_iterator() C

Complexity

Size

Duplication

Code Coverage

Importance

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like