Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .swift-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"version": 1,
"indentation" : {
"spaces" : 4
},
"lineBreakBeforeEachArgument": true
}
14 changes: 7 additions & 7 deletions Benchmarks/Benchmarks/GraphQLBenchmarks.swift
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ let benchmarks: @Sendable () -> Void = {
let result = try await graphql(
schema: starWarsSchema,
request: """
query NestedQuery {
hero {
name
friends {
query NestedQuery {
hero {
name
appearsIn
friends {
name
appearsIn
friends {
name
}
}
}
}
}
"""
"""
)
}
}
20 changes: 5 additions & 15 deletions Benchmarks/Benchmarks/StarWarsData.swift
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,12 @@ let droidData: [String: Droid] = [
"2001": r2d2,
]

/**
* Helper function to get a character by ID.
*/
/// Helper function to get a character by ID.
@Sendable func getCharacter(id: String) -> Character? {
return humanData[id] ?? droidData[id]
}

/**
* Allows us to query for a character"s friends.
*/
/// Allows us to query for a character"s friends.
@Sendable func getFriends(character: Character) -> [Character] {
return character.friends.reduce(into: []) { friends, friendID in
if let friend = getCharacter(id: friendID) {
Expand All @@ -144,9 +140,7 @@ let droidData: [String: Droid] = [
}
}

/**
* Allows us to fetch the undisputed hero of the Star Wars trilogy, R2-D2.
*/
/// Allows us to fetch the undisputed hero of the Star Wars trilogy, R2-D2.
@Sendable func getHero(episode: Episode?) -> Character {
if episode == .empire {
// Luke is the hero of Episode V.
Expand All @@ -156,16 +150,12 @@ let droidData: [String: Droid] = [
return r2d2
}

/**
* Allows us to query for the human with the given id.
*/
/// Allows us to query for the human with the given id.
@Sendable func getHuman(id: String) -> Human? {
return humanData[id]
}

/**
* Allows us to query for the droid with the given id.
*/
/// Allows us to query for the droid with the given id.
@Sendable func getDroid(id: String) -> Droid? {
return droidData[id]
}
168 changes: 78 additions & 90 deletions Benchmarks/Benchmarks/StarWarsSchema.swift
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,10 @@ import GraphQL
* We begin by setting up our schema.
*/

/**
* The original trilogy consists of three movies.
*
* This implements the following type system shorthand:
* enum Episode { NEWHOPE, EMPIRE, JEDI }
*/
/// The original trilogy consists of three movies.
///
/// This implements the following type system shorthand:
/// enum Episode { NEWHOPE, EMPIRE, JEDI }
let EpisodeEnum = try! GraphQLEnumType(
name: "Episode",
description: "One of the films in the Star Wars Trilogy",
Expand All @@ -74,43 +72,43 @@ let EpisodeEnum = try! GraphQLEnumType(
]
)

/**
* Characters in the Star Wars trilogy are either humans or droids.
*
* This implements the following type system shorthand:
* interface Character {
* id: String!
* name: String
* friends: [Character]
* appearsIn: [Episode]
* secretBackstory: String
* }
*/
/// Characters in the Star Wars trilogy are either humans or droids.
///
/// This implements the following type system shorthand:
/// interface Character {
/// id: String!
/// name: String
/// friends: [Character]
/// appearsIn: [Episode]
/// secretBackstory: String
/// }
let CharacterInterface = try! GraphQLInterfaceType(
name: "Character",
description: "A character in the Star Wars Trilogy",
fields: { [
"id": GraphQLField(
type: GraphQLNonNull(GraphQLString),
description: "The id of the character."
),
"name": GraphQLField(
type: GraphQLString,
description: "The name of the character."
),
"friends": GraphQLField(
type: GraphQLList(CharacterInterface),
description: "The friends of the character, or an empty list if they have none."
),
"appearsIn": GraphQLField(
type: GraphQLList(EpisodeEnum),
description: "Which movies they appear in."
),
"secretBackstory": GraphQLField(
type: GraphQLString,
description: "All secrets about their past."
),
] },
fields: {
[
"id": GraphQLField(
type: GraphQLNonNull(GraphQLString),
description: "The id of the character."
),
"name": GraphQLField(
type: GraphQLString,
description: "The name of the character."
),
"friends": GraphQLField(
type: GraphQLList(CharacterInterface),
description: "The friends of the character, or an empty list if they have none."
),
"appearsIn": GraphQLField(
type: GraphQLList(EpisodeEnum),
description: "Which movies they appear in."
),
"secretBackstory": GraphQLField(
type: GraphQLString,
description: "All secrets about their past."
),
]
},
resolveType: { character, _ in
switch character {
case is Human:
Expand All @@ -121,18 +119,16 @@ let CharacterInterface = try! GraphQLInterfaceType(
}
)

/**
* We define our human type, which implements the character interface.
*
* This implements the following type system shorthand:
* type Human : Character {
* id: String!
* name: String
* friends: [Character]
* appearsIn: [Episode]
* secretBackstory: String
* }
*/
/// We define our human type, which implements the character interface.
///
/// This implements the following type system shorthand:
/// type Human : Character {
/// id: String!
/// name: String
/// friends: [Character]
/// appearsIn: [Episode]
/// secretBackstory: String
/// }
let HumanType = try! GraphQLObjectType(
name: "Human",
description: "A humanoid creature in the Star Wars universe.",
Expand All @@ -147,8 +143,7 @@ let HumanType = try! GraphQLObjectType(
),
"friends": GraphQLField(
type: GraphQLList(CharacterInterface),
description: "The friends of the human, or an empty list if they " +
"have none.",
description: "The friends of the human, or an empty list if they " + "have none.",
resolve: { human, _, _, _ in
getFriends(character: human as! Human)
}
Expand Down Expand Up @@ -179,19 +174,17 @@ let HumanType = try! GraphQLObjectType(
}
)

/**
* The other type of character in Star Wars is a droid.
*
* This implements the following type system shorthand:
* type Droid : Character {
* id: String!
* name: String
* friends: [Character]
* appearsIn: [Episode]
* secretBackstory: String
* primaryFunction: String
* }
*/
/// The other type of character in Star Wars is a droid.
///
/// This implements the following type system shorthand:
/// type Droid : Character {
/// id: String!
/// name: String
/// friends: [Character]
/// appearsIn: [Episode]
/// secretBackstory: String
/// primaryFunction: String
/// }
let DroidType = try! GraphQLObjectType(
name: "Droid",
description: "A mechanical creature in the Star Wars universe.",
Expand Down Expand Up @@ -237,20 +230,17 @@ let DroidType = try! GraphQLObjectType(
}
)

/**
* This is the type that will be the root of our query, and the
* entry point into our schema. It gives us the ability to fetch
* objects by their IDs, as well as to fetch the undisputed hero
* of the Star Wars trilogy, R2-D2, directly.
*
* This implements the following type system shorthand:
* type Query {
* hero(episode: Episode): Character
* human(id: String!): Human
* droid(id: String!): Droid
* }
*
*/
/// This is the type that will be the root of our query, and the
/// entry point into our schema. It gives us the ability to fetch
/// objects by their IDs, as well as to fetch the undisputed hero
/// of the Star Wars trilogy, R2-D2, directly.
///
/// This implements the following type system shorthand:
/// type Query {
/// hero(episode: Episode): Character
/// human(id: String!): Human
/// droid(id: String!): Droid
/// }
let QueryType = try! GraphQLObjectType(
name: "Query",
fields: [
Expand All @@ -260,9 +250,9 @@ let QueryType = try! GraphQLObjectType(
"episode": GraphQLArgument(
type: EpisodeEnum,
description:
"If omitted, returns the hero of the whole saga. If " +
"provided, returns the hero of that particular episode."
),
"If omitted, returns the hero of the whole saga. If "
+ "provided, returns the hero of that particular episode."
)
],
resolve: { _, arguments, _, _ in
let episode = Episode(arguments["episode"].string)
Expand All @@ -275,7 +265,7 @@ let QueryType = try! GraphQLObjectType(
"id": GraphQLArgument(
type: GraphQLNonNull(GraphQLString),
description: "id of the human"
),
)
],
resolve: { _, arguments, _, _ in
getHuman(id: arguments["id"].string!)
Expand All @@ -287,7 +277,7 @@ let QueryType = try! GraphQLObjectType(
"id": GraphQLArgument(
type: GraphQLNonNull(GraphQLString),
description: "id of the droid"
),
)
],
resolve: { _, arguments, _, _ in
getDroid(id: arguments["id"].string!)
Expand All @@ -296,10 +286,8 @@ let QueryType = try! GraphQLObjectType(
]
)

/**
* Finally, we construct our schema (whose starting query type is the query
* type we defined above) and export it.
*/
/// Finally, we construct our schema (whose starting query type is the query
/// type we defined above) and export it.
let starWarsSchema = try! GraphQLSchema(
query: QueryType,
types: [HumanType, DroidType]
Expand Down
4 changes: 2 additions & 2 deletions Benchmarks/Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ let package = Package(
],
path: "Benchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
]
),
)
],
swiftLanguageVersions: [.v5, .version("6")]
)
6 changes: 3 additions & 3 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ let package = Package(
name: "GraphQL",
platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)],
products: [
.library(name: "GraphQL", targets: ["GraphQL"]),
.library(name: "GraphQL", targets: ["GraphQL"])
],
dependencies: [
.package(url: "https://github.com/apple/swift-collections", .upToNextMajor(from: "1.0.0")),
.package(url: "https://github.com/apple/swift-collections", .upToNextMajor(from: "1.0.0"))
],
targets: [
.target(
name: "GraphQL",
dependencies: [
.product(name: "OrderedCollections", package: "swift-collections"),
.product(name: "OrderedCollections", package: "swift-collections")
]
),
.testTarget(
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,11 @@ Those contributing to this package are expected to follow the [Swift Code of Con
[Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/), and the
[SSWG Technical Best Practices](https://github.com/swift-server/sswg/blob/main/process/incubation.md#technical-best-practices).

This repo uses [SwiftFormat](https://github.com/nicklockwood/SwiftFormat), and includes lint checks to enforce these formatting standards.
To format your code, install `swiftformat` and run:
This repo uses the standard [swift format](https://github.com/swiftlang/swift-format), and includes lint checks to enforce these formatting standards.
To format your code, run:

```bash
swiftformat .
swift format --parallel --in-place --recursive ./
```

Most of this repo mirrors the structure of
Expand Down
Loading
Loading