object.php ➔ satisfies() - Code Metrics - Inspection of "adding tests" - tarsana/functional - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5a66ad...309b32 )

by Amine

created 2016-11-22 21:24 UTC

object.php ➔ satisfies() A

↳ Parent: Project

Complexity

Conditions	2
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	1
nop	0
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php namespace Tarsana\Functional;
/**
 * This file contains some useful functions to handle objects (associative arrays are considered objects).
 */

/**
 * Returns a deep copy of the given value. `Callable`s are not copied but returned by reference.
 * ```php
 * $data = (object) [
 *     'content' => (object) ['name' => 'foo'],
 *     'other' => 'value'
 * ];
 *
 * $clonedData = clone_($data);
 * $clonedData->content->name = 'bar';
 *
 * $clonedData; // stdClass({content: {name: 'bar'}, other: 'value'})
 * $data; // stdClass({content: {name: 'foo'}, other: 'value'})
 * ```
 *
 * @signature a -> a
 * @param  mixed $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return mixed
 */
function clone_() {
    $clone = function($value) {
        switch (type($value)) {
            case 'Null':
            case 'Boolean':
            case 'String':
            case 'Function':
            case 'Resource':
            case 'Number':
                return $value;
            case 'ArrayObject':
            case 'Array':
            case 'List':
                return map(clone_(), $value);
            case 'Error':
            case 'Stream':
            case 'Object':
                $result = clone $value;
                foreach (keys($value) as $key) {
                    $result->{$key} = clone_($result->{$key});
                }
                return $result;
        }
        return $value;
    };
    return apply(curry($clone), func_get_args());
}

/**
 * Converts an object to an associative array containing public non-static
 * attributes. If `$object` is not an object, it is returned unchanged.
 * ```php
 * class foo {
 *     private $a;
 *     public $b = 1;
 *     public $c;
 *     private $d;
 *     static $e;
 * }
 *
 * $test = new foo;
 * attributes($test); // ['b' => 1, 'c' => null]
 * ```
 *
 * @signature {k: v} -> {k: v}
 * @param  object $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return array
 */
function attributes() {
    $attrs = function($object) {
        if (is_object($object))
            return get_object_vars($object);
        return $object;
    };
    return apply(curry($attrs), func_get_args());
}

/**
 * Returns a list of array's keys or object's public attributes names.
 * ```php
 * keys([1, 2, 3]); // [0, 1, 2]
 * keys(['name' => 'foo', 'age' => 11]); // ['name', 'age']
 * keys((object)['name' => 'foo', 'age' => 11]); // ['name', 'age']
 * ```
 *
 * @signature [*] -> [Number]
 * @signature {k: v} -> [k]
 */
function keys() {
    $keys = function($object) {
        return array_keys(attributes($object));
    };
    return apply(curry($keys), func_get_args());
}

/**
 * Returns a list of array's values or object's public attributes values.
 * ```php
 * values([1, 2, 3]); // [1, 2, 3]
 * values(['name' => 'foo', 'age' => 11]); // ['foo', 11]
 * values((object)['name' => 'foo', 'age' => 11]); // ['foo', 11]
 * ```
 *
 * @signature [a] -> [a]
 * @signature {k: v} -> [v]
 */
function values() {
    $values = function($object) {
        return array_values(attributes($object));
    };
    return apply(curry($values), func_get_args());
}

