DataStructureLengthSniff.php

<?php

/**
 * Data structure length code sniffer.
 *
 * This sniff is the base for class, interface, trait, function and method 
 * length checks as part of "Keep your classes small" object calisthenics
 * rule.
 *
 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
 */
abstract class ObjectCalisthenics_DataStructureLengthSniff implements PHP_CodeSniffer_Sniff
{
    /**
     * Supported list of tokenizers supported by this sniff.
     *
     * @var array
     */
    public $supportedTokenizers = array('PHP');

    /**
     * Maximum data structure length for warning,
     *
     * @var integer
     */
    public $maxLength = 200;

    /**
     * Absolute maximum data structure length for error.
     *
     * @var integer
     */
    public $absoluteMaxLength = 200;

    /**
     * Registers the tokens that this sniff wants to listen for.
     *
     * @return integer[]
     */
    abstract public function register();

    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param integer               $stackPtr  The position of the current token
     *                                         in the stack passed in $tokens.
     */
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $tokens    = $phpcsFile->getTokens();
        $token     = $tokens[$stackPtr];
        $tokenType = strtolower(substr($token['type'], 2));
        $length    = $this->getStructureLength($phpcsFile, $stackPtr);

        switch (true) {
            case ($length > $this->absoluteMaxLength):
                $message = 'Keep your %s small (currently using %d lines, must be less or equals than %d lines)';
                $error   = sprintf($message, $tokenType, $length, $this->absoluteMaxLength);

                $phpcsFile->addError($error, $stackPtr, sprintf('%sTooBig', ucfirst($tokenType)));

                break;

            case ($length > $this->maxLength):
                $message = 'Your %s is too big, consider refactoring (currently using %d lines, should be less or equals than %d lines)';
                $warning = sprintf($message, $tokenType, $length, $this->maxLength);

                $phpcsFile->addWarning($warning, $stackPtr, sprintf('%sTooBig', ucfirst($tokenType)));

                break;
        }
    }

    /**
     * Retrieve the data structure LOC.
     *
     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param integer               $stackPtr  The position of the current token
     *                                         in the stack passed in $tokens.
     *
     * @return integer
     */
    private function getStructureLength(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();
        $token  = $tokens[$stackPtr];

        // Skip function without body.
        if (isset($token['scope_opener']) === false) {
            return 0;
        }

        $firstToken = $tokens[$token['scope_opener']];
        $lastToken  = $tokens[$token['scope_closer']];
        
        return $lastToken['line'] - $firstToken['line'];
    }
}