string.php ➔ chunks() - 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

string.php ➔ chunks() A

↳ Parent: Project

Complexity

Conditions	3
Paths	1

Size

Total Lines	55
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	30
nc	1
nop	0
dl	0
loc	55
rs	9.7692
c	0
b	0
f	0

How to fix Long Method

<?php namespace Tarsana\Functional;

/**
 * This file contains some useful String functions.
 */

/**
 * Curried version of `explode()`.
 * ```php
 * $words = split(' ');
 * $words('Hello World'); // ['Hello', 'World']
 * ```
 *
 * @signature String -> String -> [String]
 * @param string $delimiter
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return array
 */
function split() {
    return apply(curry('explode'), func_get_args());
}

/**
 * Curried version of `implode()`.
 * ```php
 * $sentence = join(' ');
 * $sentence(['Hello', 'World']); // 'Hello World'
 * ```
 *
 * @signature String -> [String] -> String
 * @param string $glue
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param array $pieces
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return string
 */
function join() {
    return apply(curry(function($glue, $pieces){
        return implode($glue, $pieces);
    }), func_get_args());
}

/**
 * Curried version of `str_replace()`.
 * ```php
 * $string = 'a b c d e f';
 * $noSpace = replace(' ', '');
 * $noSpace($string); // 'abcdef'
 * replace(['a', 'b', ' '], '', $string) // 'cdef'
 * replace(['a', 'e', ' '], ['x', 'y', ''], $string); // 'xbcdyf'
 * ```
 *
 * @signature String|[String] -> String -> String|[String] -> String
 * @param  string $search
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $replacement
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return string
 */
function replace() {
    return apply(curry('str_replace'), func_get_args());
}

/**
 * Curried version of `preg_replace()`.
 * ```php
 * $string = 'A12;b_{F}|d';
 * $aplha = regReplace('/[^a-z]+/i', '');
 * $alpha($string); // 'AbFd'
 * ```
 *
 * @signature String -> String -> String -> String
 * @param  string $pattern
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $replacement
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return string
 */
function regReplace() {
    return apply(curry('preg_replace'), func_get_args());
}

/**
 * Alias of `strtoupper`.
 * ```php
 * upperCase('hello') // 'HELLO'
 * ```
 *
 * @signature String -> String
 * @param  string $string
 * @return string
 */
function upperCase($string) {
    return strtoupper($string);
}

/**
 * Alias of `strtolower`.
 * ```php
 * lowerCase('HELLO') // 'hello'
 * ```
 *
 * @signature String -> String
 * @param  string $string
 * @return string
 */
function lowerCase($string) {
    return strtolower($string);
}

/**
 * Gets the camlCase version of a string.
 * ```php
 * camelCase('Yes, we can! 123') // 'yesWeCan123'
 * ```
 *
 * @signature String -> String
 * @param  string $string
 * @return string
 */
function camelCase($string) {
    return apply(pipe(
        regReplace('/[^a-z0-9]+/i', ' '),
        'trim',
        'ucwords',
        replace(' ', ''),
        'lcfirst'
    ), [$string]);
}

/**
 * Gets the snake-case of the string using `$delimiter` as separator.
 * ```
 * $underscoreCase = snakeCase('_');
 * $underscoreCase('IAm-Happy'); // i_am_happy
 * ```
 *
 * @signature String -> String -> String
 * @param  string $delimiter
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return string
 */
function snakeCase() {
    $snackCase = function($delimiter, $string) {
        return apply(pipe(
            regReplace('/([A-Z])/', ' \\1'),
            regReplace('/([0-9]+)/', ' \\1'),
            regReplace('/[^a-z0-9]+/i', ' '),
            'trim',
            'strtolower',
            replace(' ', $delimiter)
        ), [$string]);
    };
    return apply(curry($snackCase), func_get_args());
};

/**
 * Checks if `$string` starts with `$token`.
 * ```php
 * $http = startsWith('http://');
 * $http('http://gitbub.com'); // true
 * $http('gitbub.com'); // false
 * ```
 *
 * @signature String -> String -> Boolean
 * @param  string $token
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function startsWith() {

    $startsWith = function($token, $string) {
        return (
            strlen($token) <= strlen($string) &&
            substr($string, 0, strlen($token)) === $token
        );
    };
    return apply(curry($startsWith), func_get_args());
}

/**
 * Checks if `$string` ends with `$token`.
 * ```php
 * $dotCom = endsWith('.com');
 * $dotCom('http://gitbub.com'); // true
 * $dotCom('php.net'); // false
 * ```
 *
 * @signature String -> String -> Boolean
 * @param  string $token
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function endsWith() {

    $endsWith = function($token, $string) {
        return (
            strlen($token) <= strlen($string) &&
            substr($string, - strlen($token)) === $token
        );
    };
    return apply(curry($endsWith), func_get_args());
}

/**
 * Checks if a string matches a regular expression.
 * ```php
 * $numeric = test('/^[0-9.]+$/');
 * $numeric('123.43'); // true
 * $numeric('12a3.43'); // false
 * ```
 *
 * @signature String -> String -> Boolean
 * @param  string $pattern
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return bool
 */
function test() {
    $test = function($pattern, $string) {
        return 1 === preg_match($pattern, $string);
    };
    return apply(curry($test), func_get_args());
}

