ItemAssignmentSniff::checkSpacing() - Code Metrics - Inspection of "Update README with supported PHP_CodeSniffer versi..." - aik099/CodingStandard - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — phpcs-3-upgrade ( d91341 )

by Alexander

created 2018-12-09 10:31 UTC

ItemAssignmentSniff::checkSpacing() B

↳ Parent: ItemAssignmentSniff

Complexity

Conditions	8
Paths	18

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	18
nop	3
dl	0
loc	52
rs	7.8028
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * CodingStandard_Sniffs_Formatting_ItemAssignmentSniff.
 *
 * PHP version 5
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Peter Philipp <[email protected]>
 * @author   Alexander Obuhovich <[email protected]>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */

namespace CodingStandard\Sniffs\Formatting;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * CodingStandard_Sniffs_Formatting_ItemAssignmentSniff.
 *
 * Checks if the item assignment operator (=>) has
 * - a space before and after
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Peter Philipp <[email protected]>
 * @author   Alexander Obuhovich <[email protected]>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */
class ItemAssignmentSniff implements Sniff
{


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return integer[]
     */
    public function register()
    {
        return array(T_DOUBLE_ARROW);
    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param File $phpcsFile The file being scanned.
     * @param int  $stackPtr  The position of the current token in the
     *                        stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $this->checkSpacing($phpcsFile, $stackPtr, true);
        $this->checkSpacing($phpcsFile, $stackPtr, false);
    }//end process()


    /**
     * Checks spacing at given position.
     *
     * @param File $phpcsFile The file being scanned.
     * @param int  $stackPtr  The position of the current token in the
     *                        stack passed in $tokens.
     * @param bool $before    Determines direction in which to check spacing.
     *
     * @return void
     */
    protected function checkSpacing(File $phpcsFile, $stackPtr, $before)
    {
        if ($before === true) {
            $stackPtrDiff = -1;
            $errorWord    = 'prefix';
            $errorCode    = 'Before';
        } else {
            $stackPtrDiff = 1;
            $errorWord    = 'follow';
            $errorCode    = 'After';
        }

        $tokens    = $phpcsFile->getTokens();
        $tokenData = $tokens[($stackPtr + $stackPtrDiff)];

        if ($tokenData['code'] !== T_WHITESPACE) {
            $error = 'Whitespace must '.$errorWord.' the item assignment operator =>';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpacing'.$errorCode);
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();

                if ($before === true) {
                    $phpcsFile->fixer->addContentBefore($stackPtr, ' ');
                } else {
                    $phpcsFile->fixer->addContent($stackPtr, ' ');
                }

                $phpcsFile->fixer->endChangeset();
            }

            return;
        }

        if (isset($tokenData['orig_content']) === true) {
            $content = $tokenData['orig_content'];
        } else {
            $content = $tokenData['content'];
        }

        if ($this->hasOnlySpaces($content) === false) {
            $error = 'Spaces must be used to '.$errorWord.' the item assignment operator =>';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'MixedWhitespace'.$errorCode);
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();
                $phpcsFile->fixer->replaceToken(
                    ($stackPtr + $stackPtrDiff),
                    str_repeat(' ', strlen($content))
                );
                $phpcsFile->fixer->endChangeset();
            }
        }
    }//end checkSpacing()


    /**
     * Detects, that string contains only spaces.
     *
     * @param string $string String.
     *
     * @return bool
     */
    protected function hasOnlySpaces($string)
    {
        return substr_count($string, ' ') === strlen($string);
    }//end hasOnlySpaces()
}//end class


