Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#33 - Macro for parsing graphql documents at compile time #56

Merged
merged 3 commits into from
Aug 23, 2015
Merged

#33 - Macro for parsing graphql documents at compile time #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
517a251
This addresses issue #33 by adding a LiteralGraphQLStringContext tha…
dlreeves Aug 23, 2015
e8f34c6
Macro for parsing graphql documents at compile time
dlreeves Aug 23, 2015
c4c80fa
Merge branch 'master' into 33-graphql-macro
dlreeves Aug 23, 2015
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
3 changes: 3 additions & 0 deletions build.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ libraryDependencies ++= Seq(
"org.scalatest" %% "scalatest" % "2.2.4" % "test"
)

// macros
libraryDependencies <+= (scalaVersion)("org.scala-lang" % "scala-reflect" % _)

git.remoteRepo := "git@github.com:sangria-graphql/sangria.git"

// Publishing
Expand Down
87 changes: 87 additions & 0 deletions src/main/scala/sangria/macros/AstLiftable.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
package sangria.macros

import sangria.ast._

import scala.reflect.api.Universe
import scala.reflect.macros.blackbox

/**
* Implements the Liftable type class for AstNode, so we can use them in
* quasiquotes.
*/
trait AstLiftable {
val universe: Universe

import universe._

implicit def liftPosition: Liftable[org.parboiled2.Position] = Liftable {
case org.parboiled2.Position(i, l, c) =>
q"_root_.org.parboiled2.Position($i, $l, $c)"
}

implicit def liftOperationType: Liftable[OperationType] = Liftable {
case OperationType.Query => q"_root_.sangria.ast.OperationType.Query"
case OperationType.Mutation => q"_root_.sangria.ast.OperationType.Mutation"
}

implicit def liftType[T <: sangria.ast.Type]: Liftable[T] = Liftable {
case NamedType(n, p) => q"_root_.sangria.ast.NamedType($n, $p)"
case NotNullType(o, p) => q"_root_.sangria.ast.NotNullType($o, $p)"
case ListType(o, p) => q"_root_.sangria.ast.ListType($o, $p)"
}

implicit def liftVarDef: Liftable[VariableDefinition] = Liftable {
case VariableDefinition(n, t, d, p) =>
q"_root_.sangria.ast.VariableDefinition($n, $t, $d, $p)"
}

implicit def liftDefinition[T <: Definition]: Liftable[T] = Liftable {
case OperationDefinition(o, n, v, d, s, p) =>
q"_root_.sangria.ast.OperationDefinition($o, $n, $v, $d, $s, $p)"
case FragmentDefinition(n, t, d, s, p) =>
q"_root_.sangria.ast.FragmentDefinition($n, $t, $d, $s, $p)"
}

implicit def liftNamedValue[T <: NameValue]: Liftable[T] = Liftable {
case Argument(n, v, p) => q"_root_.sangria.ast.Argument($n, $v, $p)"
case ObjectField(n, v, p) => q"_root_.sangria.ast.ObjectField($n, $v, $p)"
}

implicit def liftValue[T <: sangria.ast.Value]: Liftable[T] = Liftable {
case IntValue(v, p) => q"_root_.sangria.ast.IntValue($v, $p)"
case FloatValue(v, p) => q"_root_.sangria.ast.FloatValue($v, $p)"
case StringValue(v, p) => q"_root_.sangria.ast.StringValue($v, $p)"
case BooleanValue(v, p) => q"_root_.sangria.ast.BooleanValue($v, $p)"
case EnumValue(v, p) => q"_root_.sangria.ast.EnumValue($v, $p)"
case ListValue(v, p) => q"_root_.sangria.ast.ListValue($v, $p)"
case ObjectValue(f, p) => q"_root_.sangria.ast.ObjectValue($f, $p)"
case VariableValue(n, p) => q"_root_.sangria.ast.VariableValue($n, $p)"
case BigIntValue(v, p) =>
q"_root_.sangria.ast.BigIntValue(_root_.scala.math.BigInt(${v.toByteArray}), $p)"
case sangria.ast.BigDecimalValue(v, p) =>
q"_root_.sangria.ast.BigDecimalValue(_root_.scala.math.BigDecimal(${v.toString()}), $p)"
}

implicit def directive: Liftable[sangria.ast.Directive] = Liftable {
case Directive(n, a, p) => q"_root_.sangria.ast.Directive($n, $a, $p)"
}

implicit def selection[T <: Selection]: Liftable[T] = Liftable {
case Field(a, n, arg, d, s, p) =>
q"_root_.sangria.ast.Field($a, $n, $arg, $d, $s, $p)"
case FragmentSpread(n, d, p) =>
q"_root_.sangria.ast.FragmentSpread($n, $d, $p)"
case InlineFragment(t, d, s, p) =>
q"_root_.sangria.ast.InlineFragment($t, $d, $s, $p)"
}

implicit def liftDocument: Liftable[Document] = Liftable {
// Not sure how to translate SourceMapper to ast tree, so set it to None
case Document(d, p, _) => q"_root_.sangria.ast.Document($d, $p, _root_.scala.None)"
}
}

