einfach\operation\step\AbstractStep

Complexity

Total Complexity

9

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

92.31%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	isSkipped()	0	4	1
A	skip()	0	4	1
A	functionSignature()	0	5	1
A	name()	0	4	1
A	signature()	0	5	1
A	normalizeStepResult()	0	20	3
	__invoke()	0	1	?

<?php

namespace einfach\operation\step;

use const einfach\operation\response\RESPONSE_TYPE_ERROR;
use const einfach\operation\response\RESPONSE_TYPE_OK;
use einfach\operation\Result;

abstract class AbstractStep
{
    /**
     * @var callable
     */
    public $function;
    protected $name;
    /**
     * Indicates was this step performed or not
     *
     * @var bool
     */
    protected $skipped;

    public function __construct(callable $callable, string $name = null)
    {
        $this->function = $callable;
        $this->name = $name;
        $this->skipped = false;
    }

    public function isSkipped() : bool
    {
        return true == $this->skipped;

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

    }

    public function skip() : bool
    {
        return $this->skipped = true;
    }

    public function functionSignature() : string
    {
        is_callable($this->function, false, $functionName);
        return $functionName;
    }

    /**
     * Step name, respecting custom name
     */
    public function name() : string
    {
        return $this->name ?? $this->functionSignature();
    }

    public function signature($template = "%-10s | %s") : string
    {
        $className = (new \ReflectionClass($this))->getShortName();
        return sprintf($template, $className, $this->name());
    }

    /**
     * Transform all results into valid resut array form
     * It could be Result object instance for nested steps
     */
    protected function normalizeStepResult($result) : array
    {
        $stepResult = $result;
        
        if (is_a($result, Result::class)) {
            if ($result->isSuccess()) {
                $stepResult = [
                    'type' => RESPONSE_TYPE_OK,
                    'appendParams' => $result->params()
                ];
            } else {
                $stepResult = [
                    'type' => RESPONSE_TYPE_ERROR,
                    'appendError' => $result->errors()
                ];
            }
        }

        return $stepResult;
    }

    abstract public function __invoke(&$params, string $track);
}