Generator::defaultPrinter() - Code Metrics - Inspection of "Add code generation support" - RoundingWellOS/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c4f399...2b6d50 )

by Woody

created 2017-07-03 16:04 UTC

Generator::defaultPrinter() A

↳ Parent: Generator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	1
rs	9.4285
c	0
b	0
f	0

<?php
declare(strict_types=1);

namespace RoundingWell\Schematic;

use PhpParser\BuilderFactory;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt\Class_ as Cls;
use PhpParser\Node\Stmt\Namespace_ as Ns;
use PhpParser\PrettyPrinterAbstract;
use PhpParser\PrettyPrinter\Standard as StandardPrinter;
use RoundingWell\Schematic\Schema\ObjectSchema;

class Generator
{
    /**
     * @var BuilderFactory
     */
    private $builder;

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

    /**
     * @var System
     */
    private $system;

    public function __construct(
        BuilderFactory $factory = null,
        PrettyPrinterAbstract $printer = null,
        System $system = null
    ) {
        $this->factory = $factory ?: $this->defaultBuilder();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->printer = $printer ?: $this->defaultPrinter();
        $this->system = $system ?: $this->defaultSystem();
    }

    public function generate(ObjectSchema $schema, string $className, string $baseClass = ''): array
    {
        $classes = [];

        $className = new Name($className);
        // Start the class AST definition
        $namespace = $this->factory->namespace($className->slice(0, -1)->toString());
        $class = $this->factory->class($className->getLast());

        if ($baseClass) {
            $baseClassName = new Name($baseClass);
            // Import the base class with a "use" statement
            $namespace->addStmt($this->factory->use($baseClassName));
            // Make the class extend the base class
            $class->extend($baseClassName->getLast());
        }

        foreach ($schema->properties() as $name => $property) {
            $typeHint = $property->phpType();

            if ($property->isObject()) {
                // Create a new class for this property
                $nextClass = Name::concat($className, ucfirst($name));
                $typeHint = '\\' . $nextClass->toString();
                $classes = array_merge($classes, $this->generate(
                    $property,

                    $nextClass->toString(),
                    $baseClass
                ));
            } elseif ($property->isArray() && $property->items()->isObject()) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                // Create a new class for this array of properties
                $nextClass = Name::concat($className, ucfirst(singular($name)));
                $typeHint = '\\' . $nextClass->toString() . '[]';
                $classes = array_merge($classes, $this->generate(
                    $property->items(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    $nextClass->toString(),
                    $baseClass
                ));
            } elseif (!$schema->isRequired($name) && !$property->isNull()) {
                $typeHint = "$typeHint|null";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            }

            // Add a property declaration to the class
            $class->addStmt(
                $this->factory->property($name)
                    ->makePublic()
                    ->setDocComment("/**\n * @var $typeHint\n */")
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            );
        }

        // Add the class declaration to the namespace
        $namespace->addStmt($class);

        $classes[$className->toString()] = $namespace->getNode();

        return $classes;
    }

    /**
     * @param Ns[] $classes
     * @return string[]
     */
    public function write(array $classes, string $rootDirectory, string $rootNamespace = ''): array
    {
        $rootDirectory = rtrim($rootDirectory, '/');

        return array_map(
            function (Ns $node) use ($rootDirectory, $rootNamespace): string {
                // Remove the root (PSR-4) namespace and convert to a path
                $directory = str_replace($rootNamespace, '', $node->name->toString());
                $directory = trim(str_replace('\\', '/', $directory), '/');
                $directory = rtrim("$rootDirectory/$directory", '/');
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
                // Grab the class name from AST
                $class = $this->classNode($node->stmts)->name;

                $path = "$directory/$class.php";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
                $code = $this->printer->prettyPrintFile([$node]);

                $this->system->writeFile($path, $code);

                return $path;
            },
            $classes
        );
    }

    protected function defaultBuilder(): BuilderFactory
    {
        return new BuilderFactory();

    }

    protected function defaultPrinter(): PrettyPrinterAbstract
    {
        return new StandardPrinter([
            'shortArraySyntax' => true,
        ]);
    }

    protected function defaultSystem(): System
    {
        return new System();
    }

