Failed Conditions
Push — feature/EVO-4410-username-id-t... ( fedcd7...832965 )
by
unknown
10:33
created

DocumentMap::processDocument()   F

Complexity

Conditions 29
Paths 900

Size

Total Lines 97
Code Lines 73

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 97
rs 2.1641
cc 29
eloc 73
nc 900
nop 4

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * DocumentMap class file
4
 */
5
6
namespace Graviton\DocumentBundle\DependencyInjection\Compiler\Utils;
7
8
use Symfony\Component\Finder\Finder;
9
10
/**
11
 * Document map
12
 *
13
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
14
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
15
 * @link     http://swisscom.ch
16
 */
17
class DocumentMap
18
{
19
    /**
20
     * @var array
21
     */
22
    private $mappings = [];
23
    /**
24
     * @var Document[]
25
     */
26
    private $documents = [];
27
28
    /**
29
     * Constructor
30
     *
31
     * @param Finder $doctrineFinder   Doctrine mapping finder
32
     * @param Finder $serializerFinder Serializer mapping finder
33
     * @param Finder $validationFinder Validation mapping finder
34
     */
35
    public function __construct(Finder $doctrineFinder, Finder $serializerFinder, Finder $validationFinder)
36
    {
37
        $doctrineMap = $this->loadDoctrineClassMap($doctrineFinder);
38
        $serializerMap = $this->loadSerializerClassMap($serializerFinder);
39
        $validationMap = $this->loadValidationClassMap($validationFinder);
40
41
        foreach ($doctrineMap as $className => $doctrineMapping) {
42
            $this->mappings[$className] = [
43
                'doctrine'   => $doctrineMap[$className],
44
                'serializer' => isset($serializerMap[$className]) ? $serializerMap[$className] : null,
45
                'validation' => isset($validationMap[$className]) ? $validationMap[$className] : null,
46
            ];
47
        }
48
    }
49
50
    /**
51
     * Get document
52
     *
53
     * @param string $className Document class
54
     * @return Document
55
     */
56
    public function getDocument($className)
57
    {
58
        if (isset($this->documents[$className])) {
59
            return $this->documents[$className];
60
        }
61
        if (!isset($this->mappings[$className])) {
62
            throw new \InvalidArgumentException(sprintf('No XML mapping found for document "%s"', $className));
63
        }
64
65
        return $this->documents[$className] = $this->processDocument(
66
            $className,
67
            $this->mappings[$className]['doctrine'],
68
            $this->mappings[$className]['serializer'],
69
            $this->mappings[$className]['validation']
70
        );
71
    }
72
73
    /**
74
     * Get all documents
75
     *
76
     * @return Document[]
77
     */
78
    public function getDocuments()
79
    {
80
        return array_map([$this, 'getDocument'], array_keys($this->mappings));
81
    }
82
83
    /**
84
     * Process document
85
     *
86
     * @param string      $className         Class name
87
     * @param \DOMElement $doctrineMapping   Doctrine XML mapping
88
     * @param \DOMElement $serializerMapping Serializer XML mapping
0 ignored issues
show
Documentation introduced by
Should the type for parameter $serializerMapping not be null|\DOMElement?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
89
     * @param \DOMElement $validationMapping Validation XML mapping
0 ignored issues
show
Documentation introduced by
Should the type for parameter $validationMapping not be null|\DOMElement?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
90
     * @return Document
91
     */
92
    private function processDocument(
93
        $className,
94
        \DOMElement $doctrineMapping,
95
        \DOMElement $serializerMapping = null,
96
        \DOMElement $validationMapping = null
97
    ) {
98
        if ($serializerMapping === null) {
99
            $serializerFields = [];
100
        } else {
101
            $serializerFields = array_reduce(
102
                $this->getSerializerFields($serializerMapping),
103
                function (array $fields, array $field) {
104
                    $fields[$field['fieldName']] = $field;
105
                    return $fields;
106
                },
107
                []
108
            );
109
        }
110
111
        if ($validationMapping === null) {
112
            $validationFields = [];
113
        } else {
114
            $validationFields = array_reduce(
115
                $this->getValidationFields($validationMapping),
116
                function (array $fields, array $field) {
117
                    $fields[$field['fieldName']] = $field;
118
                    return $fields;
119
                },
120
                []
121
            );
122
        }
123
124
        $fields = [];
125
        foreach ($this->getDoctrineFields($doctrineMapping) as $doctrineField) {
126
            $serializerField = isset($serializerFields[$doctrineField['name']]) ?
127
                $serializerFields[$doctrineField['name']] :
128
                null;
129
            $validationField = isset($validationFields[$doctrineField['name']]) ?
130
                $validationFields[$doctrineField['name']] :
131
                null;
132
133
            if ($doctrineField['type'] === 'collection') {
134
                $fields[] = new ArrayField(
135
                    $serializerField === null ? 'array<string>' : $serializerField['fieldType'],
136
                    $doctrineField['name'],
137
                    $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'],
138
                    $serializerField === null ? false : $serializerField['readOnly'],
139
                    $validationField === null ? false : $validationField['required'],
140
                    $serializerField === null ? false : $serializerField['searchable']
0 ignored issues
show
Unused Code introduced by
The call to ArrayField::__construct() has too many arguments starting with $serializerField === nul...izerField['searchable'].

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
141
                );
142
            } else {
143
                $fields[] = new Field(
144
                    $doctrineField['type'],
145
                    $doctrineField['name'],
146
                    $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'],
147
                    $serializerField === null ? false : $serializerField['readOnly'],
148
                    $validationField === null ? false : $validationField['required'],
149
                    $serializerField === null ? false : $serializerField['searchable']
150
                );
151
            }
152
        }
153
        foreach ($this->getDoctrineEmbedOneFields($doctrineMapping) as $doctrineField) {
154
            $serializerField = isset($serializerFields[$doctrineField['name']]) ?
155
                $serializerFields[$doctrineField['name']] :
156
                null;
157
            $validationField = isset($validationFields[$doctrineField['name']]) ?
158
                $validationFields[$doctrineField['name']] :
159
                null;
160
161
            $fields[] = new EmbedOne(
162
                $this->getDocument($doctrineField['type']),
163
                $doctrineField['name'],
164
                $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'],
165
                $serializerField === null ? false : $serializerField['readOnly'],
166
                $validationField === null ? false : $validationField['required'],
167
                $serializerField === null ? false : $serializerField['searchable']
0 ignored issues
show
Unused Code introduced by
The call to EmbedOne::__construct() has too many arguments starting with $serializerField === nul...izerField['searchable'].

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
168
            );
169
        }
170
        foreach ($this->getDoctrineEmbedManyFields($doctrineMapping) as $doctrineField) {
171
            $serializerField = isset($serializerFields[$doctrineField['name']]) ?
172
                $serializerFields[$doctrineField['name']] :
173
                null;
174
            $validationField = isset($validationFields[$doctrineField['name']]) ?
175
                $validationFields[$doctrineField['name']] :
176
                null;
177
178
            $fields[] = new EmbedMany(
179
                $this->getDocument($doctrineField['type']),
180
                $doctrineField['name'],
181
                $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'],
182
                $serializerField === null ? false : $serializerField['readOnly'],
183
                $validationField === null ? false : $validationField['required']
184
            );
185
        }
186
187
        return new Document($className, $fields);
188
    }
189
190
    /**
191
     * Load doctrine class map
192
     *
193
     * @param Finder $finder Mapping finder
194
     * @return array
195
     */
196 View Code Duplication
    private function loadDoctrineClassMap(Finder $finder)
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...
197
    {
198
        $classMap = [];
199
        foreach ($finder as $file) {
200
            $document = new \DOMDocument();
201
            $document->load($file);
202
203
            $xpath = new \DOMXPath($document);
204
            $xpath->registerNamespace('doctrine', 'http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping');
205
206
            $classMap = array_reduce(
207
                iterator_to_array($xpath->query('//*[self::doctrine:document or self::doctrine:embedded-document]')),
208
                function (array $classMap, \DOMElement $element) {
209
                    $classMap[$element->getAttribute('name')] = $element;
210
                    return $classMap;
211
                },
212
                $classMap
213
            );
214
        }
215
216
        return $classMap;
217
    }
218
219
    /**
220
     * Load serializer class map
221
     *
222
     * @param Finder $finder Mapping finder
223
     * @return array
224
     */
225 View Code Duplication
    private function loadSerializerClassMap(Finder $finder)
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...
226
    {
227
        $classMap = [];
228
        foreach ($finder as $file) {
229
            $document = new \DOMDocument();
230
            $document->load($file);
231
232
            $xpath = new \DOMXPath($document);
233
234
            $classMap = array_reduce(
235
                iterator_to_array($xpath->query('//class')),
236
                function (array $classMap, \DOMElement $element) {
237
                    $classMap[$element->getAttribute('name')] = $element;
238
                    return $classMap;
239
                },
240
                $classMap
241
            );
242
        }
243
244
        return $classMap;
245
    }
246
247
    /**
248
     * Load validation class map
249
     *
250
     * @param Finder $finder Mapping finder
251
     * @return array
252
     */
253 View Code Duplication
    private function loadValidationClassMap(Finder $finder)
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...
254
    {
255
        $classMap = [];
256
        foreach ($finder as $file) {
257
            $document = new \DOMDocument();
258
            $document->load($file);
259
260
            $xpath = new \DOMXPath($document);
261
            $xpath->registerNamespace('constraint', 'http://symfony.com/schema/dic/constraint-mapping');
262
263
            $classMap = array_reduce(
264
                iterator_to_array($xpath->query('//constraint:class')),
265
                function (array $classMap, \DOMElement $element) {
266
                    $classMap[$element->getAttribute('name')] = $element;
267
                    return $classMap;
268
                },
269
                $classMap
270
            );
271
        }
272
273
        return $classMap;
274
    }
275
276
    /**
277
     * Get serializer fields
278
     *
279
     * @param \DOMElement $mapping Serializer XML mapping
280
     * @return array
281
     */
282
    private function getSerializerFields(\DOMElement $mapping)
283
    {
284
        $xpath = new \DOMXPath($mapping->ownerDocument);
285
286
        return array_map(
287
            function (\DOMElement $element) {
288
                return [
289
                    'fieldName'   => $element->getAttribute('name'),
290
                    'fieldType'   => $this->getSerializerFieldType($element),
291
                    'exposedName' => $element->getAttribute('serialized-name') ?: $element->getAttribute('name'),
292
                    'readOnly'    => $element->getAttribute('read-only') === 'true',
293
                    'searchable'  => $element->getAttribute('searchable') === 'true',
294
                ];
295
            },
296
            iterator_to_array($xpath->query('property', $mapping))
297
        );
298
    }
299
300
    /**
301
     * Get serializer field type
302
     *
303
     * @param \DOMElement $field Field node
304
     * @return string|null
305
     */
306
    private function getSerializerFieldType(\DOMElement $field)
307
    {
308
        if ($field->getAttribute('type')) {
309
            return $field->getAttribute('type');
310
        }
311
312
        $xpath = new \DOMXPath($field->ownerDocument);
313
314
        $type = $xpath->query('type', $field)->item(0);
315
        return $type === null ? null : $type->nodeValue;
316
    }
317
318
    /**
319
     * Get validation fields
320
     *
321
     * @param \DOMElement $mapping Validation XML mapping
322
     * @return array
323
     */
324
    private function getValidationFields(\DOMElement $mapping)
325
    {
326
        $xpath = new \DOMXPath($mapping->ownerDocument);
327
        $xpath->registerNamespace('constraint', 'http://symfony.com/schema/dic/constraint-mapping');
328
329
        return array_map(
330
            function (\DOMElement $element) use ($xpath) {
331
                $constraints = $xpath->query('constraint:constraint[@name="NotBlank" or @name="NotNull"]', $element);
332
                return [
333
                    'fieldName' => $element->getAttribute('name'),
334
                    'required'  => $constraints->length > 0,
335
                ];
336
            },
337
            iterator_to_array($xpath->query('constraint:property', $mapping))
338
        );
339
    }
340
341
    /**
342
     * Get doctrine document fields
343
     *
344
     * @param \DOMElement $mapping Doctrine XML mapping
345
     * @return array
346
     */
347 View Code Duplication
    private function getDoctrineFields(\DOMElement $mapping)
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...
348
    {
349
        $xpath = new \DOMXPath($mapping->ownerDocument);
350
        $xpath->registerNamespace('doctrine', 'http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping');
351
352
        return array_map(
353
            function (\DOMElement $element) {
354
                return [
355
                    'name' => $element->getAttribute('fieldName'),
356
                    'type' => $element->getAttribute('type'),
357
                ];
358
            },
359
            iterator_to_array($xpath->query('doctrine:field', $mapping))
360
        );
361
    }
362
363
    /**
364
     * Get doctrine document embed-one fields
365
     *
366
     * @param \DOMElement $mapping Doctrine XML mapping
367
     * @return array
368
     */
369 View Code Duplication
    private function getDoctrineEmbedOneFields(\DOMElement $mapping)
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...
370
    {
371
        $xpath = new \DOMXPath($mapping->ownerDocument);
372
        $xpath->registerNamespace('doctrine', 'http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping');
373
374
        return array_map(
375
            function (\DOMElement $element) {
376
                return [
377
                    'name' => $element->getAttribute('field'),
378
                    'type' => $element->getAttribute('target-document'),
379
                ];
380
            },
381
            iterator_to_array($xpath->query('*[self::doctrine:embed-one or self::doctrine:reference-one]', $mapping))
382
        );
383
    }
384
385
    /**
386
     * Get doctrine document embed-many fields
387
     *
388
     * @param \DOMElement $mapping Doctrine XML mapping
389
     * @return array
390
     */
391 View Code Duplication
    private function getDoctrineEmbedManyFields(\DOMElement $mapping)
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...
392
    {
393
        $xpath = new \DOMXPath($mapping->ownerDocument);
394
        $xpath->registerNamespace('doctrine', 'http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping');
395
396
        return array_map(
397
            function (\DOMElement $element) {
398
                return [
399
                    'name' => $element->getAttribute('field'),
400
                    'type' => $element->getAttribute('target-document'),
401
                ];
402
            },
403
            iterator_to_array($xpath->query('*[self::doctrine:embed-many or self::doctrine:reference-many]', $mapping))
404
        );
405
    }
406
}
407