ONGR\ElasticsearchBundle\Generator\DocumentGenerator

Complexity

Total Complexity

40

Size/Duplication

Total Lines	311
Duplicated Lines	7.07 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	7
Bugs	0	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	generateDocumentClass()	0	16	1
A	generateDocumentBody()	0	18	4
A	generateDocumentProperties()	11	11	2
A	generateDocumentMethods()	11	11	2
B	generateDocumentConstructor()	0	14	5
A	generateDocumentMethod()	0	10	1
C	generatePropertyDocBlock()	0	39	11
A	generateDocumentDocBlock()	0	17	2
A	prefixWithSpaces()	0	12	3
A	getClassName()	0	5	2
A	generateDocumentUse()	0	10	2
B	hasMultipleEmbedded()	0	10	5

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <info@nfq.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Generator;

/**
 * Document Generator
 */
class DocumentGenerator
{
    /**
     * @var string
     */
    private $spaces = '    ';

    /**
     * @var string
     */
    private $getMethodTemplate =
        '/**
 * Returns <fieldName>
 *
 * @return string
 */
public function get<methodName>()
{
<spaces>return $this-><fieldName>;
}';

    /**
     * @var string
     */
    private $setMethodTemplate =
        '/**
 * Sets <fieldName>
 *
 * @param string $<fieldName>
 */
public function set<methodName>($<fieldName>)
{
<spaces>$this-><fieldName> = $<fieldName>;
}';

    /**
     * @var string
     */
    private $constructorTemplate =
        '/**
 * Constructor
 */
public function __construct()
{
<fields>
}';

    /**
     * @param array $metadata
     *
     * @return string
     */
    public function generateDocumentClass(array $metadata)
    {
        return implode(
            "\n",
            [
                "<?php\n",
                sprintf('namespace %s;', substr($metadata['name'], 0, strrpos($metadata['name'], '\\'))) . "\n",
                $this->generateDocumentUse($metadata),
                $this->generateDocumentDocBlock($metadata),
                'class ' . $this->getClassName($metadata),
                "{",
                str_replace('<spaces>', $this->spaces, $this->generateDocumentBody($metadata)),
                "}\n"
            ]
        );
    }

    /**
     * Generates document body
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentBody(array $metadata)
    {
        $lines = [];

        if ($properties = $this->generateDocumentProperties($metadata)) {
            $lines[] = $properties;
        }

        if ($this->hasMultipleEmbedded($metadata)) {
            $lines[] = $this->generateDocumentConstructor($metadata);
        }

        if ($methods = $this->generateDocumentMethods($metadata)) {
            $lines[] = $methods;
        }

        return rtrim(implode("\n", $lines));
    }

    /**
     * Generates document properties
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentProperties(array $metadata)

This method seems to be duplicated in your project.

    {
        $lines = [];

        foreach ($metadata['properties'] as $property) {
            $lines[] = $this->generatePropertyDocBlock($property);
            $lines[] = $this->spaces . 'private $' . $property['field_name'] . ";\n";
        }

        return implode("\n", $lines);
    }

    /**
     * Generates document methods
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentMethods(array $metadata)

This method seems to be duplicated in your project.

    {
        $lines = [];

        foreach ($metadata['properties'] as $property) {
            $lines[] = $this->generateDocumentMethod($property, $this->setMethodTemplate) . "\n";
            $lines[] = $this->generateDocumentMethod($property, $this->getMethodTemplate) . "\n";
        }

        return implode("\n", $lines);
    }

    /**
     * Generates document constructor
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentConstructor(array $metadata)
    {
        $fields = [];

        foreach ($metadata['properties'] as $prop) {
            if ($prop['annotation'] == 'embedded' && isset($prop['property_multiple']) && $prop['property_multiple']) {
                $fields[] = sprintf('%s$this->%s = new Collection();', $this->spaces, $prop['field_name']);
            }
        }

        return $this->prefixWithSpaces(
            str_replace('<fields>', implode("\n", $fields), $this->constructorTemplate)
        ) . "\n";
    }

    /**
     * Generates document method
     *
     * @param array  $metadata
     * @param string $template
     *
     * @return string
     */
    private function generateDocumentMethod(array $metadata, $template)
    {
        return $this->prefixWithSpaces(
            str_replace(
                ['<methodName>', '<fieldName>'],
                [ucfirst($metadata['field_name']), $metadata['field_name']],
                $template
            )
        );
    }

    /**
     * Returns property doc block
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generatePropertyDocBlock(array $metadata)
    {
        $lines = [
            $this->spaces . '/**',
            $this->spaces . ' * @var string',
            $this->spaces . ' *',
        ];

        $column = [];
        if (isset($metadata['property_name']) && $metadata['property_name'] != $metadata['field_name']) {
            $column[] = 'name="' . $metadata['property_name'] . '"';
        }

        if (isset($metadata['property_class'])) {
            $column[] = 'class="' . $metadata['property_class'] . '"';
        }

        if (isset($metadata['property_multiple']) && $metadata['property_multiple']) {
            $column[] = 'multiple=true';
        }

        if (isset($metadata['property_type']) && $metadata['annotation'] == 'property') {
            $column[] = 'type="' . $metadata['property_type'] . '"';
        }

        if (isset($metadata['property_default'])) {
            $column[] = 'default="' . $metadata['property_default'] . '"';
        }

        if (isset($metadata['property_options'])  && $metadata['property_options']) {
            $column[] = 'options={' . $metadata['property_options'] . '}';
        }

        $lines[] = $this->spaces . ' * @ES\\' . ucfirst($metadata['annotation']) . '(' . implode(', ', $column) . ')';

        $lines[] = $this->spaces . ' */';

        return implode("\n", $lines);
    }

    /**
     * Generates document doc block
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentDocBlock(array $metadata)
    {
        return str_replace(
            ['<className>', '<annotation>', '<options>'],
            [
                $this->getClassName($metadata),
                ucfirst($metadata['annotation']),
                $metadata['type'] != lcfirst($this->getClassName($metadata))
                    ? sprintf('type="%s"', $metadata['type']) : '',
            ],
            '/**
 * <className>
 *
 * @ES\<annotation>(<options>)
 */'
        );
    }

    /**
     * @param string $code
     *
     * @return string
     */
    private function prefixWithSpaces($code)
    {
        $lines = explode("\n", $code);

        foreach ($lines as $key => $value) {
            if ($value) {
                $lines[$key] = $this->spaces . $lines[$key];
            }
        }

        return implode("\n", $lines);
    }

    /**
     * Returns class name
     *
     * @param array $metadata
     *
     * @return string
     */
    private function getClassName(array $metadata)
    {
        return ($pos = strrpos($metadata['name'], '\\'))
            ? substr($metadata['name'], $pos + 1, strlen($metadata['name'])) : $metadata['name'];
    }

    /**
     * Generates document use statements
     *
     * @param array $metadata
     *
     * @return string
     */
    private function generateDocumentUse(array $metadata)
    {
        $uses = ['use ONGR\ElasticsearchBundle\Annotation as ES;'];

        if ($this->hasMultipleEmbedded($metadata)) {
            $uses[] = 'use ONGR\ElasticsearchBundle\Collection\Collection;';
        }

        return implode("\n", $uses) . "\n";
    }

    /**
     * @param array $metadata
     *
     * @return bool
     */
    private function hasMultipleEmbedded(array $metadata)
    {
        foreach ($metadata['properties'] as $prop) {
            if ($prop['annotation'] == 'embedded' && isset($prop['property_multiple']) && $prop['property_multiple']) {
                return true;
            }
        }

        return false;
    }
}