webonyx /
graphql-php
| Total Complexity | 66 |
| Total Lines | 438 |
| Duplicated Lines | 0 % |
| Coverage | 88.48% |
| Changes | 0 | ||
Complex classes like ASTDefinitionBuilder 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 ASTDefinitionBuilder, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 43 | class ASTDefinitionBuilder |
||
| 44 | { |
||
| 45 | /** @var Node[] */ |
||
| 46 | private $typeDefintionsMap; |
||
| 47 | |||
| 48 | /** @var callable */ |
||
| 49 | private $typeConfigDecorator; |
||
| 50 | |||
| 51 | /** @var bool[] */ |
||
| 52 | private $options; |
||
| 53 | |||
| 54 | /** @var callable */ |
||
| 55 | private $resolveType; |
||
| 56 | |||
| 57 | /** @var Type[] */ |
||
| 58 | private $cache; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * @param Node[] $typeDefintionsMap |
||
| 62 | * @param bool[] $options |
||
| 63 | */ |
||
| 64 | 79 | public function __construct( |
|
| 65 | array $typeDefintionsMap, |
||
| 66 | $options, |
||
| 67 | callable $resolveType, |
||
| 68 | ?callable $typeConfigDecorator = null |
||
| 69 | ) { |
||
| 70 | 79 | $this->typeDefintionsMap = $typeDefintionsMap; |
|
| 71 | 79 | $this->typeConfigDecorator = $typeConfigDecorator; |
|
| 72 | 79 | $this->options = $options; |
|
| 73 | 79 | $this->resolveType = $resolveType; |
|
| 74 | |||
| 75 | 79 | $this->cache = Type::getAllBuiltInTypes(); |
|
| 76 | 79 | } |
|
| 77 | |||
| 78 | /** |
||
| 79 | * @param TypeNode|ListTypeNode|NonNullTypeNode $inputTypeNode |
||
| 80 | * @return Type |
||
| 81 | */ |
||
| 82 | 74 | private function buildWrappedType(Type $innerType, TypeNode $inputTypeNode) |
|
| 83 | { |
||
| 84 | 74 | if ($inputTypeNode->kind === NodeKind::LIST_TYPE) { |
|
|
Bug
introduced
by
|
|||
| 85 | 7 | return Type::listOf($this->buildWrappedType($innerType, $inputTypeNode->type)); |
|
| 86 | } |
||
| 87 | 74 | if ($inputTypeNode->kind === NodeKind::NON_NULL_TYPE) { |
|
| 88 | 6 | $wrappedType = $this->buildWrappedType($innerType, $inputTypeNode->type); |
|
| 89 | |||
| 90 | 6 | return Type::nonNull(NonNull::assertNullableType($wrappedType)); |
|
| 91 | } |
||
| 92 | |||
| 93 | 74 | return $innerType; |
|
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * @param TypeNode|ListTypeNode|NonNullTypeNode $typeNode |
||
| 98 | * @return TypeNode |
||
| 99 | */ |
||
| 100 | 76 | private function getNamedTypeNode(TypeNode $typeNode) |
|
| 101 | { |
||
| 102 | 76 | $namedType = $typeNode; |
|
| 103 | 76 | while ($namedType->kind === NodeKind::LIST_TYPE || $namedType->kind === NodeKind::NON_NULL_TYPE) { |
|
| 104 | 10 | $namedType = $namedType->type; |
|
| 105 | } |
||
| 106 | |||
| 107 | 76 | return $namedType; |
|
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @param string $typeName |
||
| 112 | * @param NamedTypeNode|null $typeNode |
||
| 113 | * @return Type |
||
| 114 | * @throws Error |
||
| 115 | */ |
||
| 116 | 79 | private function internalBuildType($typeName, $typeNode = null) |
|
| 117 | { |
||
| 118 | 79 | if (! isset($this->cache[$typeName])) { |
|
| 119 | 79 | if (isset($this->typeDefintionsMap[$typeName])) { |
|
| 120 | 79 | $type = $this->makeSchemaDef($this->typeDefintionsMap[$typeName]); |
|
| 121 | 79 | if ($this->typeConfigDecorator) { |
|
| 122 | 2 | $fn = $this->typeConfigDecorator; |
|
| 123 | try { |
||
| 124 | 2 | $config = $fn($type->config, $this->typeDefintionsMap[$typeName], $this->typeDefintionsMap); |
|
| 125 | } catch (\Throwable $e) { |
||
| 126 | throw new Error( |
||
| 127 | sprintf('Type config decorator passed to %s threw an error ', static::class) . |
||
| 128 | sprintf('when building %s type: %s', $typeName, $e->getMessage()), |
||
| 129 | null, |
||
| 130 | null, |
||
| 131 | null, |
||
| 132 | null, |
||
| 133 | $e |
||
| 134 | ); |
||
| 135 | } |
||
| 136 | 2 | if (! is_array($config) || isset($config[0])) { |
|
| 137 | throw new Error( |
||
| 138 | sprintf( |
||
| 139 | 'Type config decorator passed to %s is expected to return an array, but got %s', |
||
| 140 | static::class, |
||
| 141 | Utils::getVariableType($config) |
||
| 142 | ) |
||
| 143 | ); |
||
| 144 | } |
||
| 145 | 2 | $type = $this->makeSchemaDefFromConfig($this->typeDefintionsMap[$typeName], $config); |
|
| 146 | } |
||
| 147 | 79 | $this->cache[$typeName] = $type; |
|
| 148 | } else { |
||
| 149 | 3 | $fn = $this->resolveType; |
|
| 150 | 3 | $this->cache[$typeName] = $fn($typeName, $typeNode); |
|
| 151 | } |
||
| 152 | } |
||
| 153 | |||
| 154 | 79 | return $this->cache[$typeName]; |
|
| 155 | } |
||
| 156 | |||
| 157 | /** |
||
| 158 | * @param string|NamedTypeNode $ref |
||
| 159 | * @return Type |
||
| 160 | * @throws Error |
||
| 161 | */ |
||
| 162 | 79 | public function buildType($ref) |
|
| 163 | { |
||
| 164 | 79 | if (is_string($ref)) { |
|
| 165 | 79 | return $this->internalBuildType($ref); |
|
| 166 | } |
||
| 167 | |||
| 168 | 77 | return $this->internalBuildType($ref->name->value, $ref); |
|
| 169 | } |
||
| 170 | |||
| 171 | /** |
||
| 172 | * @return Type|InputType |
||
| 173 | * @throws Error |
||
| 174 | */ |
||
| 175 | 76 | private function internalBuildWrappedType(TypeNode $typeNode) |
|
| 176 | { |
||
| 177 | 76 | $typeDef = $this->buildType($this->getNamedTypeNode($typeNode)); |
|
| 178 | |||
| 179 | 74 | return $this->buildWrappedType($typeDef, $typeNode); |
|
| 180 | } |
||
| 181 | |||
| 182 | 5 | public function buildDirective(DirectiveDefinitionNode $directiveNode) |
|
| 183 | { |
||
| 184 | 5 | return new Directive([ |
|
| 185 | 5 | 'name' => $directiveNode->name->value, |
|
| 186 | 5 | 'description' => $this->getDescription($directiveNode), |
|
| 187 | 5 | 'locations' => Utils::map( |
|
| 188 | 5 | $directiveNode->locations, |
|
| 189 | function ($node) { |
||
| 190 | 5 | return $node->value; |
|
| 191 | 5 | } |
|
| 192 | ), |
||
| 193 | 5 | 'args' => $directiveNode->arguments ? FieldArgument::createMap($this->makeInputValues($directiveNode->arguments)) : null, |
|
| 194 | 5 | 'astNode' => $directiveNode, |
|
| 195 | ]); |
||
| 196 | } |
||
| 197 | |||
| 198 | 75 | public function buildField(FieldDefinitionNode $field) |
|
| 199 | { |
||
| 200 | return [ |
||
| 201 | // Note: While this could make assertions to get the correctly typed |
||
| 202 | // value, that would throw immediately while type system validation |
||
| 203 | // with validateSchema() will produce more actionable results. |
||
| 204 | 75 | 'type' => $this->internalBuildWrappedType($field->type), |
|
| 205 | 73 | 'description' => $this->getDescription($field), |
|
| 206 | 73 | 'args' => $field->arguments ? $this->makeInputValues($field->arguments) : null, |
|
| 207 | 73 | 'deprecationReason' => $this->getDeprecationReason($field), |
|
| 208 | 73 | 'astNode' => $field, |
|
| 209 | ]; |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * @param ObjectTypeDefinitionNode|InterfaceTypeDefinitionNode|EnumTypeDefinitionNode|ScalarTypeDefinitionNode|InputObjectTypeDefinitionNode|UnionTypeDefinitionNode $def |
||
| 214 | * @return CustomScalarType|EnumType|InputObjectType|InterfaceType|ObjectType|UnionType |
||
| 215 | * @throws Error |
||
| 216 | */ |
||
| 217 | 79 | private function makeSchemaDef($def) |
|
| 237 | } |
||
| 238 | } |
||
| 239 | |||
| 240 | /** |
||
| 241 | * @param ObjectTypeDefinitionNode|InterfaceTypeDefinitionNode|EnumTypeExtensionNode|ScalarTypeDefinitionNode|InputObjectTypeDefinitionNode $def |
||
| 242 | * @param mixed[] $config |
||
| 243 | * @return CustomScalarType|EnumType|InputObjectType|InterfaceType|ObjectType|UnionType |
||
| 244 | * @throws Error |
||
| 245 | */ |
||
| 246 | 2 | private function makeSchemaDefFromConfig($def, array $config) |
|
| 247 | { |
||
| 248 | 2 | if (! $def) { |
|
| 249 | throw new Error('def must be defined.'); |
||
| 250 | } |
||
| 251 | 2 | switch ($def->kind) { |
|
| 252 | 2 | case NodeKind::OBJECT_TYPE_DEFINITION: |
|
| 253 | 2 | return new ObjectType($config); |
|
| 254 | 2 | case NodeKind::INTERFACE_TYPE_DEFINITION: |
|
| 255 | 2 | return new InterfaceType($config); |
|
| 256 | 2 | case NodeKind::ENUM_TYPE_DEFINITION: |
|
| 257 | 2 | return new EnumType($config); |
|
| 258 | case NodeKind::UNION_TYPE_DEFINITION: |
||
| 259 | return new UnionType($config); |
||
| 260 | case NodeKind::SCALAR_TYPE_DEFINITION: |
||
| 261 | return new CustomScalarType($config); |
||
| 262 | case NodeKind::INPUT_OBJECT_TYPE_DEFINITION: |
||
| 263 | return new InputObjectType($config); |
||
| 264 | default: |
||
| 265 | throw new Error(sprintf('Type kind of %s not supported.', $def->kind)); |
||
| 266 | } |
||
| 267 | } |
||
| 268 | |||
| 269 | 78 | private function makeTypeDef(ObjectTypeDefinitionNode $def) |
|
| 270 | { |
||
| 271 | 78 | $typeName = $def->name->value; |
|
| 272 | |||
| 273 | 78 | return new ObjectType([ |
|
| 274 | 78 | 'name' => $typeName, |
|
| 275 | 78 | 'description' => $this->getDescription($def), |
|
| 276 | 'fields' => function () use ($def) { |
||
| 277 | 75 | return $this->makeFieldDefMap($def); |
|
| 278 | 78 | }, |
|
| 279 | 'interfaces' => function () use ($def) { |
||
| 280 | 73 | return $this->makeImplementedInterfaces($def); |
|
| 281 | 78 | }, |
|
| 282 | 78 | 'astNode' => $def, |
|
| 283 | ]); |
||
| 284 | } |
||
| 285 | |||
| 286 | 75 | private function makeFieldDefMap($def) |
|
| 287 | { |
||
| 288 | 75 | return $def->fields |
|
| 289 | 75 | ? Utils::keyValMap( |
|
| 290 | 75 | $def->fields, |
|
| 291 | function ($field) { |
||
| 292 | 75 | return $field->name->value; |
|
| 293 | 75 | }, |
|
| 294 | function ($field) { |
||
| 295 | 75 | return $this->buildField($field); |
|
| 296 | 75 | } |
|
| 297 | ) |
||
| 298 | 73 | : []; |
|
| 299 | } |
||
| 300 | |||
| 301 | 73 | private function makeImplementedInterfaces(ObjectTypeDefinitionNode $def) |
|
| 316 | } |
||
| 317 | |||
| 318 | 75 | private function makeInputValues($values) |
|
| 319 | { |
||
| 320 | 75 | return Utils::keyValMap( |
|
| 321 | 75 | $values, |
|
| 322 | function ($value) { |
||
| 323 | 32 | return $value->name->value; |
|
| 324 | 75 | }, |
|
| 325 | function ($value) { |
||
| 326 | // Note: While this could make assertions to get the correctly typed |
||
| 327 | // value, that would throw immediately while type system validation |
||
| 328 | // with validateSchema() will produce more actionable results. |
||
| 329 | 32 | $type = $this->internalBuildWrappedType($value->type); |
|
| 330 | $config = [ |
||
| 331 | 32 | 'name' => $value->name->value, |
|
| 332 | 32 | 'type' => $type, |
|
| 333 | 32 | 'description' => $this->getDescription($value), |
|
| 334 | 32 | 'astNode' => $value, |
|
| 335 | ]; |
||
| 336 | 32 | if (isset($value->defaultValue)) { |
|
| 337 | 2 | $config['defaultValue'] = AST::valueFromAST($value->defaultValue, $type); |
|
| 338 | } |
||
| 339 | |||
| 340 | 32 | return $config; |
|
| 341 | 75 | } |
|
| 342 | ); |
||
| 343 | } |
||
| 344 | |||
| 345 | 25 | private function makeInterfaceDef(InterfaceTypeDefinitionNode $def) |
|
| 346 | { |
||
| 347 | 25 | $typeName = $def->name->value; |
|
| 348 | |||
| 349 | 25 | return new InterfaceType([ |
|
| 350 | 25 | 'name' => $typeName, |
|
| 351 | 25 | 'description' => $this->getDescription($def), |
|
| 352 | 'fields' => function () use ($def) { |
||
| 353 | 25 | return $this->makeFieldDefMap($def); |
|
| 354 | 25 | }, |
|
| 355 | 25 | 'astNode' => $def, |
|
| 356 | ]); |
||
| 357 | } |
||
| 358 | |||
| 359 | 10 | private function makeEnumDef(EnumTypeDefinitionNode $def) |
|
| 360 | { |
||
| 361 | 10 | return new EnumType([ |
|
| 362 | 10 | 'name' => $def->name->value, |
|
| 363 | 10 | 'description' => $this->getDescription($def), |
|
| 364 | 10 | 'values' => $def->values |
|
| 365 | 10 | ? Utils::keyValMap( |
|
| 366 | 10 | $def->values, |
|
| 367 | function ($enumValue) { |
||
| 368 | 9 | return $enumValue->name->value; |
|
| 369 | 10 | }, |
|
| 370 | function ($enumValue) { |
||
| 371 | return [ |
||
| 372 | 9 | 'description' => $this->getDescription($enumValue), |
|
| 373 | 9 | 'deprecationReason' => $this->getDeprecationReason($enumValue), |
|
| 374 | 9 | 'astNode' => $enumValue, |
|
| 375 | ]; |
||
| 376 | 10 | } |
|
| 377 | ) |
||
| 378 | : [], |
||
| 379 | 10 | 'astNode' => $def, |
|
| 380 | ]); |
||
| 381 | } |
||
| 382 | |||
| 383 | 12 | private function makeUnionDef(UnionTypeDefinitionNode $def) |
|
| 384 | { |
||
| 385 | 12 | return new UnionType([ |
|
| 386 | 12 | 'name' => $def->name->value, |
|
| 387 | 12 | 'description' => $this->getDescription($def), |
|
| 388 | // Note: While this could make assertions to get the correctly typed |
||
| 389 | // values below, that would throw immediately while type system |
||
| 390 | // validation with validateSchema() will produce more actionable results. |
||
| 391 | 12 | 'types' => $def->types |
|
| 392 | 11 | ? Utils::map( |
|
| 393 | 11 | $def->types, |
|
| 394 | function ($typeNode) { |
||
| 395 | 11 | return $this->buildType($typeNode); |
|
| 396 | 11 | } |
|
| 397 | ) : |
||
| 398 | [], |
||
| 399 | 11 | 'astNode' => $def, |
|
| 400 | ]); |
||
| 401 | } |
||
| 402 | |||
| 403 | 2 | private function makeScalarDef(ScalarTypeDefinitionNode $def) |
|
| 404 | { |
||
| 405 | 2 | return new CustomScalarType([ |
|
| 406 | 2 | 'name' => $def->name->value, |
|
| 407 | 2 | 'description' => $this->getDescription($def), |
|
| 408 | 2 | 'astNode' => $def, |
|
| 409 | 'serialize' => function ($value) { |
||
| 410 | 1 | return $value; |
|
| 411 | 2 | }, |
|
| 412 | ]); |
||
| 413 | } |
||
| 414 | |||
| 415 | 12 | private function makeInputObjectDef(InputObjectTypeDefinitionNode $def) |
|
| 426 | ]); |
||
| 427 | } |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Given a collection of directives, returns the string value for the |
||
| 431 | * deprecation reason. |
||
| 432 | * |
||
| 433 | * @param EnumValueDefinitionNode | FieldDefinitionNode $node |
||
| 434 | * @return string |
||
| 435 | */ |
||
| 436 | 73 | private function getDeprecationReason($node) |
|
| 437 | { |
||
| 438 | 73 | $deprecated = Values::getDirectiveValues(Directive::deprecatedDirective(), $node); |
|
| 439 | |||
| 440 | 73 | return $deprecated['reason'] ?? null; |
|
| 441 | } |
||
| 442 | |||
| 443 | /** |
||
| 444 | * Given an ast node, returns its string description. |
||
| 445 | */ |
||
| 446 | 79 | private function getDescription($node) |
|
| 459 | } |
||
| 460 | |||
| 461 | 1 | private function getLeadingCommentBlock($node) |
|
| 462 | { |
||
| 481 | } |
||
| 482 | } |
||
| 483 |
Loading history...