@@ -1,77 +1,37 @@
1−{-# LANGUAGE CPP #-}
1+module Common.Monad.Validation where
2−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE TemplateHaskell #-}
5−{-# LANGUAGE TypeFamilies #-}
6−{-# LANGUAGE UndecidableInstances #-}
8−module Control.Monad.Validation
11− , runValidationTEither
28−import Control.Applicative
29import Control.Lens hiding ((.=))
3import Control.Lens hiding ((.=))
30import Control.Monad.Base
4import Control.Monad.Base
31import Control.Monad.Catch
5import Control.Monad.Catch
32import Control.Monad.Except
6import Control.Monad.Except
33−import Control.Monad.Fail
34import Control.Monad.State.Strict
7import Control.Monad.State.Strict
35−import Control.Monad.Trans.Control
8+import Control.Monad.Trans.Lift.Local
36import Data.Aeson
9import Data.Aeson
37import Data.Foldable as F
10import Data.Foldable as F
39import Data.List as L
11import Data.List as L
40import Data.Map.Strict as M
12import Data.Map.Strict as M
41import Data.Text as T
14import Data.Text as T
42import Data.Vector as V
15import Data.Vector as V
43import Test.QuickCheck
16import Test.QuickCheck
45−#if MIN_VERSION_mtl(2,3,0)
47−import Control.Monad.Fix
50−-- | Collects all thrown warnings in 'StateT' and errors
18+-- | Collects all throwed "warnings" throwed through StateT and "errors" throwed
51−-- in 'ExceptT' into a single value using 'Monoid'.
19+-- through ExceptT to single value using Monoid
20+-- FIXME: give more instances like HReaderT and MonadBaseControl/MonadMask
52newtype ValidationT e m a = ValidationT
21newtype ValidationT e m a = ValidationT
53 { unValidationT :: ExceptT e (StateT e m) a
22 { unValidationT :: ExceptT e (StateT e m) a
54 } deriving ( Functor, Applicative, Monad, MonadThrow, MonadCatch
23 } deriving ( Functor, Applicative, Monad, MonadThrow, MonadCatch
55− , MonadBase b, Alternative, MonadFix, MonadFail, Contravariant
24+ , MonadBase b )
56− , MonadIO, MonadPlus, MonadBaseControl b, MonadMask )
58instance MonadTrans (ValidationT e) where
26instance MonadTrans (ValidationT e) where
59 lift = ValidationT . lift . lift
27 lift = ValidationT . lift . lift
29+instance LiftLocal (ValidationT e) where
30+ liftLocal _ l f = ValidationT . mapExceptT (mapStateT $ l f) . unValidationT
61-- | Map with 'Monoid' instance which 'mappend' its values
32-- | Map with 'Monoid' instance which 'mappend' its values
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.
68−-- [ MonoidMap $ M.fromList [(1, "foo"), (2, "hello, "), (3, "oh no")]
69−-- , MonoidMap $ M.fromList [(1, "bar"), (2, "world")]
72−-- MonoidMap (fromList [(1,"foobar"),(2,"hello, world"),(3,"oh no")])
73newtype MonoidMap k v = MonoidMap (Map k v)
33newtype MonoidMap k v = MonoidMap (Map k v)
74− deriving (Eq, Ord, Show, Arbitrary, Foldable)
34+ deriving (Eq, Ord, Show, Arbitrary)
76makePrisms ''MonoidMap
36makePrisms ''MonoidMap
@@ -82,14 +42,10 @@ instance (Ord k) => Ixed (MonoidMap k v) where
82instance (Ord k) => At (MonoidMap k v) where
42instance (Ord k) => At (MonoidMap k v) where
83 at key = _MonoidMap . at key
43 at key = _MonoidMap . at key
85−#if MIN_VERSION_base(4,11,0)
86−instance (Ord k, Semigroup v) => Semigroup (MonoidMap k v) where
90instance (Ord k, Monoid v) => Monoid (MonoidMap k v) where
45instance (Ord k, Monoid v) => Monoid (MonoidMap k v) where
91 mempty = MonoidMap M.empty
46 mempty = MonoidMap M.empty
92− mappend = (<>)
47+ mappend (MonoidMap a) (MonoidMap b) =
48+ MonoidMap $ M.unionWith (<>) a b
94instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
50instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
95 toJSON (MonoidMap m) = toJSON $ L.map toObj $ M.toList m
51 toJSON (MonoidMap m) = toJSON $ L.map toObj $ M.toList m
@@ -99,7 +55,7 @@ instance (ToJSON k, ToJSON v) => ToJSON (MonoidMap k v) where
99 , "value" .= v ]
55 , "value" .= v ]
101instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
57instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
102− parseJSON = withArray "MonoidMap" go
58+ parseJSON v = withArray "MonoidMap" go v
104 go arr = do
60 go arr = do
105 keyvals <- traverse fromObj arr
61 keyvals <- traverse fromObj arr
@@ -109,67 +65,35 @@ instance (Ord k, FromJSON k, FromJSON v) => FromJSON (MonoidMap k v) where
109 val <- obj .: "value"
65 val <- obj .: "value"
110 return (key, val)
66 return (key, val)
112−#if MIN_VERSION_base(4,11,0)
113−mmAppend :: (Ord k, Semigroup v) => MonoidMap k v -> MonoidMap k v -> MonoidMap k v
115−mmAppend :: (Ord k, Monoid v) => MonoidMap k v -> MonoidMap k v -> MonoidMap k v
117−mmAppend (MonoidMap a) (MonoidMap b) = MonoidMap $ M.unionWith (<>) a b
119−-- | Convenient for 'vZoom' as first argument. Will prevent generation
68+-- | Convenient for 'vZoom' as first artument. Will prevent generation
120−-- of map with 'mempty' values.
69+-- of map with 'mempty' values
121mmSingleton :: (Eq v, Monoid v, Ord k) => k -> v -> MonoidMap k v
70mmSingleton :: (Eq v, Monoid v, Ord k) => k -> v -> MonoidMap k v
123− | v == mempty = mempty
124− | otherwise = MonoidMap . M.singleton k $ v
71+mmSingleton k = memptyWrap mempty $ MonoidMap . M.singleton k
126−-- | Sets given value to 'mempty'.
73+-- | Set given value to 'mempty'
127setMempty :: (Monoid s) => ASetter' s a -> a -> s
74setMempty :: (Monoid s) => ASetter' s a -> a -> s
128setMempty setter a = set setter a mempty
75setMempty setter a = set setter a mempty
130−neConcat :: Foldable f => (a -> a -> a) -> f a -> Maybe a
77+memptyWrap :: (Eq a, Monoid a) => b -> (a -> b) -> a -> b
131−neConcat f a
78+memptyWrap b f a
132− | F.null a = Nothing
79+ | a == mempty = b
133− | otherwise = Just $ F.foldr1 f a
80+ | otherwise = f a
82+-- | If given container is not 'mempty', then use given function to
83+-- append all its elements and return 'Just' result
85+ :: (Foldable f, Eq (f a), Monoid a, Monoid (f a))
89+neConcat f = memptyWrap Nothing (Just . F.foldl' f mempty)
135−-- | Returns the strings, concatanated with @", "@ if the list is not empty.
137−-- Returns Nothing if the list is empty
139−-- >>> textErrors ["foo", "bar"]
142−-- >>> textErrors ["foo"]
147textErrors :: [Text] -> Maybe Text
91textErrors :: [Text] -> Maybe Text
148textErrors = neConcat (\a b -> a <> ", " <> b)
92textErrors = neConcat (\a b -> a <> ", " <> b)
150−-- | Returns 'mempty' instead of error if no warnings have occurred.
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
151−-- Returns 'Nothing' as the second element of tuple if computation was
96+-- Nothing for second element of tuple if compuration was interruped by 'vError'
152−-- interrupted by 'vError'.
154−-- Returns all concatenated errors and warnings and the result if no
155−-- errors have occurred (warnings could have occurred).
158−-- runValidationT $ do
159−-- vWarning ["warning1"]
161−-- vWarning ["warning2"]
164−-- (["error","warning1"],Nothing)
167−-- runValidationT $ do
168−-- vWarning ["warning1"]
169−-- vWarning ["warning2"]
172−-- (["warning1","warning2"],Just 8)
173runValidationT :: (Monoid e, Monad m) => ValidationT e m a -> m (e, Maybe a)
97runValidationT :: (Monoid e, Monad m) => ValidationT e m a -> m (e, Maybe a)
174runValidationT (ValidationT m) = do
98runValidationT (ValidationT m) = do
175 (res, warnings) <- runStateT (runExceptT m) mempty
99 (res, warnings) <- runStateT (runExceptT m) mempty
@@ -177,25 +101,6 @@ runValidationT (ValidationT m) = do
177 Left err -> (err <> warnings, Nothing)
101 Left err -> (err <> warnings, Nothing)
178 Right a -> (warnings, Just a)
102 Right a -> (warnings, Just a)
180−-- | Like 'runValidationT' but doesn't return the result
181−-- if any warning has occurred.
184−-- runValidationTEither $ do
185−-- vWarning ["warning1"]
187−-- vWarning ["warning2"]
190−-- Left ["error","warning1"]
193−-- runValidationTEither $ do
194−-- vWarning ["warning1"]
195−-- vWarning ["warning2"]
198−-- Left ["warning1","warning2"]
199runValidationTEither
104runValidationTEither
200 :: (Monoid e, Eq e, Monad m)
105 :: (Monoid e, Eq e, Monad m)
201 => ValidationT e m a
106 => ValidationT e m a
@@ -206,71 +111,28 @@ runValidationTEither action = do
206 Just a | err == mempty -> Right a
111 Just a | err == mempty -> Right a
207 _ -> Left err
112 _ -> Left err
209−-- | Like 'runValidationTEither', but takes an error handler instead of
210−-- returning errors and warnings.
213−-- handleValidationT (\_ -> return 11) $ do
214−-- vWarning ["warning1"]
216−-- vWarning ["warning2"]
222−-- handleValidationT (\_ -> return 11) $ do
223−-- vWarning ["warning1"]
224−-- vWarning ["warning2"]
228handleValidationT
114handleValidationT
229 :: (Monoid e, Monad m, Eq e)
115 :: (Monoid e, Monad m, Eq e)
230 => (e -> m a)
116 => (e -> m a)
231 -> ValidationT e m a
117 -> ValidationT e m a
233−handleValidationT handler action =
119+handleValidationT handler action = do
234 runValidationTEither action >>= either handler return
120 runValidationTEither action >>= either handler return
236−-- | Stops further execution and appends the given error.
122+-- | Stops further execution of validation
237vError :: (Monad m) => e -> ValidationT e m a
123vError :: (Monad m) => e -> ValidationT e m a
238vError e = ValidationT $ throwError e
124vError e = ValidationT $ throwError e
240−-- | Does not stop further execution and appends the given warning.
126+-- | Does not stop further execution, append warning to
241vWarning :: (Monad m, Monoid e) => e -> ValidationT e m ()
127vWarning :: (Monad m, Monoid e) => e -> ValidationT e m ()
242vWarning e = ValidationT $ modify' (<> e)
128vWarning e = ValidationT $ modify' (<> e)
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.
247vErrorL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m x
130vErrorL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m x
248vErrorL l a = vError $ setMempty l a
131vErrorL l a = vError $ setMempty l a
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.
253vWarningL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m ()
133vWarningL :: (Monad m, Monoid e) => ASetter' e a -> a -> ValidationT e m ()
254vWarningL l a = vWarning $ setMempty l a
134vWarningL l a = vWarning $ setMempty l a
256−-- | Allows you apply a transformation to the "e" in "ValidationT e m x".
259−--runValidationT . vZoom (Data.Map.singleton "password errors") $ do
260−-- vWarning ["warning1"]
262−-- vWarning ["warning2"]
265−-- (fromList [("password errors",["error","warning1"])],Nothing)
268−-- runValidationT . vZoom (Data.Map.singleton "password errors") $ do
269−-- vWarning ["warning1"]
270−-- vWarning ["warning2"]
273−-- (fromList [("password errors",["warning1","warning2"])],Just 8)
275 :: (Monad m, Monoid a, Monoid b)
137 :: (Monad m, Monoid a, Monoid b)
276 => (a -> b)
138 => (a -> b)
@@ -280,21 +142,11 @@ vZoom up action = do
280 (err, res) <- lift $ runValidationT action
142 (err, res) <- lift $ runValidationT action
281 case res of
143 case res of
282 Nothing -> vError $ up err
144 Nothing -> vError $ up err
283− Just a -> vWarning (up err) $> a
145+ Just a -> vWarning (up err) *> return a
285−-- | Like 'vZoom' but takes a setter instead of a function.
287 :: (Monad m, Monoid a, Monoid b)
148 :: (Monad m, Monoid a, Monoid b)
288 => ASetter' b a
149 => ASetter' b a
289 -> ValidationT a m x
150 -> ValidationT a m x
290 -> ValidationT b m x
151 -> ValidationT b m x
291−vZoomL l = vZoom (setMempty l)
152+vZoomL l action = vZoom (setMempty l) action
293−-- | Turn any warnings the have occurred into errors.
295− :: (Monad m, Monoid a, Eq a)
296− => ValidationT a m x
297− -> ValidationT a m x
299− err <- lift $ runValidationTEither m
300− either vError return err