Completed
Pull Request — master (#5)
by Cees-Jan
03:18
created

AsyncTableGenerator   B

Complexity

Total Complexity 23

Size/Duplication

Total Lines 201
Duplicated Lines 13.93 %

Coupling/Cohesion

Components 1
Dependencies 18

Test Coverage

Coverage 94.51%

Importance

Changes 0
Metric Value
wmc 23
lcom 1
cbo 18
dl 28
loc 201
ccs 86
cts 91
cp 0.9451
rs 7.3333
c 0
b 0
f 0

8 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 7 1
A locateClassloader() 0 13 3
A generate() 0 64 3
A createMethod() 0 21 1
A createMethodArguments() 0 11 3
A extractMethods() 12 12 4
B iterageStmts() 16 16 5
A extractNamespace() 0 10 3

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace WyriHaximus\React\Cake\Orm;
4
5
use Cake\Datasource\EntityInterface;
6
use Composer\Autoload\ClassLoader;
7
use Generator;
8
use PhpParser\BuilderFactory;
9
use PhpParser\Node;
10
use PhpParser\Parser;
11
use PhpParser\ParserFactory;
12
use PhpParser\PrettyPrinter\Standard;
13
use RuntimeException;
14
15
final class AsyncTableGenerator
16
{
17
    const NAMESPACE_PREFIX = 'WyriHaximus\GeneratedAsyncCakeTable\\';
18
19
    /**
20
     * @var string
21
     */
22
    private $storageLocation;
23
24
    /**
25
     * @var BuilderFactory
26
     */
27
    private $factory;
28
29
    /**
30
     * @var Parser
31
     */
32
    private $parser;
33
34
    /**
35
     * @var ClassLoader
36
     */
37
    private $classLoader;
38
39
    /**
40
     * @param string $storageLocation
41
     */
42 1
    public function __construct($storageLocation)
43
    {
44 1
        $this->storageLocation = $storageLocation;
45 1
        $this->factory = new BuilderFactory();
46 1
        $this->parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
47 1
        $this->classLoader = $this->locateClassloader();
48 1
    }
49
50 1
    private function locateClassloader()
51
    {
52
        foreach ([
53 1
            dirname(__DIR__) . DS . 'vendor' . DS . 'autoload.php',
54 1
            dirname(dirname(dirname(__DIR__))) . DS . 'autoload.php',
55
        ] as $path) {
56 1
            if (file_exists($path)) {
57 1
                return require $path;
58
            }
59
        }
60
61
        throw new RuntimeException('Unable to locate class loader');
62
    }
63
64
    /**
65
     * @param $tableClass
66
     * @return GeneratedTable
67
     */
68 1
    public function generate($tableClass)
69
    {
70 1
        $fileName = $this->classLoader->findFile($tableClass);
71 1
        $contents = file_get_contents($fileName);
72 1
        $ast = $this->parser->parse($contents);
73 1
        $namespace = static::NAMESPACE_PREFIX . $this->extractNamespace($ast);
0 ignored issues
show
Bug introduced by
It seems like $ast defined by $this->parser->parse($contents) on line 72 can also be of type null; however, WyriHaximus\React\Cake\O...tor::extractNamespace() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
74
75 1
        $hashedClass = 'C' . md5($tableClass) . '_F' . md5($contents);
76
77 1
        $generatedTable = new GeneratedTable($namespace, $hashedClass);
78
79 1
        if (file_exists($this->storageLocation . DIRECTORY_SEPARATOR . $hashedClass . '.php')) {
80
            return $generatedTable;
81
        }
82
83 1
        $class = $this->factory->class($hashedClass)
84 1
            ->extend('BaseTable')
85 1
            ->implement('AsyncTableInterface')
86
        ;
87
88 1
        $class->addStmt(
89 1
            new Node\Stmt\TraitUse([
90 1
                new Node\Name('AsyncTable')
91
            ])
92
        );
93
94 1
        $class->addStmt(
95 1
            self::createMethod(
96 1
                'save',
97
                [
98 1
                    new Node\Param('entity', null, 'EntityInterface'),
99 1
                    new Node\Param('options', new Node\Expr\Array_()),
100
                ]
101
            )
102
        );
103
104 1
        foreach ($this->extractMethods($ast) as $method) {
0 ignored issues
show
Bug introduced by
It seems like $ast defined by $this->parser->parse($contents) on line 72 can also be of type null; however, WyriHaximus\React\Cake\O...rator::extractMethods() does only seem to accept array<integer,object<PhpParser\Node>>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
105 1
            $class->addStmt(
106 1
                self::createMethod(
107 1
                    $method->name,
108 1
                    $method->params
109
                )
110
            );
111
        }
112
113 1
        $node = $this->factory->namespace($namespace)
114 1
            ->addStmt($this->factory->use(EntityInterface::class))
115 1
            ->addStmt($this->factory->use($tableClass)->as('BaseTable'))
116 1
            ->addStmt($this->factory->use(AsyncTable::class))
117 1
            ->addStmt($this->factory->use(AsyncTableInterface::class))
118 1
            ->addStmt($class)
119 1
            ->getNode()
120
        ;
121
122 1
        $prettyPrinter = new Standard();
123 1
        file_put_contents(
124 1
            $this->storageLocation . DIRECTORY_SEPARATOR . $hashedClass . '.php',
125 1
            $prettyPrinter->prettyPrintFile([
126 1
                $node
127 1
            ]) . PHP_EOL
128
        );
129
130 1
        return $generatedTable;
131
    }
132
133 1
    protected function createMethod($method, array $params)
134
    {
135 1
        return $this->factory->method($method)
136 1
            ->makePublic()
137 1
            ->addParams($params)
138 1
            ->addStmt(
139 1
                new Node\Stmt\Return_(
140 1
                    new Node\Expr\MethodCall(
141 1
                        new Node\Expr\Variable('this'),
142 1
                        'callAsyncOrSync',
143
                        [
0 ignored issues
show
Documentation introduced by
array(new \PhpParser\Nod...hodArguments($params))) is of type array<integer,object<Php...\Node\\Expr\\Array_>"}>, 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...
144 1
                            new Node\Scalar\String_($method),
145 1
                            new Node\Expr\Array_(
146 1
                                $this->createMethodArguments($params)
147
                            ),
148
                        ]
149
                    )
150
                )
151
            )
152
        ;
153
    }
154
155
    /**
156
     * @param array $params
157
     * @return array
158
     */
159 1
    protected function createMethodArguments(array $params)
160
    {
161 1
        $arguments = [];
162 1
        foreach ($params as $param) {
163 1
            if (!($param instanceof Node\Param)) {
164
                continue;
165
            }
166 1
            $arguments[] = new Node\Expr\Variable($param->name);
167
        }
168 1
        return $arguments;
169
    }
170
171
    /**
172
     * @param Node[] $ast
173
     * @return Generator
174
     */
175 1 View Code Duplication
    protected function extractMethods(array $ast)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
176
    {
177 1
        foreach ($ast as $node) {
178 1
            if (!isset($node->stmts)) {
0 ignored issues
show
Bug introduced by
Accessing stmts on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
179
                continue;
180
            }
181
182 1
            foreach ($this->iterageStmts($node->stmts) as $stmt) {
0 ignored issues
show
Bug introduced by
Accessing stmts on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
183 1
                yield $stmt;
184
            }
185
        }
186 1
    }
187
188 1 View Code Duplication
    protected function iterageStmts(array $stmts)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
189
    {
190 1
        foreach ($stmts as $stmt) {
191 1
            if ($stmt instanceof Node\Stmt\ClassMethod) {
192 1
                yield $stmt;
193
            }
194
195 1
            if (!isset($stmt->stmts)) {
196 1
                continue;
197
            }
198
199 1
            foreach ($this->iterageStmts($stmt->stmts) as $stmt) {
200 1
                yield $stmt;
201
            }
202
        }
203 1
    }
204
205 1
    protected function extractNamespace(array $ast)
206
    {
207 1
        foreach ($ast as $node) {
208 1
            if ($node instanceof Node\Stmt\Namespace_) {
209 1
                return (string)$node->name;
210
            }
211
        }
212
213
        return 'N' . uniqid('', true);
214
    }
215
}
216