Safe Haskell	Safe-Inferred
Language	Haskell2010

Constrained.GenT

Synopsis

data GE a
- = FatalError (NonEmpty (NonEmpty String))
- | GenError (NonEmpty (NonEmpty String))
- | Result a
data GenMode
- = Loose
- | Strict
newtype GenT m a = GenT {
- runGenT ∷ GenMode → [NonEmpty String] → Gen (m a)
}
class Monad m ⇒ MonadGenError m where
- genErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → m a
- fatalErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → m a
- genErrorNE ∷ HasCallStack ⇒ NonEmpty String → m a
- fatalErrorNE ∷ HasCallStack ⇒ NonEmpty String → m a
- explainNE ∷ HasCallStack ⇒ NonEmpty String → m a → m a
genError ∷ MonadGenError m ⇒ String → m a
fatalError ∷ MonadGenError m ⇒ String → m a
explain ∷ MonadGenError m ⇒ String → m a → m a
add ∷ NonEmpty a → [NonEmpty a] → NonEmpty (NonEmpty a)
cat ∷ NonEmpty (NonEmpty a) → [NonEmpty a] → NonEmpty (NonEmpty a)
catMessages ∷ NonEmpty (NonEmpty String) → String
catMessageList ∷ NonEmpty (NonEmpty String) → NonEmpty String
catGEs ∷ ∀ m a. MonadGenError m ⇒ [GE a] → m [a]
fromGE ∷ HasCallStack ⇒ (NonEmpty (NonEmpty String) → a) → GE a → a
errorGE ∷ GE a → a
isOk ∷ GE a → Bool
runGE ∷ ∀ m r. MonadGenError m ⇒ GE r → m r
fromGEProp ∷ Testable p ⇒ GE p → Property
fromGEDiscard ∷ Testable p ⇒ GE p → Property
headGE ∷ Foldable t ⇒ t a → GE a
listFromGE ∷ GE [a] → [a]
strictGen ∷ GenT m a → Gen (m a)
genFromGenT ∷ GenT GE a → Gen a
resizeT ∷ (Int → Int) → GenT m a → GenT m a
pureGen ∷ Applicative m ⇒ Gen a → GenT m a
listOfT ∷ MonadGenError m ⇒ GenT GE a → GenT m [a]
listOfUntilLenT ∷ (Typeable a, MonadGenError m) ⇒ GenT GE a → Int → (Int → Bool) → GenT m [a]
vectorOfT ∷ MonadGenError m ⇒ Int → GenT GE a → GenT m [a]
suchThatT ∷ (Typeable a, MonadGenError m) ⇒ GenT m a → (a → Bool) → GenT m a
suchThatWithTryT ∷ ∀ a m. (Typeable a, MonadGenError m) ⇒ Int → GenT m a → (a → Bool) → GenT m a
scaleT ∷ (Int → Int) → GenT m a → GenT m a
getMode ∷ Applicative m ⇒ GenT m GenMode
getMessages ∷ Applicative m ⇒ GenT m [NonEmpty String]
withMode ∷ GenMode → GenT m a → GenT m a
oneofT ∷ (Typeable a, MonadGenError m) ⇒ [GenT GE a] → GenT m a
frequencyT ∷ (Typeable a, MonadGenError m) ⇒ [(Int, GenT GE a)] → GenT m a
chooseT ∷ (Random a, Ord a, Show a, MonadGenError m) ⇒ (a, a) → GenT m a
sizeT ∷ Monad m ⇒ GenT m Int
inspect ∷ ∀ m x. MonadGenError m ⇒ GenT GE x → GenT m (GE x)
tryGenT ∷ MonadGenError m ⇒ GenT GE a → GenT m (Maybe a)
catchGenT ∷ MonadGenError m ⇒ GenT GE a → GenT m (Either (NonEmpty (NonEmpty String)) a)
catchGen ∷ GenT GE a → Gen (Either (NonEmpty (NonEmpty String)) a)
firstGenT ∷ ∀ m a. MonadGenError m ⇒ [GenT GE a] → GenT m (Either [NonEmpty (NonEmpty String)] a)
liftGen ∷ ∀ x. (∀ m. MonadGenError m ⇒ GenT m x) → GenT GE x
dropGen ∷ MonadGenError m ⇒ GenT GE a → GenT m a
frequency2 ∷ ∀ m a. MonadGenError m ⇒ (Int, GenT GE a) → (Int, GenT GE a) → GenT m a
push ∷ ∀ m a. MonadGenError m ⇒ [String] → m a → m a
pushGE ∷ ∀ a. [String] → GE a → GE a