/**
 * Checks if the given array or object has a specific key or public attribute.
 * ```php
 * class Foo {
 *     public $a = 1;
 *     private $b = 2;
 *     protected $c = 3;
 *     public $d;
 * }
 * $array = [
 *     'type' => 'Array',
 *     'length' => 78
 * ];
 * $array[3] = 'three';
 * $object = (object) ['name' => 'ok'];
 *
 * $hasName = has('name');
 *
 * has('type', $array); // true
 * has(3, $array); // true
 * $hasName($array); // false
 * $hasName($object); // true
 * has('length', $object); // false
 * has('a', new Foo); // true
 * has('b', new Foo); // false (not a public attribute)
 * ```
 *
 * @signature k -> {k: v} -> Boolean
 * @param  string|int $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function has() {
    $has = function($name, $object){
        return contains($name, keys($object));
    };
    return apply(curry($has), func_get_args());
}

/**
 * Gets the value of a key from an array or the
 * value of an public attribute from an object.
 * If the key/attribute is missing, `null` is returned.
 * ```php
 * $data = [
 *     ['name' => 'foo', 'type' => 'test'],
 *     ['name' => 'bar', 'type' => 'test'],
 *     (object) ['name' => 'baz'],
 *     [1, 2, 3]
 * ];
 * $nameOf = get('name');
 * get(0, $data); // ['name' => 'foo', 'type' => 'test']
 * $nameOf($data[1]); // 'bar'
 * $nameOf($data[2]); // 'baz'
 * $nameOf($data[3]); // null
 * ```
 *
 * @signature k -> {k: v} -> Maybe(v)
 * @param  string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  array $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return mixed
 */
function get() {

    $get = function($name, $object){
        $object = attributes($object);
        return has($name, $object)
            ? $object[$name]
            : null;
    };
    return apply(curry($get), func_get_args());
}

/**
 * Gets a value from an array/object using a path of keys/attributes.
 * ```php
 * $data = [
 *     ['name' => 'foo', 'type' => 'test'],
 *     ['name' => 'bar', 'type' => 'test'],
 *     (object) ['name' => 'baz', 'scores' => [1, 2, 3]]
 * ];
 * $nameOfFirst = getPath([0, 'name']);
 * $nameOfFirst($data); // 'foo'
 * getPath([2, 'scores', 1]); // 2
 * ```
 *
 * @signature [k] -> {k: v} -> v
 * @param  array $path
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return mixed
 */
function getPath() {

    $getPath = function($path, $object){
        return reduce(function($result, $name) {
            if ($result !== null)
                $result = get($name, $result);
            return $result;
        }, $object, $path);
    };
    return apply(curry($getPath), func_get_args());
}

/**
 * Returns a new array or object with the value of a key or a public attribute set
 * to a specific value. if the key/attribute is missing and `$object` is an `array`
 * or `stdClass`; the key/attribute is added. Otherwise `null` is returned.
 * ```php
 * $task = ['name' => 'test', 'complete' => false];
 * $done = set('complete', true);
 * $done($task); // ['name' => 'test', 'complete' => true]
 * $done((object) $task); // stdClass({name: 'test', complete: true})
 * set('description', 'Some text here', $task); // ['name' => 'test', 'complete' => false, 'description' => 'Some text here']
 * ```
 *
 * @signature k -> v -> {k: v} -> {k: v}
 * @param  string|int $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return mixed
 */
function set() {
    $set = function($name, $value, $object) {
        $object = clone_($object);
        if (is_object($object))
            $object->{$name} = $value;
        else
            $object[$name] = $value;
        return $object;
    };
    return apply(curry($set), func_get_args());
}

