Utf8Controller::actionCheckGuide() - Code Metrics - Inspection of "Upgrade to newer scrutinizer engine" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — scrutinizer-migrate-to-new-eng... ( 58afd6 )

by Alexander

created 2019-02-03 20:56 UTC

Utf8Controller::actionCheckGuide() D

↳ Parent: Project

Complexity

Conditions	18
Paths	40

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	53
rs	4.8666
c	0
b	0
f	0
cc	18
nc	40
nop	1

How to fix Long Method Complexity

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\build\controllers;

use yii\console\Controller;
use yii\helpers\Console;
use yii\helpers\FileHelper;

/**
 * Check files for broken UTF8 and non-printable characters.
 *
 * @author Carsten Brandt <[email protected]>
 */
class Utf8Controller extends Controller
{
    public $defaultAction = 'check-guide';

    /**
     * Check guide for non-printable characters that may break docs generation.
     *
     * @param string $directory the directory to check. If not specified, the default
     * guide directory will be checked.
     */
    public function actionCheckGuide($directory = null)
    {
        if ($directory === null) {
            $directory = \dirname(\dirname(__DIR__)) . '/docs';
        }
        if (is_file($directory)) {
            $files = [$directory];
        } else {
            $files = FileHelper::findFiles($directory, [
                'only' => ['*.md'],
            ]);
        }

        foreach ($files as $file) {
            $content = file_get_contents($file);
            $chars = preg_split('//u', $content, null, PREG_SPLIT_NO_EMPTY);

            $line = 1;
            $pos = 0;
            foreach ($chars as $c) {
                $ord = $this->unicodeOrd($c);

                $pos++;
                if ($ord == 0x000A) {
                    $line++;
                    $pos = 0;
                }

                if ($ord === false) {
                    $this->found('BROKEN UTF8', $c, $line, $pos, $file);
                    continue;
                }

                // http://unicode-table.com/en/blocks/general-punctuation/
                if (0x2000 <= $ord && $ord <= 0x200F
                 || 0x2028 <= $ord && $ord <= 0x202E
                 || 0x205f <= $ord && $ord <= 0x206F
                    ) {
                    $this->found('UNSUPPORTED SPACE CHARACTER', $c, $line, $pos, $file);
                    continue;
                }
                if ($ord < 0x0020 && $ord != 0x000A && $ord != 0x0009 ||
                    0x0080 <= $ord && $ord < 0x009F) {
                    $this->found('CONTROL CHARARCTER', $c, $line, $pos, $file);
                    continue;
                }
//                if ($ord > 0x009F) {
//                    $this->found("NON ASCII CHARARCTER", $c, $line, $pos, $file);
//                    continue;
//                }
            }
        }
    }

    private $_foundFiles = [];

    private function found($what, $char, $line, $pos, $file)
    {
        if (!isset($this->_foundFiles[$file])) {
            $this->stdout("$file: \n", Console::BOLD);
            $this->_foundFiles[$file] = $file;
        }

        $hexcode = dechex($this->unicodeOrd($char));
        $hexcode = str_repeat('0', max(4 - \strlen($hexcode), 0)) . $hexcode;

        $this->stdout("  at $line:$pos FOUND $what: 0x$hexcode '$char' http://unicode-table.com/en/$hexcode/\n");
    }

    /**
     * Equivalent for ord() just for unicode.
     *
     * http://stackoverflow.com/a/10333324/1106908
     *
     * @param $c
     * @return bool|int
     */
    private function unicodeOrd($c)
    {
        $h = \ord($c[0]);
        if ($h <= 0x7F) {
            return $h;
        } elseif ($h < 0xC2) {
            return false;
        } elseif ($h <= 0xDF) {
            return ($h & 0x1F) << 6 | (\ord($c[1]) & 0x3F);
        } elseif ($h <= 0xEF) {
            return ($h & 0x0F) << 12 | (\ord($c[1]) & 0x3F) << 6
                                     | (\ord($c[2]) & 0x3F);
        } elseif ($h <= 0xF4) {
            return ($h & 0x0F) << 18 | (\ord($c[1]) & 0x3F) << 12
                                     | (\ord($c[2]) & 0x3F) << 6
                                     | (\ord($c[3]) & 0x3F);
        }

        return false;
    }
}