Documentation

data GE a Source #

It distinguishes between two kinds of errors: FatalError and GenError and non-fatal errors.

Constructors

FatalError (NonEmpty (NonEmpty String))
GenError (NonEmpty (NonEmpty String))
Result a

Instances

Instances details

Applicative GE Source #
Instance details Defined in Constrained.GenT Methods pure ∷ a → GE a (<>) ∷ GE (a → b) → GE a → GE b liftA2 ∷ (a → b → c) → GE a → GE b → GE c (>) ∷ GE a → GE b → GE b (<*) ∷ GE a → GE b → GE a
Functor GE Source #
Instance details Defined in Constrained.GenT Methods fmap ∷ (a → b) → GE a → GE b (<$) ∷ a → GE b → GE a
Monad GE Source #
Instance details Defined in Constrained.GenT Methods (>>=) ∷ GE a → (a → GE b) → GE b (>>) ∷ GE a → GE b → GE b return ∷ a → GE a
MonadGenError GE Source #
Instance details Defined in Constrained.GenT Methods genErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GE a Source # fatalErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GE a Source # genErrorNE ∷ HasCallStack ⇒ NonEmpty String → GE a Source # fatalErrorNE ∷ HasCallStack ⇒ NonEmpty String → GE a Source # explainNE ∷ HasCallStack ⇒ NonEmpty String → GE a → GE a Source #
Show a ⇒ Show (GE a) Source #
Instance details Defined in Constrained.GenT Methods showsPrec ∷ Int → GE a → ShowS show ∷ GE a → String showList ∷ [GE a] → ShowS
Eq a ⇒ Eq (GE a) Source #
Instance details Defined in Constrained.GenT Methods (==) ∷ GE a → GE a → Bool (/=) ∷ GE a → GE a → Bool
Ord a ⇒ Ord (GE a) Source #
Instance details Defined in Constrained.GenT Methods compare ∷ GE a → GE a → Ordering (<) ∷ GE a → GE a → Bool (<=) ∷ GE a → GE a → Bool (>) ∷ GE a → GE a → Bool (>=) ∷ GE a → GE a → Bool max ∷ GE a → GE a → GE a min ∷ GE a → GE a → GE a

data GenMode Source #

