cloak\reporter\LcovReporter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	145
Duplicated Lines	4.83 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	6
Bugs	0	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	onFinalize()	0	4	1
A	writeFileFooter()	0	4	1
A	onInitialize()	7	7	1
A	onAnalyzeStop()	0	5	1
A	writeResult()	0	8	2
A	writeFileResult()	0	12	2
A	writeFileHeader()	0	10	1
A	writeLineResult()	0	12	2
A	getTargetLinesFromFile()	0	10	2
A	registerTo()	0	4	1

<?php

/**
 * This file is part of cloak.
 *
 * (c) Noritaka Horio <holy.shared.design@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace cloak\reporter;


use cloak\AnalyzedCoverageResult;
use cloak\result\FileResult;
use cloak\analyzer\result\LineResult;
use cloak\event\InitializeEvent;
use cloak\event\AnalyzeStopEvent;
use cloak\event\FinalizeEvent;
use cloak\writer\FileWriter;
use PHPExtra\EventManager\EventManager;


/**
 * Class LcovReporter
 * @package cloak\reporter
 */
class LcovReporter
    implements Reporter, InitializeEventListener, FinalizeEventListener, AnalyzeStopEventListener
{

    const SOURCE_FILE_PREFIX = 'SF:';
    const COVERAGE_PREFIX = 'DA:';
    const END_OF_RECORD = 'end_of_record';

    /**
     * @var string Report file name
     */
    private $fileName;


    /**
     * @var \cloak\writer\FileWriter
     */
    private $reportWriter;


    /**
     * @param string|null $fileName
     * @throws \cloak\writer\DirectoryNotFoundException
     * @throws \cloak\writer\DirectoryNotWritableException
     */
    public function __construct($fileName)
    {
        $this->fileName = $fileName;
    }

    /**
     * @param InitializeEvent $event
     */
    public function onInitialize(InitializeEvent $event)

This method seems to be duplicated in your project.

    {
        $reportDirectory = $event->getReportDirectory();
        $reportFile = $reportDirectory->join($this->fileName);

        $this->reportWriter = new FileWriter( $reportFile->stringify() );
    }

    /**
     * @param \cloak\event\AnalyzeStopEvent $event
     */
    public function onAnalyzeStop(AnalyzeStopEvent $event)
    {
        $result = $event->getResult();
        $this->writeResult($result);
    }

    /**
     * @param FinalizeEvent $event
     */
    public function onFinalize(FinalizeEvent $event)
    {
        $this->reportWriter = null;
    }

    /**
     * @param AnalyzedCoverageResult $result
     */
    private function writeResult(AnalyzedCoverageResult $result)
    {
        $files = $result->getFiles();

        foreach($files as $file) {
            $this->writeFileResult($file);
        }
    }

    /**
     * @param FileResult $file
     */
    private function writeFileResult(FileResult $file)
    {
        $this->writeFileHeader($file);

        $targetLines = $this->getTargetLinesFromFile($file);

        foreach ($targetLines as $targetLine) {
            $this->writeLineResult($targetLine);
        }

        $this->writeFileFooter();
    }

    /**
     * @param FileResult $file
     */
    private function writeFileHeader(FileResult $file)
    {
        $parts = [
            self::SOURCE_FILE_PREFIX,
            $file->getPath()
        ];

        $record = implode('', $parts);
        $this->reportWriter->writeLine($record);
    }

    private function writeFileFooter()
    {
        $this->reportWriter->writeLine(self::END_OF_RECORD);
    }

    /**
     * @param \cloak\analyzer\result\LineResult $line
     */
    private function writeLineResult(LineResult $line)
    {

        $executedCount = $line->isExecuted() ? 1 : 0;
        $recordParts = [
            $line->getLineNumber(),
            $executedCount
        ];

        $record = self::COVERAGE_PREFIX . implode(',', $recordParts);
        $this->reportWriter->writeLine($record);
    }

    /**
     * @param FileResult $file
     * @return array
     */
    private function getTargetLinesFromFile(FileResult $file)
    {
        $lineResults = $file->getLineResults();

        $results = $lineResults->selectLines(function(LineResult $line) {
            return $line->isExecuted() || $line->isUnused();
        })->all();

        return $results;
    }

    /**
     * @param EventManager $eventManager
     */
    public function registerTo(EventManager $eventManager)
    {
        $eventManager->add($this);
    }

}