    private function classNode(array $stmts): Cls
    {
        foreach ($stmts as $stmt) {
            if ($stmt instanceof Cls) {
                return $stmt;
            }
        }

        // @codeCoverageIgnoreStart
        throw new \InvalidArgumentException(
            'Cannot find class node in statements'
        );
        // @codeCoverageIgnoreEnd
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace RoundingWell\Schematic;
5
6		use PhpParser\BuilderFactory;
7		use PhpParser\Node\Name;
8		use PhpParser\Node\Stmt\Class_ as Cls;
9		use PhpParser\Node\Stmt\Namespace_ as Ns;
10		use PhpParser\PrettyPrinterAbstract;
11		use PhpParser\PrettyPrinter\Standard as StandardPrinter;
12		use RoundingWell\Schematic\Schema\ObjectSchema;
13
14		class Generator
15		{
16		/**
17		* @var BuilderFactory
18		*/
19		private $builder;
20
21		/**
22		* @var PrettyPrinterAbstract
23		*/
24		private $printer;
25
26		/**
27		* @var System
28		*/
29		private $system;
30
31	2	public function __construct(
32		BuilderFactory $factory = null,
33		PrettyPrinterAbstract $printer = null,
34		System $system = null
35		) {
36	2	$this->factory = $factory ?: $this->defaultBuilder();
		0 ignored issues – show Bug introduced 2017-07-03 16:08 UTC by Report Bug Copy Issue Report The property `factory` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
37	2	$this->printer = $printer ?: $this->defaultPrinter();
38	2	$this->system = $system ?: $this->defaultSystem();
39	2	}
40
41	1	public function generate(ObjectSchema $schema, string $className, string $baseClass = ''): array
42		{
43	1	$classes = [];
44
45	1	$className = new Name($className);
46		// Start the class AST definition
47	1	$namespace = $this->factory->namespace($className->slice(0, -1)->toString());
48	1	$class = $this->factory->class($className->getLast());
49
50	1	if ($baseClass) {
51	1	$baseClassName = new Name($baseClass);
52		// Import the base class with a "use" statement
53	1	$namespace->addStmt($this->factory->use($baseClassName));
54		// Make the class extend the base class
55	1	$class->extend($baseClassName->getLast());
56		}
57
58	1	foreach ($schema->properties() as $name => $property) {
59	1	$typeHint = $property->phpType();
60
61	1	if ($property->isObject()) {
62		// Create a new class for this property
63	1	$nextClass = Name::concat($className, ucfirst($name));
64	1	$typeHint = '\\' . $nextClass->toString();
65	1	$classes = array_merge($classes, $this->generate(
66	1	$property,
		0 ignored issues – show Compatibility introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report `$property` of type `object<RoundingWell\Schematic\Schema>` is not a sub-type of `object<RoundingWell\Sche...ic\Schema\ObjectSchema>`. It seems like you assume a child class of the class `RoundingWell\Schematic\Schema` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
67	1	$nextClass->toString(),
68	1	$baseClass
69		));
70	1	} elseif ($property->isArray() && $property->items()->isObject()) {
		0 ignored issues – show Bug introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `RoundingWell\Schematic\Schema` as the method `items()` does only exist in the following sub-classes of `RoundingWell\Schematic\Schema`: `RoundingWell\Schematic\Schema\ArraySchema`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
71		// Create a new class for this array of properties
72	1	$nextClass = Name::concat($className, ucfirst(singular($name)));
73	1	$typeHint = '\\' . $nextClass->toString() . '[]';
74	1	$classes = array_merge($classes, $this->generate(
75	1	$property->items(),
		0 ignored issues – show Bug introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `RoundingWell\Schematic\Schema` as the method `items()` does only exist in the following sub-classes of `RoundingWell\Schematic\Schema`: `RoundingWell\Schematic\Schema\ArraySchema`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
76	1	$nextClass->toString(),
77	1	$baseClass
78		));
79	1	} elseif (!$schema->isRequired($name) && !$property->isNull()) {
80	1	$typeHint = "$typeHint\|null";
		0 ignored issues – show Coding Style Best Practice introduced 2017-07-01 02:01 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$typeHint` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
81		}
82
83		// Add a property declaration to the class
84	1	$class->addStmt(
85	1	$this->factory->property($name)
86	1	->makePublic()
87	1	->setDocComment("/*\n @var $typeHint\n */")
		0 ignored issues – show Coding Style Best Practice introduced 2017-07-01 02:01 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$typeHint` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
88		);
89		}
90
91		// Add the class declaration to the namespace
92	1	$namespace->addStmt($class);
93
94	1	$classes[$className->toString()] = $namespace->getNode();
95
96	1	return $classes;
97		}
98
99		/**
100		* @param Ns[] $classes
101		* @return string[]
102		*/
103	1	public function write(array $classes, string $rootDirectory, string $rootNamespace = ''): array
104		{
105	1	$rootDirectory = rtrim($rootDirectory, '/');
106
107	1	return array_map(
108	1	function (Ns $node) use ($rootDirectory, $rootNamespace): string {
109		// Remove the root (PSR-4) namespace and convert to a path
110	1	$directory = str_replace($rootNamespace, '', $node->name->toString());
111	1	$directory = trim(str_replace('\\', '/', $directory), '/');
112	1	$directory = rtrim("$rootDirectory/$directory", '/');
		0 ignored issues – show Coding Style Best Practice introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$rootDirectory` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history... Coding Style Best Practice introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$directory` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
113		// Grab the class name from AST
114	1	$class = $this->classNode($node->stmts)->name;
115
116	1	$path = "$directory/$class.php";
		0 ignored issues – show Coding Style Best Practice introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$directory` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history... Coding Style Best Practice introduced 2017-07-03 15:22 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$class` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
117	1	$code = $this->printer->prettyPrintFile([$node]);
118
119	1	$this->system->writeFile($path, $code);
120
121	1	return $path;
122	1	},
123	1	$classes
124		);
125		}
126
127	2	protected function defaultBuilder(): BuilderFactory
128		{
129	2	return new BuilderFactory();
130
131		}
132
133	2	protected function defaultPrinter(): PrettyPrinterAbstract
134		{
135	2	return new StandardPrinter([
136	2	'shortArraySyntax' => true,
137		]);
138		}
139
140	1	protected function defaultSystem(): System
141		{
142	1	return new System();
143		}
144
145	1	private function classNode(array $stmts): Cls
146		{
147	1	foreach ($stmts as $stmt) {
148	1	if ($stmt instanceof Cls) {
149	1	return $stmt;
150		}
151		}
152
153		// @codeCoverageIgnoreStart
154		throw new \InvalidArgumentException(
155		'Cannot find class node in statements'
156		);
157		// @codeCoverageIgnoreEnd
158		}
159		}
160

RoundingWellOS / schematic

Push — master ( c4f399...2b6d50 )

Generator::defaultPrinter() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like