Merge pull request #169 from haskell-graphql/make-examples-programs

Make examples programs

Author: jml

examples

@@ -1,17 +1,20 @@
 {-# LANGUAGE DataKinds #-}
-{-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE TypeOperators #-}
 
-module Examples.InputObject where
+-- | Demonstrate input object usage.
+module Main (main) where
 
 import Protolude hiding (Enum)
 
+import qualified Data.Aeson as Aeson
+
 import GraphQL
 import GraphQL.API
 import GraphQL.Resolver (Handler)
-import GraphQL.Value (FromValue)
+import GraphQL.Value (FromValue, toValue)
 
-data DogStuff = DogStuff { toy :: Text, likesTreats :: Bool } deriving (Show, Generic)
+data DogStuff = DogStuff { _toy :: Text, _likesTreats :: Bool } deriving (Show, Generic)
 instance FromValue DogStuff
 instance HasAnnotatedInputType DogStuff
 instance Defaultable DogStuff where
@@ -30,10 +33,6 @@ description (DogStuff toy likesTreats)
   | likesTreats = pure $ "likes treats and their favorite toy is a " <> toy
   | otherwise = pure $ "their favorite toy is a " <> toy
 
--- $setup
--- >>> import Data.Aeson (encode)
--- >>> import GraphQL.Value (ToValue(..))
-
 -- | Show input object usage
 --
 -- >>> response <- example "{ description(dogStuff: {toy: \"bone\", likesTreats: true}) }"
@@ -45,3 +44,11 @@ description (DogStuff toy likesTreats)
 -- {"data":{"description":"their favorite toy is a shoe"}}
 example :: Text -> IO Response
 example = interpretAnonymousQuery @Query root
+
+
+main :: IO ()
+main = do
+  response <- example "{ description(dogStuff: {toy: \"bone\", likesTreats: true}) }"
+  putStrLn $ Aeson.encode $ toValue response
+  response' <- example "{ description }"
+  putStrLn $ Aeson.encode $ toValue response'

tests/Examples/InputObject.hs renamed to examples/InputObject.hs

@@ -1,10 +1,13 @@
 {-# LANGUAGE DataKinds #-}
-module Examples.UnionExample  where
+module Main (main) where
 
 import Protolude
+
+import qualified Data.Aeson as Aeson
 import GraphQL.API (Field, List, Object, Union)
-import GraphQL (Response, interpretAnonymousQuery)
+import GraphQL (interpretAnonymousQuery)
 import GraphQL.Resolver (Handler, (:<>)(..), unionValue)
+import GraphQL.Value (ToValue(..))
 
 -- Slightly reduced example from the spec
 type MiniCat = Object "MiniCat" '[] '[Field "name" Text, Field "meowVolume" Int32]
@@ -31,22 +34,9 @@ catOrDogList = pure $
        , unionValue @MiniDog miniDog
        ]
 
--- $setup
--- >>> import Data.Aeson (encode)
--- >>> import GraphQL.Value (ToValue(..))
-
--- | Show usage of a single unionValue
---
--- >>> response <- exampleQuery
--- >>> putStrLn $ encode $ toValue response
--- {"data":{"myPet":{"meowVolume":32,"name":"MonadicFelix"}}}
-exampleQuery :: IO Response
-exampleQuery = interpretAnonymousQuery @CatOrDog catOrDog "{ myPet { ... on MiniCat { name meowVolume } ... on MiniDog { barkVolume } } }"
-
--- | 'unionValue' can be used in a list context
---
--- >>> response <- exampleListQuery
--- >>> putStrLn $ encode $ toValue response
--- {"data":{"pets":[{"meowVolume":32,"name":"Felix"},{"meowVolume":32,"name":"Mini"},{"barkVolume":100}]}}
-exampleListQuery :: IO Response
-exampleListQuery = interpretAnonymousQuery @CatOrDogList catOrDogList  "{ pets { ... on MiniCat { name meowVolume } ... on MiniDog { barkVolume } } }"
+main :: IO ()
+main = do
+  response <- interpretAnonymousQuery @CatOrDog catOrDog "{ myPet { ... on MiniCat { name meowVolume } ... on MiniDog { barkVolume } } }"
+  putStrLn $ Aeson.encode $ toValue response
+  response' <- interpretAnonymousQuery @CatOrDogList catOrDogList "{ pets { ... on MiniCat { name meowVolume } ... on MiniDog { barkVolume } } }"
+  putStrLn $ Aeson.encode $ toValue response'

tests/Examples/UnionExample.hs renamed to examples/UnionExample.hs

@@ -2,7 +2,7 @@
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 244f60f8e2def55fa21d6d61b793b76e26ffbe6fea3b5a4b9fee01127d32358d
+-- hash: 6a38b887cec0d4a157469f5d73041fd16cb286d8f445f4e213c6f08965dbc563
 
 name:           graphql-api
 version:        0.3.0
@@ -74,6 +74,38 @@ library
       Paths_graphql_api
   default-language: Haskell2010
 
+executable input-object-example
+  main-is: InputObject.hs
+  hs-source-dirs:
+      examples
+  default-extensions: NoImplicitPrelude OverloadedStrings RecordWildCards TypeApplications
+  ghc-options: -Wall -fno-warn-redundant-constraints
+  build-depends:
+      aeson
+    , attoparsec
+    , base >=4.9 && <5
+    , exceptions
+    , graphql-api
+    , protolude >=0.2.1
+    , transformers
+  default-language: Haskell2010
+
+executable union-example
+  main-is: UnionExample.hs
+  hs-source-dirs:
+      examples
+  default-extensions: NoImplicitPrelude OverloadedStrings RecordWildCards TypeApplications
+  ghc-options: -Wall -fno-warn-redundant-constraints
+  build-depends:
+      aeson
+    , attoparsec
+    , base >=4.9 && <5
+    , exceptions
+    , graphql-api
+    , protolude >=0.2.1
+    , transformers
+  default-language: Haskell2010
+
 test-suite graphql-api-doctests
   type: exitcode-stdio-1.0
   main-is: Main.hs
@@ -118,8 +150,6 @@ test-suite graphql-api-tests
       ASTTests
       EndToEndTests
       EnumTests
-      Examples.InputObject
-      Examples.UnionExample
       ExampleSchema
       OrderedMapTests
       ResolverTests

graphql-api.cabal

@@ -43,6 +43,23 @@ library:
     - QuickCheck
     - text
 
+executables:
+  input-object-example:
+    main: InputObject.hs
+    source-dirs: examples
+    other-modules: []
+    dependencies:
+      - aeson
+      - graphql-api
+
+  union-example:
+    main: UnionExample.hs
+    source-dirs: examples
+    other-modules: []
+    dependencies:
+      - aeson
+      - graphql-api
+
 tests:
   graphql-api-tests:
     main: Spec.hs