-
-
Notifications
You must be signed in to change notification settings - Fork 73
/
Question.hs
271 lines (225 loc) · 7.89 KB
/
Question.hs
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
{-# LANGUAGE MultiWayIf #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE ViewPatterns #-}
{- |
Copyright: (c) 2017-2019 Kowainik
SPDX-License-Identifier: MPL-2.0
Maintainer: Kowainik <xrom.xkov@gmail.com>
This module contains function to proper questioning in terminal.
-}
module Summoner.Question
( -- * Choose functions.
choose
, chooseYesNo
, chooseYesNoBool
-- * YesNoPrompt
, YesNoPrompt(..)
, mkDefaultYesNoPrompt
-- * Queries
, query
, queryWithPredicate
, queryNotNull
, queryDef
, queryManyRepeatOnFail
, checkUniqueName
-- * Customize target message
, targetMessageWithText
, targetMessage
, trueMessage
, falseMessage
) where
import System.Directory (doesPathExist, getCurrentDirectory)
import System.FilePath ((</>))
import Summoner.Ansi (Color (..), beautyPrint, bold, boldDefault, errorMessage, italic, prompt,
putStrFlush, setColor, warningMessage)
import Summoner.Text (headToUpper, intercalateMap)
import qualified Data.Text as T
import qualified Relude.Unsafe as Unsafe
{- | Build a prompt
For example,
@
YesNoPrompt
{ yesNoTarget = "Cabal"
, yesNoPrompt = "Do you want to add a cabal integration?"}
@
will generate a following prompt message to the user
@
Do you want to add a cabal integration? [y]/n
-> y
[Cabal] will be added to the project
@
-}
data YesNoPrompt = YesNoPrompt
{ yesNoTarget :: !Text -- ^ target (e.g., __TARGET will be added to the project__)
, yesNoPrompt :: !Text -- ^ prompt (e.g., __PROMPT [y]/n__)
}
{- | Build a prompt with the TARGET name only
It will generate a simple default prompt such that
@
Add TARGET? [y]/n
@
-}
mkDefaultYesNoPrompt
:: Text -- ^ target name
-> YesNoPrompt
mkDefaultYesNoPrompt target = YesNoPrompt target ("Add " <> target <> "?")
-- | Represents a user's answer
data Answer
= Y
| N
-- | Parse an answer to 'Answer'
yesOrNo :: Text -> Maybe Answer
yesOrNo (T.toLower -> answer )
| T.null answer = Just Y
| answer `elem` ["yes", "y", "ys"] = Just Y
| answer `elem` ["no", "n"] = Just N
| otherwise = Nothing
----------------------------------------------------------------------------
-- IO Questioning
----------------------------------------------------------------------------
{- | Prints the given question in the following way:
>>> printQuestion "Which option?" [A, B, C]
"Which option? [A]/B/C"
__ Note__ that the first element in the given list is considered as
the default one.
-}
printQuestion
:: Text -- ^ Question text.
-> [Text] -- ^ List of available answers.
-> IO ()
printQuestion question [] = putTextLn question
printQuestion question (def:rest) = do
putStrFlush question
boldDefault def
let restSlash = T.intercalate "/" rest
if restSlash == ""
then putTextLn ""
else putTextLn $ "/" <> restSlash
-- | Allows users to choose one of the given options.
-- It asks the question until the appropriate answer is received.
choose :: Show a
=> (Text -> Maybe a) -- ^ Parse function
-> Text -- ^ Question text.
-> [a] -- ^ List of available options.
-> IO a -- ^ The chosen option.
choose parser question choices = do
let showChoices = map show choices
printQuestion question showChoices
answer <- prompt
if T.null answer
then pure (Unsafe.head choices)
else whenNothing (parser answer)
(errorMessage "This wasn't a valid choice." >> choose parser question choices)
-- | Like 'choose' but the possible answer are 'Y' or 'N'.
chooseYesNo :: YesNoPrompt -- ^ Target and Prompt
-> IO a -- ^ action for 'Y' answer
-> IO a -- ^ action for 'N' answer
-> IO a
chooseYesNo p@YesNoPrompt {..} yesDo noDo = do
printQuestion yesNoPrompt ["y", "n"]
answer <- yesOrNo <$> prompt
case answer of
Nothing -> do
errorMessage "This wasn't a valid choice."
chooseYesNo p yesDo noDo
Just Y -> trueMessage yesNoTarget >> yesDo
Just N -> falseMessage yesNoTarget >> noDo
-- | Like 'chooseYesNo' but returns 'Bool'.
chooseYesNoBool :: YesNoPrompt -> IO Bool
chooseYesNoBool ynPrompt = chooseYesNo ynPrompt (pure True) (pure False)
{- | The message after yes/no questions. The output depends on the answer.
@
__Benchmarks__ will be added to the project
@
-}
targetMessageWithText :: Bool -> Text -> Text -> IO Bool
targetMessageWithText result target text = do
let (color, actionResult) = if result
then (Green, " will be " <> text)
else (Cyan, " won't be " <> text)
beautyPrint [italic, bold, setColor color] $ " " <> headToUpper target
beautyPrint [setColor color] actionResult
putTextLn ""
pure result
-- | Like 'targetMessageWithText' but the text is "added to the project"
targetMessage :: Bool -> Text -> IO Bool
targetMessage result target = targetMessageWithText result target "added to the project"
trueMessage, falseMessage :: Text -> IO Bool
trueMessage = targetMessage True
falseMessage = targetMessage False
{- | Queries for any answer.
@
Short project description:
->
@
-}
query :: Text -> IO Text
query question = putTextLn question >> prompt
{- | Queries for the answer that should satisfy the given predicate, or be empty.
-}
queryWithPredicate :: Text -> [Text] -> Text -> (Text -> Bool) -> IO Text
queryWithPredicate question options instruction p = loop
where
loop :: IO Text
loop = do
printQuestion question options
beautyPrint [italic] $ instruction <> "\n"
input <- prompt
if input /= "" && not (p input)
then errorMessage ("'" <> input <> "' doesn't satisfy the requirements.") >> loop
else pure input
-- | Queries for an non-empty answer.
queryNotNull :: Text -> IO Text
queryNotNull question = do
putTextLn question
answer <- prompt
if | T.null answer -> do
errorMessage "An answer is required."
queryNotNull question
| otherwise -> pure answer
-- | Like 'query' but has the default answer if no answer is specified.
queryDef :: Text -> Text -> IO Text
queryDef question defAnswer = do
putStrFlush question
boldDefault defAnswer
putTextLn ""
answer <- prompt
if | T.null answer -> pure defAnswer
| otherwise -> pure answer
-- | Queries many answers. If answers are not parsable shows the failing part
-- and queries again
queryManyRepeatOnFail :: forall a . (Text -> Maybe a) -> IO [a]
queryManyRepeatOnFail parser = promptLoop
where
-- TODO: probably a good idea to use 'Validation' here to simplify code
promptLoop :: IO [a]
promptLoop = do
answer <- prompt
let answers = map (id &&& parser) $ words answer -- converts [Text] into [(Text, Maybe a)]
case partitionPairs answers of
Left unparsed -> do
-- TODO: create intercalateMap function
errorMessage $ "Unable to parse the following items: " <> intercalateMap " " quote unparsed
promptLoop
Right results -> pure results
-- puts only those @c@ into Left list where snd is Nothing;
-- returns Left if at least one second element is Nothing
partitionPairs :: forall x y . [(x, Maybe y)] -> Either [x] [y]
partitionPairs [] = Right []
partitionPairs ((x, my):xs) = case my of
Just y -> (y:) <$> partitionPairs xs
Nothing -> case partitionPairs xs of
Left fails -> Left (x : fails)
Right _ -> Left [x]
quote :: Text -> Text
quote t = "'" <> t <> "'"
checkUniqueName :: Text -> IO Text
checkUniqueName nm = do
curPath <- getCurrentDirectory
exist <- doesPathExist $ curPath </> toString nm
if exist then do
warningMessage "Project with this name is already exist. Please choose another one"
newNm <- queryNotNull "Project name: "
checkUniqueName newNm
else
pure nm