1			<?php
2			/**
3			* CodingStandard_Sniffs_Formatting_ItemAssignmentSniff.
4			*
5			* PHP version 5
6			*
7			* @category PHP
8			* @package PHP_CodeSniffer
9			* @author Peter Philipp <[email protected]>
10			* @author Alexander Obuhovich <[email protected]>
11			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
12			* @link https://github.com/aik099/CodingStandard
13			*/
14
15			namespace CodingStandard\Sniffs\Formatting;
16
17			use PHP_CodeSniffer\Files\File;
18			use PHP_CodeSniffer\Sniffs\Sniff;
19
20			/**
21			* CodingStandard_Sniffs_Formatting_ItemAssignmentSniff.
22			*
23			* Checks if the item assignment operator (=>) has
24			* - a space before and after
25			*
26			* @category PHP
27			* @package PHP_CodeSniffer
28			* @author Peter Philipp <[email protected]>
29			* @author Alexander Obuhovich <[email protected]>
30			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
31			* @link https://github.com/aik099/CodingStandard
32			*/
33			class ItemAssignmentSniff implements Sniff
34			{
35
36
37			/**
38			* Returns an array of tokens this test wants to listen for.
39			*
40			* @return integer[]
41			*/
42			public function register()
43			{
44			return array(T_DOUBLE_ARROW);
45			}//end register()
46
47
48			/**
49			* Processes this test, when one of its tokens is encountered.
50			*
51			* @param File $phpcsFile The file being scanned.
52			* @param int $stackPtr The position of the current token in the
53			* stack passed in $tokens.
54			*
55			* @return void
56			*/
57			public function process(File $phpcsFile, $stackPtr)
58			{
59			$this->checkSpacing($phpcsFile, $stackPtr, true);
60			$this->checkSpacing($phpcsFile, $stackPtr, false);
61			}//end process()
62
63
64			/**
65			* Checks spacing at given position.
66			*
67			* @param File $phpcsFile The file being scanned.
68			* @param int $stackPtr The position of the current token in the
69			* stack passed in $tokens.
70			* @param bool $before Determines direction in which to check spacing.
71			*
72			* @return void
73			*/
74			protected function checkSpacing(File $phpcsFile, $stackPtr, $before)
75			{
76			if ($before === true) {
77			$stackPtrDiff = -1;
78			$errorWord = 'prefix';
79			$errorCode = 'Before';
80			} else {
81			$stackPtrDiff = 1;
82			$errorWord = 'follow';
83			$errorCode = 'After';
84			}
85
86			$tokens = $phpcsFile->getTokens();
87			$tokenData = $tokens[($stackPtr + $stackPtrDiff)];
88
89			if ($tokenData['code'] !== T_WHITESPACE) {
90			$error = 'Whitespace must '.$errorWord.' the item assignment operator =>';
91			$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpacing'.$errorCode);
92			if ($fix === true) {
93			$phpcsFile->fixer->beginChangeset();
94
95			if ($before === true) {
96			$phpcsFile->fixer->addContentBefore($stackPtr, ' ');
97			} else {
98			$phpcsFile->fixer->addContent($stackPtr, ' ');
99			}
100
101			$phpcsFile->fixer->endChangeset();
102			}
103
104			return;
105			}
106
107			if (isset($tokenData['orig_content']) === true) {
108			$content = $tokenData['orig_content'];
109			} else {
110			$content = $tokenData['content'];
111			}
112
113			if ($this->hasOnlySpaces($content) === false) {
114			$error = 'Spaces must be used to '.$errorWord.' the item assignment operator =>';
115			$fix = $phpcsFile->addFixableError($error, $stackPtr, 'MixedWhitespace'.$errorCode);
116			if ($fix === true) {
117			$phpcsFile->fixer->beginChangeset();
118			$phpcsFile->fixer->replaceToken(
119			($stackPtr + $stackPtrDiff),
120			str_repeat(' ', strlen($content))
121			);
122			$phpcsFile->fixer->endChangeset();
123			}
124			}
125			}//end checkSpacing()
126
127
128			/**
129			* Detects, that string contains only spaces.
130			*
131			* @param string $string String.
132			*
133			* @return bool
134			*/
135			protected function hasOnlySpaces($string)
136			{
137			return substr_count($string, ' ') === strlen($string);
138			}//end hasOnlySpaces()
139			}//end class
140

aik099 / CodingStandard

Push — phpcs-3-upgrade ( d91341 )

ItemAssignmentSniff::checkSpacing() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like