@@ -1,14 +1,6 @@
1−#if __GLASGOW_HASKELL__ >= 806
2−{-# OPTIONS_GHC -Wno-star-is-type #-}
3−#endif
4−#if __GLASGOW_HASKELL__ >= 800
5−{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
6−#endif
7−
8−{-|
1+{- |
92
10−This module is a generic implementation of the 'arbitrary' method. Example
11−usage:
3+Generic implementation of the 'arbitrary' method. Example usage:
124
135@
146data Foo = Foo
@@ -33,192 +25,48 @@ data Foo = Foo
3325
3426The generated 'arbitrary' method is equivalent to
3527
36−@
37−Foo '<$>' arbitrary '<*>' arbitrary
38−@.
39−
40−It can also handle a recursive types problem. Assuming a type
41−
42−@
43−data R = R R
44− deriving Generic
45−@
46−
47−there is no instance
48−
49−@
50−instance Arbitrary R where
51− arbitrary = genericArbitrary
52− shrink = genericShrink
53−@
54−
55−If you try to compile this you will get a type level error
56−
57−> • R refers to itself in all constructors
58−
59−Which means that there is no finite term for @R@ because it is recursive. But,
60−if you correct the definition of @R@ like this.
61−
62−@
63−data R = R R | F
64− deriving Generic
65−@
66−
67−Then it will compile. And the @arbitrary@ generated will not hang forever, because
68−it respects the @size@ parameter.
69−
70−There is a limitation of recursion detection:
71−
72−@
73−data R1 = R1 R2
74− deriving (Eq, Ord, Show, Generic)
75− deriving anyclass NFData
76− deriving Arbitrary via (GenericArbitrary R1)
77−
78−data R2 = R2 R1
79− deriving (Eq, Ord, Show, Generic)
80− deriving anyclass NFData
81− deriving Arbitrary via (GenericArbitrary R2)
82−@
83−
84−This code will compile and the @arbitrary@ generated will always hang. Yes,
85−there is a problem with mutually recursive types.
86−
87−Now lets see an example of datatype with parameters
88−
89−@
90−data A a = A a
91− deriving (Eq, Ord, Show)
92− deriving anyclass NFData
93− deriving (Generic)
94−
95−instance (Arbitrary a) => Arbitrary (A a) where
96− arbitrary = genericArbitrary
97− shrink = genericShrink
98−@
99−
100−It should work from first glance, but when compile it will throw an error:
101−
102−@
103− • Could not deduce (Test.QuickCheck.Arbitrary.Generic.GArbitrary
104− (A a)
105− (GHC.Generics.D1
106− ('GHC.Generics.MetaData "A" "ParametersTest" "main" 'False)
107− (GHC.Generics.C1
108− ('GHC.Generics.MetaCons "A" 'GHC.Generics.PrefixI 'False)
109− (GHC.Generics.S1
110− ('GHC.Generics.MetaSel
111− 'Nothing
112− 'GHC.Generics.NoSourceUnpackedness
113− 'GHC.Generics.NoSourceStrictness
114− 'GHC.Generics.DecidedLazy)
115− (GHC.Generics.Rec0 a))))
116− (TypesDiffer (A a) a))
117− arising from a use of ‘genericArbitrary’
118−@
119−
120−Here the @TypesDiffer@ is a type familty dealing with recursive types and
121−helping us to eliminate inproper instances. To convince the compiller, that the
122−@a@ parameter is not an @A a@ we must fix the instance with additional constraint
123−
124−@
125−instance (Arg (A a) a, Arbitrary a) => Arbitrary (A a) where
126− arbitrary = genericArbitrary
127− shrink = genericShrink
128−@
129−
130−Now everything compiles and works as expected.
28+@Foo <$> arbitrary <*> arbitrary@.
13129
13230-}
13331
13432module Test.QuickCheck.Arbitrary.Generic
135− ( -- * Main
136− genericArbitrary
137−#if MIN_VERSION_QuickCheck(2, 14, 0)
138− , GenericArbitrary(..)
139−#endif
140− , Arg
141− -- * Internal
142− , GArbitrary
143− , FiniteSum
144− , FiniteSumElem
145− , Finite
146− , AllFieldsFinal
147− , TypesDiffer
148− , ArgumentsCount
149− , SumLen
150− -- * Reexports
33+ ( GenericArbitrary(..)
15134 , Arbitrary(..)
35+ , genericArbitrary
15236 , genericShrink
15337 ) where
15438
15539import Control.Applicative
40+import Data.Coerce (coerce)
15641import Data.Proxy
15742import Data.Type.Bool
15843import GHC.Generics as G
15944import GHC.TypeLits
160−import Prelude
16145import Test.QuickCheck as QC
162−#if MIN_VERSION_QuickCheck(2, 14, 0)
163−import Data.Coerce (coerce)
16446import Test.QuickCheck.Arbitrary (GSubterms, RecursivelyShrink)
16547
166−
167−
168−-- | Newtype for @DerivingVia@
169−--
170−-- Usage:
171−--
172−-- @
173−-- data Foo = Foo
174−-- { _fooX :: X
175−-- , _fooY :: Y
176−-- } deriving (Generic)
177−-- deriving (Arbitrary) via GenericArbitrary Foo
178−-- @
179−--
180−-- @since 1.0.0
18148newtype GenericArbitrary a = GenericArbitrary { unGenericArbitrary :: a }
18249 deriving (Show, Eq)
18350
18451instance
18552 ( Generic a,
186− GArbitrary a (Rep a) some,
53+ GArbitrary a (Rep a) 'True,
18754 RecursivelyShrink (Rep a),
18855 GSubterms (Rep a) a
18956 ) => Arbitrary (GenericArbitrary a) where
19057 arbitrary = coerce (genericArbitrary :: Gen a)
19158 shrink = coerce (genericShrink :: a -> [a])
192−#endif
193−
194−-- | Constraint helper for types with parameters
195−--
196−-- Usage:
197−--
198−-- @
199−-- data A a = A a
200−-- deriving (Generic)
201−-- instance (Arg (A a) a, Arbitrary a) => Arbitrary (A a) where
202−-- arbitrary = genericArbitrary
203−-- shrink = genericShrink
204−-- @
205−--
206−-- @since 1.0.0
207−
208−type Arg self field = (TypesDiffer self field ~ 'True)
209−
210−type family TypesDiffer a b where
211− TypesDiffer a a = 'False
212− TypesDiffer a b = 'True
21359
21460type family AllFieldsFinal self (a :: * -> *) :: Bool where
21561 AllFieldsFinal self U1 = 'True
21662 AllFieldsFinal self (a :*: b) = AllFieldsFinal self a && AllFieldsFinal self b
217− AllFieldsFinal self (M1 S t (K1 R field)) = TypesDiffer self field
63+ AllFieldsFinal self (M1 S t (K1 R self)) = 'False
64+ AllFieldsFinal self (M1 S t (K1 R other)) = 'True
21865
21966type family Finite self (a :: * -> *) :: Bool where
22067 Finite self U1 = 'True
221− Finite self (K1 R field) = TypesDiffer self field
68+ Finite self (K1 R self) = 'False
69+ Finite self (K1 R other) = 'True
22270 Finite self (a :*: b) = Finite self a && Finite self b
22371 Finite self (M1 D t f) = Finite self f
22472 Finite self (a :+: b) = Finite self a || Finite self b
@@ -246,8 +94,8 @@ class (Finite self a ~ finite) => GArbitrary self a (finite :: Bool) where
24694 gArbitrary :: Proxy self -> QC.Gen (a x)
24795
24896instance
249− ( GArbitrary self (M1 C c f) 'True
250− ) => GArbitrary self (M1 D t (M1 C c f)) 'True where
97+ ( GArbitrary self (C1 c f) 'True
98+ ) => GArbitrary self (D1 t (C1 c f)) 'True where
25199 gArbitrary _ = M1 <$> gArbitrary (Proxy :: Proxy self)
252100
253101-- | The constructor meta information
@@ -255,7 +103,7 @@ instance
255103 ( GArbitrary self f some
256104 , KnownNat (ArgumentsCount f)
257105 , AllFieldsFinal self f ~ some
258− ) => GArbitrary self (M1 C c f) some where
106+ ) => GArbitrary self (C1 c f) some where
259107 gArbitrary _ = M1 <$> scale predNat (gArbitrary (Proxy :: Proxy self))
260108 where
261109 argumentsCount = fromIntegral $ natVal (Proxy :: Proxy (ArgumentsCount f))
@@ -268,14 +116,14 @@ instance GArbitrary self U1 'True where
268116 gArbitrary _ = pure U1
269117
270118-- | Constructor field meta information
271−instance GArbitrary self f some => GArbitrary self (M1 S t f) some where
119+instance GArbitrary self f some => GArbitrary self (S1 t f) some where
272120 gArbitrary _ = M1 <$> gArbitrary (Proxy :: Proxy self)
273121
274122-- | Data of the constructor field
275123instance
276124 ( Arbitrary t
277− , Finite self (K1 R t) ~ some
278− ) => GArbitrary self (K1 R t) some where
125+ , Finite self (Rec0 t) ~ some
126+ ) => GArbitrary self (Rec0 t) some where
279127 gArbitrary _ = K1 <$> arbitrary
280128
281129-- | Product
@@ -291,7 +139,7 @@ instance
291139instance
292140 ( TypeError (ShowType self :<>: Text " refers to itself in all constructors")
293141 , AllFieldsFinal self f ~ 'False
294− ) => GArbitrary self (M1 D t (M1 C c f)) 'False where
142+ ) => GArbitrary self (D1 t (C1 c f)) 'False where
295143 gArbitrary _ = error "Unreachable"
296144#endif
297145
@@ -299,7 +147,7 @@ instance
299147instance
300148 ( FiniteSum self a b af bf
301149 , GArbitrary self (a :+: b) 'True
302− ) => GArbitrary self (M1 D t (a :+: b)) 'True where
150+ ) => GArbitrary self (D1 t (a :+: b)) 'True where
303151 gArbitrary _ = sized $ \s -> M1 <$>
304152 if s > 1
305153 then gArbitrary (Proxy :: Proxy self)
@@ -355,8 +203,8 @@ instance
355203 finiteElem _ = finiteSum (Proxy :: Proxy self)
356204
357205instance
358− ( GArbitrary self (M1 C c f) 'True
359− ) => FiniteSumElem self (M1 C c f) where
206+ ( GArbitrary self (C1 c f) 'True
207+ ) => FiniteSumElem self (C1 c f) where
360208 finiteElem _ = [gArbitrary (Proxy :: Proxy self)]
361209
362210
@@ -364,7 +212,7 @@ instance
364212instance
365213 ( TypeError (ShowType self :<>: Text " refers to itself in all constructors")
366214 , (Finite self a || Finite self b) ~ 'False
367− ) => GArbitrary self (M1 D t (a :+: b)) 'False where
215+ ) => GArbitrary self (D1 t (a :+: b)) 'False where
368216 gArbitrary _ = error "Unreachable"
369217#endif
370218