Graphula.Node

Generating

node :: forall a m. (MonadGraphula m, Logging m a, Arbitrary a, HasDependencies a, GenerateKey a, PersistEntityBackend a ~ SqlBackend, PersistEntity a, Typeable a, GraphulaSafeToInsert a) => Dependencies a -> NodeOptions a -> m (Entity a)

Generate a node with a default (Database-provided) key

a <- node @A () mempty

nodeKeyed :: forall a m. (MonadGraphula m, Logging m a, Arbitrary a, HasDependencies a, PersistEntityBackend a ~ SqlBackend, PersistEntity a, Typeable a, GraphulaSafeToInsert a) => Key a -> Dependencies a -> NodeOptions a -> m (Entity a)

Generate a node with an explictly-given key

let someKey = UUID.fromString "..."
a <- nodeKeyed @A someKey () mempty

NodeOptions

data NodeOptions a

Options for generating an individual node

NodeOptions can be created and combined with the Monoidal operations (<>) and mempty.

a1 <- node @A () mempty
a2 <- node @A () $ edit $ \a -> a { someField = True }
a3 <- node @A () $ ensure $ (== True) . someField

Instances

Monoid (NodeOptions a)

Defined in Graphula.Node

Methods

mempty :: NodeOptions a

mappend :: NodeOptions a -> NodeOptions a -> NodeOptions a

mconcat :: [NodeOptions a] -> NodeOptions a

Semigroup (NodeOptions a)

Defined in Graphula.Node

Methods

(<>) :: NodeOptions a -> NodeOptions a -> NodeOptions a

sconcat :: NonEmpty (NodeOptions a) -> NodeOptions a

stimes :: Integral b => b -> NodeOptions a -> NodeOptions a

Generic (NodeOptions a)

Defined in Graphula.Node

Associated Types

type Rep (NodeOptions a) :: Type -> Type

Methods

from :: NodeOptions a -> Rep (NodeOptions a) x

to :: Rep (NodeOptions a) x -> NodeOptions a

type Rep (NodeOptions a)

Defined in Graphula.Node

type Rep (NodeOptions a)

edit :: (a -> a) -> NodeOptions a

Modify the node after it's been generated

a <- node @A () $ edit $ \a -> a { someField = True }

ensure :: (a -> Bool) -> NodeOptions a

Require a node to satisfy the specified predicate

a <- node @A () $ ensure $ (== True) . someField

N.B. ensuring a condition that is infrequently met can be innefficient.

Exceptions

data GenerationFailure

Constructors

GenerationFailureMaxAttemptsToConstrain TypeRep

Could not satisfy constraints defined using ensure

GenerationFailureMaxAttemptsToInsert TypeRep

Could not satisfy database constraints on insert

Instances

Exception GenerationFailure

Defined in Graphula.Node

Methods

toException :: GenerationFailure -> SomeException

fromException :: SomeException -> Maybe GenerationFailure

displayException :: GenerationFailure -> String

Show GenerationFailure

Defined in Graphula.Node

Methods

showsPrec :: Int -> GenerationFailure -> ShowS

show :: GenerationFailure -> String

showList :: [GenerationFailure] -> ShowS

Eq GenerationFailure

Defined in Graphula.Node

Methods

(==) :: GenerationFailure -> GenerationFailure -> Bool

(/=) :: GenerationFailure -> GenerationFailure -> Bool