tidy up

Author: paulofaria

Sources/GraphQL/Error/GraphQLError.swift

@@ -1,35 +1,35 @@
 /**
  * A GraphQLError describes an Error found during the parse, validate, or
  * execute phases of performing a GraphQL operation. In addition to a message
- * and stack trace, it also includes information about the locations in a
- * GraphQL document and/or execution result that correspond to the Error.
+ * it also includes information about the locations in a
+ * GraphQL document and/or execution result that correspond to the error.
  */
 public struct GraphQLError : Error {
 
     /**
      * A message describing the Error for debugging purposes.
      *
-     * Enumerable, and appears in the result of JSON.stringify().
+     * Appears in the result of `description`.
      */
     let message: String
 
     /**
-     * An array of { line, column } locations within the source GraphQL document
+     * An array of (line: Int, column: Int) locations within the source GraphQL document
      * which correspond to this error.
      *
      * Errors during validation often contain multiple locations, for example to
      * point out two things with the same name. Errors during execution include a
      * single location, the field which produced the error.
      *
-     * Enumerable, and appears in the result of JSON.stringify().
+     * Appears in the result of `description`.
      */
     let locations: [SourceLocation]
 
     /**
-     * An array describing the JSON-path into the execution response which
+     * An array describing the index path into the execution response which
      * corresponds to this error. Only included for errors during execution.
      *
-     * Enumerable, and appears in the result of JSON.stringify().
+     * Appears in the result of `description`.
      */
     let path: [IndexPathElement]
 

Sources/GraphQL/Execution/Execute.swift

@@ -56,8 +56,6 @@ final class ExecutionContext {
 /**
  * Implements the "Evaluating requests" section of the GraphQL specification.
  *
- * Returns a Promise that will eventually be resolved and never rejected.
- *
  * If the arguments to this func do not result in a legal execution context,
  * a GraphQLError will be thrown immediately explaining the invalid input.
  */
@@ -69,7 +67,6 @@ func execute(
     variableValues: [String: Map] = [:],
     operationName: String? = nil
 ) throws -> Map {
-
     // If a valid context cannot be created due to incorrect arguments,
     // this will throw an error.
     let context = try buildExecutionContext(
@@ -489,7 +486,7 @@ func resolveField(
     let returnType = fieldDef.type
     let resolve = fieldDef.resolve ?? defaultResolve
 
-    // Build a JS object of arguments from the field.arguments AST, using the
+    // Build a Map object of arguments from the field.arguments AST, using the
     // variables scope to fulfill any variable references.
     // TODO: find a way to memoize, in case this field is within a List type.
     let args = try getArgumentValues(
@@ -544,7 +541,7 @@ enum ResultOrError {
 }
 
 // Isolates the "ReturnOrAbrupt" behavior to not de-opt the `resolveField`
-// function. Returns the result of resolveFn or the abrupt-return Error object.
+// function. Returns the result of `resolve` or the abrupt-return Error object.
 func resolveOrError(
     resolve: GraphQLFieldResolve,
     source: MapRepresentable,
@@ -597,7 +594,7 @@ func completeValueCatchingError(
         return completed
     } catch let error as GraphQLError {
         // If `completeValueWithLocatedError` returned abruptly (threw an error),
-        // log the error and return null.
+        // log the error and return .null.
         exeContext.errors.append(error)
         return Map.null
     } catch {
@@ -669,7 +666,7 @@ func completeValue(
         throw error
     case .result(let result):
         // If field type is NonNull, complete for inner type, and throw field error
-        // if result is null.
+        // if result is nullish.
         if let returnType = returnType as? GraphQLNonNull {
             let completed = try completeValue(
                 exeContext: exeContext,
@@ -689,7 +686,7 @@ func completeValue(
             return completed
         }
 
-        // If result value is null-ish (null, undefined, or NaN) then return null.
+        // If result value is null-ish (nil or .null) then return .null.
         if isNullish(result) {
             return Map.null
         }
@@ -707,7 +704,7 @@ func completeValue(
         }
 
         // If field type is a leaf type, Scalar or Enum, serialize to a valid value,
-        // returning null if serialization is not possible.
+        // returning .null if serialization is not possible.
         if let returnType = returnType as? GraphQLLeafType {
             return try completeLeafValue(returnType: returnType, result: result)
         }
@@ -759,7 +756,7 @@ func completeListValue(
     guard let result = result as? [MapRepresentable] else {
         throw GraphQLError(
             message:
-            "Expected Iterable, but did not find one for field " +
+            "Expected array, but did not find one for field " +
             "\(info.parentType.name).\(info.fieldName)."
         )
     }
@@ -789,7 +786,7 @@ func completeListValue(
 
 /**
  * Complete a Scalar or Enum by serializing to a valid value, returning
- * null if serialization is not possible.
+ * .null if serialization is not possible.
  */
 func completeLeafValue(returnType: GraphQLLeafType, result: MapRepresentable) throws -> Map {
     let serializedResult = try returnType.serialize(value: result)
@@ -802,7 +799,7 @@ func completeLeafValue(returnType: GraphQLLeafType, result: MapRepresentable) th
         )
     }
 
-    return serializedResult!
+    return serializedResult
 }
 
 /**

Sources/GraphQL/Execution/Values.swift

@@ -159,7 +159,7 @@ func coerceValue(type: GraphQLInputType, value: Map) throws -> Map? {
     }
 
     guard let type = type as? GraphQLLeafType else {
-        fatalError("Must be input type")
+        throw GraphQLError(message: "Must be input type")
     }
 
     let parsed = try type.parseValue(value: value)

Sources/GraphQL/GraphQL.swift

@@ -9,13 +9,13 @@
 /// - parameter schema:         The GraphQL type system to use when validating and executing a query.
 /// - parameter request:        A GraphQL language formatted string representing the requested operation.
 /// - parameter rootValue:      The value provided as the first argument to resolver functions on the top level type (e.g. the query object type).
-/// - parameter contextValue:   contextValue description
+/// - parameter contextValue:   A context value provided to all resolver functions functions
 /// - parameter variableValues: A mapping of variable name to runtime value to use for all variables defined in the `request`.
 /// - parameter operationName:  The name of the operation to use if `request` contains multiple possible operations. Can be omitted if `request` contains only one operation.
 ///
-/// - throws: throws value description
+/// - throws: throws GraphQLError if an error occurs while parsing the `request`.
 ///
-/// - returns: return value description
+/// - returns: returns a `Map` dictionary containing the result of the query inside the key `data` and any validation or execution errors inside the key `errors`. The value of `data` might be `null` if, for example, the query is invalid. It's possible to have both `data` and `errors` if an error occurs only in a specific field. If that happens the value of that field will be `null` and there will be an error inside `errors` specifying the reason for the failure and the path of the failed field.
 public func graphql(
     schema: GraphQLSchema,
     request: String,

Sources/GraphQL/Language/AST.swift

@@ -171,42 +171,42 @@ extension Node {
     }
 }
 
-extension Name : Node {}
-extension Document : Node {}
-extension OperationDefinition : Node {}
-extension VariableDefinition : Node {}
-extension Variable : Node {}
-extension SelectionSet : Node {}
-extension Field : Node {}
-extension Argument : Node {}
-extension FragmentSpread : Node {}
-extension InlineFragment : Node {}
-extension FragmentDefinition : Node {}
-extension IntValue : Node {}
-extension FloatValue : Node {}
-extension StringValue : Node {}
-extension BooleanValue : Node {}
-extension EnumValue : Node {}
-extension ListValue : Node {}
-extension ObjectValue : Node {}
-extension ObjectField : Node {}
-extension Directive : Node {}
-extension NamedType : Node {}
-extension ListType : Node {}
-extension NonNullType : Node {}
-extension SchemaDefinition : Node {}
-extension OperationTypeDefinition : Node {}
-extension ScalarTypeDefinition : Node {}
-extension ObjectTypeDefinition : Node {}
-extension FieldDefinition : Node {}
-extension InputValueDefinition : Node {}
-extension InterfaceTypeDefinition : Node {}
-extension UnionTypeDefinition : Node {}
-extension EnumTypeDefinition : Node {}
-extension EnumValueDefinition : Node {}
+extension Name                      : Node {}
+extension Document                  : Node {}
+extension OperationDefinition       : Node {}
+extension VariableDefinition        : Node {}
+extension Variable                  : Node {}
+extension SelectionSet              : Node {}
+extension Field                     : Node {}
+extension Argument                  : Node {}
+extension FragmentSpread            : Node {}
+extension InlineFragment            : Node {}
+extension FragmentDefinition        : Node {}
+extension IntValue                  : Node {}
+extension FloatValue                : Node {}
+extension StringValue               : Node {}
+extension BooleanValue              : Node {}
+extension EnumValue                 : Node {}
+extension ListValue                 : Node {}
+extension ObjectValue               : Node {}
+extension ObjectField               : Node {}
+extension Directive                 : Node {}
+extension NamedType                 : Node {}
+extension ListType                  : Node {}
+extension NonNullType               : Node {}
+extension SchemaDefinition          : Node {}
+extension OperationTypeDefinition   : Node {}
+extension ScalarTypeDefinition      : Node {}
+extension ObjectTypeDefinition      : Node {}
+extension FieldDefinition           : Node {}
+extension InputValueDefinition      : Node {}
+extension InterfaceTypeDefinition   : Node {}
+extension UnionTypeDefinition       : Node {}
+extension EnumTypeDefinition        : Node {}
+extension EnumValueDefinition       : Node {}
 extension InputObjectTypeDefinition : Node {}
-extension TypeExtensionDefinition : Node {}
-extension DirectiveDefinition : Node {}
+extension TypeExtensionDefinition   : Node {}
+extension DirectiveDefinition       : Node {}
 
 final class Name {
     let kind: Kind = .name
@@ -264,9 +264,9 @@ extension Document : Equatable {
     }
 }
 
-protocol Definition : Node {}
+protocol  Definition          : Node       {}
 extension OperationDefinition : Definition {}
-extension FragmentDefinition : Definition {}
+extension FragmentDefinition  : Definition {}
 
 func == (lhs: Definition, rhs: Definition) -> Bool {
     switch lhs {
@@ -469,8 +469,8 @@ extension SelectionSet : Hashable {
     }
 }
 
-protocol Selection : Node {}
-extension Field : Selection {}
+protocol  Selection      : Node      {}
+extension Field          : Selection {}
 extension FragmentSpread : Selection {}
 extension InlineFragment : Selection {}
 
@@ -578,9 +578,9 @@ extension Argument : Equatable {
     }
 }
 
-protocol Fragment : Selection {}
-extension FragmentSpread : Fragment {}
-extension InlineFragment : Fragment {}
+protocol  Fragment       : Selection {}
+extension FragmentSpread : Fragment  {}
+extension InlineFragment : Fragment  {}
 
 final class FragmentSpread {
     let kind: Kind = .fragmentSpread
@@ -721,15 +721,15 @@ extension FragmentDefinition : Hashable {
     }
 }
 
-public protocol Value : Node {}
-extension Variable : Value {}
-extension IntValue : Value {}
-extension FloatValue : Value {}
-extension StringValue : Value {}
+public protocol Value  : Node  {}
+extension Variable     : Value {}
+extension IntValue     : Value {}
+extension FloatValue   : Value {}
+extension StringValue  : Value {}
 extension BooleanValue : Value {}
-extension EnumValue : Value {}
-extension ListValue : Value {}
-extension ObjectValue : Value {}
+extension EnumValue    : Value {}
+extension ListValue    : Value {}
+extension ObjectValue  : Value {}
 
 public func == (lhs: Value, rhs: Value) -> Bool {
     switch lhs {
@@ -941,9 +941,9 @@ extension Directive : Equatable {
     }
 }
 
-protocol Type : Node {}
-extension NamedType : Type {}
-extension ListType : Type {}
+protocol  Type        : Node {}
+extension NamedType   : Type {}
+extension ListType    : Type {}
 extension NonNullType : Type {}
 
 func == (lhs: Type, rhs: Type) -> Bool {
@@ -1042,10 +1042,10 @@ extension NonNullType : Equatable {
 
 // Type System Definition
 // experimental non-spec addition.
-protocol TypeSystemDefinition : Definition {}
-extension SchemaDefinition : TypeSystemDefinition {}
+protocol  TypeSystemDefinition    : Definition           {}
+extension SchemaDefinition        : TypeSystemDefinition {}
 extension TypeExtensionDefinition : TypeSystemDefinition {}
-extension DirectiveDefinition : TypeSystemDefinition {}
+extension DirectiveDefinition     : TypeSystemDefinition {}
 
 func == (lhs: TypeSystemDefinition, rhs: TypeSystemDefinition) -> Bool {
     switch lhs {
@@ -1112,13 +1112,13 @@ extension OperationTypeDefinition : Equatable {
     }
 }
 
-protocol TypeDefinition : TypeSystemDefinition {}
-extension ScalarTypeDefinition : TypeDefinition {}
-extension ObjectTypeDefinition : TypeDefinition {}
-extension InterfaceTypeDefinition : TypeDefinition {}
-extension UnionTypeDefinition : TypeDefinition {}
-extension EnumTypeDefinition : TypeDefinition {}
-extension InputObjectTypeDefinition : TypeDefinition {}
+protocol  TypeDefinition            : TypeSystemDefinition {}
+extension ScalarTypeDefinition      : TypeDefinition       {}
+extension ObjectTypeDefinition      : TypeDefinition       {}
+extension InterfaceTypeDefinition   : TypeDefinition       {}
+extension UnionTypeDefinition       : TypeDefinition       {}
+extension EnumTypeDefinition        : TypeDefinition       {}
+extension InputObjectTypeDefinition : TypeDefinition       {}
 
 func == (lhs: TypeDefinition, rhs: TypeDefinition) -> Bool {
     switch lhs {

Sources/GraphQL/Language/Lexer.swift

@@ -120,38 +120,6 @@ extension String {
     }
 }
 
-/**
- * Helper function for constructing the Token object.
- */
-//function Tok(
-//  kind,
-//  start: number,
-//  end: number,
-//  line: number,
-//  column: number,
-//  prev: Token | null,
-//  value?: string
-//) {
-//  this.kind = kind
-//  this.start = start
-//  this.end = end
-//  this.line = line
-//  this.column = column
-//  this.value = value
-//  this.prev = prev
-//  this.next = null
-//}
-
-// Print a simplified form when appearing in JSON/util.inspect.
-//Tok.prototype.toJSON = Tok.prototype.inspect = function toJSON() {
-//  return {
-//    kind: this.kind,
-//    value: this.value,
-//    line: this.line,
-//    column: this.column
-//  }
-//}
-
 func character(_ code: UInt8) -> Character {
   return Character(UnicodeScalar(code))
 }