Safe Haskell	None
Language	Haskell2010

Test.MockCat.Internal.Types

Synopsis

data InvocationRecorder params = InvocationRecorder {
- invocationRef :: TVar (InvocationRecord params)
- functionNature :: FunctionNature
}
data BuiltMock fn params = BuiltMock {
- builtMockFn :: fn
- builtMockRecorder :: InvocationRecorder params
}
data FunctionNature
- = PureConstant
- | IOConstant
- | ParametricFunction
type InvocationList params = [params]
type InvocationCounts params = AssociationList params Int
data InvocationRecord params = InvocationRecord {
- invocations :: InvocationList params
- invocationCounts :: InvocationCounts params
}
data CountVerifyMethod
- = Equal Int
- | LessThanEqual Int
- | GreaterThanEqual Int
- | LessThan Int
- | GreaterThan Int
newtype Cases a b = Cases (State [a] b)
newtype VerifyFailed = VerifyFailed Message
data VerifyOrderMethod
- = ExactlySequence
- | PartiallySequence
data VerifyOrderResult a = VerifyOrderResult {
- index :: Int
- calledValue :: a
- expectedValue :: a
}
type Message = String
data VerifyMatchType a
- = MatchAny a
- | MatchAll a
type MockName = String
safeIndex :: [a] -> Int -> Maybe a
perform :: IO a -> a

Documentation

data InvocationRecorder params Source #

Constructors

InvocationRecorder
Fields invocationRef :: TVar (InvocationRecord params) functionNature :: FunctionNature

data BuiltMock fn params Source #

Result of building a mock: function plus its recorder.

Constructors

BuiltMock
Fields builtMockFn :: fn builtMockRecorder :: InvocationRecorder params

data FunctionNature Source #

Constructors

PureConstant
IOConstant
ParametricFunction

Instances

Instances details

Show FunctionNature Source #
Instance details Defined in Test.MockCat.Internal.Types Methods showsPrec :: Int -> FunctionNature -> ShowS # show :: FunctionNature -> String # showList :: [FunctionNature] -> ShowS #
Eq FunctionNature Source #
Instance details Defined in Test.MockCat.Internal.Types Methods (==) :: FunctionNature -> FunctionNature -> Bool # (/=) :: FunctionNature -> FunctionNature -> Bool #

type InvocationList params = [params] Source #

type InvocationCounts params = AssociationList params Int Source #

data InvocationRecord params Source #

Constructors

InvocationRecord
Fields invocations :: InvocationList params invocationCounts :: InvocationCounts params

Instances

Instances details

Show params => Show (InvocationRecord params) Source #
Instance details Defined in Test.MockCat.Internal.Types Methods showsPrec :: Int -> InvocationRecord params -> ShowS # show :: InvocationRecord params -> String # showList :: [InvocationRecord params] -> ShowS #
Eq params => Eq (InvocationRecord params) Source #
Instance details Defined in Test.MockCat.Internal.Types Methods (==) :: InvocationRecord params -> InvocationRecord params -> Bool # (/=) :: InvocationRecord params -> InvocationRecord params -> Bool #

data CountVerifyMethod Source #

Constructors

Equal Int
LessThanEqual Int
GreaterThanEqual Int
LessThan Int
GreaterThan Int

Instances

Instances details

Show CountVerifyMethod Source #
Instance details Defined in Test.MockCat.Internal.Types Methods showsPrec :: Int -> CountVerifyMethod -> ShowS # show :: CountVerifyMethod -> String # showList :: [CountVerifyMethod] -> ShowS #

newtype Cases a b Source #

Constructors

Cases (State [a] b)

Instances

Instances details

Applicative (Cases a) Source #
Instance details Defined in Test.MockCat.Internal.Types Methods pure :: a0 -> Cases a a0 # (<>) :: Cases a (a0 -> b) -> Cases a a0 -> Cases a b # liftA2 :: (a0 -> b -> c) -> Cases a a0 -> Cases a b -> Cases a c # (>) :: Cases a a0 -> Cases a b -> Cases a b # (<*) :: Cases a a0 -> Cases a b -> Cases a a0 #
Functor (Cases a) Source #
Instance details Defined in Test.MockCat.Internal.Types Methods fmap :: (a0 -> b) -> Cases a a0 -> Cases a b # (<$) :: a0 -> Cases a b -> Cases a a0 #
Monad (Cases a) Source #
Instance details Defined in Test.MockCat.Internal.Types Methods (>>=) :: Cases a a0 -> (a0 -> Cases a b) -> Cases a b # (>>) :: Cases a a0 -> Cases a b -> Cases a b # return :: a0 -> Cases a a0 #
(ParamConstraints params args r, BuildCurried args r fn, BuildCurriedPure args r fn) => StubBuilder (Cases params ()) fn Source #	Overlapping instance for building a mock for a function with multiple parameters. This instance is used when the parameter type is a `Cases` type.
Instance details Defined in Test.MockCat.Internal.Builder Methods buildStub :: Maybe MockName -> Cases params () -> fn Source #
(ParamConstraints params args r, BuildCurried args r fn) => MockBuilder (Cases params ()) fn args Source #	Overlapping instance for building a stub when parameters are provided as `Cases`.
Instance details Defined in Test.MockCat.Internal.Builder Methods build :: MonadIO m => Maybe MockName -> Cases params () -> m (BuiltMock fn args) Source #
(ParamConstraints params args r, BuildCurriedIO args r fn) => MockIOBuilder (Cases params ()) fn args Source #
Instance details Defined in Test.MockCat.Internal.Builder Methods buildIO :: MonadIO m => Maybe MockName -> Cases params () -> m (BuiltMock fn args) Source #
StubBuilder (Cases (IO a) ()) (IO a) Source #	Instance for building a mock for a function with multiple parameters.
Instance details Defined in Test.MockCat.Internal.Builder Methods buildStub :: Maybe MockName -> Cases (IO a) () -> IO a Source #
MockBuilder (Cases (IO a) ()) (IO a) () Source #	Instance for building a stub for `Cases (IO a) ()`.
Instance details Defined in Test.MockCat.Internal.Builder Methods build :: MonadIO m => Maybe MockName -> Cases (IO a) () -> m (BuiltMock (IO a) ()) Source #

newtype VerifyFailed Source #

Constructors

VerifyFailed Message

data VerifyOrderMethod Source #

Constructors

ExactlySequence
PartiallySequence

data VerifyOrderResult a Source #

Constructors

VerifyOrderResult
Fields index :: Int calledValue :: a expectedValue :: a

type Message = String Source #

data VerifyMatchType a Source #

Constructors

MatchAny a
MatchAll a

type MockName = String Source #

safeIndex :: [a] -> Int -> Maybe a Source #

perform :: IO a -> a Source #