Tvi\MonitorBundle\Reporter\Console

Complexity

Total Complexity

15

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Test Coverage

Coverage

9.09%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getDataOut()	0	16	4
A	tagByCode()	0	11	1
A	__construct()	0	8	2
A	onAfterRun()	0	31	5
A	onStart()	0	5	1
A	tagByImportance()	0	11	1
A	onFinish()	0	12	1

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Reporter;

use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Tvi\MonitorBundle\Check\CheckAbstract;
use ZendDiagnostics\Check\CheckInterface;
use ZendDiagnostics\Result\Collection as ResultsCollection;
use ZendDiagnostics\Result\ResultInterface;

/**

Missing short description in doc comment

 * @author Kevin Bond <kevinbond@gmail.com>, Vladimir Turnaev <turnaev@gmail.com>

Content of the @author tag must be in the form "Display Name <username@example.com>"

 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Console extends ReporterAbstract
{
    private const STATUS_TAG_SUCCESS = '<fg=green;options=bold>';
    private const STATUS_TAG_WARNING = '<fg=yellow;options=bold>';
    private const STATUS_TAG_SKIP = '<fg=blue;options=bold>';
    private const STATUS_TAG_FAILURE = '<fg=red;options=bold>';
    private const STATUS_TAG_UNKNOWN = '<fg=white;options=bold>';

    private const IMPORTANCE_TAG_EMERGENCY = '<fg=red;options=bold>';
    private const IMPORTANCE_TAG_WARNING = '<fg=yellow;options=bold>';
    private const IMPORTANCE_TAG_NOTE = '<fg=green;options=bold>';
    private const IMPORTANCE_TAG_INFO = '<fg=blue;options=bold>';
    private const IMPORTANCE_TAG_DEFAULT = '<fg=default>';

    /**

Missing short description in doc comment

     * @var OutputInterface
     */
    protected $output;

    /**

Missing short description in doc comment

     * @var bool
     */
    protected $withData;

    /**

Missing short description in doc comment

Parameter $withData should have a doc-comment as per coding-style.

     * @param OutputInterface $output

Missing parameter comment

     */
    public function __construct(OutputInterface $output = null, $withData = false)
    {
        if (null === $output) {
            $output = new ConsoleOutput();
        }
        $this->output = $output;

        $this->withData = $withData;
    }

    /**

Parameter $check should have a doc-comment as per coding-style.

Parameter $result should have a doc-comment as per coding-style.

Parameter $checkAlias should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function onAfterRun(CheckInterface $check, ResultInterface $result, $checkAlias = null)
    {
        list($status, $code) = $this->getStatusByResul($result);

        $statusTag = static::tagByCode($code);

        $groupTag = $check->getGroup();

The method getGroup() does not exist on ZendDiagnostics\Check\CheckInterface. It seems like you code against a sub-type of ZendDiagnostics\Check\CheckInterface such as Tvi\MonitorBundle\Check\CheckAbstract.

        $tags = $check->getTags();

The method getTags() does not exist on ZendDiagnostics\Check\CheckInterface. It seems like you code against a sub-type of ZendDiagnostics\Check\CheckInterface such as Tvi\MonitorBundle\Check\CheckAbstract.

        if ($tags) {
            $tags = implode(', ', $tags);
            $tags = "[$tags]";
            $groupTag .= ' / '.$tags;
        } else {
            $tags = null;

The assignment to $tags is dead and can be removed.

        }

        $message = $result->getMessage();
        if ($message) {
            $message = ", {$message}";
        }

        $labelTag = static::tagByImportance($check->getImportance());

The method getImportance() does not exist on ZendDiagnostics\Check\CheckInterface. It seems like you code against a sub-type of ZendDiagnostics\Check\CheckInterface such as Tvi\MonitorBundle\Check\CheckAbstract.

        $this->output->writeln(sprintf('%s%-30s</> %-40s %s%-10s</> %s%s',

The opening parenthesis of a multi-line function call should be the last content on the line.

            $labelTag, $check->getId(), $groupTag, $statusTag, $status, $check->getLabel(), $message));

The method getId() does not exist on ZendDiagnostics\Check\CheckInterface. It seems like you code against a sub-type of ZendDiagnostics\Check\CheckInterface such as Tvi\MonitorBundle\Check\CheckAbstract.

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

For multi-line function calls, the closing parenthesis should be on a new line.

        if ($this->withData) {
            $dataOut = $this->getDataOut($result);
            if ($dataOut) {
                $this->output->writeln(sprintf('%-71s < %s >', ' ', $dataOut));
            }
        }
    }

    /**

Parameter $checks should have a doc-comment as per coding-style.

Parameter $runnerConfig should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function onStart(\ArrayObject $checks, $runnerConfig)
    {
        parent::onStart($checks, $runnerConfig);

        $this->output->writeln(sprintf('<fg=white;options=bold>%-30s %-40s %-10s %s, %s</>', 'Check', 'Group / Tag(s)', 'Status', 'Info', 'Message'));
    }

    /**

Parameter $results should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function onFinish(ResultsCollection $results)
    {
        parent::onFinish($results);

        $this->output->writeln('---------------------------------');
        $this->output->writeln(sprintf('%s: %s', 'total', $this->getTotalCount()));
        $this->output->writeln('');
        $this->output->writeln(sprintf('%s%-10s</>: %s', self::STATUS_TAG_SUCCESS, 'SUCCESSES', $this->getSuccessCount()));
        $this->output->writeln(sprintf('%s%-10s</>: %s', self::STATUS_TAG_WARNING, 'WARNINGS', $this->getWarningCount()));
        $this->output->writeln(sprintf('%s%-10s</>: %s', self::STATUS_TAG_SKIP, 'SKIP', $this->getSkipCount()));
        $this->output->writeln(sprintf('%s%-10s</>: %s', self::STATUS_TAG_FAILURE, 'FAILURES', $this->getFailureCount()));
        $this->output->writeln(sprintf('%s%-10s</>: %s', self::STATUS_TAG_UNKNOWN, 'UNKNOWNS', $this->getUnknownCount()));
    }

    public static function tagByCode($code): string

Missing doc comment for function tagByCode()

    {
        $tags = [
            static::STATUS_CODE_SUCCESS => static::STATUS_TAG_SUCCESS,
            static::STATUS_CODE_WARNING => static::STATUS_TAG_WARNING,
            static::STATUS_CODE_SKIP => static::STATUS_TAG_SKIP,
            static::STATUS_CODE_FAILURE => static::STATUS_TAG_FAILURE,
            'default' => static::STATUS_TAG_UNKNOWN,
        ];

        return $tags[$code] ?? $tags['default'];
    }

    public static function tagByImportance($importance): string

Missing doc comment for function tagByImportance()

    {
        $tags = [
            CheckAbstract::IMPORTANCE_EMERGENCY => static::IMPORTANCE_TAG_EMERGENCY,
            CheckAbstract::IMPORTANCE_WARNING => static::IMPORTANCE_TAG_WARNING,
            CheckAbstract::IMPORTANCE_NOTE => static::IMPORTANCE_TAG_NOTE,
            CheckAbstract::IMPORTANCE_INFO => static::IMPORTANCE_TAG_INFO,
            'default' => static::IMPORTANCE_TAG_DEFAULT,
        ];

        return $tags[$importance] ?? $tags['default'];
    }


    /**

Missing short description in doc comment

Parameter $result should have a doc-comment as per coding-style.

     * @return null|string
     */
    protected function getDataOut(ResultInterface $result)
    {
        $dataOut = null;
        $message = $result->getMessage();
        if ($message) {
            $data = $result->getData();
            if (null !== $data) {
                $dataOut = json_encode($data);

                if (\mb_strlen($dataOut) > 100) {
                    $dataOut .= "\n";
                }
            }
        }

        return $dataOut;
    }
}