Renderer::renderClass() - Code Metrics - Inspection of "Patch 1" - slawomirkania/class-generator-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#14)

unknown
created 2017-04-24 11:35 UTC
Renderer::renderClass() B

↳ Parent: Renderer
Complexity

Conditions	5
Paths	16
Size

Total Lines	30
Code Lines	22
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	30
rs	8.439
c	0
b	0
f	0
cc	5
eloc	22
nc	16
nop	1
<?php

namespace SimpleEntityGeneratorBundle\Lib;

use Doctrine\Common\Collections\ArrayCollection;
use SimpleEntityGeneratorBundle\Lib\Exceptions\RendererException;
use SimpleEntityGeneratorBundle\Lib\Exceptions\UnrecognizedItemToRenderException;
use SimpleEntityGeneratorBundle\Lib\Interfaces\RenderableInterface;
use SimpleEntityGeneratorBundle\Lib\Interfaces\SetterMethodInterface;
use SimpleEntityGeneratorBundle\Lib\Items\ClassConstructorManager;
use SimpleEntityGeneratorBundle\Lib\Items\ClassManager;
use SimpleEntityGeneratorBundle\Lib\Items\InitPropertyManager;
use SimpleEntityGeneratorBundle\Lib\Items\InterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodDerivedFromInterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodForPropertyManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanInterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterInterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterManager;
use SimpleEntityGeneratorBundle\Lib\Items\PropertyManager;
use SimpleEntityGeneratorBundle\Lib\Items\TestClassManager;
use SimpleEntityGeneratorBundle\Lib\Items\TestMethodManager;

/**
 * Factory for rendering items
 *
 * @author Sławomir Kania <[email protected]>
 */
class Renderer
{

    /**
     * No indention
     *
     * @var integer
     */
    const INDENT_NO_INDENT = 0;

    /**
     * One indention
     *
     * @var integer
     */
    const INDENT_4_SPACES = 4;

    /**
     * Two indentations
     *
     * @var integer
     */
    const INDENT_8_SPACES = 8;

    /**
     * @var string
     */
    const JMS_ANNOTATION_NAMESPACE = "@\\JMS\\Serializer\\Annotation";

    /**
     * @var TemplateManager
     */
    private $templateManager;

    /**
     * CONSTR
     */
    public function __construct(TemplateManager $templateManager)
    {
        $this->templateManager = $templateManager;
    }

    /**
     * @return TemplateManager
     */
    public function getTemplateManager()
    {
        return $this->templateManager;
    }

    /**
     * Render renderable item
     *
     * @param RenderableInterface $item
     * @return string
     * @throws RendererException
     * @throws UnrecognizedItemToRenderException
     */
    public function render(RenderableInterface $item)
    {
        $this->getTemplateManager()->loadAndSetTemplateOnItem($item);
        switch (true) {
            case $item instanceof ClassManager:
                return $this->renderClass($item);
            case $item instanceof ClassConstructorManager:
                return $this->renderClassConstructor($item);
            case $item instanceof InitPropertyManager:
                return $this->renderInitProperty($item);
            case $item instanceof InterfaceManager:
                return $this->renderInterface($item);
            case $item instanceof PropertyManager:
                return $this->renderProperty($item);
            case $item instanceof MethodForPropertyManager:
                return $this->renderMethodForProperty($item);
            case $item instanceof MethodDerivedFromInterfaceManager:
                return $this->renderMethodDerivedFromInterface($item);
            case $item instanceof TestClassManager:
                return $this->renderTestClass($item);
            case $item instanceof TestMethodManager:
                return $this->renderTestMethod($item);
            default:
                throw $this->getExceptionUnrecognizedItem($item);
        }
    }

    /**
     * @param string $content
     * @param ClassConstructorManager $constructor
     * @param int $position
     * @return string
     */
    public function renderAndPutConstructorBodyToContent($content, ClassConstructorManager $constructor, $position = 0)
    {
        $source = Tools::explodeTemplateStringToArray($content);
        foreach ($constructor->getInitProperties() as $initProperty) {
            $this->putElementIntoSource($source, $position, $this->addIndentation($this->render($initProperty), self::INDENT_8_SPACES));
        }

        return Tools::implodeArrayToTemplate($source);
    }

    /**
     * @param string $content
     * @param ArrayCollection $itemsToRender
     * @param int $position
     * @return string
     */
    public function renderAndPutItemsToContent($content, ArrayCollection $itemsToRender, $position = 0)
    {
        $itemsRendered = [];
        foreach ($itemsToRender as $itemToRender) {
            $itemsRendered[] = $this->render($itemToRender);
        }

        return $this->updateSourceWithElements($content, $position, $itemsRendered);
    }

