ClassDeclarationSniff::processClose() - 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

ClassDeclarationSniff::processClose() C

↳ Parent: ClassDeclarationSniff

Complexity

Conditions	14
Paths	78

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	14
nc	78
nop	2
dl	0
loc	69
rs	5.6896
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * CodingStandard_Sniffs_Classes_ClassDeclarationSniff.
 *
 * PHP version 5
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Greg Sherwood <[email protected]>
 * @author   Marc McIntyre <[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\Classes;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff as PSR2_ClassDeclarationSniff;

/**
 * Class Declaration Test.
 *
 * Checks the declaration of the class and its inheritance is correct.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Greg Sherwood <[email protected]>
 * @author   Marc McIntyre <[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 ClassDeclarationSniff extends PSR2_ClassDeclarationSniff
{


    /**
     * 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)
    {
        // We want all the errors from the PEAR standard, plus some of our own.
        parent::process($phpcsFile, $stackPtr);
    }//end process()


    /**
     * Processes the opening section of a class declaration.
     *
     * @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 processOpen(File $phpcsFile, $stackPtr)
    {
        parent::processOpen($phpcsFile, $stackPtr);

        $tokens = $phpcsFile->getTokens();

        if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {
            $prevContent = $tokens[($stackPtr - 1)]['content'];
            if ($prevContent !== $phpcsFile->eolChar) {
                $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
                $spaces     = strlen($blankSpace);

                if (in_array($tokens[($stackPtr - 2)]['code'], array(T_ABSTRACT, T_FINAL)) === false) {
                    if ($spaces !== 0) {
                        $type  = strtolower($tokens[$stackPtr]['content']);
                        $error = 'Expected 0 spaces before %s keyword; %s found';
                        $data  = array(
                                  $type,
                                  $spaces,
                                 );

                        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeKeyword', $data);
                        if ($fix === true) {
                            $phpcsFile->fixer->beginChangeset();
                            $phpcsFile->fixer->replaceToken(($stackPtr - 1), '');
                            $phpcsFile->fixer->endChangeset();
                        }
                    }
                }
            }//end if
        }//end if
    }//end processOpen()


    /**
     * Processes the closing section of a class declaration.
     *
     * @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 processClose(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();

        // Just in case.
        if (isset($tokens[$stackPtr]['scope_closer']) === false) {
            return;
        }

        $closeBrace = $tokens[$stackPtr]['scope_closer'];
        if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) {
            $prevContent = $tokens[($closeBrace - 1)]['content'];
            if ($prevContent !== $phpcsFile->eolChar) {
                $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
                $spaces     = strlen($blankSpace);
                if ($spaces !== 0) {
                    if ($tokens[($closeBrace - 1)]['line'] !== $tokens[$closeBrace]['line']) {
                        $error = 'Expected 0 spaces before closing brace; newline found';
                        $fix   = $phpcsFile->addFixableError($error, $closeBrace, 'NewLineBeforeCloseBrace');
                    } else {
                        $error = 'Expected 0 spaces before closing brace; %s found';
                        $data  = array($spaces);
                        $fix   = $phpcsFile->addFixableError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data);
                    }//end if

                    if ($fix === true) {
                        $phpcsFile->fixer->beginChangeset();
                        $phpcsFile->fixer->replaceToken(($closeBrace - 1), '');
                        $phpcsFile->fixer->endChangeset();
                    }
                }//end if
            }//end if
        }//end if

        // Check that the closing brace has one blank line after it.
        $nextContent = $phpcsFile->findNext(array(T_WHITESPACE), ($closeBrace + 1), null, true);
        if ($nextContent !== false) {
            $difference = ($tokens[$nextContent]['line'] - $tokens[$closeBrace]['line'] - 1);
            if ($difference < 0) {
                $difference = 0;
            }

            if ($difference !== 1) {
                $error = 'Closing brace of a %s must be followed by a single blank line; found %s';
                $data  = array(
                          $tokens[$stackPtr]['content'],
                          $difference,
                         );
                $fix   = $phpcsFile->addFixableError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->beginChangeset();

                    if ($difference > 1) {
                        for ($i = ($closeBrace + 1); $i < $nextContent; $i++) {
                            if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) {
                                // Keep existing indentation.
                                break;
                            }

                            $phpcsFile->fixer->replaceToken($i, '');
                        }
                    }

                    $phpcsFile->fixer->addNewline($closeBrace);
                    $phpcsFile->fixer->endChangeset();
                }
            }//end if
        }//end if
    }//end processClose()
}//end class


1			<?php
2			/**
3			* CodingStandard_Sniffs_Classes_ClassDeclarationSniff.
4			*
5			* PHP version 5
6			*
7			* @category PHP
8			* @package PHP_CodeSniffer
9			* @author Greg Sherwood <[email protected]>
10			* @author Marc McIntyre <[email protected]>
11			* @author Alexander Obuhovich <[email protected]>
12			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
13			* @link https://github.com/aik099/CodingStandard
14			*/
15
16			namespace CodingStandard\Sniffs\Classes;
17
18			use PHP_CodeSniffer\Files\File;
19			use PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff as PSR2_ClassDeclarationSniff;
20
21			/**
22			* Class Declaration Test.
23			*
24			* Checks the declaration of the class and its inheritance is correct.
25			*
26			* @category PHP
27			* @package PHP_CodeSniffer
28			* @author Greg Sherwood <[email protected]>
29			* @author Marc McIntyre <[email protected]>
30			* @author Alexander Obuhovich <[email protected]>
31			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
32			* @link https://github.com/aik099/CodingStandard
33			*/
34			class ClassDeclarationSniff extends PSR2_ClassDeclarationSniff
35			{
36
37
38			/**
39			* Processes this test, when one of its tokens is encountered.
40			*
41			* @param File $phpcsFile The file being scanned.
42			* @param int $stackPtr The position of the current token in the
43			* stack passed in $tokens.
44			*
45			* @return void
46			*/
47			public function process(File $phpcsFile, $stackPtr)
48			{
49			// We want all the errors from the PEAR standard, plus some of our own.
50			parent::process($phpcsFile, $stackPtr);
51			}//end process()
52
53
54			/**
55			* Processes the opening section of a class declaration.
56			*
57			* @param File $phpcsFile The file being scanned.
58			* @param int $stackPtr The position of the current token
59			* in the stack passed in $tokens.
60			*
61			* @return void
62			*/
63			public function processOpen(File $phpcsFile, $stackPtr)
64			{
65			parent::processOpen($phpcsFile, $stackPtr);
66
67			$tokens = $phpcsFile->getTokens();
68
69			if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {
70			$prevContent = $tokens[($stackPtr - 1)]['content'];
71			if ($prevContent !== $phpcsFile->eolChar) {
72			$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
73			$spaces = strlen($blankSpace);
74
75			if (in_array($tokens[($stackPtr - 2)]['code'], array(T_ABSTRACT, T_FINAL)) === false) {
76			if ($spaces !== 0) {
77			$type = strtolower($tokens[$stackPtr]['content']);
78			$error = 'Expected 0 spaces before %s keyword; %s found';
79			$data = array(
80			$type,
81			$spaces,
82			);
83
84			$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeKeyword', $data);
85			if ($fix === true) {
86			$phpcsFile->fixer->beginChangeset();
87			$phpcsFile->fixer->replaceToken(($stackPtr - 1), '');
88			$phpcsFile->fixer->endChangeset();
89			}
90			}
91			}
92			}//end if
93			}//end if
94			}//end processOpen()
95
96
97			/**
98			* Processes the closing section of a class declaration.
99			*
100			* @param File $phpcsFile The file being scanned.
101			* @param int $stackPtr The position of the current token
102			* in the stack passed in $tokens.
103			*
104			* @return void
105			*/
106			public function processClose(File $phpcsFile, $stackPtr)
107			{
108			$tokens = $phpcsFile->getTokens();
109
110			// Just in case.
111			if (isset($tokens[$stackPtr]['scope_closer']) === false) {
112			return;
113			}
114
115			$closeBrace = $tokens[$stackPtr]['scope_closer'];
116			if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) {
117			$prevContent = $tokens[($closeBrace - 1)]['content'];
118			if ($prevContent !== $phpcsFile->eolChar) {
119			$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
120			$spaces = strlen($blankSpace);
121			if ($spaces !== 0) {
122			if ($tokens[($closeBrace - 1)]['line'] !== $tokens[$closeBrace]['line']) {
123			$error = 'Expected 0 spaces before closing brace; newline found';
124			$fix = $phpcsFile->addFixableError($error, $closeBrace, 'NewLineBeforeCloseBrace');
125			} else {
126			$error = 'Expected 0 spaces before closing brace; %s found';
127			$data = array($spaces);
128			$fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data);
129			}//end if
130
131			if ($fix === true) {
132			$phpcsFile->fixer->beginChangeset();
133			$phpcsFile->fixer->replaceToken(($closeBrace - 1), '');
134			$phpcsFile->fixer->endChangeset();
135			}
136			}//end if
137			}//end if
138			}//end if
139
140			// Check that the closing brace has one blank line after it.
141			$nextContent = $phpcsFile->findNext(array(T_WHITESPACE), ($closeBrace + 1), null, true);
142			if ($nextContent !== false) {
143			$difference = ($tokens[$nextContent]['line'] - $tokens[$closeBrace]['line'] - 1);
144			if ($difference < 0) {
145			$difference = 0;
146			}
147
148			if ($difference !== 1) {
149			$error = 'Closing brace of a %s must be followed by a single blank line; found %s';
150			$data = array(
151			$tokens[$stackPtr]['content'],
152			$difference,
153			);
154			$fix = $phpcsFile->addFixableError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data);
155			if ($fix === true) {
156			$phpcsFile->fixer->beginChangeset();
157
158			if ($difference > 1) {
159			for ($i = ($closeBrace + 1); $i < $nextContent; $i++) {
160			if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) {
161			// Keep existing indentation.
162			break;
163			}
164
165			$phpcsFile->fixer->replaceToken($i, '');
166			}
167			}
168
169			$phpcsFile->fixer->addNewline($closeBrace);
170			$phpcsFile->fixer->endChangeset();
171			}
172			}//end if
173			}//end if
174			}//end processClose()
175			}//end class
176

aik099 / CodingStandard

Push — phpcs-3-upgrade ( d91341 )

ClassDeclarationSniff::processClose() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like