PhpDocBuilder::build() - Code Metrics - Inspection of "Simplify some methods" - Prometee/SwaggerClientGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 04ad09...373749 )

by Francis
created 2020-01-26 22:58 UTC
PhpDocBuilder::build() A

↳ Parent: PhpDocBuilder
Complexity

Conditions	4
Paths	4
Size

Total Lines	18
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	9
c	0
b	0
f	0
dl	0
loc	18
rs	9.9666
cc	4
nc	4
nop	1
<?php

declare(strict_types=1);

namespace Prometee\SwaggerClientBuilder\PhpBuilder\PhpDoc;

class PhpDocBuilder implements PhpDocBuilderInterface
{
    /** @var array */
    protected $lines = [];
    /** @var int */
    protected $wrapOn = 100;

    /**
     * {@inheritDoc}
     */
    public function configure(array $lines = [], int $wrapOn = 100)
    {
        $this->lines = $lines;
        $this->wrapOn = $wrapOn;
    }

    /**
     * {@inheritDoc}
     */
    public function addLine(string $line, string $type = ''): void
    {
        if (!isset($this->lines[$type])) {
            $this->lines[$type] = [];
        }
        foreach (explode("\n", $line) as $l) {
            $this->lines[$type][] = $l;
        }
    }

    /**
     * {@inheritDoc}
     */
    public function addDescriptionLine(string $line): void
    {
        $this->addLine($line, static::TYPE_DESCRIPTION);
    }

    /**
     * {@inheritDoc}
     */
    public function addEmptyLine(): void
    {
        $this->addDescriptionLine('');
    }

    /**
     * {@inheritDoc}
     */
    public function addVarLine(?string $line): void
    {
        $this->addLine($line, static::TYPE_VAR);
        $this->addLine(/** @scrutinizer ignore-type */ $line, static::TYPE_VAR);
    }

    /**
     * {@inheritDoc}
     */
    public function addParamLine(string $name, string $type = '', string $description = ''): void
    {
        $this->addLine(
            (empty($type) ? '' : $type . ' ') . $name . (empty($description) ? '' : ' ' . $description),
            static::TYPE_PARAM
        );
    }

    /**
     * {@inheritDoc}
     */
    public function addReturnLine(?string $line): void
    {
        $this->addLine($line, static::TYPE_RETURN);
        $this->addLine(/** @scrutinizer ignore-type */ $line, static::TYPE_RETURN);
    }

    /**
     * {@inheritDoc}
     */
    public function addThrowsLine(?string $line): void
    {
        $this->addLine($line, static::TYPE_THROWS);
        $this->addLine(/** @scrutinizer ignore-type */ $line, static::TYPE_THROWS);
    }

    /**
     * {@inheritDoc}
     */
    public function hasSingleVarLine(): bool
    {
        return isset($this->lines[static::TYPE_VAR])
            && count($this->lines) === 1
            && count($this->lines[static::TYPE_VAR]) === 1;
    }

    /**
     * {@inheritDoc}
     */
    public function build(string $indent = null): ?string
    {
        $phpdocLines = $this->buildLines();

        if (empty($phpdocLines)) {
            return null;
        }

        if ($this->hasSingleVarLine()) {
            return sprintf('%1$s/** %3$s */%2$s', $indent, "\n", $phpdocLines[0]);
        }

        $lines = [];
        foreach ($phpdocLines as $phpdocLine) {
            $lines[] = sprintf('%s * %s', $indent,$phpdocLine);
        }

        return sprintf('%1$s/**%2$s%3$s%2$s%1$s */%2$s', $indent, "\n", implode("\n", $lines));
    }

    /**
     * {@inheritDoc}
     */
    public function buildLines(): array
    {
        $phpdocLines = [];
        $previousType = null;
        $this->orderLines();
        foreach ($this->lines as $type => $lines) {
            if ($previousType === null) {
                $previousType = $type;
            }
            if ($previousType !== $type) {
                $phpdocLines[] = '';
                $previousType = $type;
            }
            $this->buildTypedLines($type, $lines, $phpdocLines);
        }
        return $phpdocLines;
    }

    /**
     * {@inheritDoc}
     */
    public function buildTypedLines(string $type, array $lines, array &$phpdocLines): void
    {
        foreach ($lines as $line) {
            $lineSuffix = ($type === static::TYPE_DESCRIPTION ? '' : '@' . $type . ' ');
            foreach (static::wrapLines($lineSuffix . $line, $this->wrapOn) as $i => $l) {
                $phpdocLines[] = ($i > 0 ? str_repeat(' ', strlen($lineSuffix)) : '') . $l;
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public static function wrapLines(string $line, int $wrapOn = 100): array
    {
        $lines = [];
        $currentLine = '';
        foreach (explode(' ', $line) as $word) {
            if (iconv_strlen($currentLine . ' ' . $word) > $wrapOn) {
                $lines[] = $currentLine;
                $currentLine = $word;
            } else {
                $currentLine .= (!empty($currentLine) ? ' ' : '') . $word;
            }
        }
        $lines[] = $currentLine;

        return $lines;
    }

    /**
     * {@inheritDoc}
     */
    public static function getPossibleTypesFromTypeNames(array $types = []): string
    {
        if (empty($types)) {
            return '';
        }
        $typesFound = [];

        foreach ($types as $type) {
            if ($type === null) {
                continue;
            }
            if (preg_match('#^\?#', $type)) {
                $typesFound[] = 'null';
            }
            $typesFound[] = ltrim($type, '?');
        }

        $typesFound = array_unique($typesFound);

        return implode('|', $typesFound);
    }

    /**
     * {@inheritDoc}
     */
    public function setWrapOn(int $wrapOn): void
    {
        $this->wrapOn = $wrapOn;
    }

    /**
     * {@inheritDoc}
     */
    public function getWrapOn(): int
    {
        return $this->wrapOn;
    }

    /**
     * {@inheritDoc}
     */
    public function orderLines(): void
    {
        uksort($this->lines, function ($k1, $k2) {
            $o1 = array_search($k1, static::LINE_TYPE_ORDER);
            $o2 = array_search($k2, static::LINE_TYPE_ORDER);

            return $o1 - $o2;
        });
    }
}

Prometee / SwaggerClientGenerator

Push — master ( 04ad09...373749 )

PhpDocBuilder::build() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
