ClassBuilder::dump() - Code Metrics - Inspection of "Playing arround with AST" - RunOpenCode/abstract-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ce73d9...ed5962 )

by Nikola

created 2017-06-25 17:13 UTC

ClassBuilder::dump() A

↳ Parent: ClassBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php
/*
 * This file is part of the Abstract builder package, an RunOpenCode project.
 *
 * (c) 2017 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\AbstractBuilder\Ast;

use PhpParser\Builder\Class_;
use PhpParser\BuilderFactory;
use PhpParser\Node;
use PhpParser\PrettyPrinter\Standard;
use RunOpenCode\AbstractBuilder\ReflectiveAbstractBuilder;

class ClassBuilder
{
    /**
     * @var ClassMetadata
     */
    private $builderClass;

    /**
     * @var ClassMetadata
     */
    private $buildingClass;

    /**
     * @var BuilderFactory
     */
    private $factory;

    /**
     * @var Node
     */
    private $namespaceNode;

    /**
     * @var Class_
     */
    private $classNode;

    /**
     * @var Standard
     */
    private $printer;

    public function __construct(ClassMetadata $buildingClass, ClassMetadata $builderClass, array $methods)
    {
        $this->buildingClass = $buildingClass;
        $this->builderClass = $builderClass;
        $this->factory = new BuilderFactory();
        $this->printer = new Standard();

        $this->namespaceNode = $this->factory->namespace($this->builderClass->getNamespace());


        if (null !== $builderClass->getAst()) {
            $this->classNode = $this->builderClass->getAst();

            $this->namespaceNode->addStmt($this->classNode);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return;
        }

        $this->initializeBuilderClass($methods);

        $this->namespaceNode->addStmt($this->classNode->getNode());
    }

    public function dump()
    {
        file_put_contents($this->builderClass->getFilename(), $this->display());
    }

    public function display()
    {
        return $this->printer->prettyPrintFile([$this->namespaceNode->getNode()]);

    }

    public static function create(ClassMetadata $buildingClass, ClassMetadata $builderClass, array $methods)
    {
        return new static($buildingClass, $builderClass, $methods);
    }

    private function initializeBuilderClass($methods)
    {
        $this->classNode = $this->factory
            ->class($this->builderClass->getClass())
            ->extend('\\'.ReflectiveAbstractBuilder::class)
            ->setDocComment(sprintf(
'/**
 * Class %s
 *
 * This class is implementation of builder pattern 
 * for class %s. 
 *  
 * This class is autogenerated by runopencode/abstract-builder library.
 *
 * @package %s
 *
 * @see %s
 * @see https://en.wikipedia.org/wiki/Builder_pattern
 */',
                    $this->builderClass->getClass(), $this->buildingClass->getFqcn(), $this->builderClass->getNamespace(), $this->buildingClass->getFqcn()));

        if ($this->buildingClass->isAbstract()) {
            $this->classNode->makeAbstract();
        }

        if ($this->buildingClass->isFinal()) {
            $this->classNode->makeFinal();
        }

        /**
         * @var MethodMetadata $method
         */
        foreach ($methods as $method) {

            $methodFactory = $this->factory
                ->method($method->getName())
                ->makePublic();

            $this->classNode->addStmt($methodFactory->getNode());
        }

        $getObjectFqcnMethod = $this->factory->method('getObjectFqcn')
            ->makeProtected()
            ->addStmt(new Node\Stmt\Return_(new Node\Scalar\String_($this->buildingClass->getFqcn())))
            ->setDocComment(sprintf(
'
/**
 * {@inheritdoc}
 */'
            ));

        $this->classNode->addStmt($getObjectFqcnMethod->getNode());
    }
}


