f96915e · servant · git.iko.soy

git.iko.soy/servant

Add samples helper to define samples without documentation

commitf96915e85e2ed8d6d9d53a457d5734d67e08c2ad authorNickolay Kudasov <nickolay.kudasov@gmail.com> dateMon 21 Sep 2015, 12:51 (11 years ago) parentf56a656

3 files changed+6−2

compare with master

unifiedsplit

servant-docs/src/Servant/Docs.hs+1 servant-docs/src/Servant/Docs/Internal.hs+4 servant-docs/test/Servant/DocsSpec.hs+1−2

servant-docs/src/Servant/Docs.hs+1

@@ -151,6 +151,7 @@ module Servant.Docs

151151 , toSample

152152 , noSamples

153153 , singleSample

154+ , samples

154155 , sampleByteString

155156 , sampleByteStrings

156157 , ToParam(..)

servant-docs/src/Servant/Docs/Internal.hs+4

@@ -399,6 +399,10 @@ noSamples = empty

399399singleSample :: a -> [(Text, a)]

400400singleSample x = [("", x)]

401401

402+-- | Samples without documentation.

403+samples :: [a] -> [(Text, a)]

404+samples = map ("",)

405+

402406-- | Default sample Generic-based inputs/outputs.

403407defaultSamples :: forall a b. (Generic a, Generic b, GToSample (Rep a) (Rep b)) => Proxy a -> [(Text, b)]

404408defaultSamples _ = Omega.runOmega $ second to <$> gtoSamples (Proxy :: Proxy (Rep a))

servant-docs/test/Servant/DocsSpec.hs+1−2

@@ -4,7 +4,6 @@

44{-# LANGUAGE FlexibleContexts #-}

55{-# LANGUAGE MultiParamTypeClasses #-}

66{-# LANGUAGE OverloadedStrings #-}

7−{-# LANGUAGE TupleSections #-}

87{-# LANGUAGE TypeOperators #-}

98{-# LANGUAGE TypeSynonymInstances #-}

109{-# OPTIONS_GHC -fno-warn-orphans #-}

@@ -95,7 +94,7 @@ instance ToSample Datatype1 Datatype1 where

9594 toSamples _ = singleSample $ Datatype1 "field 1" 13

9695

9796instance ToSample Char Char where

98− toSamples _ = map ("",) ['a'..'z']

97+ toSamples _ = samples ['a'..'z']

9998

10099instance ToSample Int Int where

101100 toSamples _ = singleSample 17