ResourceGenerator::createProperty() - Code Metrics - Inspection of "Add refresh method" - WyriHaximus/php-api-client-resource-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4d702c...ef515b )

by Cees-Jan

created 2016-05-23 17:06 UTC

ResourceGenerator::createProperty() A

↳ Parent: ResourceGenerator

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	13
rs	9.4285
cc	2
eloc	8
nc	2
nop	4

<?php
declare(strict_types=1);

namespace WyriHaximus\ApiClient\Tools;

use Doctrine\Common\Inflector\Inflector;
use League\CLImate\CLImate;
use PhpParser\Builder\Method;
use PhpParser\Builder\Property;
use PhpParser\BuilderFactory;
use PhpParser\PrettyPrinter;
use PhpParser\Node;
use Symfony\Component\Yaml\Yaml;

class ResourceGenerator
{
    protected $climate;

    public function __construct(CLImate $climate)
    {
        $this->climate = $climate;

        $this->setUpArguments();
    }

    protected function setUpArguments()
    {
        $this->climate->arguments->add([
            'definition' => [
                'description' => 'YAML definition file',
                'required'    => true,
            ],
            'path' => [
                'description' => 'Path to the resource directory',
                'required'    => true,
            ],
            'sync' => [
                'prefix'       => 's',
                'longPrefix'   => 'sync',
                'defaultValue' => true,
                'noValue'      => false,
                'description'  => 'Don\'t generate Sync resource',
                'castTo'       => 'bool',
            ],
            'async' => [
                'prefix'       => 'as',
                'longPrefix'   => 'async',
                'defaultValue' => true,
                'noValue'      => false,
                'description'  => 'Don\'t generate Async resource',
                'castTo'       => 'bool',
            ],
        ]);
    }

    public function run()
    {
        $yaml = $this->readYaml($this->climate->arguments->get('definition'));
        file_put_contents(
            $this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . $yaml['class'] . '.php',
            $this->createBaseClass($yaml)
        );
        file_put_contents(
            $this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . $yaml['class'] . 'Interface.php',
            $this->createInterface($yaml)
        );
        file_put_contents(
            $this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . 'Async' . DIRECTORY_SEPARATOR . $yaml['class'] . '.php',
            $this->createExtendingClass('Async', $yaml)
        );
        file_put_contents(
            $this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . 'Sync' . DIRECTORY_SEPARATOR . $yaml['class'] . '.php',
            $this->createExtendingClass('Sync', $yaml)
        );
    }

    protected function readYaml(string $filename): array
    {
        return Yaml::parse(file_get_contents($filename));
    }

    protected function createBaseClass(array $yaml)
    {
        $factory = new BuilderFactory;

        $class = $factory->class($yaml['class'])
            ->implement($yaml['class'] . 'Interface')
            ->makeAbstract();
        $class->addStmt(
            new Node\Stmt\TraitUse([
                new Node\Name('TransportAwareTrait')
            ])
        );

        foreach ($yaml['properties'] as $name => $details) {
            $type = $details;
            if (is_array($details)) {
                $type = $details['type'];
            }
            $class->addStmt($this->createProperty($factory, $type, $name, $details));
            $class->addStmt($this->createMethod($factory, $type, $name, $details));
        }

        $node = $factory->namespace($yaml['namespace'])
            ->addStmt($factory->use('WyriHaximus\ApiClient\Resource\TransportAwareTrait'))
            ->addStmt($class)

            ->getNode()
        ;

        $prettyPrinter = new PrettyPrinter\Standard();
        return $prettyPrinter->prettyPrintFile([
            $node
        ]) . PHP_EOL;
    }

    protected function createInterface(array $yaml)
    {
        $factory = new BuilderFactory;

        $class = $factory->interface($yaml['class'] . 'Interface')
            ->extend('ResourceInterface');

        foreach ($yaml['properties'] as $name => $details) {
            $type = $details;
            if (is_array($details)) {
                $type = $details['type'];
            }
            $class->addStmt($this->createMethod($factory, $type, $name, $details));
        }

        $node = $factory->namespace($yaml['namespace'])
            ->addStmt($factory->use('WyriHaximus\ApiClient\Resource\ResourceInterface'))
            ->addStmt($class)
            ->getNode()
        ;

        $prettyPrinter = new PrettyPrinter\Standard();
        return $prettyPrinter->prettyPrintFile([
            $node
        ]) . PHP_EOL;
    }