/**
 * Performs a global regular expression match
 * and returns array of results.
 * ```php
 * $numbers = match('/[0-9.]+/');
 * $numbers('Hello World'); // []
 * $numbers('12 is 4 times 3'); // ['12', '4', '3']
 * ```
 *
 * @signature String -> String -> [String]
 * @param  string $pattern
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $string
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return array
 */
function match() {
    $match = function($pattern, $string) {
        $results = [];
        preg_match_all($pattern, $string, $results);
        return $results[0];
    };
    return apply(curry($match), func_get_args());
}

/**
 * Curried version of `substr_count` with changed order of parameters,
 * ```php
 * $spaces = occurences(' ');
 * $spaces('Hello') // 0
 * $spaces('12 is 4 times 3'); // 4
 * ```
 *
 * @signature String -> String -> Number
 * @param  string $token
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $text
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return int
 */
function occurences() {
    $occurences = function($token, $text) {
        return substr_count($text, $token);
    };
    return apply(curry($occurences), func_get_args());
}

/**
 * Splits a string into chunks without spliting any group surrounded with some
 * specified characters. `$surrounders` is a string where each pair of characters
 * specifies the starting and ending characters of a group that should not be split.
 * ```php
 * $groups = chunks('(){}', ',');
 * $groups('1,2,(3,4,5),{6,(7,8)},9'); // ['1', '2', '(3,4,5)', '{6,(7,8)}', '9']
 *
 * $names = chunks('()""', ' ');
 * $names('Foo "Bar Baz" (Some other name)'); // ['Foo', 'Bar Baz', 'Some other name']
 * ```
 *
 * @signature String -> String -> String -> [String]
 * @param  string $surrounders
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  string $separator
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param  sring $text
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @return array
 */
function chunks() {
    $chunks = function($surrounders, $separator, $text) {
        // Let's assume some values to understand how this function works
        // surrounders = '""{}()'
        // separator = ' '
        // $text = 'foo ("bar baz" alpha) beta'

        $surrounders = map(slices(1), slices(2, $surrounders)); // [['"'. '"'], ['{'. '}'], ['(', ')']]

        $openings = map(get(0), $surrounders); // ['"', '{', '(']

        $closings = map(get(1), $surrounders); // ['"', '}', ')']

        $numOfSurrounders = length($surrounders); // 3
        $indexes = keys($surrounders); // [0, 1, 2]


        $items = split($separator, $text); // ['foo', '("bar', 'baz"', 'alpha)', 'beta']


        // The initial state
        $state = (object) [
            'chunks'    => [], //: the resulting chunks
            'counts'   => array_fill(0, $numOfSurrounders, 0), // [0, 0, 0] : count of openings not closed yet
            'total'    => 0 //: total of not closed openings
        ];
        // We will iterate over $items and update the $state while adding them
        // For each item we need to update counts and chunks

        // Updates count for a single surrender (the surrender at $index)
        // $item : the item we are adding
        // $counts : the previous counts
        $updateCountAt = curry(function($item, $counts, $index) use($openings, $closings) {
            $count = occurences(__(), $item);
            return ($openings[$index] == $closings[$index]) ?
                ($counts[$index] + $count($openings[$index])) % 2 :
                $counts[$index] + $count($openings[$index]) - $count($closings[$index]);
        });
        // Updates counts for all surrenders
        $updateCounts = curry(function($item, $counts) use($indexes, $updateCountAt) {
            return map($updateCountAt($item, $counts), $indexes);
        });
        // Adds an item to the state and returns a new state
        $addItem = function($state, $item) use ($separator, $updateCounts){
            $counts = $updateCounts($item, get('counts', $state));
            $newChunks = (0 == $state->total) // if all openings are closed
                ? append($item, $state->chunks) // then add a new chunk
                // else append the item to the last chunk using the separator as glue
                : append(last($state->chunks) . $separator . $item, init($state->chunks));
            return (object) [
                'chunks' => $newChunks,
                'counts' => $counts,
                'total' => sum($counts)
            ];
        };
        // Returns the chunks of the resulting state after adding all items
        return get('chunks', reduce($addItem, $state, $items));
    };
    return apply(curry($chunks), func_get_args());
}


1			<?php namespace Tarsana\Functional;
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 18 and the first side effect is on line 150. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* This file contains some useful String functions.
4			*/
5
6			/**
7			* Curried version of `explode()`.
8			* ```php
9			* $words = split(' ');
10			* $words('Hello World'); // ['Hello', 'World']
11			* ```
12			*
13			* @signature String -> String -> [String]
14			* @param string $delimiter
			0 ignored issues – show Bug introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report There is no parameter named `$delimiter`. 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...
15			* @param string $string
			0 ignored issues – show Bug introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report There is no parameter named `$string`. 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...
16			* @return array
17			*/
18			function split() {
19			return apply(curry('explode'), func_get_args());
20			}
21
22			/**
23			* Curried version of `implode()`.
24			* ```php
25			* $sentence = join(' ');
26			* $sentence(['Hello', 'World']); // 'Hello World'
27			* ```
28			*
29			* @signature String -> [String] -> String
30			* @param string $glue
			0 ignored issues – show Bug introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report There is no parameter named `$glue`. 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...
31			* @param array $pieces
			0 ignored issues – show Bug introduced 2016-08-15 21:58 UTC by Report Bug Copy Issue Report There is no parameter named `$pieces`. 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...
32			* @return string
33			*/
34			function join() {
35			return apply(curry(function($glue, $pieces){

tarsana / functional

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

string.php ➔ chunks() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like