ZenifyCodingStandard\Sniffs\Classes\FinalInterfaceSniff

Complexity

Total Complexity

14

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

94.12%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
B	process()	0	23	5
A	implementsInterface()	0	4	1
A	isFinalOrAbstractClass()	0	5	2
A	isDoctrineEntity()	0	20	4
A	addFinalToClass()	0	4	1

<?php

declare(strict_types = 1);

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

namespace ZenifyCodingStandard\Sniffs\Classes;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Sniff;


/**
 * Rules:
 * - Non-abstract class that implements interface should be final.
 * - Except for Doctrine entities, they cannot be final.
 *
 * Inspiration:
 * - http://ocramius.github.io/blog/when-to-declare-classes-final/
 */
final class FinalInterfaceSniff implements PHP_CodeSniffer_Sniff
{

	/**
	 * @var string
	 */
	const NAME = 'ZenifyCodingStandard.Classes.FinalInterface';

	/**
	 * @var PHP_CodeSniffer_File
	 */
	private $file;

	/**
	 * @var int
	 */
	private $position;


	/**
	 * @return int[]
	 */
	public function register() : array
	{
		return [T_CLASS];
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 */
	public function process(PHP_CodeSniffer_File $file, $position)
	{
		$this->file = $file;
		$this->position = $position;

		if ($this->implementsInterface() === FALSE) {
			return;
		}

		if ($this->isFinalOrAbstractClass()) {
			return;
		}

		if ($this->isDoctrineEntity()) {
			return;
		}

		$fix = $file->addFixableError('Non-abstract class that implements interface should be final.', $position);

		if ($fix) {
			$this->addFinalToClass($position);
		}
	}


	/**
	 * @return bool
	 */
	private function implementsInterface()
	{
		return (bool) $this->file->findNext(T_IMPLEMENTS, $this->position);
	}


	/**
	 * @return bool
	 */
	private function isFinalOrAbstractClass()
	{
		$classProperties = $this->file->getClassProperties($this->position);
		return ($classProperties['is_abstract'] || $classProperties['is_final']);
	}


	/**
	 * @return bool
	 */
	private function isDoctrineEntity()
	{
		$docCommentPosition = $this->file->findPrevious(T_DOC_COMMENT_OPEN_TAG, $this->position);
		if ($docCommentPosition === FALSE) {
			return FALSE;
		}

		$seekPosition = $docCommentPosition;

		do {
			$docCommentTokenContent = $this->file->getTokens()[$docCommentPosition]['content'];
			if (strpos($docCommentTokenContent, 'Entity') !== FALSE) {
				return TRUE;
			}
			$seekPosition++;

		} while ($docCommentPosition = $this->file->findNext(T_DOC_COMMENT_TAG, $seekPosition, $this->position));

It seems like $seekPosition defined by $seekPosition++ on line 117 can also be of type boolean; however, PHP_CodeSniffer_File::findNext() does only seem to accept integer, maybe add an additional type check?

		return FALSE;
	}


	public function addFinalToClass(int $position)
	{
		$this->file->fixer->addContentBefore($position, 'final ');
	}

}