1			<?php
2			/**
3			* @link http://www.yiiframework.com/
4			* @copyright Copyright (c) 2008 Yii Software LLC
5			* @license http://www.yiiframework.com/license/
6			*/
7
8			namespace yii\build\controllers;
9
10			use yii\console\Controller;
11			use yii\helpers\Console;
12			use yii\helpers\FileHelper;
13
14			/**
15			* Check files for broken UTF8 and non-printable characters.
16			*
17			* @author Carsten Brandt <[email protected]>
18			*/
19			class Utf8Controller extends Controller
20			{
21			public $defaultAction = 'check-guide';
22
23			/**
24			* Check guide for non-printable characters that may break docs generation.
25			*
26			* @param string $directory the directory to check. If not specified, the default
27			* guide directory will be checked.
28			*/
29			public function actionCheckGuide($directory = null)
30			{
31			if ($directory === null) {
32			$directory = \dirname(\dirname(__DIR__)) . '/docs';
33			}
34			if (is_file($directory)) {
35			$files = [$directory];
36			} else {
37			$files = FileHelper::findFiles($directory, [
38			'only' => ['*.md'],
39			]);
40			}
41
42			foreach ($files as $file) {
43			$content = file_get_contents($file);
44			$chars = preg_split('//u', $content, null, PREG_SPLIT_NO_EMPTY);
45
46			$line = 1;
47			$pos = 0;
48			foreach ($chars as $c) {
49			$ord = $this->unicodeOrd($c);
50
51			$pos++;
52			if ($ord == 0x000A) {
53			$line++;
54			$pos = 0;
55			}
56
57			if ($ord === false) {
58			$this->found('BROKEN UTF8', $c, $line, $pos, $file);
59			continue;
60			}
61
62			// http://unicode-table.com/en/blocks/general-punctuation/
63			if (0x2000 <= $ord && $ord <= 0x200F
64			\|\| 0x2028 <= $ord && $ord <= 0x202E
65			\|\| 0x205f <= $ord && $ord <= 0x206F
66			) {
67			$this->found('UNSUPPORTED SPACE CHARACTER', $c, $line, $pos, $file);
68			continue;
69			}
70			if ($ord < 0x0020 && $ord != 0x000A && $ord != 0x0009 \|\|
71			0x0080 <= $ord && $ord < 0x009F) {
72			$this->found('CONTROL CHARARCTER', $c, $line, $pos, $file);
73			continue;
74			}
75			// if ($ord > 0x009F) {
76			// $this->found("NON ASCII CHARARCTER", $c, $line, $pos, $file);
77			// continue;
78			// }
79			}
80			}
81			}
82
83			private $_foundFiles = [];
84
85			private function found($what, $char, $line, $pos, $file)
86			{
87			if (!isset($this->_foundFiles[$file])) {
88			$this->stdout("$file: \n", Console::BOLD);
89			$this->_foundFiles[$file] = $file;
90			}
91
92			$hexcode = dechex($this->unicodeOrd($char));
93			$hexcode = str_repeat('0', max(4 - \strlen($hexcode), 0)) . $hexcode;
94
95			$this->stdout(" at $line:$pos FOUND $what: 0x$hexcode '$char' http://unicode-table.com/en/$hexcode/\n");
96			}
97
98			/**
99			* Equivalent for ord() just for unicode.
100			*
101			* http://stackoverflow.com/a/10333324/1106908
102			*
103			* @param $c
104			* @return bool\|int
105			*/
106			private function unicodeOrd($c)
107			{
108			$h = \ord($c[0]);
109			if ($h <= 0x7F) {
110			return $h;
111			} elseif ($h < 0xC2) {
112			return false;
113			} elseif ($h <= 0xDF) {
114			return ($h & 0x1F) << 6 \| (\ord($c[1]) & 0x3F);
115			} elseif ($h <= 0xEF) {
116			return ($h & 0x0F) << 12 \| (\ord($c[1]) & 0x3F) << 6
117			\| (\ord($c[2]) & 0x3F);
118			} elseif ($h <= 0xF4) {
119			return ($h & 0x0F) << 18 \| (\ord($c[1]) & 0x3F) << 12
120			\| (\ord($c[2]) & 0x3F) << 6
121			\| (\ord($c[3]) & 0x3F);
122			}
123
124			return false;
125			}
126			}
127

yiisoft / yii2

Push — scrutinizer-migrate-to-new-eng... ( 58afd6 )

Utf8Controller::actionCheckGuide() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like