1			<?php
2			/*
3			* This file is part of the Abstract builder package, an RunOpenCode project.
4			*
5			* (c) 2017 RunOpenCode
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace RunOpenCode\AbstractBuilder\Ast;
11
12			use PhpParser\Builder\Class_;
13			use PhpParser\BuilderFactory;
14			use PhpParser\Node;
15			use PhpParser\PrettyPrinter\Standard;
16			use RunOpenCode\AbstractBuilder\ReflectiveAbstractBuilder;
17
18			class ClassBuilder
19			{
20			/**
21			* @var ClassMetadata
22			*/
23			private $builderClass;
24
25			/**
26			* @var ClassMetadata
27			*/
28			private $buildingClass;
29
30			/**
31			* @var BuilderFactory
32			*/
33			private $factory;
34
35			/**
36			* @var Node
37			*/
38			private $namespaceNode;
39
40			/**
41			* @var Class_
42			*/
43			private $classNode;
44
45			/**
46			* @var Standard
47			*/
48			private $printer;
49
50			public function __construct(ClassMetadata $buildingClass, ClassMetadata $builderClass, array $methods)
51			{
52			$this->buildingClass = $buildingClass;
53			$this->builderClass = $builderClass;
54			$this->factory = new BuilderFactory();
55			$this->printer = new Standard();
56
57			$this->namespaceNode = $this->factory->namespace($this->builderClass->getNamespace());
			0 ignored issues – show Documentation Bug introduced 2017-06-25 17:17 UTC by Report Bug Copy Issue Report It seems like `$this->factory->namespac...rClass->getNamespace())` of type `object<PhpParser\Builder\Namespace_>` is incompatible with the declared type `object<PhpParser\Node>` of property `$namespaceNode`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
58
59			if (null !== $builderClass->getAst()) {
60			$this->classNode = $this->builderClass->getAst();
			0 ignored issues – show Documentation Bug introduced 2017-06-25 17:17 UTC by Report Bug Copy Issue Report It seems like `$this->builderClass->getAst()` of type `array` is incompatible with the declared type `object<PhpParser\Builder\Class_>` of property `$classNode`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
61			$this->namespaceNode->addStmt($this->classNode);
			0 ignored issues – show Documentation introduced 2017-06-25 17:17 UTC by Report Bug Copy Issue Report `$this->classNode` is of type `array`, but the function expects a `object<PhpParser\Node>\|object<PhpParser\Builder>`. 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...
62			return;
63			}
64
65			$this->initializeBuilderClass($methods);
66
67			$this->namespaceNode->addStmt($this->classNode->getNode());
68			}
69
70			public function dump()
71			{
72			file_put_contents($this->builderClass->getFilename(), $this->display());
73			}
74
75			public function display()
76			{
77			return $this->printer->prettyPrintFile([$this->namespaceNode->getNode()]);
			0 ignored issues – show Bug introduced 2017-06-25 17:17 UTC by Report Bug Copy Issue Report The method `getNode()` does not seem to exist on `object<PhpParser\Node>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
78			}
79
80			public static function create(ClassMetadata $buildingClass, ClassMetadata $builderClass, array $methods)
81			{
82			return new static($buildingClass, $builderClass, $methods);
83			}
84
85			private function initializeBuilderClass($methods)
86			{
87			$this->classNode = $this->factory
88			->class($this->builderClass->getClass())
89			->extend('\\'.ReflectiveAbstractBuilder::class)
90			->setDocComment(sprintf(
91			'/**
92			* Class %s
93			*
94			* This class is implementation of builder pattern
95			* for class %s.
96			*
97			* This class is autogenerated by runopencode/abstract-builder library.
98			*
99			* @package %s
100			*
101			* @see %s
102			* @see https://en.wikipedia.org/wiki/Builder_pattern
103			*/',
104			$this->builderClass->getClass(), $this->buildingClass->getFqcn(), $this->builderClass->getNamespace(), $this->buildingClass->getFqcn()));
105
106			if ($this->buildingClass->isAbstract()) {
107			$this->classNode->makeAbstract();
108			}
109
110			if ($this->buildingClass->isFinal()) {
111			$this->classNode->makeFinal();
112			}
113
114			/**
115			* @var MethodMetadata $method
116			*/
117			foreach ($methods as $method) {
118
119			$methodFactory = $this->factory
120			->method($method->getName())
121			->makePublic();
122
123			$this->classNode->addStmt($methodFactory->getNode());
124			}
125
126			$getObjectFqcnMethod = $this->factory->method('getObjectFqcn')
127			->makeProtected()
128			->addStmt(new Node\Stmt\Return_(new Node\Scalar\String_($this->buildingClass->getFqcn())))
129			->setDocComment(sprintf(
130			'
131			/**
132			* {@inheritdoc}
133			*/'
134			));
135
136			$this->classNode->addStmt($getObjectFqcnMethod->getNode());
137			}
138			}
139

RunOpenCode / abstract-builder

Push — master ( ce73d9...ed5962 )

ClassBuilder::dump() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like