FileHelper::findFiles() - Code Metrics - Inspection of "Added missed ukrainian translations" - vova07/yii2-imperavi-widget - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#81)

unknown

created 2017-03-12 15:40 UTC

FileHelper::findFiles() C

↳ Parent: FileHelper

Complexity

Conditions	15
Paths	41

Size

Total Lines	60
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	4	Features	2

Metric	Value
c	7
b	4
f	2
dl	0
loc	60
rs	6.305
cc	15
eloc	41
nc	41
nop	3

How to fix Long Method Complexity

<?php

namespace the0rist\imperavi\helpers;

use the0rist\imperavi\actions\GetAction;
use yii\base\InvalidParamException;
use yii\helpers\BaseFileHelper;
use yii\helpers\StringHelper;

/**
 * File system helper
 *
 * @author Vasile Crudu <[email protected]>
 *
 * @link https://github.com/the0rist
 */
class FileHelper extends BaseFileHelper
{
    /**
     * @inheritdoc
     *
     * @param array $options {
     *
     * @type array $except
     * @type array $only
     * }
     */
    public static function findFiles($dir, $options = [], $type = GetAction::TYPE_IMAGES)
    {
        if (!is_dir($dir)) {
            throw new InvalidParamException('The dir argument must be a directory.');
        }
        $dir = rtrim($dir, DIRECTORY_SEPARATOR);
        if (isset($options['url'])) {
            $options['url'] = rtrim($options['url'], '/');
        }
        if (!isset($options['basePath'])) {
            $options['basePath'] = realpath($dir);
            // this should also be done only once
            $options = self::normalizeOptions($options);
        }
        $list = [];
        $handle = opendir($dir);
        if ($handle === false) {
            // @codeCoverageIgnoreStart
            throw new InvalidParamException('Unable to open directory: ' . $dir);
            // @codeCoverageIgnoreEnd
        }
        while (($file = readdir($handle)) !== false) {
            if ($file === '.' || $file === '..') {
                continue;
            }
            $path = $dir . DIRECTORY_SEPARATOR . $file;
            if (static::filterPath($path, $options)) {
                if (is_file($path)) {
                    if (isset($options['url'])) {
                        $url = str_replace([$options['basePath'], '\\'], [$options['url'], '/'], static::normalizePath($path));

                        if ($type === GetAction::TYPE_IMAGES) {
                            $list[] = [
                                'title' => $file,
                                'thumb' => $url,
                                'image' => $url
                            ];
                        } elseif ($type === GetAction::TYPE_FILES) {
                            $size = self::getFileSize($path);
                            $list[] = [
                                'title' => $file,
                                'name' => $file,
                                'link' => $url,
                                'size' => $size
                            ];
                        } else {
                            $list[] = $path;
                        }
                    } else {
                        $list[] = $path;
                    }
                } elseif (!isset($options['recursive']) || $options['recursive']) {
                    $list = array_merge($list, static::findFiles($path, $options, $type));
                }
            }
        }
        closedir($handle);

        return $list;
    }

    /**
     * @param string $path
     *
     * @return string filesize in(B|KB|MB|GB)
     */
    protected static function getFileSize($path)
    {
        $size = filesize($path);
        $labels = ['B', 'KB', 'MB', 'GB'];
        $factor = floor((strlen($size) - 1) / 3);

        return sprintf("%.1f ", $size / pow(1024, $factor)) . $labels[$factor];
    }

    /**
     * @inheritdoc
     *
     * @codeCoverageIgnore
     */
    private static function parseExcludePattern($pattern)

    {
        if (!is_string($pattern)) {
            throw new InvalidParamException('Exclude/include pattern must be a string.');
        }
        $result = [
            'pattern' => $pattern,
            'flags' => 0,
            'firstWildcard' => false,
        ];
        if (!isset($pattern[0])) {
            return $result;
        }

        if ($pattern[0] == '!') {
            $result['flags'] |= self::PATTERN_NEGATIVE;
            $pattern = StringHelper::byteSubstr($pattern, 1, StringHelper::byteLength($pattern));
        }
        $len = StringHelper::byteLength($pattern);
        if ($len && StringHelper::byteSubstr($pattern, -1, 1) == '/') {
            $pattern = StringHelper::byteSubstr($pattern, 0, -1);
            $len--;
            $result['flags'] |= self::PATTERN_MUSTBEDIR;
        }
        if (strpos($pattern, '/') === false) {
            $result['flags'] |= self::PATTERN_NODIR;
        }
        $result['firstWildcard'] = self::firstWildcardInPattern($pattern);
        if ($pattern[0] == '*' && self::firstWildcardInPattern(StringHelper::byteSubstr($pattern, 1, StringHelper::byteLength($pattern))) === false) {
            $result['flags'] |= self::PATTERN_ENDSWITH;
        }
        $result['pattern'] = $pattern;

        return $result;
    }