    /**
     * @param InitPropertyManager $initProperty
     * @return string
     * @throws RendererException
     */
    protected function renderInitProperty(InitPropertyManager $initProperty)
    {
        $template = $initProperty->getTemplate();
        $tags = $initProperty->getTemplateTags();

        $args[RenderableInterface::TAG_PROPERTY_NAME] = $initProperty->getProperty()->getPreparedName();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $args[RenderableInterface::TAG_PROPERTY_TYPE] = sprintf('\%s', $initProperty->getProperty()->getTypeName());
        return $this->replace($tags, $args, $template);
    }

    /**
     * @param ClassConstructorManager $classConstructor
     * @return string
     * @throws RendererException
     */
    protected function renderClassConstructor(ClassConstructorManager $classConstructor)
    {
        $template = $classConstructor->getTemplate();
        $tags = $classConstructor->getTemplateTags();

        $initProperties = [];
        foreach ($classConstructor->getInitProperties() as $initProperty) {
            $initProperties[] = $this->render($initProperty);
        }

        $initPropertiesRendered = empty($initProperties) ? "" : Tools::implodeArrayToTemplate($initProperties);
        $args[RenderableInterface::TAG_INIT_PROPERTIES] = $initPropertiesRendered;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        return $this->addNewLineAfter($this->addIndentation($this->replace($tags, $args, $template), self::INDENT_4_SPACES));
    }

    /**
     * @param MethodForPropertyManager $method
     * @return string
     * @throws RendererException
     * @throws UnrecognizedItemToRenderException
     */
    protected function renderMethodForProperty(MethodForPropertyManager $method)
    {
        $template = $method->getTemplate();
        $tags = $method->getTemplateTags();

        $property = $method->getProperty();
        $propertyName = $property->getPreparedName();
        $methodName = $method->getPreparedName();
        $comment = sprintf('For property "%s"', $propertyName);

        $args = [];
        switch (true) {
            case $method instanceof MethodGetterManager:

                $args[RenderableInterface::TAG_COMMENT] = $comment;
                $args[RenderableInterface::TAG_PROPERTY_TYPE] = $this->getScalarTypeOrAbsoluteObjectTypeFromProperty($property);
                $args[RenderableInterface::TAG_METHOD_NAME] = $methodName;
                $args[RenderableInterface::TAG_PROPERTY_NAME] = $propertyName;
                break;
            case $method instanceof MethodGetterInterfaceManager:
                $args[RenderableInterface::TAG_COMMENT] = $comment;
                $args[RenderableInterface::TAG_PROPERTY_TYPE] = $this->getScalarTypeOrAbsoluteObjectTypeFromProperty($property);
                $args[RenderableInterface::TAG_METHOD_NAME] = $methodName;
                break;
            case $method instanceof MethodGetterBooleanManager:

                $args[RenderableInterface::TAG_COMMENT] = $comment;
                $args[RenderableInterface::TAG_PROPERTY_TYPE] = $this->getScalarTypeOrAbsoluteObjectTypeFromProperty($property);
                $args[RenderableInterface::TAG_METHOD_NAME] = $methodName;
                $args[RenderableInterface::TAG_PROPERTY_NAME] = $propertyName;
                break;
            case $method instanceof MethodGetterBooleanInterfaceManager:
                $args[RenderableInterface::TAG_COMMENT] = $comment;
                $args[RenderableInterface::TAG_PROPERTY_TYPE] = $this->getScalarTypeOrAbsoluteObjectTypeFromProperty($property);
                $args[RenderableInterface::TAG_METHOD_NAME] = $methodName;
                break;
            case $method instanceof SetterMethodInterface:
                $typeHintitngPart = '';
                if ($method->canAddTypeHinting()) {
                    $typeHintitngPart = sprintf('%s ', $property->getTypeNameAbsoluteIfIsObjectTypeOrThrowException());
                }

                $optionalPart = '';
                if ($property->isOptional()) {
                    $optionalPart = ' = null';
                }

                $args[RenderableInterface::TAG_COMMENT] = $comment;
                $args[RenderableInterface::TAG_PROPERTY_TYPE] = $this->getScalarTypeOrAbsoluteObjectTypeFromProperty($property);
                $args[RenderableInterface::TAG_TYPE_HINTING] = $typeHintitngPart;
                $args[RenderableInterface::TAG_METHOD_NAME] = $methodName;
                $args[RenderableInterface::TAG_PROPERTY_NAME] = $propertyName;
                $args[RenderableInterface::TAG_OPTIONAL_PART] = $optionalPart;
                break;
            default:
                throw $this->getExceptionUnrecognizedItem($method);
        }

        return $this->addNewLineAfter($this->addIndentation($this->replace($tags, $args, $template), self::INDENT_4_SPACES));
    }

