Ktomk\Pipelines\Runner\Containers\NameBuilder

Complexity

Total Complexity

9

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	stepContainerNameByStep()	0	7	1
A	slugify()	0	31	4
A	serviceContainerName()	0	11	1
A	setRole()	0	5	1
A	setProject()	0	5	1
A	stepContainerName()	0	17	1

<?php

/* this file is part of pipelines */

namespace Ktomk\Pipelines\Runner\Containers;

use Ktomk\Pipelines\File\Pipeline\Step;
use Ktomk\Pipelines\Project;
use UnexpectedValueException;

/**
 * Class NameBuilder
 *
 * @package Ktomk\Pipelines\Runner\Containers
 */
class NameBuilder
{
    /**
     * @var Project
     */
    private $project;

    /**
     * @var string
     */
    private $role;

    /**
     * @param string $string
     * @param string $replacement [optional] defaults to dash "-"
     * @param string $fallBack [optional] defaults to empty string
     *
     * @return string
     */
    public static function slugify($string, $replacement = null, $fallBack = null)
    {
        null === $replacement && $replacement = '-';

        // all non-allowed characters -> replacement (which is normally a separator "_", "." or "-")
        $buffer = preg_replace('([^a-zA-Z0-9_.-]+)', (string)$replacement, (string)$string);
        if (false === $buffer) {
            // @codeCoverageIgnoreStart
            throw new UnexpectedValueException('regex operation failed');
            // @codeCoverageIgnoreEnd
        }

        // multiple separator(s) after each other -> one replacement (which is normally a separator)
        $buffer = preg_replace('(([_.-])[_.-]+)', (string)$replacement, $buffer);

        // not starting nor ending with a separator
        $buffer = trim($buffer, '_.-');

        // not starting with a number
        $buffer = preg_replace('(^\d+([_.-]\d+)*)', (string)$replacement, $buffer);

        // multiple separator(s) after each other -> one replacement (which is normally a separator)
        $buffer = preg_replace('(([_.-])[_.-]+)', (string)$replacement, $buffer);

        // not starting nor ending with a separator
        $buffer = trim($buffer, '_.-');

        // separator(s) only -> empty string
        $buffer = preg_replace('(^[_.-]+$)', '', $buffer);

        return '' === (string)$buffer ? (string)$fallBack : (string)$buffer;
    }

    /**
     * service container name
     *
     * example: pipelines.service-redis.pipelines
     *              ^    `   ^   `  ^  `   ^
     *              |        |      |      |
     *              |    "service"  |   project
     *           prefix       service name
     *
     * @param string $prefix
     * @param string $serviceName
     * @param string $projectName
     *
     * @return string
     */
    public static function serviceContainerName($prefix, $serviceName, $projectName)
    {
        return self::slugify(
            sprintf(
                '%s.service-%s',
                $prefix,
                implode(
                    '.',
                    array(
                        self::slugify($serviceName, '-', 'unnamed'),
                        $projectName,
                    )
                )
            )
        );
    }

    /**
     * step container name
     *
     * example: pipelines-1.pipeline-features-and-introspection.default.app
     *              ^    `^`                  ^                `    ^  ` ^
     *              |     |                   |                     |    |
     *              | step number        step name           pipeline id |
     *           prefix                                                project
     *
     * @param string $pipelineId
     * @param string $stepName
     * @param int $stepNumber (step numbers start at one)
     * @param string $prefix
     * @param string $projectName
     *
     * @return string
     */
    public static function stepContainerName($pipelineId, $stepName, $stepNumber, $prefix, $projectName)
    {
        return self::slugify(
            sprintf(
                '%s-%s',
                $prefix,
                implode(
                    '.',
                    array(
                        (string)(int)max(1, $stepNumber),
                        self::slugify($stepName, '-', 'no-name'),
                        self::slugify($pipelineId, '-', 'null'),
                        $projectName,
                    )
                )
            ),
            ''
        );
    }

    /**
     * generate step container name
     *
     * @param string $prefix
     * @param Step $step
     * @param string $projectName
     *
     * @return string
     *
     * @see StepContainer::generateName()
     */
    public static function stepContainerNameByStep(Step $step, $prefix, $projectName)
    {
        $pipelineId = $step->getPipeline()->getId();
        $stepName = $step->getName();
        $stepNumber = $step->getIndex() + 1;

        return self::stepContainerName($pipelineId, $stepName, $stepNumber, $prefix, $projectName);
    }

    /**
     * @param Project $project
     *
     * @return self
     */
    public function setProject(Project $project)
    {
        $this->project = $project;

        return $this;
    }

    /**
     * @param string $role
     *
     * @return NameBuilder
     */
    public function setRole($role)
    {
        $this->role = Role::verify($role);

        return $this;
    }
}