Insolita / yii2-codestat

src/controllers/DefaultController.php

<?php
/**
 * Created by solly [18.10.17 4:41]
 */

namespace insolita\codestat\controllers;

use insolita\codestat\CodeStatModule;
use insolita\codestat\helpers\Output;
use insolita\codestat\lib\CodestatService;
use League\CLImate\CLImate;
use yii\base\Module;
use yii\console\Controller;
use yii\console\ExitCode;
use yii\helpers\Console;
use yii\helpers\FileHelper;
use function array_flip;
use function count;
use function file_exists;

class DefaultController extends Controller
{
    public $defaultAction = 'summary';
    /**
     * @var CodeStatModule|Module
     **/
    public $module;
    
    public $color = true;
    
    protected $climate;

    private static $metricGroups = [
        'Common'=> Console::FG_GREEN,
        'Size'=> Console::FG_YELLOW,
        'Cyclomatic Complexity'=> Console::FG_PURPLE,
        'Dependencies'=> Console::FG_CYAN,
        'Structure'=> Console::FG_BLUE,
    ];

    public function __construct($id, Module $module, CLImate $CLImate, array $config = [])
    {
        $this->climate = $CLImate;
        parent::__construct($id, $module, $config);
    }

    /**
     *  Show summary from partial phploc statistic information per each defined group
     * @param bool $showErrors
     * @return int
     */
    public function actionSummary(bool $showErrors = false)
    {
        $service = $this->module->statService;
        $summary = $service->makeStatistic($this->module->prepareFiles());

The method makeStatistic() does not exist on null.

        foreach ($summary as $name => &$row) {
            $row = ['Group' => $name] + $row;
        }
        $total = $service->summaryStatistic($summary);
        $total = ['Group' => 'Total'] + $total;
        $summary = $summary + [$total];
        if ($this->color) {
            $summary = $this->colorize(array_values($summary));
        }
        $this->headline('YII-2 Code Statistic', 'lightYellow');
        $this->climate->table($summary);

        if ($showErrors !== true) {
            return ExitCode::OK;
        }
        $this->headline('Failed for resolve', 'lightYellow');
        if (!count($service->errorList())) {
            $this->climate->info('Errors not found');
        } else {
            Output::arrayList($service->errorList());
        }
        return ExitCode::OK;
    }

    /**
     *  Return full phploc statistic per each defined group
     * @param array $groupNames
     * @return int
     */
    public function actionAdvanced(array $groupNames = []):int
    {
        $service = $this->module->statService;
        $statistic = $service->makeAdvancedStatistic($this->module->prepareFiles(), $this->module->metrics);

It seems like $this->module->metrics can also be of type null and object; however, parameter $metrics of insolita\codestat\lib\contracts\CodestatServiceInterface::makeAdvancedStatistic() does only seem to accept array, maybe add an additional type check?

        $this->headline('YII-2 Code Statistic', 'green');


        foreach ($statistic as $group => $data) {
            if (!empty($groupNames) && !in_array($group, $groupNames, true)) {
                continue;
            }
            $this->headline($group, 'lightYellow');
            $this->printMetricData($data);
            if (empty($groupNames) && !$this->confirm('Show next group?', true)) {
                break;
            }
        }
        return ExitCode::OK;
    }

    /**
     * Return  phploc statistic for all files
     * @return int
     */
    public function actionCommon():int
    {
        $service = $this->module->statService;
        $statistic = $service->makeCommonStatistic($this->module->prepareFiles(), $this->module->metrics);

It seems like $this->module->metrics can also be of type null and object; however, parameter $metrics of insolita\codestat\lib\contracts\CodestatServiceInterface::makeCommonStatistic() does only seem to accept array, maybe add an additional type check?

        $this->headline('YII-2 Code Statistic', 'green');
        $this->printMetricData($statistic, !empty($this->module->metrics));
        return ExitCode::OK;
    }

    /**
     * Return  phploc statistic for concrete directory
     * @param string $dir - Path or path alias
     * @return int
     */
    public function actionDirectory(string $dir):int
    {
        $service = $this->module->statService;
        $dir = \Yii::getAlias($dir);
        if (!is_dir($dir)) {
            $this->stderr('Directory not found by path ' . $dir);
            return ExitCode::UNSPECIFIED_ERROR;
        }
        $statistic = $service->makeCommonStatistic(FileHelper::findFiles($dir, [
            'only' => ['*.php'],
            'caseSensitive' => false,
            'recursive' => true,
        ]), $this->module->metrics);

It seems like $this->module->metrics can also be of type null and object; however, parameter $metrics of insolita\codestat\lib\contracts\CodestatServiceInterface::makeCommonStatistic() does only seem to accept array, maybe add an additional type check?

        $this->headline('YII-2 Code Statistic', 'green');
        $this->printMetricData($statistic, !empty($this->module->metrics));
        return ExitCode::OK;
    }

    /**
     * Return  phploc statistic for concrete file
     * @param string $filePath - Path or path alias
     * @return int
     */
    public function actionFile(string $filePath):int
    {
        $service = $this->module->statService;
        $filePath = \Yii::getAlias($filePath);
        if (!file_exists($filePath)) {
            $this->stderr('File not found by path ' . $filePath);
            return ExitCode::UNSPECIFIED_ERROR;
        }
        $statistic = $service->makeCommonStatistic([$filePath], $this->module->metrics);

It seems like $this->module->metrics can also be of type null and object; however, parameter $metrics of insolita\codestat\lib\contracts\CodestatServiceInterface::makeCommonStatistic() does only seem to accept array, maybe add an additional type check?

        $this->headline('YII-2 Code Statistic', 'green');
        $this->printMetricData($statistic, !empty($this->module->metrics));
        return ExitCode::OK;
    }

    /**
     * Show files that will be processed accordingly module configuration
     */
    public function actionListFiles()
    {
        Output::info('The following files will be processed accordingly module configuration');
        $files = $this->module->prepareFiles();
        Output::arrayList($files);
        Output::separator();
        Output::info('Total: ' . count($files));
    }

    /**
     * Show available metrics
     */
    public function actionListMetrics()
    {
        foreach (CodestatService::$metricNames as $group =>$data)
        {
            $printData = array_merge([$group => 'Group'], array_flip($data));
            $this->printMetricData($printData);
            Output::separator();
        }
    }
    
    protected function colorize(array $summary):array
    {
        $colorized = [];
        foreach ($summary as $i => $row) {
            foreach ($row as $key => $value) {
                if ($key === 'Group') {
                    $value = $this->wrap($value, 'yellow');
                }
                if ($i == count($summary) - 1) {
                    $value = $this->wrap($value, 'light_cyan');
                }
                $key = $this->wrap($key, 'green');
                $colorized[$i][$key] = (string) $value;
            }
        }
        return $colorized;
    }

    protected function wrap($string, $color):string
    {
        return "<bold><$color>$string</$color></bold>";
    }

    protected function headline($string, $color):void
    {
        $this->climate->green()->border('=', 110)->$color()->tab(4)->out($string);
    }

    /**
     * @param      $data
     * @param bool $skipHeaders
     */
    private function printMetricData($data, bool $skipHeaders = false):void
    {
        foreach ($data as $index => $line) {
            if ($line === 'Group') {
                if ($skipHeaders === true) {
                    continue;
                }
                $this->stdout($index, self::$metricGroups[$index], Console::BOLD);
                $this->stdout(PHP_EOL);
                Output::separator();
                continue;
            }
            $this->stdout(' ' . $index . '  ', Console::BOLD);
            $this->stdout($line . PHP_EOL);
        }
    }
}