@@ -1,77 +1,37 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE TemplateHaskell #-}
5−{-# LANGUAGE TypeFamilies #-}
6−{-# LANGUAGE UndecidableInstances #-}
1+module Common.Monad.Validation where
72
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
27−
28−import Control.Applicative
293import Control.Lens hiding ((.=))
304import Control.Monad.Base
315import Control.Monad.Catch
326import Control.Monad.Except
33−import Control.Monad.Fail
347import Control.Monad.State.Strict
35−import Control.Monad.Trans.Control
8+import Control.Monad.Trans.Lift.Local
369import Data.Aeson
3710import Data.Foldable as F
38−import Data.Functor
3911import Data.List as L
4012import Data.Map.Strict as M
13+import Data.Monoid
4114import Data.Text as T
4215import Data.Vector as V
4316import Test.QuickCheck
4417
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'.
18+-- | Collects all throwed "warnings" throwed through StateT and "errors" throwed
19+-- through ExceptT to single value using Monoid
20+-- FIXME: give more instances like HReaderT and MonadBaseControl/MonadMask
5221newtype ValidationT e m a = ValidationT
5322 { unValidationT :: ExceptT e (StateT e m) a
5423 } deriving ( Functor, Applicative, Monad, MonadThrow, MonadCatch
55− , MonadBase b, Alternative, MonadFix, MonadFail, Contravariant
56− , MonadIO, MonadPlus, MonadBaseControl b, MonadMask )
24+ , MonadBase b )
5725
5826instance MonadTrans (ValidationT e) where
5927 lift = ValidationT . lift . lift
6028
29+instance LiftLocal (ValidationT e) where
30+ liftLocal _ l f = ValidationT . mapExceptT (mapStateT $ l f) . unValidationT
31+
6132-- | 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")])
7333newtype MonoidMap k v = MonoidMap (Map k v)
74− deriving (Eq, Ord, Show, Arbitrary, Foldable)
34+ deriving (Eq, Ord, Show, Arbitrary)
7535
7636makePrisms ''MonoidMap
7737
@@ -82,14 +42,10 @@ instance (Ord k) => Ixed (MonoidMap k v) where
8242instance (Ord k) => At (MonoidMap k v) where
8343 at key = _MonoidMap . at key
8444
85−#if MIN_VERSION_base(4,11,0)
86−instance (Ord k, Semigroup v) => Semigroup (MonoidMap k v) where
87− (<>) = mmAppend
88−#endif
89−
9045instance (Ord k, Monoid v) => Monoid (MonoidMap k v) where
9146 mempty = MonoidMap M.empty
92− mappend = (<>)
47+ mappend (MonoidMap a) (MonoidMap b) =
48+ MonoidMap $ M.unionWith (<>) a b
9349
9450instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
9551 toJSON (MonoidMap m) = toJSON $ L.map toObj $ M.toList m
@@ -99,7 +55,7 @@ instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
9955 , "value" .= v ]
10056
10157instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
102− parseJSON = withArray "MonoidMap" go
58+ parseJSON v = withArray "MonoidMap" go v
10359 where
10460 go arr = do
10561 keyvals <- traverse fromObj arr
@@ -109,67 +65,35 @@ instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
10965 val <- obj .: "value"
11066 return (key, val)
11167
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.
68+-- | Convenient for 'vZoom' as first artument. Will prevent generation
69+-- of map with 'mempty' values
12170mmSingleton :: (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
71+mmSingleton k = memptyWrap mempty $ MonoidMap . M.singleton k
12572
126−-- | Sets given value to 'mempty'.
73+-- | Set given value to 'mempty'
12774setMempty :: (Monoid s) => ASetter' s a -> a -> s
12875setMempty setter a = set setter a mempty
12976
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
77+memptyWrap :: (Eq a, Monoid a) => b -> (a -> b) -> a -> b
78+memptyWrap b f a
79+ | a == mempty = b
80+ | otherwise = f a
81+
82+-- | If given container is not 'mempty', then use given function to
83+-- append all its elements and return 'Just' result
84+neConcat
85+ :: (Foldable f, Eq (f a), Monoid a, Monoid (f a))
86+ => (a -> a -> a)
87+ -> f a
88+ -> Maybe a
89+neConcat f = memptyWrap Nothing (Just . F.foldl' f mempty)
13490
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
14791textErrors :: [Text] -> Maybe Text
14892textErrors = neConcat (\a b -> a <> ", " <> b)
14993
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)
94+-- | Returns `mempty` instead of error if no warnings was occured. So, your
95+-- error should have `Eq` instance to detect that any error was occured. Returns
96+-- Nothing for second element of tuple if compuration was interruped by 'vError'
17397runValidationT :: (Monoid e, Monad m) => ValidationT e m a -> m (e, Maybe a)
17498runValidationT (ValidationT m) = do
17599 (res, warnings) <- runStateT (runExceptT m) mempty
@@ -177,25 +101,6 @@ runValidationT (ValidationT m) = do
177101 Left err -> (err <> warnings, Nothing)
178102 Right a -> (warnings, Just a)
179103
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"]
199104runValidationTEither
200105 :: (Monoid e, Eq e, Monad m)
201106 => ValidationT e m a
@@ -206,71 +111,28 @@ runValidationTEither action = do
206111 Just a | err == mempty -> Right a
207112 _ -> Left err
208113
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
228114handleValidationT
229115 :: (Monoid e, Monad m, Eq e)
230116 => (e -> m a)
231117 -> ValidationT e m a
232118 -> m a
233−handleValidationT handler action =
119+handleValidationT handler action = do
234120 runValidationTEither action >>= either handler return
235121
236−-- | Stops further execution and appends the given error.
122+-- | Stops further execution of validation
237123vError :: (Monad m) => e -> ValidationT e m a
238124vError e = ValidationT $ throwError e
239125
240−-- | Does not stop further execution and appends the given warning.
126+-- | Does not stop further execution, append warning to
241127vWarning :: (Monad m, Monoid e) => e -> ValidationT e m ()
242128vWarning e = ValidationT $ modify' (<> e)
243129
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.
247130vErrorL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m x
248131vErrorL l a = vError $ setMempty l a
249132
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.
253133vWarningL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m ()
254134vWarningL l a = vWarning $ setMempty l a
255135
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)
274136vZoom
275137 :: (Monad m, Monoid a, Monoid b)
276138 => (a -> b)
@@ -280,21 +142,11 @@ vZoom up action = do
280142 (err, res) <- lift $ runValidationT action
281143 case res of
282144 Nothing -> vError $ up err
283− Just a -> vWarning (up err) $> a
145+ Just a -> vWarning (up err) *> return a
284146
285−-- | Like 'vZoom' but takes a setter instead of a function.
286147vZoomL
287148 :: (Monad m, Monoid a, Monoid b)
288149 => ASetter' b a
289150 -> ValidationT a m x
290151 -> 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
152+vZoomL l action = vZoom (setMempty l) action