@@ -1,77 +1,38 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE TemplateHaskell #-}
5−{-# LANGUAGE TypeFamilies #-}
6−{-# LANGUAGE UndecidableInstances #-}
71
8−module Control.Monad.Validation
9− ( ValidationT(..)
10− , runValidationT
11− , runValidationTEither
12− , handleValidationT
13− , vError
14− , vWarning
15− , vErrorL
16− , vWarningL
17− , vZoom
18− , vZoomL
19− , vPromote
20− , mmSingleton
21− , setMempty
22− , neConcat
23− , textErrors
24− , _MonoidMap
25− , MonoidMap(..)
26− ) where
2+module Common.Validation where
273
28−import Control.Applicative
294import Control.Lens hiding ((.=))
305import Control.Monad.Base
316import Control.Monad.Catch
327import Control.Monad.Except
33−import Control.Monad.Fail
348import Control.Monad.State.Strict
35−import Control.Monad.Trans.Control
9+import Control.Monad.Trans.Lift.Local
3610import Data.Aeson
3711import Data.Foldable as F
38−import Data.Functor
3912import Data.List as L
4013import Data.Map.Strict as M
14+import Data.Monoid
4115import Data.Text as T
4216import Data.Vector as V
4317import Test.QuickCheck
4418
45−#if MIN_VERSION_mtl(2,3,0)
46−import Control.Monad
47−import Control.Monad.Fix
48−#endif
49−
50−-- | Collects all thrown warnings in 'StateT' and errors
51−-- in 'ExceptT' into a single value using 'Monoid'.
19+-- | Collects all throwed "warnings" throwed through StateT and "errors" throwed
20+-- through ExceptT to single value using Monoid
21+-- FIXME: give more instances like HReaderT and MonadBaseControl/MonadMask
5222newtype ValidationT e m a = ValidationT
5323 { unValidationT :: ExceptT e (StateT e m) a
5424 } deriving ( Functor, Applicative, Monad, MonadThrow, MonadCatch
55− , MonadBase b, Alternative, MonadFix, MonadFail, Contravariant
56− , MonadIO, MonadPlus, MonadBaseControl b, MonadMask )
25+ , MonadBase b )
5726
5827instance MonadTrans (ValidationT e) where
5928 lift = ValidationT . lift . lift
6029
30+instance LiftLocal (ValidationT e) where
31+ liftLocal _ l f = ValidationT . mapExceptT (mapStateT $ l f) . unValidationT
32+
6133-- | Map with 'Monoid' instance which 'mappend' its values
62−--
63−-- This can be used as the `e` in `ValidationT e m a` to provide different
64−-- sets of errors and warnings for different keys.
65−--
66−-- >>> :{
67−-- mconcat
68−-- [ MonoidMap $ M.fromList [(1, "foo"), (2, "hello, "), (3, "oh no")]
69−-- , MonoidMap $ M.fromList [(1, "bar"), (2, "world")]
70−-- ]
71−-- :}
72−-- MonoidMap (fromList [(1,"foobar"),(2,"hello, world"),(3,"oh no")])
7334newtype MonoidMap k v = MonoidMap (Map k v)
74− deriving (Eq, Ord, Show, Arbitrary, Foldable)
35+ deriving (Eq, Ord, Show, Arbitrary)
7536
7637makePrisms ''MonoidMap
7738
@@ -82,14 +43,10 @@ instance (Ord k) => Ixed (MonoidMap k v) where
8243instance (Ord k) => At (MonoidMap k v) where
8344 at key = _MonoidMap . at key
8445
85−#if MIN_VERSION_base(4,11,0)
86−instance (Ord k, Semigroup v) => Semigroup (MonoidMap k v) where
87− (<>) = mmAppend
88−#endif
89−
9046instance (Ord k, Monoid v) => Monoid (MonoidMap k v) where
9147 mempty = MonoidMap M.empty
92− mappend = (<>)
48+ mappend (MonoidMap a) (MonoidMap b) =
49+ MonoidMap $ M.unionWith (<>) a b
9350
9451instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
9552 toJSON (MonoidMap m) = toJSON $ L.map toObj $ M.toList m
@@ -99,7 +56,7 @@ instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
9956 , "value" .= v ]
10057
10158instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
102− parseJSON = withArray "MonoidMap" go
59+ parseJSON v = withArray "MonoidMap" go v
10360 where
10461 go arr = do
10562 keyvals <- traverse fromObj arr
@@ -109,67 +66,35 @@ instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
10966 val <- obj .: "value"
11067 return (key, val)
11168
112−#if MIN_VERSION_base(4,11,0)
113−mmAppend :: (Ord k, Semigroup v) => MonoidMap k v -> MonoidMap k v -> MonoidMap k v
114−#else
115−mmAppend :: (Ord k, Monoid v) => MonoidMap k v -> MonoidMap k v -> MonoidMap k v
116−#endif
117−mmAppend (MonoidMap a) (MonoidMap b) = MonoidMap $ M.unionWith (<>) a b
118−
119−-- | Convenient for 'vZoom' as first argument. Will prevent generation
120−-- of map with 'mempty' values.
69+-- | Convenient for 'vZoom' as first artument. Will prevent generation
70+-- of map with 'mempty' values
12171mmSingleton :: (Eq v, Monoid v, Ord k) => k -> v -> MonoidMap k v
122−mmSingleton k v
123− | v == mempty = mempty
124− | otherwise = MonoidMap . M.singleton k $ v
72+mmSingleton k = memptyWrap mempty $ MonoidMap . M.singleton k
12573
126−-- | Sets given value to 'mempty'.
74+-- | Set given value to 'mempty'
12775setMempty :: (Monoid s) => ASetter' s a -> a -> s
12876setMempty setter a = set setter a mempty
12977
130−neConcat :: Foldable f => (a -> a -> a) -> f a -> Maybe a
131−neConcat f a
132− | F.null a = Nothing
133− | otherwise = Just $ F.foldr1 f a
78+memptyWrap :: (Eq a, Monoid a) => b -> (a -> b) -> a -> b
79+memptyWrap b f a
80+ | a == mempty = b
81+ | otherwise = f a
82+
83+-- | If given container is not 'mempty', then use given function to
84+-- append all its elements and return 'Just' result
85+neConcat
86+ :: (Foldable f, Eq (f a), Monoid a, Monoid (f a))
87+ => (a -> a -> a)
88+ -> f a
89+ -> Maybe a
90+neConcat f = memptyWrap Nothing (Just . F.foldl' f mempty)
13491
135−-- | Returns the strings, concatanated with @", "@ if the list is not empty.
136−--
137−-- Returns Nothing if the list is empty
138−--
139−-- >>> textErrors ["foo", "bar"]
140−-- Just "foo, bar"
141−--
142−-- >>> textErrors ["foo"]
143−-- Just "foo"
144−--
145−-- >>> textErrors []
146−-- Nothing
14792textErrors :: [Text] -> Maybe Text
14893textErrors = neConcat (\a b -> a <> ", " <> b)
14994
150−-- | Returns 'mempty' instead of error if no warnings have occurred.
151−-- Returns 'Nothing' as the second element of tuple if computation was
152−-- interrupted by 'vError'.
153−--
154−-- Returns all concatenated errors and warnings and the result if no
155−-- errors have occurred (warnings could have occurred).
156−--
157−-- >>> :{
158−-- runValidationT $ do
159−-- vWarning ["warning1"]
160−-- vError ["error"]
161−-- vWarning ["warning2"]
162−-- return 8
163−-- :}
164−-- (["error","warning1"],Nothing)
165−--
166−-- >>> :{
167−-- runValidationT $ do
168−-- vWarning ["warning1"]
169−-- vWarning ["warning2"]
170−-- return 8
171−-- :}
172−-- (["warning1","warning2"],Just 8)
95+-- | Returns `mempty` instead of error if no warnings was occured. So, your
96+-- error should have `Eq` instance to detect that any error was occured. Returns
97+-- Nothing for second element of tuple if compuration was interruped by 'vError'
17398runValidationT :: (Monoid e, Monad m) => ValidationT e m a -> m (e, Maybe a)
17499runValidationT (ValidationT m) = do
175100 (res, warnings) <- runStateT (runExceptT m) mempty
@@ -177,25 +102,6 @@ runValidationT (ValidationT m) = do
177102 Left err -> (err <> warnings, Nothing)
178103 Right a -> (warnings, Just a)
179104
180−-- | Like 'runValidationT' but doesn't return the result
181−-- if any warning has occurred.
182−--
183−-- >>> :{
184−-- runValidationTEither $ do
185−-- vWarning ["warning1"]
186−-- vError ["error"]
187−-- vWarning ["warning2"]
188−-- return 8
189−-- :}
190−-- Left ["error","warning1"]
191−--
192−-- >>> :{
193−-- runValidationTEither $ do
194−-- vWarning ["warning1"]
195−-- vWarning ["warning2"]
196−-- return 8
197−-- :}
198−-- Left ["warning1","warning2"]
199105runValidationTEither
200106 :: (Monoid e, Eq e, Monad m)
201107 => ValidationT e m a
@@ -206,71 +112,28 @@ runValidationTEither action = do
206112 Just a | err == mempty -> Right a
207113 _ -> Left err
208114
209−-- | Like 'runValidationTEither', but takes an error handler instead of
210−-- returning errors and warnings.
211−--
212−-- >>> :{
213−-- handleValidationT (\_ -> return 11) $ do
214−-- vWarning ["warning1"]
215−-- vError ["error"]
216−-- vWarning ["warning2"]
217−-- return 8
218−-- :}
219−-- 11
220−--
221−-- >>> :{
222−-- handleValidationT (\_ -> return 11) $ do
223−-- vWarning ["warning1"]
224−-- vWarning ["warning2"]
225−-- return 8
226−-- :}
227−-- 11
228115handleValidationT
229116 :: (Monoid e, Monad m, Eq e)
230117 => (e -> m a)
231118 -> ValidationT e m a
232119 -> m a
233−handleValidationT handler action =
120+handleValidationT handler action = do
234121 runValidationTEither action >>= either handler return
235122
236−-- | Stops further execution and appends the given error.
123+-- | Stops further execution of validation
237124vError :: (Monad m) => e -> ValidationT e m a
238125vError e = ValidationT $ throwError e
239126
240−-- | Does not stop further execution and appends the given warning.
127+-- | Does not stop further execution, append warning to
241128vWarning :: (Monad m, Monoid e) => e -> ValidationT e m ()
242129vWarning e = ValidationT $ modify' (<> e)
243130
244−-- | Like 'vError' but allows you to use a setter to insert an error somewhere
245−-- deeper into an empty ('mempty') "e" from "ValidationT e m x", which is then
246−-- combined with all gathered warnings.
247131vErrorL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m x
248132vErrorL l a = vError $ setMempty l a
249133
250−-- | Like 'vWarning' but allows you to use a setter to insert an error somewhere
251−-- deeper into an empty ('mempty') "e" from "ValidationT e m x", which is then
252−-- combined with all gathered warnings.
253134vWarningL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m ()
254135vWarningL l a = vWarning $ setMempty l a
255136
256−-- | Allows you apply a transformation to the "e" in "ValidationT e m x".
257−--
258−-- >>> :{
259−--runValidationT . vZoom (Data.Map.singleton "password errors") $ do
260−-- vWarning ["warning1"]
261−-- vError ["error"]
262−-- vWarning ["warning2"]
263−-- return 8
264−-- :}
265−-- (fromList [("password errors",["error","warning1"])],Nothing)
266−--
267−-- >>> :{
268−-- runValidationT . vZoom (Data.Map.singleton "password errors") $ do
269−-- vWarning ["warning1"]
270−-- vWarning ["warning2"]
271−-- return 8
272−-- :}
273−-- (fromList [("password errors",["warning1","warning2"])],Just 8)
274137vZoom
275138 :: (Monad m, Monoid a, Monoid b)
276139 => (a -> b)
@@ -280,21 +143,11 @@ vZoom up action = do
280143 (err, res) <- lift $ runValidationT action
281144 case res of
282145 Nothing -> vError $ up err
283− Just a -> vWarning (up err) $> a
146+ Just a -> vWarning (up err) *> return a
284147
285−-- | Like 'vZoom' but takes a setter instead of a function.
286148vZoomL
287149 :: (Monad m, Monoid a, Monoid b)
288150 => ASetter' b a
289151 -> ValidationT a m x
290152 -> ValidationT b m x
291−vZoomL l = vZoom (setMempty l)
292−
293−-- | Turn any warnings the have occurred into errors.
294−vPromote
295− :: (Monad m, Monoid a, Eq a)
296− => ValidationT a m x
297− -> ValidationT a m x
298−vPromote m = do
299− err <- lift $ runValidationTEither m
300− either vError return err
153+vZoomL l action = vZoom (setMempty l) action