GenerateCommand::generateJson() - Code Metrics - Th3Mouk/OpenAPIGenerator - Measure and Improve Code Quality continuously with Scrutinizer

GenerateCommand::generateJson() B
last analyzed 2020-07-23 09:50 UTC

↳ Parent: GenerateCommand

Complexity

Conditions	6
Paths	8

Size

Total Lines	61
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	38
c	3
b	0
f	0
dl	0
loc	61
rs	8.6897
cc	6
nc	8
nop	1

How to fix Long Method

<?php

declare(strict_types=1);

namespace Th3Mouk\OpenAPIGenerator\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Yaml\Yaml;
use Th3Mouk\OpenAPIGenerator\PathHelper;
use Traversable;

final class GenerateCommand extends Command
{
    protected function configure(): void
    {
        $this
            ->setName('generate')
            ->setDescription('Generate the openapi.json')
            ->addArgument('path', InputArgument::OPTIONAL, 'The path where generate the openapi.json file', '')
            ->addOption('pretty-json', 'p', InputOption::VALUE_NONE, 'Generate json file in pretty format');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->generateJson($input);
        echo 'generated' . PHP_EOL;

        return 0;
    }

    private function generateJson(InputInterface $input): void
    {
        $template_file = (new Finder())
            ->in(getRootPath() . PathHelper::ROOT)
            ->files()
            ->name('openapi.yaml');

        if (!$template_file->hasResults()) {
            echo 'no openapi.yaml file found' . PHP_EOL;

            return;
        }

        $template = $this->getFirstElementOfFileIterator($template_file);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        $template   = Yaml::parse($template->getContents());
        $components = $template['components'] ?? [];

        $node_compactor = static fn (Traversable $node_iterator) => array_reduce(
            iterator_to_array($node_iterator),
            static fn ($carry, $item) => array_merge($carry, $item),
            [],
        );

        $components['schemas']         = (object) $node_compactor($this->getContentGenerator(PathHelper::SCHEMAS));
        $components['responses']       = (object) $node_compactor($this->getContentGenerator(PathHelper::RESPONSES));
        $components['parameters']      = (object) $node_compactor($this->getContentGenerator(PathHelper::PARAMETERS));
        $components['examples']        = (object) $node_compactor($this->getContentGenerator(PathHelper::EXAMPLES));
        $components['requestBodies']   = (object) $node_compactor($this->getContentGenerator(PathHelper::REQUEST_BODIES));
        $components['headers']         = (object) $node_compactor($this->getContentGenerator(PathHelper::HEADERS));
        $components['securitySchemes'] = (object) $node_compactor($this->getContentGenerator(PathHelper::SECURITY_SCHEMES));
        $components['links']           = (object) $node_compactor($this->getContentGenerator(PathHelper::LINKS));
        $components['callbacks']       = (object) $node_compactor($this->getContentGenerator(PathHelper::CALLBACKS));

        $template['paths']      = (object) $node_compactor($this->getContentGenerator(PathHelper::PATHS));
        $template['components'] = (object) $components;

        $arg_path = $input->getArgument('path');

        if (!is_string($arg_path)) {
            throw new \RuntimeException('Path argument must be a string');
        }

        $path = '/' !== substr($arg_path, 0, 1) ? '/' . $arg_path : $arg_path;

        $openapi_file_path = getRootPath() . $path . '/openapi.json';
        if (!$file = fopen($openapi_file_path, 'w')) {
            echo 'error generating openapi.json file' . PHP_EOL;

            return;
        }

        if ($input->getOption('pretty-json')) {
            fwrite($file, \json_encode($template, JSON_UNESCAPED_SLASHES | JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT));
            fclose($file);

            return;
        }

        fwrite($file, \json_encode($template, JSON_UNESCAPED_SLASHES | JSON_THROW_ON_ERROR));
        fclose($file);
    }

    /**
     * @return \Generator<mixed>
     */
    private function getContentGenerator(string $path): \Generator
    {
        foreach ((new Finder())->files()->in(getRootPath() . $path)->name('*.yaml') as $file) {
            yield Yaml::parse($file->getContents());
        }
    }