    protected function renderMethodDerivedFromInterface(MethodDerivedFromInterfaceManager $method)
    {
        $template = $method->getTemplate();
        $tags = $method->getTemplateTags();
        $args = [
            RenderableInterface::TAG_METHOD_NAME => $method->getPreparedName()
        ];
        return $this->addNewLineAfter($this->addIndentation($this->replace($tags, $args, $template), self::INDENT_4_SPACES));
    }

    /**
     * @param ClassManager $class
     * @return string
     * @throws RendererException
     */
    protected function renderClass(ClassManager $class)
    {
        $template = $class->getTemplate();
        $tags = $class->getTemplateTags();

        $properties = [];
        $methods = [];
        $extendsPart = '';
        foreach ($class->getProperties() as $property) {
            $properties[] = $this->render($property);
        }
        foreach ($class->getMethods() as $method) {
            $methods[] = $this->render($method);
        }
        if ($class->hasExtends()) {
            $extendsPart = sprintf(" extends %s", $class->getExtends());
        }

        $args[RenderableInterface::TAG_NAMESPACE] = $class->getNamespaceWithoutNameAndBackslashPrefix();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $args[RenderableInterface::TAG_COMMENT] = empty($class->getComment()) ? "" : $class->getComment();
        $args[RenderableInterface::TAG_NAME] = $class->getName();
        $args[RenderableInterface::TAG_EXTENDS] = $extendsPart;
        $args[RenderableInterface::TAG_INTERFACE] = $this->renderInterfacePart($class);
        $args[RenderableInterface::TAG_CONSTRUCTOR] = $this->addNewLineBefore($this->render($class->getConstructor()));
        $args[RenderableInterface::TAG_PROPERTIES] = $this->addNewLineBefore(Tools::implodeArrayToTemplate($properties));
        $args[RenderableInterface::TAG_METHODS] = $this->addNewLineBefore(Tools::implodeArrayToTemplate($methods));
        $args[RenderableInterface::TAG_MULTILINE_COMMENT] = $this->prepareMultilineCommentForCollection($class->getMultilineComment());

        return $this->addNewLineAfter($this->replace($tags, $args, $template));
    }

    protected function renderInterfacePart(ClassManager $class)
    {
        $namespaces = $class->getImplements()->toArray();
        if ($class->hasInterface()) {
            $namespaces[] = $class->getInterface()->getNamespace();
        }
        $namespacesStr = implode(', ', $namespaces);
        return $namespacesStr ? sprintf(" implements %s", $namespacesStr) : '';
    }

    /**
     * @param InterfaceManager $interface
     * @return string
     * @throws RendererException
     */
    protected function renderInterface(InterfaceManager $interface)
    {
        $template = $interface->getTemplate();
        $tags = $interface->getTemplateTags();

        $methods = [];
        foreach ($interface->getMethods() as $method) {
            $methods[] = $this->render($method);
        }

        $args[RenderableInterface::TAG_NAMESPACE] = $interface->getNamespaceWithoutNameAndBackslashPrefix();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $args[RenderableInterface::TAG_COMMENT] = $interface->getComment();
        $args[RenderableInterface::TAG_NAME] = $interface->getName();
        $args[RenderableInterface::TAG_METHODS] = $this->addNewLineBefore(Tools::implodeArrayToTemplate($methods));

        return $this->addNewLineAfter($this->replace($tags, $args, $template));
    }

    /**
     * @param PropertyManager $property
     * @return string
     * @throws RendererException
     */
    protected function renderProperty(PropertyManager $property)
    {
        $template = $property->getTemplate();
        $tags = $property->getTemplateTags();

        $comment = $property->getComment();
        if (empty($comment)) {
            $comment = sprintf("'%s' property", $property->getName());
        }

        $jmsCollection = new ArrayCollection();
        $jmsCollection->add(sprintf("%s\Type(\"%s\")", self::JMS_ANNOTATION_NAMESPACE, $property->getType()));
        if ($property->hasSerializedName()) {
            $jmsCollection->add(sprintf("%s\SerializedName(\"%s\")", self::JMS_ANNOTATION_NAMESPACE, $property->getSerializedName()));
        } else {
            $jmsCollection->add(sprintf("%s\SerializedName(\"%s\")", self::JMS_ANNOTATION_NAMESPACE, $property->getName()));
        }

        $args[RenderableInterface::TAG_COMMENT] = $comment;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $args[RenderableInterface::TAG_CONSTRAINTS] = $this->prepareMultilineCommentForCollection($property->getConstraintAnnotationCollection());
        $args[RenderableInterface::TAG_JMS_PART] = $this->prepareMultilineCommentForCollection($jmsCollection);
        $args[RenderableInterface::TAG_TYPE] = $this->getScalarTypeOrAbsoluteObjectTypeFromProperty($property);
        $args[RenderableInterface::TAG_NAME] = $property->getPreparedName();
        $args[RenderableInterface::TAG_MULTILINE_COMMENT] = $this->prepareMultilineCommentForCollection($property->getMultilineComment());

        return $this->addNewLineAfter($this->addIndentation($this->replace($tags, $args, $template), self::INDENT_4_SPACES));
    }

