HydratorMethodsVisitorTest::classAstProvider() - Code Metrics - Inspection of "Merge pull request #73 from Ocramius/enhancement/u..." - Ocramius/GeneratedHydrator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2bbfc9...9b6b62 )

by Marco

created 2017-11-28 20:58 UTC

HydratorMethodsVisitorTest::classAstProvider() A

↳ Parent: HydratorMethodsVisitorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0
cc	1
eloc	13
nc	1
nop	0

<?php

declare(strict_types=1);

namespace GeneratedHydratorTest\CodeGenerator\Visitor;

use GeneratedHydrator\CodeGenerator\Visitor\HydratorMethodsVisitor;
use PhpParser\Node;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\ParserFactory;
use PHPUnit\Framework\TestCase;
use CodeGenerationUtils\Inflector\Util\UniqueIdentifierGenerator;
use ReflectionClass;

/**
 * Tests for {@see \GeneratedHydrator\CodeGenerator\Visitor\HydratorMethodsVisitor}
 *
 * @author Marco Pivetta <[email protected]>
 * @license MIT
 *
 * @covers \GeneratedHydrator\CodeGenerator\Visitor\HydratorMethodsVisitor
 */
class HydratorMethodsVisitorTest extends TestCase
{
    /**
     * @dataProvider classAstProvider
     *
     * @param string   $className
     * @param Class_   $classNode
     * @param string[] $properties
     */
    public function testBasicCodeGeneration(string $className, Class_ $classNode, array $properties)

    {
        $visitor = new HydratorMethodsVisitor(new ReflectionClass($className));

        /* @var $modifiedAst Class_ */
        $modifiedNode = $visitor->leaveNode($classNode);

        self::assertMethodExistence('hydrate', $modifiedNode);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        self::assertMethodExistence('extract', $modifiedNode);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        self::assertMethodExistence('__construct', $modifiedNode);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * Verifies that a method was correctly added to by the visitor
     *
     * @param string $methodName
     * @param Class_ $class
     */
    private function assertMethodExistence(string $methodName, Class_ $class)
    {
        $members = $class->stmts;

        self::assertCount(
            1,
            array_filter(
                $members,
                function (Node $node) use ($methodName) : bool {
                    return $node instanceof ClassMethod
                        && $methodName === $node->name;
                }
            )
        );
    }

    /**
     * @return \PhpParser\Node[][]
     */
    public function classAstProvider() : array
    {
        $parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);

        $className = UniqueIdentifierGenerator::getIdentifier('Foo');
        $classCode = 'class ' . $className . ' { private $bar; private $baz; protected $tab; '
            . 'protected $tar; public $taw; public $tam; }';

        eval($classCode);

        $staticClassName = UniqueIdentifierGenerator::getIdentifier('Foo');
        $staticClassCode = 'class ' . $staticClassName . ' { private static $bar; '
            . 'protected static $baz; public static $tab; private $taz; }';

        eval($staticClassCode);

        return [
            [$className, $parser->parse('<?php ' . $classCode)[0], ['bar', 'baz', 'tab', 'tar', 'taw', 'tam']],
            [$staticClassName, $parser->parse('<?php ' . $staticClassCode)[0], ['taz']],
        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace GeneratedHydratorTest\CodeGenerator\Visitor;
6
7			use GeneratedHydrator\CodeGenerator\Visitor\HydratorMethodsVisitor;
8			use PhpParser\Node;
9			use PhpParser\Node\Expr\Assign;
10			use PhpParser\Node\Expr\PropertyFetch;
11			use PhpParser\Node\Stmt\Class_;
12			use PhpParser\Node\Stmt\ClassMethod;
13			use PhpParser\ParserFactory;
14			use PHPUnit\Framework\TestCase;
15			use CodeGenerationUtils\Inflector\Util\UniqueIdentifierGenerator;
16			use ReflectionClass;
17
18			/**
19			* Tests for {@see \GeneratedHydrator\CodeGenerator\Visitor\HydratorMethodsVisitor}
20			*
21			* @author Marco Pivetta <[email protected]>
22			* @license MIT
23			*
24			* @covers \GeneratedHydrator\CodeGenerator\Visitor\HydratorMethodsVisitor
25			*/
26			class HydratorMethodsVisitorTest extends TestCase
27			{
28			/**
29			* @dataProvider classAstProvider
30			*
31			* @param string $className
32			* @param Class_ $classNode
33			* @param string[] $properties
34			*/
35			public function testBasicCodeGeneration(string $className, Class_ $classNode, array $properties)
			0 ignored issues – show Unused Code introduced 2017-11-28 19:43 UTC by Report Bug Copy Issue Report The parameter `$properties` 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...
36			{
37			$visitor = new HydratorMethodsVisitor(new ReflectionClass($className));
38
39			/* @var $modifiedAst Class_ */
40			$modifiedNode = $visitor->leaveNode($classNode);
41
42			self::assertMethodExistence('hydrate', $modifiedNode);
			0 ignored issues – show Bug introduced 2017-11-28 20:37 UTC by Report Bug Copy Issue Report It seems like `$modifiedNode` defined by `$visitor->leaveNode($classNode)` on line `40` can be `null`; however, `GeneratedHydratorTest\Co...assertMethodExistence()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
43			self::assertMethodExistence('extract', $modifiedNode);
			0 ignored issues – show Bug introduced 2017-11-28 20:37 UTC by Report Bug Copy Issue Report It seems like `$modifiedNode` defined by `$visitor->leaveNode($classNode)` on line `40` can be `null`; however, `GeneratedHydratorTest\Co...assertMethodExistence()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
44			self::assertMethodExistence('__construct', $modifiedNode);
			0 ignored issues – show Bug introduced 2017-11-28 20:37 UTC by Report Bug Copy Issue Report It seems like `$modifiedNode` defined by `$visitor->leaveNode($classNode)` on line `40` can be `null`; however, `GeneratedHydratorTest\Co...assertMethodExistence()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
45			}
46
47			/**
48			* Verifies that a method was correctly added to by the visitor
49			*
50			* @param string $methodName
51			* @param Class_ $class
52			*/
53			private function assertMethodExistence(string $methodName, Class_ $class)
54			{
55			$members = $class->stmts;
56
57			self::assertCount(
58			1,
59			array_filter(
60			$members,
61			function (Node $node) use ($methodName) : bool {
62			return $node instanceof ClassMethod
63			&& $methodName === $node->name;
64			}
65			)
66			);
67			}
68
69			/**
70			* @return \PhpParser\Node[][]
71			*/
72			public function classAstProvider() : array
73			{
74			$parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
75
76			$className = UniqueIdentifierGenerator::getIdentifier('Foo');
77			$classCode = 'class ' . $className . ' { private $bar; private $baz; protected $tab; '
78			. 'protected $tar; public $taw; public $tam; }';
79
80			eval($classCode);
81
82			$staticClassName = UniqueIdentifierGenerator::getIdentifier('Foo');
83			$staticClassCode = 'class ' . $staticClassName . ' { private static $bar; '
84			. 'protected static $baz; public static $tab; private $taz; }';
85
86			eval($staticClassCode);
87
88			return [
89			[$className, $parser->parse('<?php ' . $classCode)[0], ['bar', 'baz', 'tab', 'tar', 'taw', 'tam']],
90			[$staticClassName, $parser->parse('<?php ' . $staticClassCode)[0], ['taz']],
91			];
92			}
93			}
94

Ocramius / GeneratedHydrator

Push — master ( 2bbfc9...9b6b62 )

HydratorMethodsVisitorTest::classAstProvider() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like