Test.QuickCheck.Arbitrary.ADT

Type classes to assist random generation of values for various types of abstract data types.

How to use this library

How to use ToADTArbitrary with Generic.

{-# LANGUAGE DeriveGeneric #-}

import Data.Proxy
import GHC.Generics
import Test.QuickCheck
import Test.QuickCheck.Arbitrary.ADT

-- Sum Type, multiple constructors with parameters
data Fruit = Apple  Int
           | Orange String Int
           | PassionFruit Int String Int
  deriving (Generic, Show)

-- Product Type, single constructor
data Person = Person {
  name :: String
, age  :: Int
} deriving (Generic, Show)

Any type that implements ToADTArbitrary must also implement Arbitrary. These examples all require that the data type is an instance of Generic.

instance Arbitrary Fruit where
  arbitrary = genericArbitrary

instance ToADTArbitrary Fruit

instance Arbitrary Person where
  arbitrary = genericArbitrary

instance ToADTArbitrary Person

Now we can use toADTArbitrarySingleton to produce an arbitrary value of one random constructor along with some metadata. toADTArbitrary will produce an arbitrary value for each constructor and return it along with a String of the constructor name.

λ> generate (toADTArbitrarySingleton (Proxy :: Proxy Fruit))
ADTArbitrarySingleton {
  _adtasTypeName = "Fruit"
, _adtasCAP = ConstructorArbitraryPair {
    _capConstructor = "Apple", _capArbitrary = Apple 30}}

λ> generate (toADTArbitrary (Proxy :: Proxy Fruit))
ADTArbitrary {
  _adtTypeName = "Fruit"
, _adtCAPs = [
    ConstructorArbitraryPair {
        _capConstructor = "Apple"
      , _capArbitrary = Apple 17}
  , ConstructorArbitraryPair {
        _capConstructor = "Orange"
      , _capArbitrary = Orange "abcdef" 18}
  , ConstructorArbitraryPair {
        _capConstructor = "PassionFruit"
      , _capArbitrary = PassionFruit 16 "datadata" 6}]}

λ> generate (toADTArbitrarySingleton (Proxy :: Proxy Person))
ADTArbitrarySingleton {
  _adtasTypeName = "Person"
, _adtasCAP = ConstructorArbitraryPair {_capConstructor = "Person", _capArbitrary = Person {name = "John Doe", age = 30}}}

λ> generate (toADTArbitrary (Proxy :: Proxy Person))
ADTArbitrary {
  _adtTypeName = "Person"
, _adtCAPs = [ConstructorArbitraryPair {_capConstructor = "Person", _capArbitrary = Person {name = "Jane Doe", age = 15}}]}

Data types

data ConstructorArbitraryPair a

ConstructorArbitraryPair holds the construct name as a string and an arbitrary instance of that constructor.

Constructors

ConstructorArbitraryPair

Fields

• _capConstructor :: String
• _capArbitrary :: a

Instances

Functor ConstructorArbitraryPair

fmap applies a function to _capArbitrary

Methods

fmap :: (a -> b) -> ConstructorArbitraryPair a -> ConstructorArbitraryPair b

(<$) :: a -> ConstructorArbitraryPair b -> ConstructorArbitraryPair a

Eq a => Eq (ConstructorArbitraryPair a)

Methods

(==) :: ConstructorArbitraryPair a -> ConstructorArbitraryPair a -> Bool

(/=) :: ConstructorArbitraryPair a -> ConstructorArbitraryPair a -> Bool

Read a => Read (ConstructorArbitraryPair a)

Methods

readsPrec :: Int -> ReadS (ConstructorArbitraryPair a)

readList :: ReadS [ConstructorArbitraryPair a]

readPrec :: ReadPrec (ConstructorArbitraryPair a)

readListPrec :: ReadPrec [ConstructorArbitraryPair a]

Show a => Show (ConstructorArbitraryPair a)

Methods

showsPrec :: Int -> ConstructorArbitraryPair a -> ShowS

show :: ConstructorArbitraryPair a -> String

showList :: [ConstructorArbitraryPair a] -> ShowS

Generic (ConstructorArbitraryPair a)

Associated Types

type Rep (ConstructorArbitraryPair a) :: * -> *

Methods

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

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

Arbitrary a => Arbitrary (ConstructorArbitraryPair a)

Methods

arbitrary :: Gen (ConstructorArbitraryPair a)

shrink :: ConstructorArbitraryPair a -> [ConstructorArbitraryPair a]

type Rep (ConstructorArbitraryPair a)

type Rep (ConstructorArbitraryPair a) = D1 (MetaData "ConstructorArbitraryPair" "Test.QuickCheck.Arbitrary.ADT" "quickcheck-arbitrary-adt-0.1.0.0-HAYijnjhLM4JRyByGPvCi0" False) (C1 (MetaCons "ConstructorArbitraryPair" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_capConstructor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "_capArbitrary") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

data ADTArbitrarySingleton a

ADTArbitrarySingleton holds the type name and one ConstructorArbitraryPair.

Constructors

ADTArbitrarySingleton

Fields

• _adtasTypeName :: String
• _adtasCAP :: ConstructorArbitraryPair a

Instances

Functor ADTArbitrarySingleton

fmap applies a function to the ConstructorArbitraryPair in _adtasCAP.

Methods

fmap :: (a -> b) -> ADTArbitrarySingleton a -> ADTArbitrarySingleton b

(<$) :: a -> ADTArbitrarySingleton b -> ADTArbitrarySingleton a

Eq a => Eq (ADTArbitrarySingleton a)

Methods

(==) :: ADTArbitrarySingleton a -> ADTArbitrarySingleton a -> Bool

(/=) :: ADTArbitrarySingleton a -> ADTArbitrarySingleton a -> Bool

Read a => Read (ADTArbitrarySingleton a)

Methods

readsPrec :: Int -> ReadS (ADTArbitrarySingleton a)

readList :: ReadS [ADTArbitrarySingleton a]

readPrec :: ReadPrec (ADTArbitrarySingleton a)

readListPrec :: ReadPrec [ADTArbitrarySingleton a]

Show a => Show (ADTArbitrarySingleton a)

Methods

showsPrec :: Int -> ADTArbitrarySingleton a -> ShowS

show :: ADTArbitrarySingleton a -> String

showList :: [ADTArbitrarySingleton a] -> ShowS

Generic (ADTArbitrarySingleton a)

Associated Types

type Rep (ADTArbitrarySingleton a) :: * -> *

Methods

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

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

Arbitrary a => Arbitrary (ADTArbitrarySingleton a)

Methods

arbitrary :: Gen (ADTArbitrarySingleton a)

shrink :: ADTArbitrarySingleton a -> [ADTArbitrarySingleton a]

type Rep (ADTArbitrarySingleton a)

type Rep (ADTArbitrarySingleton a) = D1 (MetaData "ADTArbitrarySingleton" "Test.QuickCheck.Arbitrary.ADT" "quickcheck-arbitrary-adt-0.1.0.0-HAYijnjhLM4JRyByGPvCi0" False) (C1 (MetaCons "ADTArbitrarySingleton" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_adtasTypeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "_adtasCAP") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ConstructorArbitraryPair a)))))

