saxulum / saxulum-elasticsearch-querybuilder-generator

src/QueryBuilderGenerator.php

<?php

declare(strict_types=1);

namespace Saxulum\ElasticSearchQueryBuilder\Generator;

use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\ConstFetch;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Name;
use PhpParser\Node\Scalar\DNumber;
use PhpParser\Node\Scalar\LNumber;
use PhpParser\Node\Scalar\String_;
use PhpParser\PrettyPrinter\Standard as PhpGenerator;

/**
 * @deprecated use Saxulum\ElasticSearchQueryBuilder\Generator\NodeGenerator
 */
final class QueryBuilderGenerator
{
    /**
     * @var PhpGenerator
     */
    private $phpGenerator;

    /**
     * @var bool
     */
    private $useMethodName;

    /**
     * @param bool         $useMethodName
     * @param PhpGenerator $phpGenerator
     */
    public function __construct(PhpGenerator $phpGenerator, bool $useMethodName = false)
    {
        @trigger_error(sprintf('Use "%s" instead of the "%s"', NodeGenerator::class, self::class), E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        $this->phpGenerator = $phpGenerator;
        $this->useMethodName = $useMethodName;
    }

    /**
     * @param $query
     *
     * @return string
     */
    public function generateByJson($query): string
    {
        $data = json_decode($query, false);
        if (JSON_ERROR_NONE !== json_last_error()) {
            throw new \InvalidArgumentException(sprintf('Message: %s, query: %s', json_last_error_msg(), $query));
        }

        $queryBuilder = new Variable('qb');

        $stmts = [];

        $stmts[] = $this->createQueryBuilderNode();
        $stmts[] = $this->appendChildrenToObjectNode($queryBuilder, $queryBuilder, $data);

        return $this->structureCode($this->phpGenerator->prettyPrint($stmts));
    }

    /**
     * @return Expr
     */
    private function createQueryBuilderNode(): Expr
    {
        return new Assign(new Variable('qb'), new New_(new Name('QueryBuilder')));
    }

    /**
     * @param Expr $expr
     *
     * @return Expr
     */
    private function createObjectNode(Expr $expr): Expr
    {
        return new MethodCall($expr, 'objectNode');
    }

    /**
     * @param Expr $expr
     *
     * @return Expr
     */
    private function createArrayNode(Expr $expr): Expr
    {
        return new MethodCall($expr, 'arrayNode');
    }

    /**
     * @param Expr                       $expr
     * @param string|float|int|bool|null $value
     *
     * @return Expr
     */
    private function createScalarNode(Expr $expr, $value): Expr
    {
        if (is_int($value)) {
            return new MethodCall($expr, 'intNode', [new Arg(new LNumber($value))]);
        } elseif (is_float($value)) {
            return new MethodCall($expr, 'floatNode', [new Arg(new DNumber($value))]);
        } elseif (is_bool($value)) {
            return new MethodCall($expr, 'boolNode', [new Arg(new ConstFetch(new Name($value ? 'true' : 'false')))]);
        } elseif (null === $value) {
            return new MethodCall($expr, 'nullNode');
        }

        return new MethodCall($expr, 'stringNode', [new Arg(new String_($value))]);
    }

    /**
     * @param Expr  $queryBuilder
     * @param Expr  $expr
     * @param array $data
     *
     * @return Expr
     */
    private function appendChildrenToArrayNode(Expr $queryBuilder, Expr $expr, array $data)
    {
        foreach ($data as $value) {
            if ($value instanceof \stdClass) {

This code seems to be duplicated across your project.

                $argument = $this->createObjectNode($queryBuilder);
            } elseif (is_array($value)) {
                $argument = $this->createArrayNode($queryBuilder);
            } else {
                $argument = $this->createScalarNode($queryBuilder, $value);
            }

            $methodName = $this->useMethodName ? 'addToArrayNode' : 'add';

            $expr = new MethodCall($expr, $methodName, [new Arg($argument)]);

            if ($value instanceof \stdClass) {

This code seems to be duplicated across your project.

                $expr = new MethodCall($this->appendChildrenToObjectNode($queryBuilder, $expr, $value), 'end');
            } elseif (is_array($value)) {
                $expr = new MethodCall($this->appendChildrenToArrayNode($queryBuilder, $expr, $value), 'end');
            }
        }

        return $expr;
    }

    /**
     * @param Expr      $queryBuilder
     * @param Expr      $expr
     * @param \stdClass $data
     *
     * @return Expr
     */
    private function appendChildrenToObjectNode(Expr $queryBuilder, Expr $expr, \stdClass $data)
    {
        foreach ($data as $key => $value) {

The expression $data of type object<stdClass> is not traversable.

            if ($value instanceof \stdClass) {

This code seems to be duplicated across your project.

                $argument = $this->createObjectNode($queryBuilder);
            } elseif (is_array($value)) {
                $argument = $this->createArrayNode($queryBuilder);
            } else {
                $argument = $this->createScalarNode($queryBuilder, $value);
            }

            $methodName = $this->useMethodName ? 'addToObjectNode' : 'add';

            $expr = new MethodCall($expr, $methodName, [new Arg(new String_($key)), new Arg($argument)]);

            if ($value instanceof \stdClass) {

This code seems to be duplicated across your project.

                $expr = new MethodCall($this->appendChildrenToObjectNode($queryBuilder, $expr, $value), 'end');
            } elseif (is_array($value)) {
                $expr = new MethodCall($this->appendChildrenToArrayNode($queryBuilder, $expr, $value), 'end');
            }
        }

        return $expr;
    }

    /**
     * @param string $code
     *
     * @return string
     */
    private function structureCode(string $code): string
    {
        $lines = $this->getLinesByCode($code);

        $position = 0;

        $structuredLines = [];

        foreach ($lines as $i => $line) {

This code seems to be duplicated across your project.

            $lastLine = $lines[$i - 1] ?? '';
            $this->structuredLine($line, $lastLine, $position, $structuredLines);
        }

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

    /**
     * @param string $code
     *
     * @return array
     */
    private function getLinesByCode(string $code): array
    {
        $codeWithLinebreaks = str_replace('->add', "\n->add", $code);
        $codeWithLinebreaks = str_replace('->end', "\n->end", $codeWithLinebreaks);

        return explode("\n", $codeWithLinebreaks);
    }

    /**
     * @param string $line
     * @param string $lastLine
     * @param int    $position
     * @param array  $structuredLines
     */
    private function structuredLine(string $line, string $lastLine, int &$position, array &$structuredLines)
    {
        if (0 === strpos($line, '->add')) {
            if (false === strpos($lastLine, '->end') &&
                false === strpos($lastLine, '->boolNode') &&
                false === strpos($lastLine, '->floatNode') &&
                false === strpos($lastLine, '->intNode') &&
                false === strpos($lastLine, '->nullNode') &&
                false === strpos($lastLine, '->stringNode')
            ) {
                ++$position;
            }

            $structuredLines[] = str_pad('', $position * 4).$line;

            return;
        }

        if (0 === strpos($line, '->end')) {
            if (strpos($lastLine, '->objectNode') || strpos($lastLine, '->arrayNode')) {
                $structuredLines[count($structuredLines) - 1] .= '->end()';

                return;
            }

            --$position;

            $structuredLines[] = str_pad('', $position * 4).$line;

            return;
        }

        $structuredLines[] = $line;
    }
}