ZenifyCodingStandard\Sniffs\WhiteSpace\PropertiesMethodsMutualSpacingSniff

Complexity

Total Complexity

16

Size/Duplication

Total Lines	128
Duplicated Lines	14.06 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

83.33%

Importance

Changes	3
Bugs	2	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
B	process()	0	27	4
A	isLastProperty()	0	14	3
A	isInsideMethod()	9	9	2
A	areMethodsPresent()	9	9	2
A	getEndOfProperty()	0	18	4

<?php

/*
 * This file is part of Zenify
 * Copyright (c) 2012 Tomas Votruba (http://tomasvotruba.cz)
 */

namespace ZenifyCodingStandard\Sniffs\WhiteSpace;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Sniff;


/**
 * Rules:
 * - Between properties and methods should be x empty line(s).
 */
final class PropertiesMethodsMutualSpacingSniff implements PHP_CodeSniffer_Sniff
{

	/**
	 * @var int
	 */
	public $blankLinesInBetween = 2;


	/**
	 * {@inheritdoc}
	 */
	public function register()
	{
		return [T_VARIABLE];
	}


	/**
	 * {@inheritdoc}
	 */
	public function process(PHP_CodeSniffer_File $file, $position)
	{
		// Fix type
		$this->blankLinesInBetween = (int) $this->blankLinesInBetween;

		if ($this->isLastProperty($file, $position) === FALSE) {
			return;
		}

		if ($this->areMethodsPresent($file, $position) === FALSE) {
			return;
		}

		$tokens = $file->getTokens();
		$next = $file->findNext([T_DOC_COMMENT_OPEN_TAG, T_FUNCTION], $position);

		$endOfProperty = $this->getEndOfProperty($file, $position);
		$blankLines = $tokens[$next]['line'] - $tokens[$endOfProperty]['line'] - 1;
		if ($blankLines !== $this->blankLinesInBetween) {
			$error = 'Between properties and methods should be %s empty line(s); %s found.';
			$data = [
				$this->blankLinesInBetween,
				$blankLines
			];
			$file->addError($error, $position, NULL, $data);
		}
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 * @return bool
	 */
	private function isLastProperty(PHP_CodeSniffer_File $file, $position)
	{
		if ($this->isInsideMethod($file, $position)) {
			return FALSE;
		}

		$tokens = $file->getTokens();
		$next = $file->findNext([T_VARIABLE, T_FUNCTION], $position + 1);
		if ($tokens[$next]['code'] === T_VARIABLE) {
			return FALSE;
		}

		return TRUE;
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 * @return bool
	 */
	private function isInsideMethod(PHP_CodeSniffer_File $file, $position)
	{
		$previousMethod = $file->findPrevious(T_FUNCTION, $position);
		$tokens = $file->getTokens();
		if ($tokens[$previousMethod]['code'] === T_FUNCTION) {
			return TRUE;
		}
		return FALSE;
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 * @return bool
	 */
	private function areMethodsPresent(PHP_CodeSniffer_File $file, $position)
	{
		$next = $file->findNext(T_FUNCTION, $position + 1);
		$tokens = $file->getTokens();
		if ($tokens[$next]['code'] === T_FUNCTION) {
			return TRUE;
		}
		return FALSE;
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 * @return int
	 */
	private function getEndOfProperty(PHP_CodeSniffer_File $file, $position)
	{
		$tokens = $file->getTokens();

		$arrayPosition = $file->findNext(T_ARRAY, $position);
		if ($tokens[$arrayPosition]['line'] === $tokens[$position]['line']) {
			if ($tokens[$arrayPosition]['parenthesis_closer']) {
				return $tokens[$arrayPosition]['parenthesis_closer'];
			}
		}

		$openShortArrayPosition = $file->findNext(T_OPEN_SHORT_ARRAY, $position);
		if ($tokens[$openShortArrayPosition]['line'] === $tokens[$position]['line']) {
			return $tokens[$openShortArrayPosition]['bracket_closer'];
		}

		return $position;
	}

}