/**
 * Checks if an attribute/value of an object/array passes the given predicate.
 * ```php
 * $foo = ['name' => 'foo', 'age' => 11];
 * $isAdult = satisfies(gt(__(), 18), 'age');
 * satisfies(startsWith('f'), 'name', $foo); // true
 * satisfies(startsWith('g'), 'name', $foo); // false
 * satisfies(startsWith('g'), 'friends', $foo); // false
 * $isAdult($foo); // false
 * ```
 *
 * @signature (a -> Boolean) -> k -> {k : a} -> Boolean
 * @param  callable $predicate
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string|int $key
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function satisfies() {
    $satisfies = function($predicate, $key, $object) {
        return has($key, $object) && $predicate(get($key, $object));
    };
    return apply(curry($satisfies), func_get_args());
}

/**
 * Checks if a list of attribute/value of an object/array passes all the given predicates.
 * ```php
 * $persons = [
 *     ['name' => 'foo', 'age' => 11],
 *     ['name' => 'bar', 'age' => 9],
 *     ['name' => 'baz', 'age' => 16],
 *     ['name' => 'zeta', 'age' => 33],
 *     ['name' => 'beta', 'age' => 25]
 * ];
 * 
 * $isValid = satisfiesAll([
 *     'name' => startsWith('b'),
 *     'age' => gt(__(), 15)
 * ]);
 * 
 * filter($isValid, $persons);
 * // [
 * //     ['name' => 'baz', 'age' => 16],
 * //     ['name' => 'beta', 'age' => 25]
 * // ]
 * ```
 *
 * @signature {String: (a -> Boolean)} -> {k : a} -> Boolean
 * @param  array $predicates
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function satisfiesAll() {

    $satisfiesAll = function($predicates, $object) {
        $predicates = map(function($pair) {
            return satisfies($pair[1], $pair[0]);
        }, toPairs($predicates));
        $predicates = apply(_f('all'), $predicates);
        return $predicates($object);
    };
    return apply(curry($satisfiesAll), func_get_args());
}

/**
 * Checks if a list of attribute/value of an object/array passes any of the given predicates.
 * ```php
 * $persons = [
 *     ['name' => 'foo', 'age' => 11],
 *     ['name' => 'bar', 'age' => 9],
 *     ['name' => 'baz', 'age' => 16],
 *     ['name' => 'zeta', 'age' => 33],
 *     ['name' => 'beta', 'age' => 25]
 * ];
 * 
 * $isValid = satisfiesAny([
 *     'name' => startsWith('b'),
 *     'age' => gt(__(), 15)
 * ]);
 * 
 * filter($isValid, $persons);
 * // [
 * //   ['name' => 'bar', 'age' => 9],
 * //   ['name' => 'baz', 'age' => 16],
 * //   ['name' => 'zeta', 'age' => 33],
 * //   ['name' => 'beta', 'age' => 25]
 * // ]
 * ```
 *
 * @signature {String: (a -> Boolean)} -> {k : a} -> Boolean
 * @param  array $predicates
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  mixed $object
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function satisfiesAny() {

    $satisfiesAny = function($predicates, $object) {
        $predicates = map(function($pair) {
            return satisfies($pair[1], $pair[0]);
        }, toPairs($predicates));
        $predicates = apply(_f('any'), $predicates);
        return $predicates($object);
    };
    return apply(curry($satisfiesAny), func_get_args());
}

/**
 * Converts an object or associative array to an array of [key, value] pairs.
 * ```php
 * $list = ['key' => 'value', 'number' => 53, 'foo', 'bar'];
 * toPairs($list); // [['key', 'value'], ['number', 53], [0, 'foo'], [1, 'bar']]
 * ```
 *
 * @signature {k: v} -> [(k,v)]
 * @param  array $object
 * @return array
 */
function toPairs($object) {
    $object = attributes($object);
    return map(function($key) use($object) {
        return [$key, $object[$key]];
    }, keys($object));
}


1			<?php namespace Tarsana\Functional;
2			/**
3			* This file contains some useful functions to handle objects (associative arrays are considered objects).
4			*/
5
6			/**
7			* Returns a deep copy of the given value. `Callable`s are not copied but returned by reference.
8			* ```php
9			* $data = (object) [
10			* 'content' => (object) ['name' => 'foo'],
11			* 'other' => 'value'
12			* ];
13			*
14			* $clonedData = clone_($data);
15			* $clonedData->content->name = 'bar';
16			*
17			* $clonedData; // stdClass({content: {name: 'bar'}, other: 'value'})
18			* $data; // stdClass({content: {name: 'foo'}, other: 'value'})
19			* ```
20			*
21			* @signature a -> a
22			* @param mixed $value
			0 ignored issues – show Bug introduced 2016-11-14 15:06 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
23			* @return mixed
24			*/
25			function clone_() {
26			$clone = function($value) {
27			switch (type($value)) {
28			case 'Null':
29			case 'Boolean':
30			case 'String':
31			case 'Function':
32			case 'Resource':
33			case 'Number':
34			return $value;
35			case 'ArrayObject':
36			case 'Array':
37			case 'List':
38			return map(clone_(), $value);
39			case 'Error':

tarsana / functional

Push — master ( 5a66ad...309b32 )

object.php ➔ satisfies() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like