    /**
     * @param TestClassManager $testClass
     * @return string
     * @throws RendererException
     */
    protected function renderTestClass(TestClassManager $testClass)
    {
        $template = $testClass->getTemplate();
        $tags = $testClass->getTemplateTags();

        $constructTestMethodBody = [];
        $methods = [];
        foreach ($testClass->getMethods() as $method) {
            $methods[] = $this->render($method);
        }

        $class = $testClass->getClassManager();

        $constructTestMethodBody[] = "\$this->assertNotNull(\$this->object);";
        if ($testClass->getClassManager()->hasInterface()) {
            $interfaceTestAssert = sprintf("\$this->assertInstanceof('%s', \$this->object);", $testClass->getClassManager()->getInterface()->getNamespace());
            $constructTestMethodBody[] = $this->addIndentation($interfaceTestAssert, self::INDENT_8_SPACES);
        }

        $classTestAssert = sprintf("\$this->assertInstanceof('%s', \$this->object);", $class->getNamespace());
        $constructTestMethodBody[] = $this->addIndentation($classTestAssert, self::INDENT_8_SPACES);

        if ($testClass->getClassManager()->hasExtends()) {
            $extendsTestAssert = sprintf("\$this->assertInstanceof('%s', \$this->object);", $testClass->getClassManager()->getExtends());
            $constructTestMethodBody[] = $this->addIndentation($extendsTestAssert, self::INDENT_8_SPACES);
        }

        $testObjectType = $class->getNamespace();
        if ($class->hasInterface()) {
            $testObjectType = $class->getInterface()->getNamespace();
        }

        $args[RenderableInterface::TAG_NAMESPACE] = $testClass->getNamespaceWithoutNameAndBackslashPrefix();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $args[RenderableInterface::TAG_COMMENT] = $testClass->getComment();
        $args[RenderableInterface::TAG_NAME] = $testClass->getName();
        $args[RenderableInterface::TAG_CLASS] = $class->getNamespace();
        $args[RenderableInterface::TAG_METHODS] = $this->addNewLineBefore(Tools::implodeArrayToTemplate($methods));
        $args[RenderableInterface::TAG_TEST_OBJECT_TYPE] = $testObjectType;
        $args[RenderableInterface::TAG_METHOD_BODY] = Tools::implodeArrayToTemplate($constructTestMethodBody);

        return $this->addNewLineAfter($this->replace($tags, $args, $template));
    }

    /**
     * @param TestMethodManager $testMethod
     * @return string
     * @throws RendererException
     */
    protected function renderTestMethod(TestMethodManager $testMethod)
    {
        $template = $testMethod->getTemplate();
        $tags = $testMethod->getTemplateTags();

        $args[RenderableInterface::TAG_CLASS] = $testMethod->getMethod()->getClassManager()->getNamespace();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $args[RenderableInterface::TAG_METHOD_NAME] = $testMethod->getMethod()->getPreparedName();
        $args[RenderableInterface::TAG_TEST_METHOD_NAME] = $testMethod->getPreparedName();

        return $this->addNewLineAfter($this->addIndentation($this->replace($tags, $args, $template), self::INDENT_4_SPACES));
    }

    /**
     * Replace tags in template witch arguments
     *
     * @param array $tags
     * @param array $args
     * @param string $template
     * @return string
     * @throws RendererException
     */
    protected function replace($tags, $args, $template)
    {
        if ($tags !== array_keys($args)) {
            throw new RendererException("Tags and keys are not identical!");
        }

        return str_replace($tags, array_values($args), $template);
    }

    /**
     * Add Indentation to template
     *
     * @param string $template
     * @param integer $spaces
     * @return string
     */
    protected function addIndentation($template, $spaces = self::INDENT_NO_INDENT)
    {
        $parts = Tools::explodeTemplateStringToArray($template);
        array_walk(
            $parts, function (&$value) use ($spaces) {
            $value = str_pad($value, strlen($value) + (int)$spaces, " ", STR_PAD_LEFT);
        }
        );

        return Tools::implodeArrayToTemplate($parts);
    }

