AlexWells\ApiDocsGenerator\Parsers\AbstractStepTransformer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	parse()	0	17	4
A	getTransformerMethodName()	0	9	1
A	callTransformer()	0	9	2
A	__construct()	0	3	1

<?php

namespace AlexWells\ApiDocsGenerator\Parsers;

use AlexWells\ApiDocsGenerator\Exceptions\InvalidFormat;

abstract class AbstractStepTransformer
{
    /**
     * Steps that should be taken to transform the string from raw to end result.
     *
     * @return array
     */
    abstract protected static function getTransformerSteps();

    /**
     * Content to be parsed.
     *
     * @var string
     */
    protected $content;

    /**
     * AbstractStep constructor.
     *
     * @param string $content content to be parsed
     */
    public function __construct(string $content)
    {
        $this->content = $content;
    }

    /**
     * Parse the content.
     *
     * @throws InvalidFormat
     *
     * @return array
     */
    public function parse()
    {
        $content = $this->content;

        foreach (static::getTransformerSteps() as $step) {
            $content = static::callTransformer($step, $content);

            if($content === null) {
                throw new InvalidFormat("Format is invalid. Failed at step: $step");
            }

            if(empty($content)) {
                return $content;
            }
        }

        return $content;

The expression return $content also could return the type string which is incompatible with the documented return type array.

    }

    /**
     * Call transformer method by it's partial name.
     *
     * @param string $name Transformer name
     *
     * @return string|array
     */
    protected static function callTransformer($name, $content)
    {
        $transformer = static::getTransformerMethodName($name);

        if(! method_exists(static::class, $transformer)) {
            return $content;
        }

        return static::$transformer($content);
    }

    /**
     * Get method name for transformer by it's partial name.
     *
     * @param string $name Transformer name
     *
     * @return string
     */
    protected static function getTransformerMethodName($name)
    {
        // Convert snake_case (if present) to camelCase
        $name = camel_case($name);

        // Capitalize first letter
        $name = ucfirst($name);

        return "transform$name";
    }
}