Test.Syd.Def.SetupFunc

The SetupFunc abstraction makes resource provider functions (of type (a -> IO r) -> IO r) composable.

Documentation

newtype SetupFunc old new

A function that can provide an new given an old.

You can think of this as a potentially-resource-aware version of 'old -> IO new'.

This type has a monad instance, which means you can now compose setup functions using regular do-notation.

Constructors

SetupFunc

Fields

• unSetupFunc :: forall r. (new -> IO r) -> old -> IO r

Instances

Monad (SetupFunc old)

Defined in Test.Syd.Def.SetupFunc

Methods

(>>=) :: SetupFunc old a -> (a -> SetupFunc old b) -> SetupFunc old b

(>>) :: SetupFunc old a -> SetupFunc old b -> SetupFunc old b

return :: a -> SetupFunc old a

Functor (SetupFunc old)

Defined in Test.Syd.Def.SetupFunc

Methods

fmap :: (a -> b) -> SetupFunc old a -> SetupFunc old b

(<$) :: a -> SetupFunc old b -> SetupFunc old a

Applicative (SetupFunc old)

Defined in Test.Syd.Def.SetupFunc

Methods

pure :: a -> SetupFunc old a

(<*>) :: SetupFunc old (a -> b) -> SetupFunc old a -> SetupFunc old b

liftA2 :: (a -> b -> c) -> SetupFunc old a -> SetupFunc old b -> SetupFunc old c

(*>) :: SetupFunc old a -> SetupFunc old b -> SetupFunc old b

(<*) :: SetupFunc old a -> SetupFunc old b -> SetupFunc old a

MonadIO (SetupFunc old)

Defined in Test.Syd.Def.SetupFunc

Methods

liftIO :: IO a -> SetupFunc old a

Category SetupFunc

Defined in Test.Syd.Def.SetupFunc

Methods

id :: forall (a :: k). SetupFunc a a

(.) :: forall (b :: k) (c :: k) (a :: k). SetupFunc b c -> SetupFunc a b -> SetupFunc a c

makeSimpleSetupFunc :: (forall result. (resource -> IO result) -> IO result) -> SetupFunc () resource

Turn a simple provider function into a SetupFunc.

This works together nicely with most supplier functions. Some examples:

• Network.Wai.Handler.Warp.testWithApplication
• Path.IO.withSystemTempDir

useSimpleSetupFunc :: SetupFunc () resource -> forall result. (resource -> IO result) -> IO result

Use a 'SetupFunc ()' as a simple provider function.

This is the opposite of the makeSimpleSetupFunc function

wrapSetupFunc :: (old -> SetupFunc () new) -> SetupFunc old new

Wrap a function that produces a SetupFunc to into a SetupFunc.

This is useful to combine a given 'SetupFunc b' with other 'SetupFunc ()'s as follows:

mySetupFunc :: SetupFunc B A
mySetupFunc = wrapSetupFunc $ \b -> do
  r <- setupSomething
  c <- setupSomethingElse b r
  pure $ somehowCombine c r

setupSomething :: SetupFunc () R
setupSomething :: B -> R -> SetupFunc () C
somehowCombine :: C -> R -> A

unwrapSetupFunc :: SetupFunc old new -> old -> SetupFunc () new

Unwrap a SetupFunc into a function that produces a SetupFunc

This is the opposite of wrapSetupFunc.

composeSetupFunc :: SetupFunc newer newest -> SetupFunc old newer -> SetupFunc old newest

Compose two setup functions.

This is (.) but for SetupFuncs

connectSetupFunc :: SetupFunc old newer -> SetupFunc newer newest -> SetupFunc old newest

Connect two setup functions.

This is basically 'flip (.)' but for SetupFuncs. It's exactly 'flip composeSetupFunc'.

setupAround :: SetupFunc () inner -> TestDefM outers inner result -> TestDefM outers () result

Use around with a SetupFunc

setupAroundWith :: SetupFunc oldInner newInner -> TestDefM outers newInner result -> TestDefM outers oldInner result

Use aroundWith with a SetupFunc

setupAroundWith' :: HContains outers outer => (outer -> SetupFunc oldInner newInner) -> TestDefM outers newInner result -> TestDefM outers oldInner result

Use aroundWith' with a SetupFunc