wol-soft/php-workflow

View on GitHub
src/State/ExecutionLog/OutputFormat/GraphViz.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method renderWorkflowGraph has 67 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function renderWorkflowGraph(string $workflowName, array $steps): string
    {
        $dotScript = sprintf("  %s [label=\"$workflowName\"]\n", self::$stepIndex++);
        foreach ($steps as $stage => $stageSteps) {
            $dotScript .= sprintf(
Severity: Major
Found in src/State/ExecutionLog/OutputFormat/GraphViz.php - About 2 hrs to fix

    Function renderWorkflowGraph has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        private function renderWorkflowGraph(string $workflowName, array $steps): string
        {
            $dotScript = sprintf("  %s [label=\"$workflowName\"]\n", self::$stepIndex++);
            foreach ($steps as $stage => $stageSteps) {
                $dotScript .= sprintf(
    Severity: Minor
    Found in src/State/ExecutionLog/OutputFormat/GraphViz.php - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Avoid using static access to class '\PHPWorkflow\State\ExecutionLog\ExecutionLog' in method 'renderWorkflowGraph'.
    Open

                    ExecutionLog::mapStage($stage)

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    syntax error, unexpected 'int' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
    Open

        private static int $stepIndex = 0;

    Multi-line function call not indented correctly; expected 28 spaces but found 32
    Open

                                    $info->getInfo(),

    Multi-line function call not indented correctly; expected 28 spaces but found 32
    Open

                                    [

    Space before opening parenthesis of function call prohibited
    Open

                                fn (StepInfo $info): bool => !in_array(

    Space before opening parenthesis of function call prohibited
    Open

                            fn (StepInfo $info): string => "<BR/><FONT POINT-SIZE=\"10\">{$info->getInfo()}</FONT>",

    There are no issues that match your filters.

    Category
    Status