MS\PHPMD\Rule\CleanCode\SuperfluousComment

Complexity

Total Complexity

19

Size/Duplication

Total Lines	150
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	3

9 Methods

Rating	Name	Duplication	Size	Complexity
A	apply()	0	16	4
A	checkClass()	0	8	1
A	checkProperties()	0	10	2
A	checkMethods()	0	10	2
A	checkNode()	0	6	2
A	calculateNameToCommentSimilarityInPercent()	0	16	2
A	getCommentDescription()	0	14	3
A	transformDescriptionLines()	0	10	2
A	transformString()	0	7	1

<?php

namespace MS\PHPMD\Rule\CleanCode;

use PDepend\Source\AST\ASTClass;
use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Node\ClassNode;
use PHPMD\Rule\ClassAware;
use PDepend\Source\AST\AbstractASTArtifact;

/**
 * Class SuperfluousComment
 *
 * Don't write superfluous comments. It's adding by subtracting.
 *
 * @package MS\PHPMD\Rule\CleanCode
 */
class SuperfluousComment extends AbstractRule implements ClassAware
{
    /**
     * @var int
     */
    private $percent;

    /**
     * @param AbstractNode $node
     */
    public function apply(AbstractNode $node)
    {
        $this->percent = $this->getIntProperty('percent');

        if (true === $this->getBooleanProperty('checkClass')) {
            $this->checkClass($node);
        }

        if (true === $this->getBooleanProperty('checkProperties')) {
            $this->checkProperties($node);
        }

        if (true === $this->getBooleanProperty('checkMethods')) {
            $this->checkMethods($node);
        }
    }

    /**
     * @param AbstractNode $node
     */
    private function checkClass(AbstractNode $node)
    {
        $this->checkNode(
            $node,
            $node->getType(),
            $this->calculateNameToCommentSimilarityInPercent($node)
        );
    }

    /**
     * @param AbstractNode|ASTClass $node
     */
    private function checkProperties(AbstractNode $node)
    {
        foreach ($node->getProperties() as $property) {
            $this->checkNode(
                $node,
                'property ' . $property->getName(),
                $this->calculateNameToCommentSimilarityInPercent($property)
            );
        }
    }

    /**
     * @param AbstractNode|ClassNode $node
     */
    private function checkMethods(AbstractNode $node)
    {
        foreach ($node->getMethods() as $method) {
            $this->checkNode(
                $method,
                $method->getType(),
                $this->calculateNameToCommentSimilarityInPercent($method)
            );
        }
    }

    /**
     * @param AbstractNode $node
     * @param string       $type
     * @param int          $percent
     */
    private function checkNode(AbstractNode $node, $type, $percent)
    {
        if ($this->percent < $percent) {
            $this->addViolation($node, [$type, $percent]);
        }
    }

    /**
     * @param AbstractNode|AbstractASTArtifact $node
     *
     * @return float
     */
    private function calculateNameToCommentSimilarityInPercent($node)
    {
        $docComment = $node->getDocComment();

The method getDocComment does only exist in PDepend\Source\AST\AbstractASTArtifact, but not in PHPMD\AbstractNode.

        if (empty($docComment)) {
            return 0;
        }

        similar_text(
            $this->transformString($node->getName()),
            $this->getCommentDescription($docComment),
            $percent
        );

        return round($percent);
    }

    /**
     * @param string $docComment
     *
     * @return string
     */
    private function getCommentDescription($docComment)
    {
        $lines = explode(PHP_EOL, $docComment);

        $descriptionLines = [];

        foreach ($lines as $line) {
            if (false === strpos($line, '@')) {
                $descriptionLines[] = $line;
            }
        }

        return $this->transformDescriptionLines($descriptionLines);
    }

    /**
     * @param array $descriptionLines
     *
     * @return string
     */
    private function transformDescriptionLines(array $descriptionLines)
    {
        $description = '';

        foreach ($descriptionLines as $line) {
            $description .= $this->transformString($line);
        }

        return $description;
    }

    /**
     * @param string $string
     *
     * @return string
     */
    private function transformString($string)
    {
        $string = strtolower($string);
        $string = preg_replace('/[^a-z0-9]/', '', $string);

        return $string;
    }
}