data ADTArbitrary a

ADTArbitrary holds the type name and a ConstructorArbitraryPair for each constructor.

Constructors

ADTArbitrary

Fields

• _adtTypeName :: String
• _adtCAPs :: [ConstructorArbitraryPair a]

Instances

Functor ADTArbitrary

fmap applies a function to each ConstructorArbitraryPair in _adtCAPs.

Methods

fmap :: (a -> b) -> ADTArbitrary a -> ADTArbitrary b

(<$) :: a -> ADTArbitrary b -> ADTArbitrary a

Eq a => Eq (ADTArbitrary a)

Methods

(==) :: ADTArbitrary a -> ADTArbitrary a -> Bool

(/=) :: ADTArbitrary a -> ADTArbitrary a -> Bool

Read a => Read (ADTArbitrary a)

Methods

readsPrec :: Int -> ReadS (ADTArbitrary a)

readList :: ReadS [ADTArbitrary a]

readPrec :: ReadPrec (ADTArbitrary a)

readListPrec :: ReadPrec [ADTArbitrary a]

Show a => Show (ADTArbitrary a)

Methods

showsPrec :: Int -> ADTArbitrary a -> ShowS

show :: ADTArbitrary a -> String

showList :: [ADTArbitrary a] -> ShowS

Generic (ADTArbitrary a)

Associated Types

type Rep (ADTArbitrary a) :: * -> *

Methods

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

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

Arbitrary a => Arbitrary (ADTArbitrary a)

Methods

arbitrary :: Gen (ADTArbitrary a)

shrink :: ADTArbitrary a -> [ADTArbitrary a]

type Rep (ADTArbitrary a)

type Rep (ADTArbitrary a) = D1 (MetaData "ADTArbitrary" "Test.QuickCheck.Arbitrary.ADT" "quickcheck-arbitrary-adt-0.1.0.0-HAYijnjhLM4JRyByGPvCi0" False) (C1 (MetaCons "ADTArbitrary" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_adtTypeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "_adtCAPs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ConstructorArbitraryPair a]))))

Type classes

class Arbitrary a => ToADTArbitrary a where

ToADTArbitrary generalizes the production of arbitrary values for Sum types. and Product types.

Methods

toADTArbitrarySingleton :: Proxy a -> Gen (ADTArbitrarySingleton a)

produce an arbitrary instance of one random constructor

toADTArbitrarySingleton :: (Arbitrary a, Generic a, GToADTArbitrarySingleton (Rep a), GToADTArbitrarySingleton (Rep (ADTArbitrarySingleton a))) => Proxy a -> Gen (ADTArbitrarySingleton a)

produce an arbitrary instance of one random constructor

toADTArbitrary :: Proxy a -> Gen (ADTArbitrary a)

produce an arbitrary instance for each constructor in type a.

toADTArbitrary :: (Arbitrary a, Generic a, GToADTArbitrary (Rep a), GToADTArbitrary (Rep (ADTArbitrary a))) => Proxy a -> Gen (ADTArbitrary a)

produce an arbitrary instance for each constructor in type a.

Generic type classes

class GToADTArbitrarySingleton rep where

GToADTArbitrarySingleton creates an arbitrary value and returns the name of the constructor that was used to create it and the type name.

Minimal complete definition

gToADTArbitrarySingleton

Methods

gToADTArbitrarySingleton :: Proxy rep -> Gen (ADTArbitrarySingleton (rep a))

Instances

GToADTArbitrarySingleton U1

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) U1 -> Gen (ADTArbitrarySingleton (U1 a))

Arbitrary a => GToADTArbitrarySingleton (K1 i a)

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) (K1 i a) -> Gen (ADTArbitrarySingleton (K1 i a a))

