servant-elm-0.2.0.0: test/GenerateSpec.hs

{-# LANGUAGE DataKinds         #-}
{-# LANGUAGE DeriveGeneric     #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TypeOperators     #-}

module GenerateSpec where

import           Test.Hspec

import           Control.Monad (zipWithM_)
import           Data.Aeson    (ToJSON)
import           Data.Monoid   ((<>))
import qualified Data.Text.IO  as T
import           GHC.Generics  (Generic)
import           Servant.API
import           Servant.Elm


data Book = Book
  { title :: String
  } deriving Generic

instance ToJSON Book
instance ElmType Book


type TestApi =
       "one"     :> Get '[JSON] Int
  :<|> "two"     :> ReqBody '[JSON] String
                 :> Post '[JSON] (Maybe Int)
  :<|> "books"   :> Capture "id" Int
                 :> Get '[JSON] Book
  :<|> "books"   :> Capture "title" String
                 :> Get '[JSON] Book
  :<|> "books"   :> QueryFlag "published"
                 :> QueryParam "sort" String
                 :> QueryParam "year" Int
                 :> QueryParams "filters" (Maybe Bool)
                 :> Get '[JSON] [Book]
  :<|> "books"   :> ReqBody '[JSON] Book
                 :> PostNoContent '[JSON] NoContent
  :<|> "nothing" :> GetNoContent '[JSON] NoContent
  :<|> "nothing" :> Put '[JSON] () -- old way to specify no content
  :<|> "with-a-header" :> Header "myStringHeader" String
                       :> Header "myIntHeader" Int
                       :> Get '[JSON] String

testApi :: Proxy TestApi
testApi = Proxy

spec :: Test.Hspec.Spec
spec = do
  describe "encoding a simple api" $ do
    it "does it" $ do
      expected <- mapM T.readFile
        [ "test/elm-sources/getOneSource.elm"
        , "test/elm-sources/postTwoSource.elm"
        , "test/elm-sources/getBooksByIdSource.elm"
        , "test/elm-sources/getBooksByTitleSource.elm"
        , "test/elm-sources/getBooksSource.elm"
        , "test/elm-sources/emptyResponseHandlerSource.elm"
        , "test/elm-sources/handleResponseSource.elm"
        , "test/elm-sources/promoteErrorSource.elm"
        , "test/elm-sources/postBooksSource.elm"
        , "test/elm-sources/getNothingSource.elm"
        , "test/elm-sources/putNothingSource.elm"
        , "test/elm-sources/getWithaheaderSource.elm"
        ]

      let generated = map (<> "\n") (generateElmForAPI testApi)

      generated `itemsShouldBe` expected

itemsShouldBe :: (Monoid a, Eq a, Show a) => [a] -> [a] -> IO ()
itemsShouldBe actual expected =
  zipWithM_ shouldBe (actual   ++ replicate (length expected - length actual) mempty)
                     (expected ++ replicate (length actual - length expected) mempty)