Clean up before release (#171)

Author: chshersh

co-log-core/CHANGELOG.md

@@ -3,12 +3,27 @@
 `co-log-core` uses [PVP Versioning][1].
 The change log is available [on GitHub][2].
 
-## Unreleased
+## 0.2.1.0 — Jan 19, 2020
 
+* [#139](https://github.com/kowainik/co-log/issues/139):
+  Add (unrepresentable) `Functor` instance for `LogAction` with the
+  custom type-error.
+  (by [@vrom911](https://github.com/vrom911))
+* [#148](https://github.com/kowainik/co-log/issues/148):
+  Support GHC-8.8.2.
+  (by [@chshersh](https://github.com/chshersh))
 * [#122](https://github.com/kowainik/co-log/issues/122):
   Add the `separate` combinator.
-* [#139](https://github.com/kowainik/co-log/issues/139):
-  Add (unrepresentable) `Functor` instance for `LogAction` with the custom type-error.
+  (by [@vrom911](https://github.com/vrom911))
+* [#125](https://github.com/kowainik/co-log/issues/125):
+  Add monadic versions of contravariant functions.
+  (by [@piq9117](https://github.com/piq9117))
+* [#138](https://github.com/kowainik/co-log/issues/138):
+  Add `hoistLogAction` — higher-order transformation function.
+  (by [@jiribenes](https://github.com/jiribenes))
+* [#123](https://github.com/kowainik/co-log/issues/123):
+  Write default implementation to `getLogAction` via `logActionL`.
+  (by [@SanchayanMaity](https://github.com/SanchayanMaity))
 
 ## 0.2.0.0 — May 5, 2019
 

co-log-core/co-log-core.cabal

@@ -36,7 +36,7 @@ extra-doc-files:     CHANGELOG.md
 tested-with:         GHC == 8.2.2
                      GHC == 8.4.4
                      GHC == 8.6.5
-                     GHC == 8.8.1
+                     GHC == 8.8.2
 
 source-repository head
   type:                git
@@ -53,10 +53,14 @@ common common-options
                        -Wredundant-constraints
                        -fhide-source-paths
                        -freverse-errors
+  if impl(ghc >= 8.8.1)
+    ghc-options:       -Wmissing-deriving-strategies
+                       -Werror=missing-deriving-strategies
 
   default-language:    Haskell2010
   default-extensions:  ConstraintKinds
                        DeriveGeneric
+                       DerivingStrategies
                        GeneralizedNewtypeDeriving
                        InstanceSigs
                        LambdaCase

co-log-core/src/Colog/Core/Action.hs

@@ -287,9 +287,9 @@ cfilter :: Applicative m => (msg -> Bool) -> LogAction m msg -> LogAction m msg
 cfilter predicate (LogAction action) = LogAction $ \a -> when (predicate a) (action a)
 {-# INLINE cfilter #-}
 
-{- | Performs the given logging action only if satisfies the monadic predicate.
-
-Let's say you want to only to see logs that happened on weekends.
+{- | Performs the given logging action only if satisfies the monadic
+predicate. Let's say you want to only to see logs that happened on
+weekends.
 
 @
 isWeekendM :: MessageWithTimestamp -> IO Bool
@@ -299,8 +299,12 @@ And use it with 'cfilterM' like this
 
 @
 logMessageAction :: 'LogAction' m MessageWithTimestamp
+
+logWeekendAction :: 'LogAction' m MessageWithTimestamp
+logWeekendAction = cfilterM isWeekendM logMessageAction
 @
 
+@since 0.2.1.0
 -}
 cfilterM :: Monad m => (msg -> m Bool) -> LogAction m msg -> LogAction m msg
 cfilterM predicateM (LogAction action) =
@@ -364,7 +368,11 @@ cmapMaybe :: Applicative m => (a -> Maybe b) -> LogAction m b -> LogAction m a
 cmapMaybe f (LogAction action) = LogAction (maybe (pure ()) action . f)
 {-# INLINE cmapMaybe #-}
 
--- | Similar to `cmapMaybe` but for convertions that may fail inside a monadic context.
+{- | Similar to `cmapMaybe` but for convertions that may fail inside a
+monadic context.
+
+@since 0.2.1.0
+-}
 cmapMaybeM :: Monad m => (a -> m (Maybe b)) -> LogAction m b -> LogAction m a
 cmapMaybeM f (LogAction action) = LogAction (maybe (pure ()) action <=< f)
 {-# INLINE cmapMaybeM #-}
@@ -424,7 +432,6 @@ logTextAction :: 'LogAction' IO Text
 logTextAction = 'cmapM' withTime myAction
 @
 -}
-
 cmapM :: Monad m => (a -> m b) -> LogAction m b -> LogAction m a
 cmapM f (LogAction action) = LogAction (f >=> action)
 {-# INLINE cmapM #-}
@@ -456,6 +463,10 @@ divide f (LogAction actionB) (LogAction actionC) = LogAction $ \(f -> (b, c)) ->
     actionB b *> actionC c
 {-# INLINE divide #-}
 
+{- | Monadic version of 'divide'.
+
+@since 0.2.1.0
+-}
 divideM :: (Monad m) => (a -> m (b, c)) -> LogAction m b -> LogAction m c -> LogAction m a
 divideM f (LogAction actionB) (LogAction actionC) =
     LogAction $ \(f -> mbc) -> mbc >>= (\(b, c) -> actionB b *> actionC c)
@@ -541,6 +552,10 @@ choose :: (a -> Either b c) -> LogAction m b -> LogAction m c -> LogAction m a
 choose f (LogAction actionB) (LogAction actionC) = LogAction (either actionB actionC . f)
 {-# INLINE choose #-}
 
+{- | Monadic version of 'choose'.
+
+@since 0.2.1.0
+-}
 chooseM :: Monad m => (a -> m (Either b c)) -> LogAction m b -> LogAction m c -> LogAction m a
 chooseM f (LogAction actionB) (LogAction actionC) = LogAction (either actionB actionC <=< f)
 {-# INLINE chooseM #-}
@@ -726,6 +741,8 @@ to a one that performs the logging in the 'IO' monad using:
 @
 hoistLogAction performPureLogsInIO :: LogAction (PureLogger a) a -> LogAction IO a
 @
+
+@since 0.2.1.0
 -}
 hoistLogAction
     :: (forall x. m x -> n x)

co-log-core/src/Colog/Core/Class.hs

@@ -21,6 +21,7 @@ module Colog.Core.Class
 import Colog.Core.Action (LogAction)
 import Data.Functor.Const (Const (..))
 
+
 -- to inline lens better
 {- HLINT ignore "Redundant lambda" -}
 

co-log-core/src/Colog/Core/IO.hs

@@ -33,6 +33,7 @@ import Colog.Core.Action (LogAction (..))
 import Control.Monad.IO.Class (MonadIO, liftIO)
 import System.IO (Handle, IOMode (AppendMode), hPrint, hPutStrLn, stderr, withFile)
 
+
 {- $setup
 >>> import Colog.Core.Action
 -}

co-log-core/src/Colog/Core/Severity.hs

@@ -37,6 +37,7 @@ import Data.Ix (Ix)
 
 import Colog.Core.Action (LogAction (..), cfilter)
 
+
 -- | Severity for the log messages.
 data Severity
     {- | Information useful for debug purposes.
@@ -60,7 +61,7 @@ data Severity
     E.g. exceptional situations: couldn't syncronize accounts.
     -}
     | Error
-    deriving (Show, Read, Eq, Ord, Enum, Bounded, Ix)
+    deriving stock (Show, Read, Eq, Ord, Enum, Bounded, Ix)
 
 {- $pattern
 Instead of using full names of the constructors you can instead use one-letter

co-log-core/test/Doctests.hs

@@ -9,7 +9,8 @@ main :: IO ()
 main = do
     sourceFiles <- glob "src/**/*.hs"
     doctest
-        $ "-XInstanceSigs"
+        $ "-XDerivingStrategies"
+        : "-XInstanceSigs"
         : "-XScopedTypeVariables"
         : "-XViewPatterns"
         : sourceFiles