tarsana / functional

src/functions.php

Doc Comments -2 removed lines

@@ -64,8 +64,6 @@
  * ```
  *
  * @signature (*... -> a) -> [*] -> a
- * @param  callable $fn
- * @param  array    $args
  * @return mixed
  */
 function apply() {

Braces +3 added lines, -2 removed lines

@@ -91,8 +91,9 @@
  */
 function pipe() {
     $fns = func_get_args();
-    if(count($fns) < 1)
-        throw new InvalidArgument("pipe() requires at least one argument");
+    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) {

src/math.php

Doc Comments -10 removed lines

@@ -11,8 +11,6 @@ 
  * ```
  *
  * @signature Number -> Number -> Number
- * @param  int|float $x
- * @param  int|float $y
  * @return int|float
  */
 function plus() {
@@ -29,8 +27,6 @@ 
  * ```
  *
  * @signature Number -> Number -> Number
- * @param  int|float $x
- * @param  int|float $y
  * @return int|float
  */
 function minus() {
@@ -63,8 +59,6 @@ 
  * ```
  *
  * @signature Number -> Number -> Number
- * @param  int|float $x
- * @param  int|float $y
  * @return int|float
  */
 function multiply() {
@@ -81,8 +75,6 @@ 
  * ```
  *
  * @signature Number -> Number -> Number
- * @param  int|float $x
- * @param  int|float $y
  * @return int|float
  */
 function divide() {
@@ -99,8 +91,6 @@ 
  * ```
  *
  * @signature Number -> Number -> Number
- * @param  int|float $x
- * @param  int|float $y
  * @return int|float
  */
 function modulo() {

src/Stream.php

Doc Comments +1 added lines, -2 removed lines

@@ -94,6 +94,7 @@ 
      *
      * @param  mixed $data
      * @param  array $operations
+     * @param boolean $type
      * @return Stream
      */
     protected static function with ($data, $operations, $type)
@@ -414,7 +415,6 @@ 
      *
      * @signature Stream(a) -> (String, ...) -> Stream(*)
      * @param  string $method
-     * @param  mixed|null $args...
      * @return Stream
      */
     public function call ($method)
@@ -468,7 +468,6 @@ 
      *
      * @signature Stream(a) -> (String, ...) -> Stream(a)
      * @param  string $method
-     * @param  mixed|null $args...
      * @return Stream
      */
     public function run ($method)

Braces +18 added lines, -12 removed lines

@@ -84,8 +84,9 @@ 
     public static function of ($data)
     {
         $data = func_get_args();
-        if (count($data) == 1)
-            $data = $data[0];
+        if (count($data) == 1) {
+                    $data = $data[0];
+        }
         return new Stream($data, [], type($data));
     }
 
@@ -122,8 +123,9 @@ 
      */
     protected static function execute ($operations, $data)
     {
-        if (length($operations) == 0)
-            return $data;
+        if (length($operations) == 0) {
+                    return $data;
+        }
         $operations = apply('Tarsana\\Functional\\pipe', map(function($operation){
             if ($operation['name'] == 'apply') {
                 return $operation['args'];
@@ -234,8 +236,9 @@ 
      */
     public function get ()
     {
-        if ($this->type == 'Error')
-            return $this->data;
+        if ($this->type == 'Error') {
+                    return $this->data;
+        }
         return Stream::execute($this->operations, $this->data);
     }
 
@@ -421,11 +424,13 @@ 
     {
         $args = tail(func_get_args());
         return Stream::apply('apply', function($data) use($method, $args) {
-            if (is_callable([$data, $method]))
-                return call_user_func_array([$data, $method], $args);
+            if (is_callable([$data, $method])) {
+                            return call_user_func_array([$data, $method], $args);
+            }
             $text = toString($data);
-            if (method_exists($data, $method))
-                return Error::of("Method '{$method}' of {$text} is not accessible");
+            if (method_exists($data, $method)) {
+                            return Error::of("Method '{$method}' of {$text} is not accessible");
+            }
             return Error::of("Method '{$method}' of {$text} is not found");
         }, $this);
     }
@@ -480,8 +485,9 @@ 
                 return $data;
             }
             $text = toString($data);
-            if (method_exists($data, $method))
-                return Error::of("Method '{$method}' of {$text} is not accessible");
+            if (method_exists($data, $method)) {
+                            return Error::of("Method '{$method}' of {$text} is not accessible");
+            }
             return Error::of("Method '{$method}' of {$text} is not found");
         }, $this);
     }

src/string.php

Doc Comments -25 removed lines

@@ -11,8 +11,6 @@ 
  * ```
  *
  * @signature String -> String -> [String]
- * @param string $delimiter
- * @param string $string
  * @return array
  */
 function split() {
@@ -27,8 +25,6 @@ 
  * ```
  *
  * @signature String -> [String] -> String
- * @param string $glue
- * @param array $pieces
  * @return string
  */
 function join() {
@@ -48,9 +44,6 @@ 
  * ```
  *
  * @signature String|[String] -> String -> String|[String] -> String
- * @param  string $search
- * @param  string $replacement
- * @param  string $string
  * @return string
  */
 function replace() {
@@ -66,9 +59,6 @@ 
  * ```
  *
  * @signature String -> String -> String -> String
- * @param  string $pattern
- * @param  string $replacement
- * @param  string $string
  * @return string
  */
 function regReplace() {
@@ -131,8 +121,6 @@ 
  * ```
  *
  * @signature String -> String -> String
- * @param  string $delimiter
- * @param  string $string
  * @return string
  */
 function snakeCase() {
@@ -158,8 +146,6 @@ 
  * ```
  *
  * @signature String -> String -> Boolean
- * @param  string $token
- * @param  string $string
  * @return bool
  */
 function startsWith() {
@@ -181,8 +167,6 @@ 
  * ```
  *
  * @signature String -> String -> Boolean
- * @param  string $token
- * @param  string $string
  * @return bool
  */
 function endsWith() {
@@ -204,8 +188,6 @@ 
  * ```
  *
  * @signature String -> String -> Boolean
- * @param  string $pattern
- * @param  string $string
  * @return bool
  */
 function test() {
@@ -225,8 +207,6 @@ 
  * ```
  *
  * @signature String -> String -> [String]
- * @param  string $pattern
- * @param  string $string
  * @return array
  */
 function match() {
@@ -247,8 +227,6 @@ 
  * ```
  *
  * @signature String -> String -> Number
- * @param  string $token
- * @param  string $text
  * @return int
  */
 function occurences() {
@@ -271,9 +249,6 @@ 
  * ```
  *
  * @signature String -> String -> String -> [String]
- * @param  string $surrounders
- * @param  string $separator
- * @param  sring $text
  * @return array
  */
 function chunks() {

src/Error.php

Braces +3 added lines, -2 removed lines

@@ -37,8 +37,9 @@
      */
     protected function __construct ($message, Error $error = null)
     {
-        if (null != $error)
-            $message = $error->message() . ' -> ' . $message;
+        if (null != $error) {
+                    $message = $error->message() . ' -> ' . $message;
+        }
         $this->message = $message;
     }
 

src/common.php

Braces +33 added lines, -13 removed lines

@@ -27,22 +27,42 @@
  * @return string
  */
 function type($data) {
-    if (null === $data) return 'Null';
-    if (true === $data || false === $data) return 'Boolean';
-    if ($data instanceof Error) return 'Error';
-    if ($data instanceof Stream) return 'Stream';
-    if (is_callable($data)) return 'Function';
-    if (is_resource($data)) return 'Resource';
-    if (is_string($data)) return 'String';
-    if (is_integer($data) || is_float($data)) return 'Number';
+    if (null === $data) {
+        return 'Null';
+    }
+    if (true === $data || false === $data) {
+        return 'Boolean';
+    }
+    if ($data instanceof Error) {
+        return 'Error';
+    }
+    if ($data instanceof Stream) {
+        return 'Stream';
+    }
+    if (is_callable($data)) {
+        return 'Function';
+    }
+    if (is_resource($data)) {
+        return 'Resource';
+    }
+    if (is_string($data)) {
+        return 'String';
+    }
+    if (is_integer($data) || is_float($data)) {
+        return 'Number';
+    }
     if (is_array($data)) {
-        if (all('is_numeric', array_keys($data)))
-            return 'List';
-        if (all('is_string', array_keys($data)))
-            return 'ArrayObject';
+        if (all('is_numeric', array_keys($data))) {
+                    return 'List';
+        }
+        if (all('is_string', array_keys($data))) {
+                    return 'ArrayObject';
+        }
         return 'Array';
     }
-    if (is_object($data)) return 'Object';
+    if (is_object($data)) {
+        return 'Object';
+    }
     return 'Unknown';
 }
 

generate-docs.php

Braces +16 added lines, -11 removed lines

@@ -67,13 +67,16 @@ 
 // Extracts the type of a block
 // Object -> String
 function typeOf($data) {
-    if (isset($data->ctx->type))
-        return $data->ctx->type;
-    if (F\length(tags('var', $data)) > 0)
-        return 'attr';
-    if (F\length(tags('return', $data)) > 0)
-        return 'method';
-}
+    if (isset($data->ctx->type)) {
+            return $data->ctx->type;
+    }
+    if (F\length(tags('var', $data)) > 0) {
+            return 'attr';
+    }
+    if (F\length(tags('return', $data)) > 0) {
+            return 'method';
+    }
+    }
 
 // Extract keywords
 // Object -> [String]
@@ -82,8 +85,9 @@ 
         return [];
     }
     $size = strpos($data->code, '(');
-    if ($size === false)
-        $size = strlen($data->code);
+    if ($size === false) {
+            $size = strlen($data->code);
+    }
     $keywords = F\pipe(
         F\take($size),
         F\split(' '),
@@ -124,8 +128,9 @@ 
 // Get a markdown code block
 // String -> String -> String
 function code($lang, $text) {
-    if(trim($text) == '')
-        return '';
+    if(trim($text) == '') {
+            return '';
+    }
     return "```{$lang}\n{$text}\n```";
 }
 

src/list.php

Doc Comments -70 removed lines

@@ -11,8 +11,6 @@ 
  * ```
  *
  * @signature (a -> b) -> [a] -> [b]
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function map() {
@@ -31,8 +29,6 @@ 
  * ```
  *
  * @signature (a -> [b]) -> [a] -> [b]
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function chain() {
@@ -51,8 +47,6 @@ 
  * $numeric($list) // [1, 3]
  * ```
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function filter() {
@@ -72,9 +66,6 @@ 
  * ```
  *
  * @signature (* -> a -> *) -> * -> [a] -> *
- * @param  callable $fn
- * @param  mixed $initial
- * @param  array $list
  * @return array
  */
 function reduce() {
@@ -99,8 +90,6 @@ 
  * ```
  *
  * @signature (a -> *) -> [a] -> [a]
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function each() {
@@ -252,8 +241,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> Boolean
- * @param  callable $predicate
- * @param  array $list
  * @return bool
  */
 function all() {
@@ -273,8 +260,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> Boolean
- * @param  callable $predicate
- * @param  array $list
  * @return bool
  */
 function any() {
@@ -293,8 +278,6 @@ 
  *
  * @signature [*] -> [*] -> [*]
  * @signature String -> String -> String
- * @param  array $list1
- * @param  array $list2
  * @return array
  */
 function concat() {
@@ -314,7 +297,6 @@ 
  * ```
  *
  * @signature [[a]] -> [a]
- * @param  array $lists
  * @return array
  */
 function concatAll() {
@@ -338,9 +320,6 @@ 
  *
  * @signature Number -> a -> [a] -> [a]
  * @signature Number -> String -> String -> String
- * @param  int $position
- * @param  mixed $item
- * @param  array $list
  * @return array
  */
 function insert() {
@@ -365,9 +344,6 @@ 
  *
  * @signature Number -> [a] -> [a] -> [a]
  * @signature Number -> String -> String -> String
- * @param  int $position
- * @param  mixed $items
- * @param  array $list
  * @return array
  */
 function insertAll() {
@@ -388,8 +364,6 @@ 
  *
  * @signature * -> [*] -> [*]
  * @signature String -> String -> String
- * @param  mixed $item
- * @param  array $list
  * @return array
  */
 function append() {
@@ -409,8 +383,6 @@ 
  *
  * @signature a -> [a] -> [a]
  * @signature String -> String -> String
- * @param  mixed $item
- * @param  array $list
  * @return array
  */
 function prepend() {
@@ -431,8 +403,6 @@ 
  *
  * @signature Number -> [a] -> [a]
  * @signature Number -> String -> String
- * @param  int $count
- * @param  array $list
  * @return array
  */
 function take() {
@@ -461,8 +431,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeWhile() {
@@ -485,8 +453,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeLastWhile() {
@@ -510,8 +476,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeUntil() {
@@ -530,8 +494,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeLastUntil() {
@@ -556,8 +518,6 @@ 
  *
  * @signature Number -> [a] -> [a]
  * @signature Number -> String -> String
- * @param  int $count
- * @param  array $list
  * @return array
  */
 function remove() {
@@ -582,8 +542,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeWhile() {
@@ -602,8 +560,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeLastWhile() {
@@ -624,8 +580,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeUntil() {
@@ -645,8 +599,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeLastUntil() {
@@ -663,7 +615,6 @@ 
  * ```
  *
  * @signature [(k, v)] -> {k: v}
- * @param  array $pairs
  * @return stdClass
  */
 function fromPairs() {
@@ -689,8 +640,6 @@ 
  *
  * @signature Number -> [a] -> [[a]]
  * @signature Number -> String -> [String]
- * @param  int $size
- * @param  array $list
  * @return array
  */
 function slices() {
@@ -715,8 +664,6 @@ 
  *
  * @signature a -> [a] -> Boolean
  * @signature String -> String -> Boolean
- * @param  mixed $item
- * @param  array|string $list
  * @return bool
  */
 function contains() {
@@ -737,8 +684,6 @@ 
  *
  * @signature (a -> Boolean) -> [a] -> Maybe(Number)
  * @signature (v -> Boolean) -> {k: v} -> Maybe(k)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function findIndex() {
@@ -763,8 +708,6 @@ 
  *
  * @signature (a -> Boolean) -> [a] -> Maybe(Number)
  * @signature (v -> Boolean) -> {k: v} -> Maybe(k)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function findLastIndex() {
@@ -787,8 +730,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> Maybe(a)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function find() {
@@ -807,8 +748,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> Maybe(a)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function findLast() {
@@ -834,8 +773,6 @@ 
  * @signature a -> [a] -> Maybe(Number) 
  * @signature v -> {k: v} -> Maybe(k)
  * @signature String -> String -> Maybe(Number)
- * @param  mixed $item
- * @param  array $list
  * @return int
  */
 function indexOf() {
@@ -863,8 +800,6 @@ 
  *
  * @signature a -> [a] -> Number 
  * @signature String -> String -> Number
- * @param  mixed $item
- * @param  array $list
  * @return int
  */
 function lastIndexOf() {
@@ -888,8 +823,6 @@ 
  * ```
  *
  * @signature (a -> a -> Boolean) -> [a] -> [a]
- * @param  callable $areEqual
- * @param  array $list
  * @return array
  */
 function uniqueBy() {
@@ -917,7 +850,6 @@ 
  * ```
  *
  * @signature [a] -> [a]
- * @param  array $list
  * @return array
  */
 function unique() {
@@ -951,8 +883,6 @@ 
  * ```
  *
  * @signature (a -> String) -> [a] -> {String: a}
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function groupBy() {

Braces +39 added lines, -26 removed lines

@@ -128,8 +128,9 @@ 
  * @return mixed
  */
 function head($list) {
-    if(is_string($list))
-        return substr($list, 0, 1);
+    if(is_string($list)) {
+            return substr($list, 0, 1);
+    }
     return (count($list) > 0)
         ? $list[0]
         : null;
@@ -150,8 +151,9 @@ 
  * @return mixed
  */
 function last($list) {
-    if(is_string($list))
-        return substr($list, -1);
+    if(is_string($list)) {
+            return substr($list, -1);
+    }
     return (count($list) > 0)
         ? $list[count($list) - 1]
         : null;
@@ -173,10 +175,11 @@ 
  * @return array
  */
 function init($list) {
-    if(is_string($list))
-        return (strlen($list) > 1)
+    if(is_string($list)) {
+            return (strlen($list) > 1)
             ? substr($list, 0, strlen($list) - 1)
             : '';
+    }
     return (count($list) > 1)
         ? array_slice($list, 0, count($list) - 1)
         : [];
@@ -198,10 +201,11 @@ 
  * @return array
  */
 function tail($list) {
-    if(is_string($list))
-        return (strlen($list) > 1)
+    if(is_string($list)) {
+            return (strlen($list) > 1)
             ? substr($list, 1)
             : '';
+    }
     return (count($list) > 1)
         ? array_slice($list, 1)
         : [];
@@ -299,8 +303,9 @@ 
  */
 function concat() {
     $concat = function($list1, $list2) {
-        if (is_string($list1))
-            return $list1 . $list2;
+        if (is_string($list1)) {
+                    return $list1 . $list2;
+        }
         return array_merge($list1, $list2);
     };
     return apply(curry($concat), func_get_args());
@@ -372,8 +377,9 @@ 
  */
 function insertAll() {
     $insertAll = function($position, $items, $list) {
-        if ($position < 0)
-            $position = length($list) - $position;
+        if ($position < 0) {
+                    $position = length($list) - $position;
+        }
         return concatAll([take($position, $list), $items, remove($position, $list)]);
     };
     return apply(curry($insertAll), func_get_args());
@@ -437,8 +443,9 @@ 
  */
 function take() {
     $take = function($count, $list) {
-        if ($count > $length || $count < -$length)
-            return [];
+        if ($count > $length || $count < -$length) {
+                    return [];
+        }
         if(is_string($list)) {
             return ($count >= 0)
                 ? substr($list, 0, $count)
@@ -563,8 +570,9 @@ 
 function remove() {
     $remove = function($count, $list) {
         $length = length($list);
-        if ($count > $length || $count < -$length)
-            return [];
+        if ($count > $length || $count < -$length) {
+                    return [];
+        }
         return ($count > 0) 
             ? take($count - $length)
             : take($count + $length);
@@ -695,10 +703,12 @@ 
  */
 function slices() {
     $slices = function($size, $list) {
-        if(empty($list))
-            return is_string($list) ? '' : [];
-        if(length($list) <= $size)
-            return [$list];
+        if(empty($list)) {
+                    return is_string($list) ? '' : [];
+        }
+        if(length($list) <= $size) {
+                    return [$list];
+        }
         return prepend(take($size, $list), slices($size, remove($size, $list)));
     };
     return apply(curry($slices), func_get_args());
@@ -744,8 +754,9 @@ 
 function findIndex() {
     $findIndex = function($predicate, $list) {
         foreach ($list as $key => $value) {
-            if ($predicate($value))
-                return $key;
+            if ($predicate($value)) {
+                            return $key;
+            }
         }
         return null;
     };
@@ -770,8 +781,9 @@ 
 function findLastIndex() {
     $findLastIndex = function($predicate, $list) {
         foreach (reverse(toPairs($list)) as $pair) {
-            if($predicate($pair[1]))
-                return $pair[0];
+            if($predicate($pair[1])) {
+                            return $pair[0];
+            }
         }
         return null;
     };
@@ -959,8 +971,9 @@ 
     $groupBy = function($fn, $list) {
         return reduce(function($result, $item) use($fn) {
             $index = $fn($item);
-            if (! isset($result[$index]))
-                $result[$index] = [];
+            if (! isset($result[$index])) {
+                            $result[$index] = [];
+            }
             $result[$index][] = $item;
             return $result;
         }, [], $list);

src/object.php

Doc Comments -5 removed lines

@@ -27,7 +27,6 @@ 
  * ```
  *
  * @signature {k: v} -> {k: v}
- * @param  object $object
  * @return array
  */
 function attributes() {
@@ -95,8 +94,6 @@ 
  * ```
  *
  * @signature String|Number -> [key => *] -> Boolean
- * @param  string $name
- * @param  array $object
  * @return mixed
  */
 function has() {
@@ -125,8 +122,6 @@ 
  * ```
  *
  * @signature k -> {k: v} -> Maybe(v)
- * @param  string $name
- * @param  array $object
  * @return mixed
  */
 function get() {

Braces +3 added lines, -2 removed lines

@@ -32,8 +32,9 @@
  */
 function attributes() {
     $attrs = function($object) {
-        if (is_object($object))
-            return get_object_vars($object);
+        if (is_object($object)) {
+                    return get_object_vars($object);
+        }
         return $object;
     };
     return apply(curry($attrs), func_get_args());