yoghi / madda

Generator/RestGenerator.php

<?php

namespace Yoghi\Bundle\MaddaBundle\Generator;

/*
* This file is part of the MADDA project.
*
* (c) Stefano Tamagnini <>
*
* This source file is subject to the GPLv3 license that is bundled
* with this source code in the file LICENSE.
*/

use League\Flysystem\Adapter\Local;
use Nette\PhpGenerator\Method;
use Raml\Exception\InvalidJsonException;
use Raml\Exception\RamlParserException;
use Raml\Parser;
use Symfony\Component\Yaml\Dumper;

/**
 * @author Stefano Tamagnini <>
 */
class RestGenerator extends AbstractFileGenerator
{
    /**
     * Modello virtuale delle API.
     *
     * @var \Raml\ApiDefinition
     */
    private $apiDef;

    /**
     * Informazioni esterne usate per generare i web service.
     *
     * @var array
     */
    private $mapExternalInfo;

    /**
     * Name bundle.
     *
     * @var string
     */
    private $bundleName;

    public function __construct($bundleName = 'AppBundle', $mapExternalInfo = [])
    {
        $this->errors = [];
        $this->bundleName = $bundleName;
        $this->mapExternalInfo = $mapExternalInfo;
    }

    /**
     * Rimuove le parentesi graffe e capitalizza le parole della stringa passata in ingresso.
     *
     * @param [type] $str [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return [type] [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    private function removeGraph(&$str)
    {
        $str = str_replace('{', '', $str);
        $str = str_replace('}', '', $str);
        $str = ucfirst($str);
    }

    /**
     * @param string $ramlFile
     */
    public function generateRest($ramlFile, Local $directoryOutput)
    {
        $parser = new Parser();
        try {

            /*
             * file di routing symfony
             * @var array
             */
            $routing = [];

            /*
             * Mappa delle proprieta dei controller da generare
             * @var array
             */
            $mappaClassDef = [];

            $this->apiDef = $parser->parse($ramlFile);
            $this->logger->info('Title: '.$this->apiDef->getTitle());

            $baseUrl = $this->apiDef->getBaseUrl();

            $parametriBaseUrl = $this->apiDef->getBaseUriParameters();
            /** @var \Raml\BaseUriParameter $definition */
            foreach ($parametriBaseUrl as $varName => $definition) {
                if (!array_key_exists($varName, $this->mapExternalInfo)) {
                    $this->error('Missing: '.$varName.' -> '.$definition->getDescription());
                    $this->mapExternalInfo[$varName] = 'undefined';
                }
                $baseUrl = str_replace($varName, $this->mapExternalInfo[$varName], $baseUrl);
            }

            $this->info('BaseUrl '.$baseUrl); //corrisponde a host: "{subdomain}.example.com" dentro routing.yml

            $enabledProtocols = $this->apiDef->getProtocols(); //serve per fare controlli su http/https -> schemes:  [https] dentro routing.yml

            $infoSecuritySchema = $this->apiDef->getSecuredBy(); // descrive i vari security schema usati nelle varie risorse

$infoSecuritySchema is not used, you could remove the assignment.

            /* @var: \Raml\Resource[] */

58% of this comment could be valid code. Did you maybe forget this after debugging?

            $resources = $this->apiDef->getResources();

            $namespace = $this->bundleName.'\Controller';

            /** @var: \Raml\Resource $resource */
            foreach ($resources as $resource) {
                $displayName = $resource->getDisplayName();

The method getDisplayName cannot be called on $resource (of type resource).

                $this->info('Controller per path: '.$displayName);

                $names = explode('/', $displayName);
                preg_match_all("/(\/{[a-zA-Z]+}(\/)?)+/i", $displayName, $methodParam);

The string literal /(\/{[a-zA-Z]+}(\/)?)+/i does not require double quotes, as per coding-style, please use single quotes.

                array_walk($names, [$this, 'removeGraph']);
                $className = implode('', $names);

                $methods = $resource->getMethods();

The method getMethods cannot be called on $resource (of type resource).

                if (count($methods) > 0) {
                    /** @var \Raml\Method $method */
                    foreach ($methods as $method) {
                        $controllerName = ucfirst($className);

                        // Creo $appBundle / $workspace Controller . php
                        $this->info('Genera: '.$namespace.$controllerName.'Controller');
                        $controllerProperties = [];
                        $controllerProperties['name'] = $controllerName.'Controller';
                        $controllerProperties['namespace'] = $namespace;
                        $controllerProperties['extend'] = 'Symfony\Bundle\FrameworkBundle\Controller\Controller';

                        $methodListParams = implode(',', $methodParam[0]);

                        $type = strtolower($method->getType());
                        $methodCallName = $type.$controllerName;
                        $actionName = $methodCallName.'Action';
                        $this->info('Call Method: '.$actionName.'('.$methodListParams.')');

                        $controllerProperties['methods'] = [];
                        $controllerProperties['methods'][$actionName] = [];
                        $controllerProperties['methods'][$actionName]['params'] = [

                        ];

                        $description = $method->getDescription();
                        $this->info('Description: '.$description);

                        $entryName = strtolower($className).'_'.$type;
                        $routing[$entryName]['path'] = $displayName;
                        $routing[$entryName]['defaults']['_controller'] = $this->bundleName.':'.$controllerName.':'.$methodCallName;
                        $routing[$entryName]['host'] = $baseUrl;
                        $routing[$entryName]['methods'] = [];
                        $routing[$entryName]['methods'][] = strtoupper($type);
                        $routing[$entryName]['schemas'] = $enabledProtocols;
                        $routing[$entryName]['requirements'] = [];
                        $routing[$entryName]['requirements'][] = 'FIXME';

                        $mappaClassDef[$controllerName.'Controller'] = $controllerProperties;
                    } //fine methods
                }

                /* @var \Raml\Resource $subResources */
                $subResources = $resource->getResources();

The method getResources cannot be called on $resource (of type resource).

                foreach ($subResources as $subResource) {

The expression $subResources of type object<Raml\Resource> is not traversable.

This foreach statement is empty and can be removed.

                    //$this->analyzeResource($subResource, $directoryOutput);

80% of this comment could be valid code. Did you maybe forget this after debugging?

                    //// SAMPLE:
                    // /Workspace GET => Workspace/GetWorkspace.php
                    // /Workspace POST => Workspace/POSTWorkspace.php
                    // /Workspace/{id} GET => Workspace/GetWorkspaceById.php
                }
            } //fine reousrces

            $indent = 4;
            $inline = 2;
            $yaml = new Dumper($indent);
            $this->currentFile = $yaml->dump($routing, $inline, 0, 0);

            $this->_createFileOnDir($directoryOutput, $this->bundleName.'/Resources/config/routing.yml');

            foreach ($mappaClassDef as $className => $controllerProp) {
                $this->info('Devo creare '.$className);
                $gClassgen = new ClassGenerator($namespace, $className);
                $gClassgen->setLogger($this->logger);
                $config = new ClassConfig();
                $typesReferenceArray = [];
                $typesDescArray = [];
                $gClassgen->generateClassType($controllerProp, $typesReferenceArray, $typesDescArray, $config);
                $gClassgen->createFileOnDir($directoryOutput);
            }

            $this->info('Scrittura su '.$directoryOutput);
        } catch (InvalidJsonException $e) {
            $this->error('['.$e->getErrorCode().'] '.$e->getMessage());
            $this->error($e->getTraceAsString());
        } catch (RamlParserException $e) {
            $this->error('['.$e->getErrorCode().'] '.$e->getMessage());

The method getErrorCode() does not seem to exist on object<Raml\Exception\RamlParserException>.

        }
    }
}