trait MacroAstLiftable extends AstLiftable {
val c: blackbox.Context
val universe: c.universe.type = c.universe
}
34 changes: 34 additions & 0 deletions src/main/scala/sangria/macros/literal.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package sangria.macros

import sangria.ast.Document
import sangria.parser.QueryParser

import scala.language.experimental.macros
import scala.reflect.macros.blackbox

object literal {

implicit class LiteralGraphQLStringContext(val sc: StringContext) extends AnyVal {
def graphql(): Document = macro Macro.impl
}

class Macro(context: blackbox.Context) extends {
val c = context
} with MacroAstLiftable {

import c.universe._

def impl() = {
c.prefix.tree match {
// Expects a string interpolation that doesn't contain any
// expressions, thus containing only a single tree
case Apply(_, List(Apply(_, t :: Nil))) =>
val q"${gql: String}" = t
q"${QueryParser.parse(gql.stripMargin).get}"
case _ =>
c.abort(c.enclosingPosition, "invalid")
}
}
}

}
250 changes: 250 additions & 0 deletions src/test/scala/sangria/macros/LiteralMacroSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,250 @@
package sangria.macros

import org.parboiled2.Position
import org.scalatest.{Matchers, WordSpec}
import sangria.ast._
import sangria.macros.literal.LiteralGraphQLStringContext