(GToADTArbitrarySingleton l, GToADTArbitrarySingleton r) => GToADTArbitrarySingleton ((:+:) l r)

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) (l :+: r) -> Gen (ADTArbitrarySingleton ((l :+: r) a))

(GToADTArbitrarySingleton l, GToADTArbitrarySingleton r) => GToADTArbitrarySingleton ((:*:) l r)

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) (l :*: r) -> Gen (ADTArbitrarySingleton ((l :*: r) a))

(Datatype Meta t, Typeable Meta t, GToADTArbitrarySingleton rep) => GToADTArbitrarySingleton (M1 D t rep)

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) (M1 D t rep) -> Gen (ADTArbitrarySingleton (M1 D t rep a))

(Constructor Meta c, GToADTArbitrarySingleton rep) => GToADTArbitrarySingleton (M1 C c rep)

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) (M1 C c rep) -> Gen (ADTArbitrarySingleton (M1 C c rep a))

GToADTArbitrarySingleton rep => GToADTArbitrarySingleton (M1 S t rep)

Methods

gToADTArbitrarySingleton :: Proxy (* -> *) (M1 S t rep) -> Gen (ADTArbitrarySingleton (M1 S t rep a))

class GToADTArbitrary rep where

GToADTArbitrary is a typeclass for generalizing the creation of a list of arbitrary values for each constructor of a type. It also returns the name of the constructor and the type name for reference and file creation.

Minimal complete definition

gToADTArbitrary

Methods

gToADTArbitrary :: Proxy rep -> Gen (ADTArbitrary (rep a))

Instances

GToADTArbitrary U1

Methods

gToADTArbitrary :: Proxy (* -> *) U1 -> Gen (ADTArbitrary (U1 a))

Arbitrary a => GToADTArbitrary (K1 i a)

Methods

gToADTArbitrary :: Proxy (* -> *) (K1 i a) -> Gen (ADTArbitrary (K1 i a a))

(GToADTArbitrary l, GToADTArbitrary r) => GToADTArbitrary ((:+:) l r)

Methods

gToADTArbitrary :: Proxy (* -> *) (l :+: r) -> Gen (ADTArbitrary ((l :+: r) a))

(GToADTArbitrarySingleton l, GToADTArbitrary l, GToADTArbitrarySingleton r, GToADTArbitrary r) => GToADTArbitrary ((:*:) l r)

Methods

gToADTArbitrary :: Proxy (* -> *) (l :*: r) -> Gen (ADTArbitrary ((l :*: r) a))

(Datatype Meta t, GToADTArbitrary rep) => GToADTArbitrary (M1 D t rep)

Methods

gToADTArbitrary :: Proxy (* -> *) (M1 D t rep) -> Gen (ADTArbitrary (M1 D t rep a))

(Constructor Meta c, GToADTArbitrary rep) => GToADTArbitrary (M1 C c rep)

Methods

gToADTArbitrary :: Proxy (* -> *) (M1 C c rep) -> Gen (ADTArbitrary (M1 C c rep a))

GToADTArbitrary rep => GToADTArbitrary (M1 S t rep)

Methods

gToADTArbitrary :: Proxy (* -> *) (M1 S t rep) -> Gen (ADTArbitrary (M1 S t rep a))

class GArbitrary rep where

GArbitrary is a typeclass for generalizing the creation of single arbitrary product and sum types. It creates an arbitrary generating function of this style: TypeName $ arbitrary * arbitrary.

Minimal complete definition

gArbitrary

Methods

gArbitrary :: Gen (rep a)

Instances

GArbitrary U1

Methods

gArbitrary :: Gen (U1 a)

Arbitrary a => GArbitrary (K1 i a)

Methods

gArbitrary :: Gen (K1 i a a)

(GArbitrary l, GArbitrary r) => GArbitrary ((:+:) l r)

Methods

gArbitrary :: Gen ((l :+: r) a)

(GArbitrary l, GArbitrary r) => GArbitrary ((:*:) l r)

Methods

gArbitrary :: Gen ((l :*: r) a)

GArbitrary rep => GArbitrary (M1 i t rep)

Methods

gArbitrary :: Gen (M1 i t rep a)

genericArbitrary :: (Generic a, GArbitrary (Rep a)) => Gen a