Generation mode - how strict are we about requiring the generator to succeed. This is necessary because sometimes failing to find a value means there is an actual problem (a generator _should_ be satisfiable but for whatever buggy reason it isn't) and sometimes failing to find a value just means there are no values. The latter case is very relevant when you're generating e.g. lists or sets of values that can be empty.

Constructors

Loose
Strict

Instances

Instances details

Show GenMode Source #
Instance details Defined in Constrained.GenT Methods showsPrec ∷ Int → GenMode → ShowS show ∷ GenMode → String showList ∷ [GenMode] → ShowS
Eq GenMode Source #
Instance details Defined in Constrained.GenT Methods (==) ∷ GenMode → GenMode → Bool (/=) ∷ GenMode → GenMode → Bool
Ord GenMode Source #
Instance details Defined in Constrained.GenT Methods compare ∷ GenMode → GenMode → Ordering (<) ∷ GenMode → GenMode → Bool (<=) ∷ GenMode → GenMode → Bool (>) ∷ GenMode → GenMode → Bool (>=) ∷ GenMode → GenMode → Bool max ∷ GenMode → GenMode → GenMode min ∷ GenMode → GenMode → GenMode

newtype GenT m a Source #

Constructors

GenT
Fields runGenT ∷ GenMode → [NonEmpty String] → Gen (m a)

Instances

Instances details

MonadGenError m ⇒ MonadFail (GenT m) Source #
Instance details Defined in Constrained.GenT Methods fail ∷ String → GenT m a
Monad m ⇒ Applicative (GenT m) Source #
Instance details Defined in Constrained.GenT Methods pure ∷ a → GenT m a (<>) ∷ GenT m (a → b) → GenT m a → GenT m b liftA2 ∷ (a → b → c) → GenT m a → GenT m b → GenT m c (>) ∷ GenT m a → GenT m b → GenT m b (<*) ∷ GenT m a → GenT m b → GenT m a
Functor m ⇒ Functor (GenT m) Source #
Instance details Defined in Constrained.GenT Methods fmap ∷ (a → b) → GenT m a → GenT m b (<$) ∷ a → GenT m b → GenT m a
Monad m ⇒ Monad (GenT m) Source #
Instance details Defined in Constrained.GenT Methods (>>=) ∷ GenT m a → (a → GenT m b) → GenT m b (>>) ∷ GenT m a → GenT m b → GenT m b return ∷ a → GenT m a
MonadGenError m ⇒ MonadGenError (GenT m) Source #	calls to genError and fatalError, add the stacked messages in the monad.
Instance details Defined in Constrained.GenT Methods genErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GenT m a Source # fatalErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GenT m a Source # genErrorNE ∷ HasCallStack ⇒ NonEmpty String → GenT m a Source # fatalErrorNE ∷ HasCallStack ⇒ NonEmpty String → GenT m a Source # explainNE ∷ HasCallStack ⇒ NonEmpty String → GenT m a → GenT m a Source #

class Monad m ⇒ MonadGenError m where Source #

A class for different types of errors with a stack of explain calls to narrow down problems. The (NonEmpty String) means one cannot cause an Error without at least 1 string to explain it.

Methods

genErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → m a Source #

fatalErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → m a Source #

genErrorNE ∷ HasCallStack ⇒ NonEmpty String → m a Source #

fatalErrorNE ∷ HasCallStack ⇒ NonEmpty String → m a Source #

explainNE ∷ HasCallStack ⇒ NonEmpty String → m a → m a Source #

Instances

Instances details

MonadGenError GE Source #
Instance details Defined in Constrained.GenT Methods genErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GE a Source # fatalErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GE a Source # genErrorNE ∷ HasCallStack ⇒ NonEmpty String → GE a Source # fatalErrorNE ∷ HasCallStack ⇒ NonEmpty String → GE a Source # explainNE ∷ HasCallStack ⇒ NonEmpty String → GE a → GE a Source #
MonadGenError m ⇒ MonadGenError (GenT m) Source #	calls to genError and fatalError, add the stacked messages in the monad.
Instance details Defined in Constrained.GenT Methods genErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GenT m a Source # fatalErrors ∷ HasCallStack ⇒ NonEmpty (NonEmpty String) → GenT m a Source # genErrorNE ∷ HasCallStack ⇒ NonEmpty String → GenT m a Source # fatalErrorNE ∷ HasCallStack ⇒ NonEmpty String → GenT m a Source # explainNE ∷ HasCallStack ⇒ NonEmpty String → GenT m a → GenT m a Source #

genError ∷ MonadGenError m ⇒ String → m a Source #

genError with one line of explanation

fatalError ∷ MonadGenError m ⇒ String → m a Source #

fatalError with one line of explanation

explain ∷ MonadGenError m ⇒ String → m a → m a Source #

explain with one line of explanation

add ∷ NonEmpty a → [NonEmpty a] → NonEmpty (NonEmpty a) Source #

cat ∷ NonEmpty (NonEmpty a) → [NonEmpty a] → NonEmpty (NonEmpty a) Source #

catMessages ∷ NonEmpty (NonEmpty String) → String Source #

Sometimes we have a bunch of genError or fatalError messages we want to combine into one big message. This happens when we want to lift one of these into an input for error

catMessageList ∷ NonEmpty (NonEmpty String) → NonEmpty String Source #

Turn each inner (NonEmpty String) into a String

catGEs ∷ ∀ m a. MonadGenError m ⇒ [GE a] → m [a] Source #

fromGE ∷ HasCallStack ⇒ (NonEmpty (NonEmpty String) → a) → GE a → a Source #

Given a function for handling GenError, and handling FatalError by using error Turn (GE a) into a

errorGE ∷ GE a → a Source #

Turn (GE a) into a both GenError and FatalErrors are handled by using error

isOk ∷ GE a → Bool Source #

runGE ∷ ∀ m r. MonadGenError m ⇒ GE r → m r Source #

fromGEProp ∷ Testable p ⇒ GE p → Property Source #

fromGEDiscard ∷ Testable p ⇒ GE p → Property Source #

headGE ∷ Foldable t ⇒ t a → GE a Source #

listFromGE ∷ GE [a] → [a] Source #

Turn a `GE [a]` to `[a]`, genError goes to `[]` and fatalError to error.

strictGen ∷ GenT m a → Gen (m a) Source #

genFromGenT ∷ GenT GE a → Gen a Source #

resizeT ∷ (Int → Int) → GenT m a → GenT m a Source #

pureGen ∷ Applicative m ⇒ Gen a → GenT m a Source #

listOfT ∷ MonadGenError m ⇒ GenT GE a → GenT m [a] Source #

listOfUntilLenT ∷ (Typeable a, MonadGenError m) ⇒ GenT GE a → Int → (Int → Bool) → GenT m [a] Source #

Generate a list of elements of length at most goalLen, but accepting failure to get that many elements so long as validLen is true. TODO: possibly one could return "more, fewer, ok" in the validLen instead of Bool

vectorOfT ∷ MonadGenError m ⇒ Int → GenT GE a → GenT m [a] Source #

suchThatT ∷ (Typeable a, MonadGenError m) ⇒ GenT m a → (a → Bool) → GenT m a infixl 2 Source #

suchThatWithTryT ∷ ∀ a m. (Typeable a, MonadGenError m) ⇒ Int → GenT m a → (a → Bool) → GenT m a Source #

scaleT ∷ (Int → Int) → GenT m a → GenT m a Source #

getMode ∷ Applicative m ⇒ GenT m GenMode Source #

getMessages ∷ Applicative m ⇒ GenT m [NonEmpty String] Source #

withMode ∷ GenMode → GenT m a → GenT m a Source #

oneofT ∷ (Typeable a, MonadGenError m) ⇒ [GenT GE a] → GenT m a Source #

frequencyT ∷ (Typeable a, MonadGenError m) ⇒ [(Int, GenT GE a)] → GenT m a Source #

chooseT ∷ (Random a, Ord a, Show a, MonadGenError m) ⇒ (a, a) → GenT m a Source #

sizeT ∷ Monad m ⇒ GenT m Int Source #

inspect ∷ ∀ m x. MonadGenError m ⇒ GenT GE x → GenT m (GE x) Source #

Always succeeds, but returns the internal GE structure for analysis

tryGenT ∷ MonadGenError m ⇒ GenT GE a → GenT m (Maybe a) Source #

Ignore all kinds of Errors, by squashing them into Nothing

catchGenT ∷ MonadGenError m ⇒ GenT GE a → GenT m (Either (NonEmpty (NonEmpty String)) a) Source #

catchGen ∷ GenT GE a → Gen (Either (NonEmpty (NonEmpty String)) a) Source #

Pass on the error messages of both kinds of Errors in the Gen (not the GenT) monad

firstGenT ∷ ∀ m a. MonadGenError m ⇒ [GenT GE a] → GenT m (Either [NonEmpty (NonEmpty String)] a) Source #

Return the first successfull result from a list of computations, if they all fail return a list of the error messages from each one.

liftGen ∷ ∀ x. (∀ m. MonadGenError m ⇒ GenT m x) → GenT GE x Source #

dropGen ∷ MonadGenError m ⇒ GenT GE a → GenT m a Source #

frequency2 ∷ ∀ m a. MonadGenError m ⇒ (Int, GenT GE a) → (Int, GenT GE a) → GenT m a Source #

Run one of the actions with frequency proportional to the count. If it fails, run the other.

push ∷ ∀ m a. MonadGenError m ⇒ [String] → m a → m a Source #

like explain for GenT, but uses [String] rather than (NonEmpty String) if the list is null, it becomes the identity

pushGE ∷ ∀ a. [String] → GE a → GE a Source #

like explain for GE, but uses [String] rather than (NonEmpty String) if the list is null, it becomes the identity