1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
{-# Language GADTs #-}
{-|
Module : HieDemoSpec
Description : Exercise various components of FromValue on a life-sized example
Copyright : (c) Eric Mertens, 2023
License : ISC
Maintainer : emertens@gmail.com
This module demonstrates how "Toml.FromValue" can handle a real-world
format as used in hie-bios. These types are copied from
<https://github.com/haskell/hie-bios/blob/master/src/HIE/Bios/Config/YAML.hs>
with slight alterations because the Other case is for YAML-specific extensibility.
This approach would work just the same when parameterized in that same way.
-}
module HieDemoSpec where
import GHC.Generics ( Generic )
import QuoteStr (quoteStr)
import Test.Hspec (Spec, it, shouldBe)
import Toml (Value(Table, Array), Table, decode)
import Toml.FromValue
import Toml.FromValue.Generic (genericParseTable)
-----------------------------------------------------------------------
-- THIS CODE DERIVED FROM CODE UNDER THE FOLLOWING LICENSE
-----------------------------------------------------------------------
-- Copyright (c) 2009, IIJ Innovation Institute Inc.
-- All rights reserved.
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions
-- are met:
-- * Redistributions of source code must retain the above copyright
-- notice, this list of conditions and the following disclaimer.
-- * Redistributions in binary form must reproduce the above copyright
-- notice, this list of conditions and the following disclaimer in
-- the documentation and/or other materials provided with the
-- distribution.
-- * Neither the name of the copyright holders nor the names of its
-- contributors may be used to endorse or promote products derived
-- from this software without specific prior written permission.
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
-- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-- COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
-- ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-- POSSIBILITY OF SUCH DAMAGE.
data CradleConfig = CradleConfig
{ cradle :: CradleComponent
, dependencies :: Maybe [FilePath]
} deriving (Generic, Show, Eq)
data CradleComponent
= Multi [MultiSubComponent]
| Cabal CabalConfig
| Stack StackConfig
| Direct DirectConfig
| Bios BiosConfig
| None NoneConfig
deriving (Generic, Show, Eq)
data NoneConfig = NoneConfig
deriving (Generic, Show, Eq)
data MultiSubComponent = MultiSubComponent
{ path :: FilePath
, config :: CradleConfig
} deriving (Generic, Show, Eq)
data CabalConfig = CabalConfig
{ cabalProject :: Maybe FilePath
, cabalComponents :: OneOrManyComponents CabalComponent
} deriving (Show, Eq)
data CabalComponent = CabalComponent
{ cabalPath :: FilePath
, cabalComponent :: String
, cabalComponentProject :: Maybe FilePath
} deriving (Show, Eq)
data StackConfig = StackConfig
{ stackYaml :: Maybe FilePath
, stackComponents :: OneOrManyComponents StackComponent
} deriving (Show, Eq)
data StackComponent = StackComponent
{ stackPath :: FilePath
, stackComponent :: String
, stackComponentYAML :: Maybe FilePath
} deriving (Show, Eq)
data OneOrManyComponents component
= SingleComponent String
| ManyComponents [component]
| NoComponent
deriving (Show, Eq)
data DirectConfig = DirectConfig
{ arguments :: [String]
} deriving (Generic, Show, Eq)
data BiosConfig = BiosConfig
{ callable :: Callable
, depsCallable :: Maybe Callable
, ghcPath :: Maybe FilePath
} deriving (Show, Eq)
data Callable
= Program FilePath
| Shell String
deriving (Show, Eq)
-----------------------------------------------------------------------
-- END OF DERIVED CODE
-----------------------------------------------------------------------
instance FromValue CradleConfig where
fromValue = parseTableFromValue genericParseTable
instance FromValue CradleComponent where
fromValue = parseTableFromValue $
reqAlts [
KeyCase Multi "multi",
KeyCase Cabal "cabal",
KeyCase Stack "stack",
KeyCase Direct "direct",
KeyCase Bios "bios",
KeyCase None "none"]
instance FromValue MultiSubComponent where
fromValue = parseTableFromValue genericParseTable
instance FromValue CabalConfig where
fromValue v@Toml.Array{} = CabalConfig Nothing . ManyComponents <$> fromValue v
fromValue (Toml.Table t) = getComponentTable CabalConfig "cabalProject" t
fromValue _ = fail "cabal configuration expects table or array"
getComponentTable :: FromValue b => (Maybe FilePath -> OneOrManyComponents b -> a) -> String -> Toml.Table -> Matcher a
getComponentTable con pathKey = runParseTable $ con
<$> optKey pathKey
<*> pickKey [
Key "component" (fmap SingleComponent . fromValue),
Key "components" (fmap ManyComponents . fromValue),
Else (pure NoComponent)]
instance FromValue CabalComponent where
fromValue = parseTableFromValue $ CabalComponent
<$> reqKey "path"
<*> reqKey "component"
<*> optKey "cabalProject"
instance FromValue StackConfig where
fromValue v@Toml.Array{} = StackConfig Nothing . ManyComponents <$> fromValue v
fromValue (Toml.Table t) = getComponentTable StackConfig "stackYaml" t
fromValue _ = fail "stack configuration expects table or array"
instance FromValue StackComponent where
fromValue = parseTableFromValue $ StackComponent
<$> reqKey "path"
<*> reqKey "component"
<*> optKey "stackYaml"
instance FromValue DirectConfig where
fromValue = parseTableFromValue genericParseTable
instance FromValue BiosConfig where
fromValue = parseTableFromValue $ BiosConfig
<$> getCallable
<*> getDepsCallable
<*> optKey "with-ghc"
where
getCallable =
reqAlts [
KeyCase Program "program",
KeyCase Shell "shell"]
getDepsCallable =
optAlts [
KeyCase Program "dependency-program",
KeyCase Shell "dependency-shell"]
data KeyCase a where
KeyCase :: FromValue b => (b -> a) -> String -> KeyCase a
reqAlts :: [KeyCase a] -> ParseTable a
reqAlts xs = pickKey
[Key key (fmap con . fromValue) | KeyCase con key <- xs]
optAlts :: [KeyCase a] -> ParseTable (Maybe a)
optAlts xs = pickKey $
[Key key (fmap (Just . con) . fromValue) | KeyCase con key <- xs] ++
[Else (pure Nothing)]
instance FromValue NoneConfig where
fromValue = parseTableFromValue (pure NoneConfig)
spec :: Spec
spec =
do it "parses this project's hie.toml" $
decode [quoteStr|
dependencies = [
"src/Toml/Lexer.x",
"src/Toml/Parser.y",
]
[[cradle.cabal]]
path = "./src"
component = "toml-parser:lib:toml-parser"
[[cradle.cabal]]
path = "./test"
component = "toml-parser:test:unittests"
[[cradle.cabal]]
path = "./test-drivers/encoder"
component = "toml-test-drivers:exe:TomlEncoder"
[[cradle.cabal]]
path = "./test-drivers/decoder"
component = "toml-test-drivers:exe:TomlDecoder"
[[cradle.cabal]]
path = "./test-drivers/highlighter"
component = "toml-test-drivers:exe:TomlHighlighter"
|]
`shouldBe`
Success [] CradleConfig
{ cradle =
Cabal
CabalConfig
{ cabalProject = Nothing
, cabalComponents =
ManyComponents
[ CabalComponent
{ cabalPath = "./src"
, cabalComponent = "toml-parser:lib:toml-parser"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test"
, cabalComponent = "toml-parser:test:unittests"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test-drivers/encoder"
, cabalComponent = "toml-test-drivers:exe:TomlEncoder"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test-drivers/decoder"
, cabalComponent = "toml-test-drivers:exe:TomlDecoder"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test-drivers/highlighter"
, cabalComponent = "toml-test-drivers:exe:TomlHighlighter"
, cabalComponentProject = Nothing
}
]
}
, dependencies = Just ["src/Toml/Lexer.x" , "src/Toml/Parser.y"]
}
it "has focused error messages" $
decode [quoteStr|
[cradle.cabal]
path = "./src"
component = 42
|]
`shouldBe`
(Failure ["type error. wanted: string got: integer in top.cradle.cabal.component"]
:: Result String CradleConfig)
it "detects unusd keys" $
decode [quoteStr|
[[cradle.multi]]
path = "./src"
[cradle.multi.config.cradle.cabal]
component = "toml-parser:lib:toml-parser"
thing1 = 10 # unused key for test case
[[cradle.multi]]
path = "./test"
[cradle.multi.config.cradle.stack]
component = "toml-parser:test:unittests"
thing2 = 20 # more unused keys for test case
thing3 = false
|]
`shouldBe`
Success
[ "unexpected key: thing1 in top.cradle.multi[0].config.cradle.cabal"
, "unexpected keys: thing2, thing3 in top.cradle.multi[1].config.cradle.stack"
]
CradleConfig
{ cradle =
Multi
[ MultiSubComponent
{ path = "./src"
, config =
CradleConfig
{ cradle =
Cabal
CabalConfig
{ cabalProject = Nothing
, cabalComponents = SingleComponent "toml-parser:lib:toml-parser"
}
, dependencies = Nothing
}
}
, MultiSubComponent
{ path = "./test"
, config =
CradleConfig
{ cradle =
Stack
StackConfig
{ stackYaml = Nothing
, stackComponents = SingleComponent "toml-parser:test:unittests"
}
, dependencies = Nothing
}
}
]
, dependencies = Nothing
}
it "parses things using components" $
decode [quoteStr|
dependencies = [
"src/Toml/Lexer.x",
"src/Toml/Parser.y",
]
[cradle.cabal]
cabalProject = "cabal.project"
[[cradle.cabal.components]]
path = "./src"
component = "toml-parser:lib:toml-parser"
[[cradle.cabal.components]]
path = "./test"
component = "toml-parser:test:unittests"
[[cradle.cabal.components]]
path = "./test-drivers/encoder"
component = "toml-test-drivers:exe:TomlEncoder"
[[cradle.cabal.components]]
path = "./test-drivers/decoder"
component = "toml-test-drivers:exe:TomlDecoder"
[[cradle.cabal.components]]
path = "./test-drivers/highlighter"
component = "toml-test-drivers:exe:TomlHighlighter"
|]
`shouldBe`
Success
[]
CradleConfig
{ cradle =
Cabal
CabalConfig
{ cabalProject = Just "cabal.project"
, cabalComponents =
ManyComponents
[ CabalComponent
{ cabalPath = "./src"
, cabalComponent = "toml-parser:lib:toml-parser"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test"
, cabalComponent = "toml-parser:test:unittests"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test-drivers/encoder"
, cabalComponent = "toml-test-drivers:exe:TomlEncoder"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test-drivers/decoder"
, cabalComponent = "toml-test-drivers:exe:TomlDecoder"
, cabalComponentProject = Nothing
}
, CabalComponent
{ cabalPath = "./test-drivers/highlighter"
, cabalComponent = "toml-test-drivers:exe:TomlHighlighter"
, cabalComponentProject = Nothing
}
]
}
, dependencies = Just [ "src/Toml/Lexer.x" , "src/Toml/Parser.y" ]
}
it "handles the none case" $
decode [quoteStr|
[cradle.none]|]
`shouldBe`
Success [] (CradleConfig {
cradle = None NoneConfig,
dependencies = Nothing})
|