    protected function createProperty(BuilderFactory $factory, string $type, string $name, $details): Property
    {
        $property = $factory->property($name)
            ->makeProtected()
            ->setDocComment('/**
                              * @var ' . $type . '
                              */');
        if (isset($details['default'])) {
            $property->setDefault($details['default']);
        }

        return $property;
    }

    protected function createMethod(BuilderFactory $factory, string $type, string $name, $details): Method

    {
        return $factory->method(Inflector::camelize($name))
            ->makePublic()
            ->setReturnType($type)
            ->setDocComment('/**
                              * @return ' . $type . '
                              */')
            ->addStmt(
                new Node\Stmt\Return_(
                    new Node\Expr\PropertyFetch(
                        new Node\Expr\Variable('this'),
                        $name
                    )
                )
            );
    }

    protected function createExtendingClass(string $type, array $yaml)
    {

        $factory = new BuilderFactory;

        $class = $factory->class($yaml['class'])
            ->extend('Base' . $yaml['class']);

        $class->addStmt($factory->method('refresh')
            ->makePublic()
            ->setReturnType($yaml['class'])
            ->addStmt(
                new Node\Stmt\Return_(
                    new Node\Expr\MethodCall(
                        new Node\Expr\Variable('this'),
                        'wait',
                        [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                            new Node\Expr\MethodCall(
                                new Node\Expr\Variable('this'),
                                'callAsync',
                                [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                                    new Node\Scalar\String_('refresh'),
                                ]
                            ),
                        ]
                    )
                )
            ));

        $node = $factory->namespace($yaml['namespace'] . '\\' . $type )
            ->addStmt($factory->use($yaml['namespace'] . '\\' . $yaml['class'])->as('Base' . $yaml['class']))
            ->addStmt($class)

            ->getNode()
        ;

        $prettyPrinter = new PrettyPrinter\Standard();
        return $prettyPrinter->prettyPrintFile([
            $node
        ]) . PHP_EOL;
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace WyriHaximus\ApiClient\Tools;
5
6			use Doctrine\Common\Inflector\Inflector;
7			use League\CLImate\CLImate;
8			use PhpParser\Builder\Method;
9			use PhpParser\Builder\Property;
10			use PhpParser\BuilderFactory;
11			use PhpParser\PrettyPrinter;
12			use PhpParser\Node;
13			use Symfony\Component\Yaml\Yaml;
14
15			class ResourceGenerator
16			{
17			protected $climate;
18
19			public function __construct(CLImate $climate)
20			{
21			$this->climate = $climate;
22
23			$this->setUpArguments();
24			}
25
26			protected function setUpArguments()
27			{
28			$this->climate->arguments->add([
29			'definition' => [
30			'description' => 'YAML definition file',
31			'required' => true,
32			],
33			'path' => [
34			'description' => 'Path to the resource directory',
35			'required' => true,
36			],
37			'sync' => [
38			'prefix' => 's',
39			'longPrefix' => 'sync',
40			'defaultValue' => true,
41			'noValue' => false,
42			'description' => 'Don\'t generate Sync resource',
43			'castTo' => 'bool',
44			],
45			'async' => [
46			'prefix' => 'as',
47			'longPrefix' => 'async',
48			'defaultValue' => true,
49			'noValue' => false,
50			'description' => 'Don\'t generate Async resource',
51			'castTo' => 'bool',
52			],
53			]);
54			}
55
56			public function run()
57			{
58			$yaml = $this->readYaml($this->climate->arguments->get('definition'));
59			file_put_contents(
60			$this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . $yaml['class'] . '.php',
61			$this->createBaseClass($yaml)
62			);
63			file_put_contents(
64			$this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . $yaml['class'] . 'Interface.php',
65			$this->createInterface($yaml)
66			);
67			file_put_contents(
68			$this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . 'Async' . DIRECTORY_SEPARATOR . $yaml['class'] . '.php',
69			$this->createExtendingClass('Async', $yaml)
70			);
71			file_put_contents(
72			$this->climate->arguments->get('path') . DIRECTORY_SEPARATOR . 'Sync' . DIRECTORY_SEPARATOR . $yaml['class'] . '.php',
73			$this->createExtendingClass('Sync', $yaml)
74			);
75			}
76
77			protected function readYaml(string $filename): array
78			{
79			return Yaml::parse(file_get_contents($filename));
80			}
81
82			protected function createBaseClass(array $yaml)
83			{
84			$factory = new BuilderFactory;
85
86			$class = $factory->class($yaml['class'])
87			->implement($yaml['class'] . 'Interface')
88			->makeAbstract();
89			$class->addStmt(
90			new Node\Stmt\TraitUse([
91			new Node\Name('TransportAwareTrait')
92			])
93			);
94
95			foreach ($yaml['properties'] as $name => $details) {
96			$type = $details;
97			if (is_array($details)) {
98			$type = $details['type'];
99			}
100			$class->addStmt($this->createProperty($factory, $type, $name, $details));
101			$class->addStmt($this->createMethod($factory, $type, $name, $details));
102			}
103
104			$node = $factory->namespace($yaml['namespace'])
105			->addStmt($factory->use('WyriHaximus\ApiClient\Resource\TransportAwareTrait'))
106			->addStmt($class)
107
108			->getNode()
109			;
110
111			$prettyPrinter = new PrettyPrinter\Standard();
112			return $prettyPrinter->prettyPrintFile([
113			$node
114			]) . PHP_EOL;
115			}
116
117			protected function createInterface(array $yaml)
118			{
119			$factory = new BuilderFactory;
120
121			$class = $factory->interface($yaml['class'] . 'Interface')
122			->extend('ResourceInterface');
123
124			foreach ($yaml['properties'] as $name => $details) {
125			$type = $details;
126			if (is_array($details)) {
127			$type = $details['type'];
128			}
129			$class->addStmt($this->createMethod($factory, $type, $name, $details));
130			}
131
132			$node = $factory->namespace($yaml['namespace'])
133			->addStmt($factory->use('WyriHaximus\ApiClient\Resource\ResourceInterface'))
134			->addStmt($class)
135			->getNode()
136			;
137
138			$prettyPrinter = new PrettyPrinter\Standard();
139			return $prettyPrinter->prettyPrintFile([
140			$node
141			]) . PHP_EOL;
142			}
143
144			protected function createProperty(BuilderFactory $factory, string $type, string $name, $details): Property
145			{
146			$property = $factory->property($name)
147			->makeProtected()
148			->setDocComment('/**
149			* @var ' . $type . '
150			*/');
151			if (isset($details['default'])) {
152			$property->setDefault($details['default']);
153			}
154
155			return $property;
156			}
157
158			protected function createMethod(BuilderFactory $factory, string $type, string $name, $details): Method
			0 ignored issues – show Unused Code introduced 2016-05-18 15:31 UTC by Report Bug Copy Issue Report The parameter `$details` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
159			{
160			return $factory->method(Inflector::camelize($name))
161			->makePublic()
162			->setReturnType($type)
163			->setDocComment('/**
164			* @return ' . $type . '
165			*/')
166			->addStmt(
167			new Node\Stmt\Return_(
168			new Node\Expr\PropertyFetch(
169			new Node\Expr\Variable('this'),
170			$name
171			)
172			)
173			);
174			}
175
176			protected function createExtendingClass(string $type, array $yaml)
177			{
178
179			$factory = new BuilderFactory;
180
181			$class = $factory->class($yaml['class'])
182			->extend('Base' . $yaml['class']);
183
184			$class->addStmt($factory->method('refresh')
185			->makePublic()
186			->setReturnType($yaml['class'])
187			->addStmt(
188			new Node\Stmt\Return_(
189			new Node\Expr\MethodCall(
190			new Node\Expr\Variable('this'),
191			'wait',
192			[
			0 ignored issues – show Documentation introduced 2016-05-23 17:15 UTC by Report Bug Copy Issue Report `array(new \PhpParser\Nod...r\String_('refresh'))))` is of type `array<integer,object<Php...e\\Expr\\MethodCall>"}>`, but the function expects a `array<integer,object<PhpParser\Node\Arg>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
193			new Node\Expr\MethodCall(
194			new Node\Expr\Variable('this'),
195			'callAsync',
196			[
			0 ignored issues – show Documentation introduced 2016-05-23 17:15 UTC by Report Bug Copy Issue Report `array(new \PhpParser\Nod...lar\String_('refresh'))` is of type `array<integer,object<Php...de\\Scalar\\String_>"}>`, but the function expects a `array<integer,object<PhpParser\Node\Arg>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
197			new Node\Scalar\String_('refresh'),
198			]
199			),
200			]
201			)
202			)
203			));
204
205			$node = $factory->namespace($yaml['namespace'] . '\\' . $type )
206			->addStmt($factory->use($yaml['namespace'] . '\\' . $yaml['class'])->as('Base' . $yaml['class']))
207			->addStmt($class)
208
209			->getNode()
210			;
211
212			$prettyPrinter = new PrettyPrinter\Standard();
213			return $prettyPrinter->prettyPrintFile([
214			$node
215			]) . PHP_EOL;
216			}
217			}
218

WyriHaximus / php-api-client-resource-generator

GitHub Access Token became invalid

Push — master ( 4d702c...ef515b )

ResourceGenerator::createProperty() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like