Skip to content

Commit ea81b1f

Browse files
bbakermanbbakerman
committed
# Conflicts: # src/main/java/graphql/scalars/ExtendedScalars.java Start of work to get this working
2 parents c2e844f + d7768dc commit ea81b1f

File tree

5 files changed

+203
-0
lines changed

5 files changed

+203
-0
lines changed

‎readme.md

+5
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,11 @@ And example query might look like:
9393
}
9494

9595
```
96+
## ID Scalars
97+
98+
* `UUID`
99+
* A universally unique identifier scalar that accepts uuid values like `2423f0a0-3b81-4115-a189-18df8b35e8fc` and produces
100+
`java.util.UUID` type at runtime
96101

97102
## Object / JSON Scalars
98103

‎src/main/java/graphql/scalars/ExtendedScalars.java

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import graphql.scalars.datetime.TimeScalar;
99
import graphql.scalars.java.JavaPrimitives;
1010
import graphql.scalars.locale.LocaleScalar;
11+
import graphql.scalars.id.UUIDScalar;
1112
import graphql.scalars.numeric.NegativeFloatScalar;
1213
import graphql.scalars.numeric.NegativeIntScalar;
1314
import graphql.scalars.numeric.NonNegativeFloatScalar;
@@ -22,6 +23,8 @@
2223
import graphql.scalars.url.UrlScalar;
2324
import graphql.schema.GraphQLScalarType;
2425

26+
import java.util.UUID;
27+
2528
/**
2629
* This is the API entry point for all the extended scalars
2730
*/
@@ -135,6 +138,12 @@ public class ExtendedScalars {
135138
*/
136139
public static GraphQLScalarType Locale = LocaleScalar.INSTANCE;
137140

141+
/**
142+
* A UUID scalar that accepts a universally unique identifier and produces {@link
143+
* java.util.UUID} objects at runtime.
144+
*/
145+
public static GraphQLScalarType UUID = UUIDScalar.INSTANCE;
146+
138147
/**
139148
* An `Int` scalar that MUST be greater than zero
140149
*

‎src/main/java/graphql/scalars/id/UUIDScalar.java

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
package graphql.scalars.id;
2+
3+
import graphql.Internal;
4+
import graphql.language.StringValue;
5+
import graphql.language.Value;
6+
import graphql.schema.Coercing;
7+
import graphql.schema.CoercingParseLiteralException;
8+
import graphql.schema.CoercingParseValueException;
9+
import graphql.schema.CoercingSerializeException;
10+
import graphql.schema.GraphQLScalarType;
11+
12+
import java.util.UUID;
13+
14+
import static graphql.scalars.util.Kit.typeName;
15+
16+
/**
17+
* Access this via {@link graphql.scalars.ExtendedScalars#UUID}
18+
*/
19+
@Internal
20+
public class UUIDScalar {
21+
22+
public static GraphQLScalarType INSTANCE;
23+
24+
static {
25+
Coercing<UUID, String> coercing = new Coercing<UUID, String>() {
26+
@Override
27+
public String serialize(Object input) throws CoercingSerializeException {
28+
if (input instanceof String) {
29+
try {
30+
return (UUID.fromString((String) input)).toString();
31+
} catch (IllegalArgumentException ex) {
32+
throw new CoercingSerializeException(
33+
"Expected a UUID value that can be converted : '" + ex.getMessage() + "'."
34+
);
35+
}
36+
} else if (input instanceof UUID) {
37+
return input.toString();
38+
} else {
39+
throw new CoercingSerializeException(
40+
"Expected something we can convert to 'java.util.UUID' but was '" + typeName(input) + "'."
41+
);
42+
}
43+
}
44+
45+
@Override
46+
public UUID parseValue(Object input) throws CoercingParseValueException {
47+
if (input instanceof String) {
48+
try {
49+
return UUID.fromString((String) input);
50+
} catch (IllegalArgumentException ex) {
51+
throw new CoercingParseValueException(
52+
"Expected a 'String' of UUID type but was '" + typeName(input) + "'."
53+
);
54+
}
55+
} else if (input instanceof UUID) {
56+
return (UUID) input;
57+
} else {
58+
throw new CoercingParseValueException(
59+
"Expected a 'String' or 'UUID' type but was '" + typeName(input) + "'."
60+
);
61+
}
62+
}
63+
64+
@Override
65+
public UUID parseLiteral(Object input) throws CoercingParseLiteralException {
66+
if (!(input instanceof StringValue)) {
67+
throw new CoercingParseLiteralException(
68+
"Expected a 'java.util.UUID' AST type object but was '" + typeName(input) + "'."
69+
);
70+
}
71+
try {
72+
return UUID.fromString(((StringValue) input).getValue());
73+
} catch (IllegalArgumentException ex) {
74+
throw new CoercingParseLiteralException(
75+
"Expected something that we can convert to a UUID but was invalid"
76+
);
77+
}
78+
}
79+
80+
@Override
81+
public Value valueToLiteral(Object input) {
82+
return Coercing.super.valueToLiteral(input);
83+
}
84+
};
85+
86+
87+
INSTANCE = GraphQLScalarType.newScalar()
88+
.name("UUID")
89+
.description("A universally unique identifier compliant UUID Scalar")
90+
.coercing(coercing)
91+
.build();
92+
93+
}
94+
95+
}

‎src/test/groovy/graphql/scalars/id/UUIDScalarTest.groovy

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
package graphql.scalars.id
2+
3+
import graphql.language.StringValue
4+
import graphql.schema.CoercingParseLiteralException
5+
import graphql.schema.CoercingParseValueException
6+
import graphql.schema.CoercingSerializeException
7+
import spock.lang.Specification
8+
import spock.lang.Unroll
9+
10+
import static graphql.scalars.util.TestKit.*
11+
12+
class UUIDScalarTest extends Specification {
13+
14+
def coercing = new UUIDScalar().getCoercing()
15+
16+
@Unroll
17+
def "UUID parseValue"() {
18+
19+
when:
20+
def result = coercing.parseValue(input)
21+
then:
22+
result == expectedValue
23+
where:
24+
input | expectedValue
25+
"43f20307-603c-4ad1-83c6-6010d224fabf" | mkUUIDValue("43f20307-603c-4ad1-83c6-6010d224fabf")
26+
"787dbc2b-3ddb-4098-ad1d-63d026bac111" | mkUUIDValue("787dbc2b-3ddb-4098-ad1d-63d026bac111")
27+
}
28+
29+
@Unroll
30+
def "UUID parseValue bad inputs"() {
31+
32+
when:
33+
coercing.parseValue(input)
34+
then:
35+
thrown(expectedValue)
36+
where:
37+
input | expectedValue
38+
"a-string-that-is-not-uuid" | CoercingParseValueException
39+
100 | CoercingParseValueException
40+
"1985-04-12" | CoercingParseValueException
41+
}
42+
43+
def "UUID AST literal"() {
44+
45+
when:
46+
def result = coercing.parseLiteral(input)
47+
then:
48+
result == expectedValue
49+
where:
50+
input | expectedValue
51+
new StringValue("6972117d-3963-4214-ab2c-fa973d7e996b") | mkUUIDValue("6972117d-3963-4214-ab2c-fa973d7e996b")
52+
}
53+
54+
def "UUID AST literal bad inputs"() {
55+
56+
when:
57+
coercing.parseLiteral(input)
58+
then:
59+
thrown(expectedValue)
60+
where:
61+
input | expectedValue
62+
new StringValue("a-string-that-us-not-uuid") | CoercingParseLiteralException
63+
}
64+
65+
def "UUID serialization"() {
66+
67+
when:
68+
def result = coercing.serialize(input)
69+
then:
70+
result == expectedValue
71+
where:
72+
input | expectedValue
73+
"42287d47-c5bd-45e4-b470-53e426d3d503" | "42287d47-c5bd-45e4-b470-53e426d3d503"
74+
"423df0f3-cf05-4eb5-b708-ae2f4b4a052d" | "423df0f3-cf05-4eb5-b708-ae2f4b4a052d"
75+
mkUUIDValue("6a90b1e6-20f3-43e5-a7ba-34db8010c071") | "6a90b1e6-20f3-43e5-a7ba-34db8010c071"
76+
}
77+
78+
def "UUID serialization bad inputs"() {
79+
80+
when:
81+
coercing.serialize(input)
82+
then:
83+
thrown(expectedValue)
84+
where:
85+
input | expectedValue
86+
"1985-04-12" | CoercingSerializeException
87+
100 | CoercingSerializeException
88+
}
89+
90+
}

‎src/test/groovy/graphql/scalars/util/TestKit.groovy

+4
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,8 @@ class TestKit {
8585
return new FloatValue(new BigDecimal(d))
8686
}
8787

88+
static UUID mkUUIDValue(String s) {
89+
return UUID.fromString(s)
90+
}
91+
8892
}

0 commit comments

Comments
 (0)