functions.php ➔ f() - Code Metrics - Inspection of "wip" - tarsana/functional - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 713d54...d55531 )

by Amine

created 2016-11-13 22:09 UTC

functions.php ➔ f() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php namespace Tarsana\Functional;
/**
 * This file contains functions dealing with functions.
 */

use Tarsana\Functional\Exceptions\InvalidArgument;

/**
 * Returns a curried equivalent of the provided function.
 * ```php
 * $add = curry(function($x, $y){
 *     return $x + $y;
 * });
 * $addFive = $add(5); // a function
 * $addFive(5); // 10
 * $add(5, 5) // 10
 * ```
 *
 * @signature (* -> a) -> (* -> a)
 * @param  callable $fn
 * @return callable
 */
function curry(callable $fn) {
    return \Cypress\Curry\curry($fn);
}

/**
 * Argument placeholder to use with curried functions.
 * ```php
 * $minus = curry(function ($x, $y) { return $x - $y; });
 * $decrement = $minus(__(), 1);
 * $decrement(10) // 9
 *
 * $reduce = curry('array_reduce');
 * $sum = $reduce(__(), 'Tarsana\Functional\plus');
 * $sum([1, 2, 3, 4], 0) // 10
 * ```
 *
 * @signature * -> Placeholder
 * @return \Cypress\Curry\Placeholder
 */
function __() {
    return \Cypress\Curry\__();
}

/**
 * Non curried version of apply for internal use.
 *
 * @internal
 * @param  callable $fn
 * @param  array    $args
 * @return mixed
 */
function _apply($fn, $args) {
    return call_user_func_array($fn, $args);
}

/**
 * Apply the provided function to the list of arguments.
 * ```php
 * apply('strlen', ['Hello']) // 5
 * $replace = apply('str_replace');
 * $replace(['l', 'o', 'Hello']) // 'Heooo'
 * ```
 *
 * @signature (*... -> a) -> [*] -> a
 * @param  callable $fn
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  array    $args
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return mixed
 */
function apply() {
    return _apply(curry('Tarsana\Functional\_apply'), func_get_args());
}

/**
 * Performs left-to-right function composition.
 * The leftmost function may have any arity;
 * the remaining functions must be unary.
 * The result of pipe is curried.
 * **Calling pipe() without any argument throws Tarsana\Functional\Exceptions\InvalidArgument**
 * ```php
 * function add($x, $y) { return $x + $y; }
 * $double = function($x) { return 2 * $x; };
 * $addThenDouble = pipe('add', $double);
 * $addThenDouble(2, 3) // 10
 * ```
 *
 * @signature (((a, b, ...) -> o), (o -> p), ..., (y -> z)) -> ((a, b, ...) -> z)
 * @param  callable ...$fns
 * @return callable
 */
function pipe() {
    $fns = func_get_args();
    if(count($fns) < 1)
        throw new InvalidArgument("pipe() requires at least one argument");
    return curry(function () use ($fns) {
        $result = _apply(array_shift($fns), func_get_args());
        foreach ($fns as $fn) {
            $result = $fn($result);
        }
        return $result;
    });
}

/**
 * A function that takes one argument and
 * returns exactly the given argument.
 * ```php
 * identity('Hello') // 'Hello'
 * identity([1, 2, 3]) // [1, 2, 3]
 * identity(null) // null
 * ```
 *
 * @signature * -> *
 * @return mixed
 */
function identity() {
    return apply(curry(function($value) {
        return $value;
    }), func_get_args());
}

1			<?php namespace Tarsana\Functional;
2			/**
3			* This file contains functions dealing with functions.
4			*/
5
6			use Tarsana\Functional\Exceptions\InvalidArgument;
7
8			/**
9			* Returns a curried equivalent of the provided function.
10			* ```php
11			* $add = curry(function($x, $y){
12			* return $x + $y;
13			* });
14			* $addFive = $add(5); // a function
15			* $addFive(5); // 10
16			* $add(5, 5) // 10
17			* ```
18			*
19			* @signature (* -> a) -> (* -> a)
20			* @param callable $fn
21			* @return callable
22			*/
23			function curry(callable $fn) {
24			return \Cypress\Curry\curry($fn);
25			}
26
27			/**
28			* Argument placeholder to use with curried functions.
29			* ```php
30			* $minus = curry(function ($x, $y) { return $x - $y; });
31			* $decrement = $minus(__(), 1);
32			* $decrement(10) // 9
33			*
34			* $reduce = curry('array_reduce');
35			* $sum = $reduce(__(), 'Tarsana\Functional\plus');
36			* $sum([1, 2, 3, 4], 0) // 10
37			* ```
38			*
39			* @signature * -> Placeholder
40			* @return \Cypress\Curry\Placeholder
41			*/
42			function __() {
43			return \Cypress\Curry\__();
44			}
45
46			/**
47			* Non curried version of apply for internal use.
48			*
49			* @internal
50			* @param callable $fn
51			* @param array $args
52			* @return mixed
53			*/
54			function _apply($fn, $args) {
55			return call_user_func_array($fn, $args);
56			}
57
58			/**
59			* Apply the provided function to the list of arguments.
60			* ```php
61			* apply('strlen', ['Hello']) // 5
62			* $replace = apply('str_replace');
63			* $replace(['l', 'o', 'Hello']) // 'Heooo'
64			* ```
65			*
66			* @signature (... -> a) -> [] -> a
67			* @param callable $fn
			0 ignored issues – show Bug introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report There is no parameter named `$fn`. 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...
68			* @param array $args
			0 ignored issues – show Bug introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report There is no parameter named `$args`. 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...
69			* @return mixed
70			*/
71			function apply() {
72			return _apply(curry('Tarsana\Functional\_apply'), func_get_args());
73			}
74
75			/**
76			* Performs left-to-right function composition.
77			* The leftmost function may have any arity;
78			* the remaining functions must be unary.
79			* The result of pipe is curried.
80			* Calling pipe() without any argument throws Tarsana\Functional\Exceptions\InvalidArgument
81			* ```php
82			* function add($x, $y) { return $x + $y; }
83			* $double = function($x) { return 2 * $x; };
84			* $addThenDouble = pipe('add', $double);
85			* $addThenDouble(2, 3) // 10
86			* ```
87			*
88			* @signature (((a, b, ...) -> o), (o -> p), ..., (y -> z)) -> ((a, b, ...) -> z)
89			* @param callable ...$fns
90			* @return callable
91			*/
92			function pipe() {
93			$fns = func_get_args();
94			if(count($fns) < 1)
95			throw new InvalidArgument("pipe() requires at least one argument");
96			return curry(function () use ($fns) {
97			$result = _apply(array_shift($fns), func_get_args());
98			foreach ($fns as $fn) {
99			$result = $fn($result);
100			}
101			return $result;
102			});
103			}
104
105			/**
106			* A function that takes one argument and
107			* returns exactly the given argument.
108			* ```php
109			* identity('Hello') // 'Hello'
110			* identity([1, 2, 3]) // [1, 2, 3]
111			* identity(null) // null
112			* ```
113			*
114			* @signature * -> *
115			* @return mixed
116			*/
117			function identity() {
118			return apply(curry(function($value) {
119			return $value;
120			}), func_get_args());
121			}

tarsana / functional

Push — master ( 713d54...d55531 )

functions.php ➔ f() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like