    /**
     * @return mixed|null
     */
    private function getFirstElementOfFileIterator(Finder $iterator)
    {
        foreach ($iterator as $element) {
            return $element;
        }

        return null;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Th3Mouk\OpenAPIGenerator\Command;
6
7			use Symfony\Component\Console\Command\Command;
8			use Symfony\Component\Console\Input\InputArgument;
9			use Symfony\Component\Console\Input\InputInterface;
10			use Symfony\Component\Console\Input\InputOption;
11			use Symfony\Component\Console\Output\OutputInterface;
12			use Symfony\Component\Finder\Finder;
13			use Symfony\Component\Yaml\Yaml;
14			use Th3Mouk\OpenAPIGenerator\PathHelper;
15			use Traversable;
16
17			final class GenerateCommand extends Command
18			{
19			protected function configure(): void
20			{
21			$this
22			->setName('generate')
23			->setDescription('Generate the openapi.json')
24			->addArgument('path', InputArgument::OPTIONAL, 'The path where generate the openapi.json file', '')
25			->addOption('pretty-json', 'p', InputOption::VALUE_NONE, 'Generate json file in pretty format');
26			}
27
28			protected function execute(InputInterface $input, OutputInterface $output): int
29			{
30			$this->generateJson($input);
31			echo 'generated' . PHP_EOL;
32
33			return 0;
34			}
35
36			private function generateJson(InputInterface $input): void
37			{
38			$template_file = (new Finder())
39			->in(getRootPath() . PathHelper::ROOT)
40			->files()
41			->name('openapi.yaml');
42
43			if (!$template_file->hasResults()) {
44			echo 'no openapi.yaml file found' . PHP_EOL;
45
46			return;
47			}
48
49			$template = $this->getFirstElementOfFileIterator($template_file);
			0 ignored issues – show Bug introduced 2020-07-23 08:32 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$template` is correct as `$this->getFirstElementOf...terator($template_file)` targeting `Th3Mouk\OpenAPIGenerator...ElementOfFileIterator()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
50
51			$template = Yaml::parse($template->getContents());
52			$components = $template['components'] ?? [];
53
54			$node_compactor = static fn (Traversable $node_iterator) => array_reduce(
55			iterator_to_array($node_iterator),
56			static fn ($carry, $item) => array_merge($carry, $item),
57			[],
58			);
59
60			$components['schemas'] = (object) $node_compactor($this->getContentGenerator(PathHelper::SCHEMAS));
61			$components['responses'] = (object) $node_compactor($this->getContentGenerator(PathHelper::RESPONSES));
62			$components['parameters'] = (object) $node_compactor($this->getContentGenerator(PathHelper::PARAMETERS));
63			$components['examples'] = (object) $node_compactor($this->getContentGenerator(PathHelper::EXAMPLES));
64			$components['requestBodies'] = (object) $node_compactor($this->getContentGenerator(PathHelper::REQUEST_BODIES));
65			$components['headers'] = (object) $node_compactor($this->getContentGenerator(PathHelper::HEADERS));
66			$components['securitySchemes'] = (object) $node_compactor($this->getContentGenerator(PathHelper::SECURITY_SCHEMES));
67			$components['links'] = (object) $node_compactor($this->getContentGenerator(PathHelper::LINKS));
68			$components['callbacks'] = (object) $node_compactor($this->getContentGenerator(PathHelper::CALLBACKS));
69
70			$template['paths'] = (object) $node_compactor($this->getContentGenerator(PathHelper::PATHS));
71			$template['components'] = (object) $components;
72
73			$arg_path = $input->getArgument('path');
74
75			if (!is_string($arg_path)) {
76			throw new \RuntimeException('Path argument must be a string');
77			}
78
79			$path = '/' !== substr($arg_path, 0, 1) ? '/' . $arg_path : $arg_path;
80
81			$openapi_file_path = getRootPath() . $path . '/openapi.json';
82			if (!$file = fopen($openapi_file_path, 'w')) {
83			echo 'error generating openapi.json file' . PHP_EOL;
84
85			return;
86			}
87
88			if ($input->getOption('pretty-json')) {
89			fwrite($file, \json_encode($template, JSON_UNESCAPED_SLASHES \| JSON_THROW_ON_ERROR \| JSON_PRETTY_PRINT));
90			fclose($file);
91
92			return;
93			}
94
95			fwrite($file, \json_encode($template, JSON_UNESCAPED_SLASHES \| JSON_THROW_ON_ERROR));
96			fclose($file);
97			}
98
99			/**
100			* @return \Generator<mixed>
101			*/
102			private function getContentGenerator(string $path): \Generator
103			{
104			foreach ((new Finder())->files()->in(getRootPath() . $path)->name('*.yaml') as $file) {
105			yield Yaml::parse($file->getContents());
106			}
107			}
108
109			/**
110			* @return mixed\|null
111			*/
112			private function getFirstElementOfFileIterator(Finder $iterator)
113			{
114			foreach ($iterator as $element) {
115			return $element;
116			}
117
118			return null;
119			}
120			}
121

Th3Mouk / OpenAPIGenerator

GenerateCommand::generateJson() B last analyzed 2020-07-23 09:50 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

GenerateCommand::generateJson() B
last analyzed 2020-07-23 09:50 UTC