    /**
     * @inheritdoc
     *
     * @codeCoverageIgnore
     */
    private static function firstWildcardInPattern($pattern)

    {
        $wildcards = ['*', '?', '[', '\\'];
        $wildcardSearch = function ($r, $c) use ($pattern) {
            $p = strpos($pattern, $c);

            return $r === false ? $p : ($p === false ? $r : min($r, $p));
        };

        return array_reduce($wildcards, $wildcardSearch, false);
    }

    /**
     * @inheritdoc
     *
     * @codeCoverageIgnore
     */
    private static function normalizeOptions(array $options)

    {
        if (!array_key_exists('caseSensitive', $options)) {
            $options['caseSensitive'] = true;
        }
        if (isset($options['except'])) {
            foreach ($options['except'] as $key => $value) {
                if (is_string($value)) {
                    $options['except'][$key] = self::parseExcludePattern($value, $options['caseSensitive']);

                }
            }
        }
        if (isset($options['only'])) {
            foreach ($options['only'] as $key => $value) {
                if (is_string($value)) {
                    $options['only'][$key] = self::parseExcludePattern($value, $options['caseSensitive']);

                }
            }
        }
        return $options;
    }
}


1			<?php
2
3			namespace the0rist\imperavi\helpers;
4
5			use the0rist\imperavi\actions\GetAction;
6			use yii\base\InvalidParamException;
7			use yii\helpers\BaseFileHelper;
8			use yii\helpers\StringHelper;
9
10			/**
11			* File system helper
12			*
13			* @author Vasile Crudu <[email protected]>
14			*
15			* @link https://github.com/the0rist
16			*/
17			class FileHelper extends BaseFileHelper
18			{
19			/**
20			* @inheritdoc
21			*
22			* @param array $options {
23			*
24			* @type array $except
25			* @type array $only
26			* }
27			*/
28			public static function findFiles($dir, $options = [], $type = GetAction::TYPE_IMAGES)
29			{
30			if (!is_dir($dir)) {
31			throw new InvalidParamException('The dir argument must be a directory.');
32			}
33			$dir = rtrim($dir, DIRECTORY_SEPARATOR);
34			if (isset($options['url'])) {
35			$options['url'] = rtrim($options['url'], '/');
36			}
37			if (!isset($options['basePath'])) {
38			$options['basePath'] = realpath($dir);
39			// this should also be done only once
40			$options = self::normalizeOptions($options);
41			}
42			$list = [];
43			$handle = opendir($dir);
44			if ($handle === false) {
45			// @codeCoverageIgnoreStart
46			throw new InvalidParamException('Unable to open directory: ' . $dir);
47			// @codeCoverageIgnoreEnd
48			}
49			while (($file = readdir($handle)) !== false) {
50			if ($file === '.' \|\| $file === '..') {
51			continue;
52			}
53			$path = $dir . DIRECTORY_SEPARATOR . $file;
54			if (static::filterPath($path, $options)) {
55			if (is_file($path)) {
56			if (isset($options['url'])) {
57			$url = str_replace([$options['basePath'], '\\'], [$options['url'], '/'], static::normalizePath($path));
58
59			if ($type === GetAction::TYPE_IMAGES) {
60			$list[] = [
61			'title' => $file,
62			'thumb' => $url,
63			'image' => $url
64			];
65			} elseif ($type === GetAction::TYPE_FILES) {
66			$size = self::getFileSize($path);
67			$list[] = [
68			'title' => $file,
69			'name' => $file,
70			'link' => $url,
71			'size' => $size
72			];
73			} else {
74			$list[] = $path;
75			}
76			} else {
77			$list[] = $path;
78			}
79			} elseif (!isset($options['recursive']) \|\| $options['recursive']) {
80			$list = array_merge($list, static::findFiles($path, $options, $type));
81			}
82			}
83			}
84			closedir($handle);
85
86			return $list;
87			}
88
89			/**
90			* @param string $path
91			*
92			* @return string filesize in(B\|KB\|MB\|GB)
93			*/
94			protected static function getFileSize($path)
95			{
96			$size = filesize($path);
97			$labels = ['B', 'KB', 'MB', 'GB'];
98			$factor = floor((strlen($size) - 1) / 3);
99
100			return sprintf("%.1f ", $size / pow(1024, $factor)) . $labels[$factor];
101			}
102
103			/**
104			* @inheritdoc
105			*
106			* @codeCoverageIgnore
107			*/
108			private static function parseExcludePattern($pattern)
			0 ignored issues – show Bug introduced 2015-12-10 21:30 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
109			{
110			if (!is_string($pattern)) {
111			throw new InvalidParamException('Exclude/include pattern must be a string.');
112			}
113			$result = [
114			'pattern' => $pattern,
115			'flags' => 0,
116			'firstWildcard' => false,
117			];
118			if (!isset($pattern[0])) {
119			return $result;
120			}
121
122			if ($pattern[0] == '!') {
123			$result['flags'] \|= self::PATTERN_NEGATIVE;
124			$pattern = StringHelper::byteSubstr($pattern, 1, StringHelper::byteLength($pattern));
125			}
126			$len = StringHelper::byteLength($pattern);
127			if ($len && StringHelper::byteSubstr($pattern, -1, 1) == '/') {
128			$pattern = StringHelper::byteSubstr($pattern, 0, -1);
129			$len--;
130			$result['flags'] \|= self::PATTERN_MUSTBEDIR;
131			}
132			if (strpos($pattern, '/') === false) {
133			$result['flags'] \|= self::PATTERN_NODIR;
134			}
135			$result['firstWildcard'] = self::firstWildcardInPattern($pattern);
136			if ($pattern[0] == '*' && self::firstWildcardInPattern(StringHelper::byteSubstr($pattern, 1, StringHelper::byteLength($pattern))) === false) {
137			$result['flags'] \|= self::PATTERN_ENDSWITH;
138			}
139			$result['pattern'] = $pattern;
140
141			return $result;
142			}
143
144			/**
145			* @inheritdoc
146			*
147			* @codeCoverageIgnore
148			*/
149			private static function firstWildcardInPattern($pattern)
			0 ignored issues – show Bug introduced 2015-12-10 21:30 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
150			{
151			$wildcards = ['*', '?', '[', '\\'];
152			$wildcardSearch = function ($r, $c) use ($pattern) {
153			$p = strpos($pattern, $c);
154
155			return $r === false ? $p : ($p === false ? $r : min($r, $p));
156			};
157
158			return array_reduce($wildcards, $wildcardSearch, false);
159			}
160
161			/**
162			* @inheritdoc
163			*
164			* @codeCoverageIgnore
165			*/
166			private static function normalizeOptions(array $options)
			0 ignored issues – show Bug introduced 2015-12-10 21:30 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
167			{
168			if (!array_key_exists('caseSensitive', $options)) {
169			$options['caseSensitive'] = true;
170			}
171			if (isset($options['except'])) {
172			foreach ($options['except'] as $key => $value) {
173			if (is_string($value)) {
174			$options['except'][$key] = self::parseExcludePattern($value, $options['caseSensitive']);
			0 ignored issues – show Unused Code introduced 2015-12-10 21:30 UTC by Report Bug Copy Issue Report The call to `FileHelper::parseExcludePattern()` has too many arguments starting with `$options['caseSensitive']`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
175			}
176			}
177			}
178			if (isset($options['only'])) {
179			foreach ($options['only'] as $key => $value) {
180			if (is_string($value)) {
181			$options['only'][$key] = self::parseExcludePattern($value, $options['caseSensitive']);
			0 ignored issues – show Unused Code introduced 2015-12-10 21:30 UTC by Report Bug Copy Issue Report The call to `FileHelper::parseExcludePattern()` has too many arguments starting with `$options['caseSensitive']`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
182			}
183			}
184			}
185			return $options;
186			}
187			}
188

vova07 / yii2-imperavi-widget

Pull Request — master (#81)

FileHelper::findFiles() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like