TheCodingMachine\WashingMachine\Gitlab\Message

Complexity

Total Complexity

13

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	addCoverageMessage()	0	26	3
A	addDifferencesHtml()	0	6	1
A	addDifference()	0	4	1
B	getDifferencesHtml()	0	50	6
A	getLinkToMethodInCommit()	0	4	1
A	__toString()	0	4	1

<?php


namespace TheCodingMachine\WashingMachine\Gitlab;


use TheCodingMachine\WashingMachine\Clover\Analysis\Difference;
use TheCodingMachine\WashingMachine\Clover\CoverageDetectorInterface;
use TheCodingMachine\WashingMachine\Clover\CrapMethodFetcherInterface;
use TheCodingMachine\WashingMachine\Clover\DiffService;

/**
 * A class to build the message sent to Gitlab.
 */
class Message
{
    private $msg = '';

    public function addCoverageMessage(CoverageDetectorInterface $coverageDetector, CoverageDetectorInterface $previousCoverageDetector)
    {
        $coverage = $coverageDetector->getCoveragePercentage();
        $previousCoverage = $previousCoverageDetector->getCoveragePercentage();

        $additionalText = '';
        $style = '';
        if ($coverage > $previousCoverage + 0.0001) {
            $additionalText = sprintf('(<em>+%.2f%%</em>)', ($coverage - $previousCoverage)*100);
            $style .= 'background-color: #00994c; color: white';
        } elseif ($coverage < $previousCoverage - 0.0001) {
            $additionalText = sprintf('(<em>-%.2f%%</em>)', ($previousCoverage - $coverage)*100);
            $style .= 'background-color: #ff6666; color: white';
        }


        // Note: there is a failure in the way Gitlab escapes HTML for the tables. Let's use this!.
        $this->msg .= sprintf('<table>
<tr>
<td>PHP&nbsp;code&nbsp;coverage:</td>
<td style="font-weight: bold">%.2f%%</td>
<td style="%s">%s</td>
<td width="99%%"></td>
</tr>
</table><br/>', $coverageDetector->getCoveragePercentage()*100, $style, $additionalText);
    }


    public function addDifferencesHtml(CrapMethodFetcherInterface $methodFetcher, CrapMethodFetcherInterface $previousMethodFetcher, DiffService $diffService, string $commitId, string $gitlabUrl, string $projectName)
    {
        $differences = $diffService->getMeaningfulDifferences($methodFetcher, $previousMethodFetcher);

        $this->msg .= $this->getDifferencesHtml($differences, $commitId, $gitlabUrl, $projectName);
    }

    public function addDifference(Difference $difference, string $commitId, string $gitlabUrl, string $projectName)
    {
        $this->msg .= $this->getDifferencesHtml([$difference], $commitId, $gitlabUrl, $projectName);
    }


    private function getDifferencesHtml(array $differences, string $commitId, string $gitlabUrl, string $projectName) : string
    {
        if (empty($differences)) {
            return 'No meaningful differences in code complexity detected.';
        }

        $tableTemplate = '<table>
<tr>
<th></th>
<th>C.R.A.P.</th>
<th>Variation</th>
<th width="99%%"></th>
</tr>
%s
</table>';
        $tableRows = '';
        $crapScoreEmojiGenerator = EmojiGenerator::createCrapScoreEmojiGenerator();
        foreach ($differences as $difference) {
            $style = '';
            if (!$difference->isNew()) {

                if ($difference->getCrapDifference() < 0) {
                    $style = 'background-color: #00994c; color: white';
                } else {
                    $style = 'background-color: #ff6666; color: white';
                }
                $differenceCol = sprintf('%+d', $difference->getCrapDifference());
                $crapScoreEmoji = '';
            } else {
                $differenceCol = '<em>New</em>';
                // For new rows, let's display an emoji
                $crapScoreEmoji = $crapScoreEmojiGenerator->getEmoji($difference->getCrapScore());
            }

            if ($difference->getFile() !== null) {
                $link = $this->getLinkToMethodInCommit($gitlabUrl, $projectName, $commitId, $difference->getFile(), $difference->getLine());
                $fullLink = sprintf('<a href="%s">%s</a>', $link, $difference->getMethodShortName());
            } else {
                $fullLink = $difference->getMethodShortName();
            }

            $tableRows .= sprintf('<tr>
<td><code>%s</code></td>
<td style="text-align:center">%d%s</td>
<td style="text-align:center;%s">%s</td>
</tr>', $fullLink, $difference->getCrapScore(), $crapScoreEmoji, $style, $differenceCol);
        }

        return sprintf($tableTemplate, $tableRows);
    }

    private function getLinkToMethodInCommit(string $gitlabUrl, string $projectName, string $commit, string $filePath, int $line)
    {
        return rtrim($gitlabUrl, '/').'/'.$projectName.'/blob/'.$commit.'/'.ltrim($filePath, '/').'#L'.$line;
    }

    public function __toString()
    {
        return $this->msg;
    }
}