    /**
     * @param mixed $item
     * @return UnrecognizedItemToRenderException
     */
    protected function getExceptionUnrecognizedItem($item)
    {
        return new UnrecognizedItemToRenderException(sprintf("Unrecognized item: %s", get_class($item)));
    }

    /**
     * Update source file with rendered elements
     *
     * @param string $content
     * @param integer $startPosition
     * @param array $renderedElements
     * @return string
     */
    protected function updateSourceWithElements($content, $startPosition = 0, array $renderedElements = [])
    {
        $source = Tools::explodeTemplateStringToArray($content);
        foreach ($renderedElements as $renderedElement) {
            $this->putElementIntoSource($source, $startPosition, $renderedElement);
        }

        return Tools::implodeArrayToTemplate($source);
    }

    /**
     * @param array $source
     * @param integer $offset
     * @param string $element
     */
    protected function putElementIntoSource(&$source, $offset, $element)
    {
        array_splice($source, $offset, 0, [$element]);
    }

    /**
     * Put new line to the end of conent
     *
     * @param string $content
     * @return string
     * @throws RendererException
     */
    protected function addNewLineAfter($content)

    {
        if (false === is_string($content)) {
            throw new RendererException("Invalid string!");
        }

        return sprintf("%s\n", $content);
    }

    /**
     * Put new line before conent
     *
     * @param string $content
     * @return string
     * @throws RendererException
     */
    protected function addNewLineBefore($content)

    {
        if (false === is_string($content)) {
            throw new RendererException("Invalid string!");
        }

        return sprintf("\n%s", $content);
    }

    /**
     * @param ArrayCollection $collection
     * @return string
     * @throws \Exception
     */
    protected function prepareMultilineCommentForCollection(ArrayCollection $collection)
    {
        if ($collection->isEmpty()) {
            return "";
        }

        $multilinePrepared = [];
        $first = true;
        foreach ($collection as $row) {
            if ($first) {
                $multilinePrepared[] = sprintf("%s", $row);
            } else {
                $multilinePrepared[] = sprintf(" * %s", $row);
            }
            $first = false;
        }

        return Tools::implodeArrayToTemplate($multilinePrepared);
    }

    /**
     * @param PropertyManager $property
     * @return string
     * @throws \Exception
     */
    protected function getScalarTypeOrAbsoluteObjectTypeFromProperty(PropertyManager $property)
    {
        if ($property->isObjectType()) {
            return $property->getTypeNameAbsoluteIfIsObjectTypeOrThrowException();
        } else {
            return $property->getTypeName();
        }
    }
}

1			<?php
2
3			namespace SimpleEntityGeneratorBundle\Lib;
4
5			use Doctrine\Common\Collections\ArrayCollection;
6			use SimpleEntityGeneratorBundle\Lib\Exceptions\RendererException;
7			use SimpleEntityGeneratorBundle\Lib\Exceptions\UnrecognizedItemToRenderException;
8			use SimpleEntityGeneratorBundle\Lib\Interfaces\RenderableInterface;
9			use SimpleEntityGeneratorBundle\Lib\Interfaces\SetterMethodInterface;
10			use SimpleEntityGeneratorBundle\Lib\Items\ClassConstructorManager;
11			use SimpleEntityGeneratorBundle\Lib\Items\ClassManager;
12			use SimpleEntityGeneratorBundle\Lib\Items\InitPropertyManager;
13			use SimpleEntityGeneratorBundle\Lib\Items\InterfaceManager;
14			use SimpleEntityGeneratorBundle\Lib\Items\MethodDerivedFromInterfaceManager;
15			use SimpleEntityGeneratorBundle\Lib\Items\MethodForPropertyManager;
16			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanInterfaceManager;
17			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanManager;
18			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterInterfaceManager;
19			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterManager;
20			use SimpleEntityGeneratorBundle\Lib\Items\PropertyManager;
21			use SimpleEntityGeneratorBundle\Lib\Items\TestClassManager;
22			use SimpleEntityGeneratorBundle\Lib\Items\TestMethodManager;
23
24			/**
25			* Factory for rendering items
26			*
27			* @author Sławomir Kania <[email protected]>
28			*/
29			class Renderer
30			{
31
32			/**
33			* No indention
34			*
35			* @var integer
36			*/
37			const INDENT_NO_INDENT = 0;
38
39			/**
40			* One indention
slawomirkania / class-generator-bundle

Pull Request — master (#14)

Renderer::renderClass() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
