generate a method from Mock DSL. Mock DSL consists of rules. On a call of generated method, the first rule matched the arguments is applied.

matcher `thenReturn` value means the method return value if the arguments matches matcher.

matcher `thenAction` action means the method executes action if the arguments matches matcher.

matcher `thenMethod` action means the method call method with the arguments if the arguments matches matcher.

throwNoStubShow matcher means the method raises a runtime exception if the arguments matches matcher. The argument tuple is converted to String by using show function.

throwNoStubShow fshow matcher means the method raises runtime exception if the arguments matches matcher. The argument tuple is converted to String by using fshow function.

Monitor arg ret is an event monitor of methods, which logs method calls.

Event args ret is a function call event

watchBy fArgs fRet monitor method decorates method so that monitor logs the method calls. This function is suited for monitoring multiple methods.

fArgs and fRet is converter for arguments/return values of given method.

foo :: Int -> IO String
foo = ...
bar :: Int -> String -> IO ()
bar = ...

data MonitorArgs = FooArgs Int | BarArgs (Int,String) deriving(Eq,Show)
data MonitorRet = FooRet String | BarRet () deriving(Eq, Show)

foo' :: Monitor MonitorArgs MonitorRet -> Int -> IO String
foo' monitor = watch monitor (FooArgs . toTuple) FooRet foo
bar' :: Monitor MonitorArgs MonitorRet -> Int -> String -> IO ()
bar' monitor = watch monitor (BarArgs . toTuple) BarRet bar

Simplified version of watchBy. It is suitable to monitor single method.

withMonitor f calls f with Monitor, and then returns monitored event logs during the function call in addition to the return value of the function call

withMonitor_ f calls f with Monitor, and returns event logs during the call.

call matcher matches method call whose arguments matches matcher

times countMatcher eventMatcher counts events that matches eventMatcher, and then the count matches countMatcher

Generate new instance of Monitor

Get current event logs from monitor

Matcher that matches anything

synonym of id function. Use this function for improving readability

Matcher for Args

>>> args ((==2), (>3)) (2 :* 4 :* Nil)
True
>>> args even (1 :* Nil)
False
>>> args () Nil
True

Convert a tuple matcher to a tuple-like matcher.

>>> args' (\(a, b) -> a * b == 10) (2 :* 5 :* Nil)
True
>>> args' (\(a, b) -> a * b == 10) (2 :* 4 :* Nil)
False