class LiteralMacroSpec extends WordSpec with Matchers {
"literal graphql macro" should {
"parse complex query" in {
val ast = graphql"""|# test query
|query FetchLukeAndLeiaAliased($$someVar: Int = 1.23,$$anotherVar: Int = 123)@include(if: true) @include(if: false){
| luke: human(id: "1000")@include(if: true){
| friends(sort: NAME)
| }
| leia: human(id , : , "10103\n \u00F6 ö") {
| name # some name
| }
|
| ... on User {
| birth{day}
| }
|
| ...Foo
|}
|
|fragment Foo on User @foo(bar: 1){
| baz # field in fragment!
|}"""

ast should be {
Document(
List(
OperationDefinition(
OperationType.Query,
Some("FetchLukeAndLeiaAliased"),
List(
VariableDefinition(
"someVar",
NamedType("Int", Some(Position(53, 2, 41))),
Some(BigDecimalValue(BigDecimal("1.23"), Some(Position(59, 2, 47)))), Some(Position(43, 2, 31))),
VariableDefinition(
"anotherVar",
NamedType("Int", Some(Position(77, 2, 65))),
Some(BigIntValue(BigInt(123), Some(Position(83, 2, 71)))), Some(Position(64, 2, 52)))),
List(
Directive(
"include",
List(Argument("if", BooleanValue(true, Some(Position(100, 2, 88))), Some(Position(96, 2, 84)))),
Some(Position(87, 2, 75))),
Directive(
"include",
List(Argument("if", BooleanValue(false, Some(Position(119, 2, 107))), Some(Position(115, 2, 103)))),
Some(Position(106, 2, 94)))),
List(
Field(
Some("luke"),
"human",
List(Argument("id", StringValue("1000", Some(Position(145, 3, 19))), Some(Position(141, 3, 15)))),
List(Directive("include", List(Argument("if", BooleanValue(true, Some(Position(165, 3, 39))), Some(Position(161, 3, 35)))), Some(Position(152, 3, 26)))),
List(Field(None, "friends", List(Argument("sort", EnumValue("NAME", Some(Position(190, 4, 19))), Some(Position(184, 4, 13)))), Nil, Nil, Some(Position(176, 4, 5)))),
Some(Position(129, 3, 3))),
Field(
Some("leia"), "human",
List(Argument("id", StringValue("10103\n ö ö", Some(Position(223, 6, 24))), Some(Position(214, 6, 15)))),
Nil,
List(Field(None, "name", Nil, Nil, Nil, Some(Position(244, 7, 5)))),
Some(Position(202, 6, 3))),
InlineFragment(
NamedType("User", Some(Position(275, 10, 10))),
Nil,
List(Field(None, "birth", Nil, Nil, List(Field(None, "day", Nil, Nil, Nil, Some(Position(292, 11, 11)))), Some(Position(286, 11, 5)))),
Some(Position(268, 10, 3))),
FragmentSpread("Foo", Nil, Some(Position(304, 14, 3)))), Some(Position(13, 2, 1))),
FragmentDefinition(
"Foo",
NamedType("User", Some(Position(330, 17, 17))),
List(
Directive(
"foo",
List(Argument("bar", BigIntValue(BigInt(1), Some(Position(345, 17, 32))), Some(Position(340, 17, 27)))),
Some(Position(335, 17, 22)))),
List(Field(None, "baz", Nil, Nil, Nil, Some(Position(351, 18, 3)))),
Some(Position(314, 17, 1)))),
Some(Position(13, 2, 1)))
}
}

"parse kitchen sink" in {
val ast =
graphql"""|# Copyright (c) 2015, Facebook, Inc.
|# All rights reserved.
|#
|# This source code is licensed under the BSD-style license found in the
|# LICENSE file in the root directory of this source tree. An additional grant
|# of patent rights can be found in the PATENTS file in the same directory.
|
|query queryName($$foo: ComplexType, $$site: Site = MOBILE) {
| whoever123is: node(id: [123, 456]) {
| id ,
| ... on User @defer {
| field2 {
| id ,
| alias: field1(first:10, after:$$foo,) @include(if: $$foo) {
| id,
| ...frag
| }
| }
| }
| }
|}
|
|mutation likeStory {
| like(story: 123) @defer {
| story {
| id
| }
| }
|}
|
|fragment frag on Friend {
| foo(size: $$size, bar: $$b, obj: {key: "value"})
|}
|
|{
| unnamed(truthy: true, falsey: false),
| query
|}"""

ast should be {
Document(
List(
OperationDefinition(
OperationType.Query,
Some("queryName"),
List(
VariableDefinition(
"foo",
NamedType("ComplexType", Some(Position(310, 8, 23))),
None,
Some(Position(304, 8, 17))),
VariableDefinition(
"site",
NamedType("Site", Some(Position(330, 8, 43))),
Some(EnumValue("MOBILE", Some(Position(337, 8, 50)))),
Some(Position(323, 8, 36)))),
Nil,
List(
Field(
Some("whoever123is"),
"node",
List(
Argument(
"id",
ListValue(List(BigIntValue(BigInt(123), Some(Position(373, 9, 27))), BigIntValue(BigInt(456), Some(Position(378, 9, 32)))), Some(Position(372, 9, 26))),
Some(Position(368, 9, 22)))),
Nil,
List(
Field(
None,
"id",
Nil,
Nil,
Nil,
Some(Position(390, 10, 5))),
InlineFragment(
NamedType("User", Some(Position(406, 11, 12))),
List(
Directive("defer", Nil, Some(Position(411, 11, 17)))),
List(
Field(
None,
"field2",
Nil,
Nil,
List(
Field(None, "id", Nil, Nil, Nil, Some(Position(443, 13, 9))),
Field(
Some("alias"),
"field1",
List(
Argument("first", BigIntValue(BigInt(10), Some(Position(476, 14, 29))), Some(Position(470, 14, 23))),
Argument("after", VariableValue("foo", Some(Position(486, 14, 39))), Some(Position(480, 14, 33)))),
List(
Directive(
"include",
List(Argument("if", VariableValue("foo", Some(Position(506, 14, 59))), Some(Position(502, 14, 55)))),
Some(Position(493, 14, 46)))),
List(
Field(None, "id", Nil, Nil, Nil, Some(Position(524, 15, 11))),
FragmentSpread("frag", Nil, Some(Position(538, 16, 11)))),
Some(Position(456, 14, 9)))),
Some(Position(426, 12, 7)))),
Some(Position(399, 11, 5)))),
Some(Position(349, 9, 3)))),
Some(Position(288, 8, 1))),
OperationDefinition(
OperationType.Mutation,
Some("likeStory"),
Nil,
Nil,
List(
Field(
None,
"like",
List(Argument("story", BigIntValue(BigInt(123), Some(Position(612, 24, 15))), Some(Position(605, 24, 8)))),
List(Directive("defer", Nil, Some(Position(617, 24, 20)))),
List(
Field(None, "story", Nil, Nil, List(
Field(None, "id", Nil, Nil, Nil, Some(Position(644, 26, 7)))), Some(Position(630, 25, 5)))),
Some(Position(600, 24, 3)))),
Some(Position(577, 23, 1))),
FragmentDefinition(
"frag",
NamedType("Friend", Some(Position(677, 31, 18))),
Nil,
List(
Field(
None,
"foo",
List(
Argument("size", VariableValue("size", Some(Position(698, 32, 13))), Some(Position(692, 32, 7))),
Argument("bar", VariableValue("b", Some(Position(710, 32, 25))), Some(Position(705, 32, 20))),
Argument("obj", ObjectValue(List(ObjectField("key", StringValue("value", Some(Position(725, 32, 40))), Some(Position(720, 32, 35)))), Some(Position(719, 32, 34))), Some(Position(714, 32, 29)))),
Nil,
Nil,
Some(Position(688, 32, 3)))),
Some(Position(660, 31, 1))),
OperationDefinition(
OperationType.Query,
None,
Nil,
Nil,
List(
Field(
None,
"unnamed",
List(
Argument("truthy", BooleanValue(true, Some(Position(758, 36, 19))), Some(Position(750, 36, 11))),
Argument("falsey", BooleanValue(false, Some(Position(772, 36, 33))), Some(Position(764, 36, 25)))),
Nil,
Nil,
Some(Position(742, 36, 3))),
Field(None, "query", Nil, Nil, Nil, Some(Position(782, 37, 3)))),
Some(Position(738, 35, 1)))),
Some(Position(288, 8, 1)))
}
}
}
}