Ktomk\Pipelines\File\Info\StepInfo

Complexity

Total Complexity

16

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getImage()	0	3	1
A	hasDefaultImage()	0	3	1
A	__construct()	0	4	1
A	getStep()	0	3	1
A	annotate()	0	20	4
A	getAnnotations()	0	9	4
A	getImageName()	0	3	1
A	getStepNumber()	0	3	1
A	getName()	0	5	2

<?php

/* this file is part of pipelines */

namespace Ktomk\Pipelines\File\Info;

use Ktomk\Pipelines\File\File;
use Ktomk\Pipelines\File\ParseException;
use Ktomk\Pipelines\File\Pipeline\Step;

/**
 * info about a step (for show output)
 */
final class StepInfo
{
    const NO_NAME = 'no-name';
    const CHAR_ARTIFACTS = 'A';
    const CHAR_CONDITION = 'C';
    const CHAR_MANUAL = 'M';

    /**
     * @var Step
     */
    private $step;
    private $index;

    /**
     * @param Step $step
     * @param int $index (zero-based)
     */
    public function __construct(Step $step, $index)
    {
        $this->step = $step;
        $this->index = (int)$index;
    }

    /**
     * @param string $string
     * @param string $separator [optional]
     * @param mixed $errorFree
     *
     * @return string
     */
    public function annotate($string, $separator = null, &$errorFree = null)
    {
        null === $separator && $separator = ' *';
        $errorFree = true;

        $buffer = (string)$string;

        try {
            $annotations = $this->getAnnotations();
        } catch (ParseException $parseException) {
            $errorFree = false;

            return $buffer . ' ERROR ' . $parseException->getParseMessage();
        }

        if ($annotations) {
            $buffer .= $separator . implode('', $annotations);
        }

        return $buffer;
    }

    /**
     * @return array
     */
    public function getAnnotations()
    {
        $annotations = array();

        $this->step->getArtifacts() && $annotations[] = self::CHAR_ARTIFACTS;
        $this->step->getCondition() && $annotations[] = self::CHAR_CONDITION;
        $this->step->isManual() && $annotations[] = self::CHAR_MANUAL;

        return $annotations;
    }

    /**
     * @return \Ktomk\Pipelines\File\Image
     */
    public function getImage()
    {
        return $this->step->getImage();
    }

    /**
     * @return string
     */
    public function getImageName()
    {
        return $this->step->getImage()->getName();
    }

    /**
     * @return string
     */
    public function getName()
    {
        $name = $this->step->getName();

        return null === $name ? self::NO_NAME : sprintf('"%s"', $name);
    }

    public function getStep()
    {
        return $this->step;
    }

    /**
     * @return int
     */
    public function getStepNumber()
    {
        return $this->index + 1;
    }

    /**
     * @return bool
     */
    public function hasDefaultImage()
    {
        return File::DEFAULT_IMAGE === $this->getImageName();
    }
}