ynloultratech /
graphql-bundle
| Total Complexity | 84 |
| Total Lines | 479 |
| Duplicated Lines | 0 % |
| Coverage | 81.78% |
| Changes | 0 | ||
Complex classes like ObjectTypeAnnotationParser often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ObjectTypeAnnotationParser, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 33 | class ObjectTypeAnnotationParser implements AnnotationParserInterface |
||
| 34 | { |
||
| 35 | use AnnotationReaderAwareTrait; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * @var TaggedServices |
||
| 39 | */ |
||
| 40 | protected $taggedServices; |
||
| 41 | /** |
||
| 42 | * @var Endpoint |
||
| 43 | */ |
||
| 44 | protected $endpoint; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * ObjectTypeAnnotationParser constructor. |
||
| 48 | * |
||
| 49 | * @param TaggedServices $taggedServices |
||
| 50 | */ |
||
| 51 | 1 | public function __construct(TaggedServices $taggedServices) |
|
| 52 | { |
||
| 53 | 1 | $this->taggedServices = $taggedServices; |
|
| 54 | 1 | } |
|
| 55 | |||
| 56 | /** |
||
| 57 | * {@inheritdoc} |
||
| 58 | */ |
||
| 59 | 1 | public function supports($annotation): bool |
|
| 62 | } |
||
| 63 | |||
| 64 | /** |
||
| 65 | * {@inheritdoc} |
||
| 66 | */ |
||
| 67 | 1 | public function parse($annotation, \ReflectionClass $refClass, Endpoint $endpoint) |
|
| 100 | 1 | } |
|
| 101 | |||
| 102 | /** |
||
| 103 | * @param \ReflectionClass $refClass |
||
| 104 | * @param ImplementorInterface $implementor |
||
| 105 | * @param Endpoint $endpoint |
||
| 106 | * @param Annotation\ObjectType $annotation |
||
| 107 | 1 | */ |
|
| 108 | protected function resolveDefinitionInterfaces(\ReflectionClass $refClass, ImplementorInterface $implementor, Endpoint $endpoint, Annotation\ObjectType $annotation) |
||
| 109 | 1 | { |
|
| 110 | 1 | $interfaceDefinitions = $this->extractInterfaceDefinitions($refClass); |
|
| 111 | 1 | foreach ($interfaceDefinitions as $interfaceDefinition) { |
|
| 112 | if (in_array($interfaceDefinition->getName(), $annotation->ignoreInterface)) { |
||
| 113 | 1 | continue; |
|
| 114 | 1 | } |
|
| 115 | |||
| 116 | 1 | $implementor->addInterface($interfaceDefinition->getName()); |
|
| 117 | |||
| 118 | if (!$endpoint->hasType($interfaceDefinition->getName())) { |
||
| 119 | 1 | $endpoint->addType($interfaceDefinition); |
|
| 120 | 1 | } else { |
|
| 121 | $interfaceDefinition = $endpoint->getType($interfaceDefinition->getName()); |
||
| 122 | } |
||
| 123 | |||
| 124 | $interfaceDefinition->addImplementor($implementor->getName()); |
||
|
Bug
introduced
by
|
|||
| 125 | $this->copyFieldsFromInterface($interfaceDefinition, $implementor); |
||
| 126 | } |
||
| 127 | 1 | ||
| 128 | 1 | //support interface inheritance |
|
| 129 | 1 | //Interface inheritance is not implemented in GraphQL |
|
| 130 | 1 | //@see https://github.com/facebook/graphql/issues/295 |
|
| 131 | 1 | //BUT, GraphQLBundle use this feature in some places like extensions etc. |
|
| 132 | 1 | foreach ($interfaceDefinitions as $interfaceDefinition) { |
|
| 133 | 1 | if ($interfaceDefinition->getClass()) { |
|
| 134 | 1 | $childInterface = new \ReflectionClass($interfaceDefinition->getClass()); |
|
| 135 | 1 | /** @var Annotation\InterfaceType $interface */ |
|
| 136 | $interface = $this->reader->getClassAnnotation($childInterface, Annotation\InterfaceType::class); |
||
| 137 | $parentDefinitions = $this->extractInterfaceDefinitions($childInterface); |
||
| 138 | foreach ($parentDefinitions as $parentDefinition) { |
||
| 139 | if (in_array($parentDefinition->getName(), $interface->ignoreParent)) { |
||
| 140 | continue; |
||
| 141 | 1 | } |
|
| 142 | $this->copyFieldsFromInterface($parentDefinition, $interfaceDefinition); |
||
| 143 | if ($endpoint->hasType($parentDefinition->getName())) { |
||
| 144 | $existentParentDefinition = $endpoint->getType($parentDefinition->getName()); |
||
| 145 | if ($existentParentDefinition instanceof InterfaceDefinition) { |
||
| 146 | $existentParentDefinition->addImplementor($interfaceDefinition->getName()); |
||
| 147 | } |
||
| 148 | 1 | } |
|
| 149 | } |
||
| 150 | 1 | } |
|
| 151 | } |
||
| 152 | } |
||
| 153 | 1 | ||
| 154 | 1 | /** |
|
| 155 | 1 | * @param \ReflectionClass $refClass |
|
| 156 | 1 | * |
|
| 157 | * @return InterfaceDefinition[] |
||
| 158 | 1 | */ |
|
| 159 | protected function extractInterfaceDefinitions(\ReflectionClass $refClass) |
||
| 160 | { |
||
| 161 | 1 | $int = $refClass->getInterfaces(); |
|
| 162 | 1 | ||
| 163 | //get recursively all parent abstract classes to use as interfaces |
||
| 164 | 1 | $currentClass = $refClass; |
|
| 165 | 1 | while ($currentClass->getParentClass()) { |
|
| 166 | 1 | if ($currentClass->getParentClass()->isAbstract()) { |
|
| 167 | $int[] = $currentClass->getParentClass(); |
||
| 168 | } |
||
| 169 | 1 | $currentClass = $currentClass->getParentClass(); |
|
| 170 | 1 | } |
|
| 171 | 1 | ||
| 172 | 1 | //current class can be a object and interface at the same time, |
|
| 173 | 1 | //When use different object types using discriminator map |
|
| 174 | 1 | if ($this->reader->getClassAnnotation($refClass, Annotation\InterfaceType::class)) { |
|
| 175 | $int[] = $refClass; |
||
| 176 | } |
||
| 177 | |||
| 178 | 1 | $definitions = []; |
|
| 179 | 1 | foreach ($int as $intRef) { |
|
| 180 | /** @var Annotation\InterfaceType $intAnnot */ |
||
| 181 | $intAnnot = $this->reader->getClassAnnotation( |
||
| 182 | 1 | $intRef, |
|
| 183 | 1 | Annotation\InterfaceType::class |
|
| 184 | 1 | ); |
|
| 185 | |||
| 186 | if ($intAnnot) { |
||
| 187 | 1 | $intDef = new InterfaceDefinition(); |
|
| 188 | $intDef->setName($intAnnot->name); |
||
| 189 | $intDef->setClass($intRef->getName()); |
||
| 190 | |||
| 191 | 1 | if (!$intDef->getName() && preg_match('/\w+$/', $intRef->getName(), $matches)) { |
|
| 192 | $intDef->setName(preg_replace('/Interface$/', null, $matches[0])); |
||
| 193 | } |
||
| 194 | |||
| 195 | $intDef->setMetas($intAnnot->options); |
||
| 196 | $intDef->setDescription($intAnnot->description); |
||
| 197 | $intDef->setDiscriminatorMap($intAnnot->discriminatorMap); |
||
| 198 | 1 | $intDef->setDiscriminatorProperty($intAnnot->discriminatorProperty); |
|
| 199 | $intDef->setExclusionPolicy($intAnnot->exclusionPolicy); |
||
| 200 | 1 | $this->resolveFields($intRef, $intDef); |
|
| 201 | 1 | if (!$intDef->getName() && preg_match('/\w+$/', $intRef->getName(), $matches)) { |
|
| 202 | 1 | $intDef->setName(preg_replace('/Interface$/', null, $matches[0])); |
|
| 203 | } |
||
| 204 | 1 | ||
| 205 | $definitions[] = $intDef; |
||
| 206 | } |
||
| 207 | } |
||
| 208 | |||
| 209 | return $definitions; |
||
| 210 | } |
||
| 211 | |||
| 212 | 1 | /** |
|
| 213 | * @param \ReflectionClass $refClass |
||
| 214 | 1 | * @param ObjectDefinitionInterface $objectDefinition |
|
| 215 | 1 | */ |
|
| 216 | 1 | protected function loadInheritedProperties(\ReflectionClass $refClass, ObjectDefinitionInterface $objectDefinition) |
|
| 217 | 1 | { |
|
| 218 | 1 | while ($parent = $refClass->getParentClass()) { |
|
| 219 | $this->resolveFields($refClass, $objectDefinition); |
||
| 220 | 1 | $refClass = $parent; |
|
| 221 | } |
||
| 222 | } |
||
| 223 | 1 | ||
| 224 | /** |
||
| 225 | * Copy all fields from interface to given object implementor |
||
| 226 | * |
||
| 227 | * @param InterfaceDefinition $intDef |
||
| 228 | * @param FieldsAwareDefinitionInterface $fieldsAwareDefinition |
||
| 229 | */ |
||
| 230 | protected function copyFieldsFromInterface(InterfaceDefinition $intDef, FieldsAwareDefinitionInterface $fieldsAwareDefinition) |
||
| 231 | 1 | { |
|
| 232 | foreach ($intDef->getFields() as $field) { |
||
| 233 | 1 | if (!$fieldsAwareDefinition->hasField($field->getName())) { |
|
| 234 | 1 | $newField = clone $field; |
|
| 235 | 1 | $newField->addInheritedFrom($intDef->getName()); |
|
| 236 | 1 | $fieldsAwareDefinition->addField($newField); |
|
| 237 | 1 | } else { |
|
| 238 | $fieldsAwareDefinition->getField($field->getName())->addInheritedFrom($intDef->getName()); |
||
| 239 | } |
||
| 240 | 1 | } |
|
| 241 | 1 | } |
|
| 242 | 1 | ||
| 243 | /** |
||
| 244 | * Extract all fields for given definition |
||
| 245 | 1 | * |
|
| 246 | 1 | * @param \ReflectionClass $refClass |
|
| 247 | * @param ObjectDefinitionInterface $objectDefinition |
||
| 248 | 1 | */ |
|
| 249 | protected function resolveFields(\ReflectionClass $refClass, ObjectDefinitionInterface $objectDefinition) |
||
| 250 | { |
||
| 251 | 1 | $props = array_merge($this->getClassProperties($refClass), $this->getClassMethods($refClass)); |
|
| 252 | 1 | $fieldDecorators = $this->getFieldDecorators(); |
|
| 253 | foreach ($props as $prop) { |
||
| 254 | if (!$this->isExposed($objectDefinition, $prop)) { |
||
| 255 | 1 | continue; |
|
| 256 | 1 | } |
|
| 257 | 1 | ||
| 258 | 1 | $field = new FieldDefinition(); |
|
| 259 | foreach ($fieldDecorators as $fieldDecorator) { |
||
| 260 | $fieldDecorator->decorateFieldDefinition($prop, $field, $objectDefinition); |
||
| 261 | 1 | } |
|
| 262 | 1 | ||
| 263 | 1 | if ($objectDefinition->hasField($field->getName())) { |
|
| 264 | 1 | $field = $objectDefinition->getField($field->getName()); |
|
| 265 | 1 | } else { |
|
| 266 | 1 | $objectDefinition->addField($field); |
|
| 267 | 1 | } |
|
| 268 | 1 | ||
| 269 | 1 | $field->setOriginName($prop->name); |
|
| 270 | 1 | $field->setOriginType(\get_class($prop)); |
|
| 271 | |||
| 272 | //resolve field arguments |
||
| 273 | if ($prop instanceof \ReflectionMethod) { |
||
| 274 | foreach ($this->reader->getMethodAnnotations($prop) as $argAnnotation) { |
||
| 275 | if (!$argAnnotation instanceof Annotation\Argument) { |
||
| 276 | 1 | continue; |
|
| 277 | 1 | } |
|
| 278 | 1 | ||
| 279 | $arg = new ArgumentDefinition(); |
||
| 280 | $arg->setName($argAnnotation->name); |
||
| 281 | 1 | $arg->setDescription($argAnnotation->description); |
|
| 282 | $arg->setInternalName($argAnnotation->internalName); |
||
| 283 | $arg->setDefaultValue($argAnnotation->defaultValue); |
||
| 284 | $arg->setType(TypeUtil::normalize($argAnnotation->type)); |
||
| 285 | $arg->setList(TypeUtil::isTypeList($argAnnotation->type)); |
||
| 286 | $arg->setNonNullList(TypeUtil::isTypeNonNullList($argAnnotation->type)); |
||
| 287 | $arg->setNonNull(TypeUtil::isTypeNonNull($argAnnotation->type)); |
||
| 288 | $field->addArgument($arg); |
||
| 289 | 1 | } |
|
| 290 | } |
||
| 291 | } |
||
| 292 | |||
| 293 | //load overrides |
||
| 294 | foreach ($this->reader->getClassAnnotations($refClass) as $annotation) { |
||
| 295 | 1 | if (!$annotation instanceof Annotation\OverrideField) { |
|
| 296 | continue; |
||
| 297 | 1 | } |
|
| 298 | 1 | ||
| 299 | if ($annotation->in && !\in_array($objectDefinition->getName(), $annotation->in)) { |
||
| 300 | 1 | continue; |
|
| 301 | } |
||
| 302 | |||
| 303 | if ($annotation->notIn && \in_array($objectDefinition->getName(), $annotation->notIn)) { |
||
| 304 | continue; |
||
| 305 | 1 | } |
|
| 306 | 1 | ||
| 307 | if (!$objectDefinition->hasField($annotation->name)) { |
||
| 308 | 1 | throw new \InvalidArgumentException(sprintf( |
|
| 309 | 'The object definition "%s" does not have any field called "%s" in any of its parents definitions.', |
||
| 310 | $objectDefinition->getName(), |
||
| 311 | 1 | $annotation->name |
|
| 312 | )); |
||
| 313 | } |
||
| 314 | 1 | ||
| 315 | 1 | if (true === $annotation->hidden) { |
|
| 316 | $objectDefinition->removeField($annotation->name); |
||
| 317 | |||
| 318 | continue; |
||
| 319 | } |
||
| 320 | 1 | ||
| 321 | 1 | $fieldDefinition = $objectDefinition->getField($annotation->name); |
|
| 322 | 1 | ||
| 323 | if ($annotation->type) { |
||
| 324 | $fieldDefinition->setType($annotation->type); |
||
| 325 | } |
||
| 326 | if ($annotation->alias) { |
||
| 327 | $fieldDefinition->setName($annotation->alias); |
||
| 328 | $objectDefinition->removeField($fieldDefinition->getName()); |
||
| 329 | $objectDefinition->addField($fieldDefinition); |
||
| 330 | } |
||
| 331 | if ($annotation->description) { |
||
| 332 | $fieldDefinition->setDescription($annotation->description); |
||
| 333 | } |
||
| 334 | if ($annotation->deprecationReason || false === $annotation->deprecationReason) { |
||
| 335 | $fieldDefinition->setDeprecationReason($annotation->deprecationReason); |
||
| 336 | } |
||
| 337 | if ($annotation->complexity) { |
||
| 338 | $fieldDefinition->setComplexity($annotation->complexity); |
||
| 339 | 1 | } |
|
| 340 | 1 | if ($annotation->roles) { |
|
| 341 | 1 | $fieldDefinition->setRoles($annotation->roles); |
|
| 342 | } |
||
| 343 | } |
||
| 344 | |||
| 345 | //load virtual fields |
||
| 346 | $annotations = $this->reader->getClassAnnotations($refClass); |
||
| 347 | foreach ($annotations as $annotation) { |
||
| 348 | if ($annotation instanceof Annotation\VirtualField) { |
||
| 349 | if ($annotation->in && !\in_array($objectDefinition->getName(), $annotation->in)) { |
||
| 350 | continue; |
||
| 351 | } |
||
| 352 | |||
| 353 | if ($annotation->notIn && \in_array($objectDefinition->getName(), $annotation->notIn)) { |
||
| 354 | continue; |
||
| 355 | } |
||
| 356 | |||
| 357 | if (!$objectDefinition->hasField($annotation->name)) { |
||
| 358 | $fieldDefinition = new FieldDefinition(); |
||
| 359 | $fieldDefinition->setName($annotation->name); |
||
| 360 | $fieldDefinition->setDescription($annotation->description); |
||
| 361 | $fieldDefinition->setDeprecationReason($annotation->deprecationReason); |
||
| 362 | $fieldDefinition->setType(TypeUtil::normalize($annotation->type)); |
||
| 363 | $fieldDefinition->setNonNull(TypeUtil::isTypeNonNull($annotation->type)); |
||
| 364 | $fieldDefinition->setNonNullList(TypeUtil::isTypeNonNullList($annotation->type)); |
||
| 365 | $fieldDefinition->setList(TypeUtil::isTypeList($annotation->type)); |
||
| 366 | 1 | $fieldDefinition->setMeta('expression', $annotation->expression); |
|
| 367 | $fieldDefinition->setResolver(FieldExpressionResolver::class); |
||
| 368 | $fieldDefinition->setComplexity($annotation->complexity); |
||
| 369 | $fieldDefinition->setRoles((array) $annotation->roles); |
||
| 370 | 1 | $objectDefinition->addField($fieldDefinition); |
|
| 371 | } else { |
||
| 372 | $fieldDefinition = $objectDefinition->getField($annotation->name); |
||
| 373 | if ($fieldDefinition->getResolver() === FieldExpressionResolver::class) { |
||
| 374 | continue; |
||
| 375 | 1 | } |
|
| 376 | $error = sprintf( |
||
| 377 | 'The object definition "%s" already has a field called "%s".', |
||
| 378 | 1 | $objectDefinition->getName(), |
|
| 379 | 1 | $annotation->name |
|
| 380 | ); |
||
| 381 | 1 | throw new \InvalidArgumentException($error); |
|
| 382 | 1 | } |
|
| 383 | 1 | } |
|
| 384 | 1 | } |
|
| 385 | 1 | } |
|
| 386 | 1 | ||
| 387 | /** |
||
| 388 | * @return array|FieldDefinitionDecoratorInterface[] |
||
| 389 | 1 | */ |
|
| 390 | protected function getFieldDecorators(): array |
||
| 425 | 1 | } |
|
| 426 | |||
| 427 | /** |
||
| 428 | 1 | * Verify if a given property for given definition is exposed or not |
|
| 429 | 1 | * |
|
| 430 | * @param ObjectDefinitionInterface $definition |
||
| 431 | * @param \ReflectionMethod|\ReflectionProperty $prop |
||
| 432 | * |
||
| 433 | 1 | * @return boolean |
|
| 434 | 1 | */ |
|
| 435 | 1 | protected function isExposed(ObjectDefinitionInterface $definition, $prop): bool |
|
| 436 | 1 | { |
|
| 437 | $exposed = $definition->getExclusionPolicy() === ObjectDefinitionInterface::EXCLUDE_NONE; |
||
| 438 | |||
| 439 | 1 | if ($prop instanceof \ReflectionMethod) { |
|
| 440 | $exposed = false; |
||
| 441 | |||
| 442 | 1 | //implicit inclusion |
|
| 443 | 1 | if ($this->getFieldAnnotation($prop, Annotation\Field::class)) { |
|
| 444 | 1 | $exposed = true; |
|
| 445 | 1 | } |
|
| 446 | } |
||
| 447 | |||
| 448 | if ($exposed && $this->getFieldAnnotation($prop, Annotation\Exclude::class)) { |
||
| 449 | 1 | $exposed = false; |
|
| 450 | } elseif (!$exposed && $this->getFieldAnnotation($prop, Annotation\Expose::class)) { |
||
| 451 | $exposed = true; |
||
| 452 | 1 | } |
|
| 453 | |||
| 454 | /** @var Annotation\Field $fieldAnnotation */ |
||
| 455 | if ($fieldAnnotation = $this->getFieldAnnotation($prop, Annotation\Field::class)) { |
||
| 456 | $exposed = true; |
||
| 457 | if ($fieldAnnotation->in) { |
||
| 458 | $exposed = \in_array($definition->getName(), $fieldAnnotation->in); |
||
| 459 | } elseif (($fieldAnnotation->notIn)) { |
||
| 460 | $exposed = !\in_array($definition->getName(), $fieldAnnotation->notIn); |
||
| 461 | } |
||
| 462 | } |
||
| 463 | 1 | ||
| 464 | return $exposed; |
||
| 465 | 1 | } |
|
| 466 | 1 | ||
| 467 | /** |
||
| 468 | * Get field specific annotation matching given implementor |
||
| 469 | 1 | * |
|
| 470 | * @param \ReflectionMethod|\ReflectionProperty $prop |
||
| 471 | * @param string $annotationClass |
||
| 472 | * |
||
| 473 | * @return mixed |
||
| 474 | */ |
||
| 475 | protected function getFieldAnnotation($prop, string $annotationClass) |
||
| 482 | } |
||
| 483 | |||
| 484 | 1 | /** |
|
| 485 | * @param \ReflectionClass $refClass |
||
| 486 | * |
||
| 487 | * @return array |
||
| 488 | */ |
||
| 489 | protected function getClassProperties(\ReflectionClass $refClass) |
||
| 490 | { |
||
| 491 | $props = []; |
||
| 492 | 1 | foreach ($refClass->getProperties() as $prop) { |
|
| 493 | $props[$prop->name] = $prop; |
||
| 494 | 1 | } |
|
| 495 | 1 | ||
| 496 | 1 | return $props; |
|
| 497 | } |
||
| 498 | |||
| 499 | 1 | /** |
|
| 500 | * @param \ReflectionClass $refClass |
||
| 501 | * |
||
| 502 | * @return array |
||
| 503 | */ |
||
| 504 | protected function getClassMethods(\ReflectionClass $refClass) |
||
| 512 | } |
||
| 513 | } |
||
| 514 |
Loading history...
