Skip to content

Commit 1b3a318

Browse files
bbakermanbbakerman
authored
Merge pull request #143 from wakita181009/add-year-yearmonth
Add Year and YearMonth Scalars
2 parents 779ac89 + f028938 commit 1b3a318

5 files changed

Lines changed: 367 additions & 0 deletions

File tree

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
import graphql.scalars.datetime.DateTimeScalar;
1010
import graphql.scalars.datetime.LocalTimeCoercing;
1111
import graphql.scalars.datetime.TimeScalar;
12+
import graphql.scalars.datetime.YearMonthScalar;
13+
import graphql.scalars.datetime.YearScalar;
1214
import graphql.scalars.java.JavaPrimitives;
1315
import graphql.scalars.locale.LocaleScalar;
1416
import graphql.scalars.id.UUIDScalar;
@@ -70,6 +72,25 @@ public class ExtendedScalars {
7072
* @see java.time.OffsetTime
7173
*/
7274
public static final GraphQLScalarType Time = TimeScalar.INSTANCE;
75+
/**
76+
* A scalar that represents a year and month (e.g., `1996-12`) and produces
77+
* `java.time.YearMonth` objects at runtime.
78+
* <p>
79+
* Its {@link graphql.schema.Coercing#serialize(java.lang.Object)} and {@link graphql.schema.Coercing#parseValue(java.lang.Object)} methods
80+
* accept YearMonth instances and formatted Strings as valid objects.
81+
*
82+
* @see java.time.YearMonth
83+
*/
84+
public static final GraphQLScalarType YearMonth = YearMonthScalar.INSTANCE;
85+
/**
86+
* A scalar that represents a year (e.g., `1996`) and produces `java.time.Year` objects at runtime.
87+
* <p>
88+
* Its {@link graphql.schema.Coercing#serialize(java.lang.Object)} and {@link graphql.schema.Coercing#parseValue(java.lang.Object)} methods
89+
* accept Year instances and formatted Strings as valid objects.
90+
*
91+
* @see java.time.Year
92+
*/
93+
public static final GraphQLScalarType Year = YearScalar.INSTANCE;
7394

7495
/**
7596
* A 24-hour local time scalar that accepts strings like `hh:mm:ss` and `hh:mm:ss.sss` and produces

‎src/main/java/graphql/scalars/datetime/YearMonthScalar.java‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
package graphql.scalars.datetime;
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.time.DateTimeException;
13+
import java.time.YearMonth;
14+
import java.time.format.DateTimeFormatter;
15+
import java.time.format.DateTimeParseException;
16+
import java.time.temporal.TemporalAccessor;
17+
import java.util.function.Function;
18+
19+
import static graphql.scalars.util.Kit.typeName;
20+
21+
/**
22+
* Access this via {@link graphql.scalars.ExtendedScalars#YearMonth}
23+
*/
24+
@Internal
25+
public final class YearMonthScalar {
26+
27+
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM");
28+
29+
public static final GraphQLScalarType INSTANCE;
30+
31+
private YearMonthScalar() {}
32+
33+
static {
34+
Coercing<YearMonth, String> coercing = new Coercing<YearMonth, String>() {
35+
@Override
36+
public String serialize(Object input) throws CoercingSerializeException {
37+
TemporalAccessor temporalAccessor;
38+
if (input instanceof TemporalAccessor) {
39+
temporalAccessor = (TemporalAccessor) input;
40+
} else if (input instanceof String) {
41+
temporalAccessor = parseYearMonth(input.toString(), CoercingSerializeException::new);
42+
} else {
43+
throw new CoercingSerializeException(
44+
"Expected a 'String' or 'java.time.temporal.TemporalAccessor' but was '" + typeName(input) + "'."
45+
);
46+
}
47+
try {
48+
return DATE_FORMATTER.format(temporalAccessor);
49+
} catch (DateTimeException e) {
50+
throw new CoercingSerializeException(
51+
"Unable to turn TemporalAccessor into full yearMonth because of : '" + e.getMessage() + "'."
52+
);
53+
}
54+
}
55+
56+
@Override
57+
public YearMonth parseValue(Object input) throws CoercingParseValueException {
58+
TemporalAccessor temporalAccessor;
59+
if (input instanceof TemporalAccessor) {
60+
temporalAccessor = (TemporalAccessor) input;
61+
} else if (input instanceof String) {
62+
temporalAccessor = parseYearMonth(input.toString(), CoercingParseValueException::new);
63+
} else {
64+
throw new CoercingParseValueException(
65+
"Expected a 'String' or 'java.time.temporal.TemporalAccessor' but was '" + typeName(input) + "'."
66+
);
67+
}
68+
try {
69+
return YearMonth.from(temporalAccessor);
70+
} catch (DateTimeException e) {
71+
throw new CoercingParseValueException(
72+
"Unable to turn TemporalAccessor into full yearMonth because of : '" + e.getMessage() + "'."
73+
);
74+
}
75+
}
76+
77+
@Override
78+
public YearMonth parseLiteral(Object input) throws CoercingParseLiteralException {
79+
if (!(input instanceof StringValue)) {
80+
throw new CoercingParseLiteralException(
81+
"Expected AST type 'StringValue' but was '" + typeName(input) + "'."
82+
);
83+
}
84+
return parseYearMonth(((StringValue) input).getValue(), CoercingParseLiteralException::new);
85+
}
86+
87+
@Override
88+
public Value<?> valueToLiteral(Object input) {
89+
String s = serialize(input);
90+
return StringValue.newStringValue(s).build();
91+
}
92+
93+
private YearMonth parseYearMonth(String s, Function<String, RuntimeException> exceptionMaker) {
94+
try {
95+
TemporalAccessor temporalAccessor = DATE_FORMATTER.parse(s);
96+
return YearMonth.from(temporalAccessor);
97+
} catch (DateTimeParseException e) {
98+
throw exceptionMaker.apply("Invalid RFC3339 full yearMonth value : '" + s + "'. because of : '" + e.getMessage() + "'");
99+
}
100+
}
101+
};
102+
103+
INSTANCE = GraphQLScalarType.newScalar()
104+
.name("YearMonth")
105+
.description("An RFC-3339 compliant Full YearMonth Scalar")
106+
.coercing(coercing)
107+
.build();
108+
}
109+
}

‎src/main/java/graphql/scalars/datetime/YearScalar.java‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
package graphql.scalars.datetime;
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.time.DateTimeException;
13+
import java.time.Year;
14+
import java.time.format.DateTimeFormatter;
15+
import java.time.format.DateTimeParseException;
16+
import java.time.temporal.TemporalAccessor;
17+
import java.util.function.Function;
18+
19+
import static graphql.scalars.util.Kit.typeName;
20+
21+
/**
22+
* Access this via {@link graphql.scalars.ExtendedScalars#Year}
23+
*/
24+
@Internal
25+
public final class YearScalar {
26+
27+
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy");
28+
29+
public static final GraphQLScalarType INSTANCE;
30+
31+
private YearScalar() {}
32+
33+
static {
34+
Coercing<Year, String> coercing = new Coercing<Year, String>() {
35+
@Override
36+
public String serialize(Object input) throws CoercingSerializeException {
37+
TemporalAccessor temporalAccessor;
38+
if (input instanceof TemporalAccessor) {
39+
temporalAccessor = (TemporalAccessor) input;
40+
} else if (input instanceof String) {
41+
temporalAccessor = parseYear(input.toString(), CoercingSerializeException::new);
42+
} else {
43+
throw new CoercingSerializeException(
44+
"Expected a 'String' or 'java.time.temporal.TemporalAccessor' but was '" + typeName(input) + "'."
45+
);
46+
}
47+
try {
48+
return DATE_FORMATTER.format(temporalAccessor);
49+
} catch (DateTimeException e) {
50+
throw new CoercingSerializeException(
51+
"Unable to turn TemporalAccessor into full year because of : '" + e.getMessage() + "'."
52+
);
53+
}
54+
}
55+
56+
@Override
57+
public Year parseValue(Object input) throws CoercingParseValueException {
58+
TemporalAccessor temporalAccessor;
59+
if (input instanceof TemporalAccessor) {
60+
temporalAccessor = (TemporalAccessor) input;
61+
} else if (input instanceof String) {
62+
temporalAccessor = parseYear(input.toString(), CoercingParseValueException::new);
63+
} else {
64+
throw new CoercingParseValueException(
65+
"Expected a 'String' or 'java.time.temporal.TemporalAccessor' but was '" + typeName(input) + "'."
66+
);
67+
}
68+
try {
69+
return Year.from(temporalAccessor);
70+
} catch (DateTimeException e) {
71+
throw new CoercingParseValueException(
72+
"Unable to turn TemporalAccessor into full year because of : '" + e.getMessage() + "'."
73+
);
74+
}
75+
}
76+
77+
@Override
78+
public Year parseLiteral(Object input) throws CoercingParseLiteralException {
79+
if (!(input instanceof StringValue)) {
80+
throw new CoercingParseLiteralException(
81+
"Expected AST type 'StringValue' but was '" + typeName(input) + "'."
82+
);
83+
}
84+
return parseYear(((StringValue) input).getValue(), CoercingParseLiteralException::new);
85+
}
86+
87+
@Override
88+
public Value<?> valueToLiteral(Object input) {
89+
String s = serialize(input);
90+
return StringValue.newStringValue(s).build();
91+
}
92+
93+
private Year parseYear(String s, Function<String, RuntimeException> exceptionMaker) {
94+
try {
95+
TemporalAccessor temporalAccessor = DATE_FORMATTER.parse(s);
96+
return Year.from(temporalAccessor);
97+
} catch (DateTimeParseException e) {
98+
throw exceptionMaker.apply("Invalid RFC3339 full year value : '" + s + "'. because of : '" + e.getMessage() + "'");
99+
}
100+
}
101+
};
102+
103+
INSTANCE = GraphQLScalarType.newScalar()
104+
.name("Year")
105+
.description("An RFC-3339 compliant Full Year Scalar")
106+
.coercing(coercing)
107+
.build();
108+
}
109+
}

‎src/test/groovy/graphql/scalars/datetime/YearMonthScalarTest.groovy‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
package graphql.scalars.datetime
2+
3+
import graphql.language.StringValue
4+
import graphql.scalars.ExtendedScalars
5+
import spock.lang.Specification
6+
import spock.lang.Unroll
7+
8+
import java.time.YearMonth
9+
10+
import static graphql.scalars.util.TestKit.mkStringValue
11+
12+
class YearMonthScalarTest extends Specification {
13+
14+
def coercing = ExtendedScalars.YearMonth.getCoercing()
15+
16+
@Unroll
17+
def "yearMonth parseValue"() {
18+
19+
when:
20+
def result = coercing.parseValue(input)
21+
then:
22+
result == expectedValue
23+
where:
24+
input | expectedValue
25+
"1937-01" | YearMonth.of(1937, 1)
26+
}
27+
28+
@Unroll
29+
def "yearMonth parseLiteral"() {
30+
31+
when:
32+
def result = coercing.parseLiteral(input)
33+
then:
34+
result == expectedValue
35+
where:
36+
input | expectedValue
37+
new StringValue("1937-01") | YearMonth.of(1937, 1)
38+
}
39+
40+
@Unroll
41+
def "yearMonth serialize"() {
42+
43+
when:
44+
def result = coercing.serialize(input)
45+
then:
46+
result == expectedValue
47+
where:
48+
input | expectedValue
49+
"1937-01" | "1937-01"
50+
}
51+
52+
@Unroll
53+
def "yearMonth valueToLiteral"() {
54+
55+
when:
56+
def result = coercing.valueToLiteral(input)
57+
then:
58+
result.isEqualTo(expectedValue)
59+
where:
60+
input | expectedValue
61+
"1937-01" | mkStringValue("1937-01")
62+
}
63+
64+
}

‎src/test/groovy/graphql/scalars/datetime/YearScalarTest.groovy‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
package graphql.scalars.datetime
2+
3+
import graphql.language.StringValue
4+
import graphql.scalars.ExtendedScalars
5+
import spock.lang.Specification
6+
import spock.lang.Unroll
7+
8+
import java.time.Year
9+
10+
import static graphql.scalars.util.TestKit.mkStringValue
11+
12+
class YearScalarTest extends Specification {
13+
14+
def coercing = ExtendedScalars.Year.getCoercing()
15+
16+
@Unroll
17+
def "year parseValue"() {
18+
19+
when:
20+
def result = coercing.parseValue(input)
21+
then:
22+
result == expectedValue
23+
where:
24+
input | expectedValue
25+
"1937" | Year.of(1937)
26+
}
27+
28+
@Unroll
29+
def "year parseLiteral"() {
30+
31+
when:
32+
def result = coercing.parseLiteral(input)
33+
then:
34+
result == expectedValue
35+
where:
36+
input | expectedValue
37+
new StringValue("1937") | Year.of(1937)
38+
}
39+
40+
@Unroll
41+
def "year serialize"() {
42+
43+
when:
44+
def result = coercing.serialize(input)
45+
then:
46+
result == expectedValue
47+
where:
48+
input | expectedValue
49+
"1937" | "1937"
50+
}
51+
52+
@Unroll
53+
def "year valueToLiteral"() {
54+
55+
when:
56+
def result = coercing.valueToLiteral(input)
57+
then:
58+
result.isEqualTo(expectedValue)
59+
where:
60+
input | expectedValue
61+
"1937" | mkStringValue("1937")
62+
}
63+
64+
}

0 commit comments

Comments
 (0)