Merge pull request #44 from brandonchinn178/fixes

Updates + fixes to README examples

Author: brandonchinn178

.circleci/config.yml

@@ -236,6 +236,9 @@ workflows:
       - run_build_and_test:
           name: test_latest
           latest: true
+      - run_build_and_test:
+          name: test_ghc_9.0
+          stack_yaml: stack-ghc-9.0.yaml
       - run_build_and_test:
           name: test_ghc_8.10
           stack_yaml: stack-ghc-8.10.yaml

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Unreleased
 
+# 0.4.0.0
+
+* Add some mtl instances: `MonadThrow`, `MonadCatch`, `MonadMask`, `MonadLogger`, `MonadReader`
+* Removed support for GHC 8.2, 8.4
+* Add `MonadSqlQuery (TransactionM m)` superclass constraint to allow writing functions generic on some `MonadSqlQuery m` using `withTransaction`, as shown in examples in README
+
 # 0.3.0.0
 
 * Add `unsafeLiftSql` ([#38](https://github.com/brandonchinn178/persistent-mtl/pull/38))

README.md

@@ -239,7 +239,7 @@ import Database.PostgreSQL.Simple.Errors (isSerializationError)
 main :: IO ()
 main = withPostgresqlPool "..." 5 $ \pool -> do
   let env = mkSqlQueryEnv pool $ \env -> env
-        { retryIf = isSerializationError . fromException
+        { retryIf = maybe False isSerializationError . fromException
         , retryLimit = 100 -- defaults to 10
         }
 

package.yaml

@@ -1,5 +1,5 @@
 name: persistent-mtl
-version: 0.3.0.0
+version: 0.4.0.0
 maintainer: Brandon Chinn <[email protected]>
 synopsis: Monad transformer for the persistent API
 description: |

persistent-mtl.cabal

@@ -5,7 +5,7 @@ cabal-version: 1.12
 -- see: https://github.com/sol/hpack
 
 name:           persistent-mtl
-version:        0.3.0.0
+version:        0.4.0.0
 synopsis:       Monad transformer for the persistent API
 description:    A monad transformer and mtl-style type class for using the
                 persistent API directly in your monad transformer stack.
@@ -64,6 +64,7 @@ test-suite persistent-mtl-test
   type: exitcode-stdio-1.0
   main-is: Main.hs
   other-modules:
+      Basic
       Example
       Generated
       Integration

src/Database/Persist/Monad/Class.hs

@@ -6,7 +6,9 @@ in order to interpret how to run a
 'Database.Persist.Monad.SqlQueryRep.SqlQueryRep' sent by a lifted function from
 @Database.Persist.Monad.Shim@.
 -}
+{-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE UndecidableSuperClasses #-}
 
 module Database.Persist.Monad.Class
   ( MonadSqlQuery(..)
@@ -29,7 +31,7 @@ import Data.Typeable (Typeable)
 import Database.Persist.Monad.SqlQueryRep (SqlQueryRep)
 
 -- | The type-class for monads that can run persistent database queries.
-class Monad m => MonadSqlQuery m where
+class (Monad m, MonadSqlQuery (TransactionM m)) => MonadSqlQuery m where
   type TransactionM m :: Type -> Type
 
   -- | Interpret the given SQL query operation.

stack-ghc-8.10.yaml

@@ -1,8 +1,7 @@
-resolver: lts-18.4
+resolver: lts-18.18
 
 extra-deps:
-- persistent-postgresql-2.13.0.2
-- explainable-predicates-0.1.2.0
+  - explainable-predicates-0.1.2.0
 
 flags:
   explainable-predicates:

stack-ghc-9.0.yaml

@@ -0,0 +1,11 @@
+resolver: nightly-2021-12-16
+
+extra-deps:
+  - explainable-predicates-0.1.2.0
+
+flags:
+  explainable-predicates:
+    regex: false
+
+ghc-options:
+  "$locals": -Werror

stack.yaml

@@ -1 +1 @@
-stack-ghc-8.8.yaml
+stack-ghc-8.10.yaml

stack.yaml.lock

@@ -11,16 +11,9 @@ packages:
       sha256: b7423cfba1171b8c2a500e337b66eb40bbb5d4a6a99e6ce6463d637fe118ebe0
   original:
     hackage: explainable-predicates-0.1.2.0
-- completed:
-    hackage: syb-0.7.2.1@sha256:bf42655a213402215299e435c52f799e76cbec0b984cd7153d6b9af8a1c0803f,3815
-    pantry-tree:
-      size: 3396
-      sha256: 3ee55cc33d69da2953e7093f99199fbc0bfa9d90dccd19cac101d09befa5bbb3
-  original:
-    hackage: syb-0.7.2.1
 snapshots:
 - completed:
-    size: 534126
-    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/16/31.yaml
-    sha256: 637fb77049b25560622a224845b7acfe81a09fdb6a96a3c75997a10b651667f6
-  original: lts-16.31
+    size: 586296
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/18.yaml
+    sha256: 63539429076b7ebbab6daa7656cfb079393bf644971156dc349d7c0453694ac2
+  original: lts-18.18

test/Basic.hs

@@ -0,0 +1,31 @@
+{-# LANGUAGE GADTs #-}
+{-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE TypeApplications #-}
+
+module Basic where
+
+import Test.Tasty
+import Test.Tasty.HUnit
+
+import Database.Persist.Monad
+import Database.Persist.Monad.TestUtils
+import Example
+
+tests :: TestTree
+tests = testGroup "Basic functionality tests"
+  [ testCase "Ensure withTransaction README example typechecks" $ do
+      let foo :: MonadSqlQuery m => m ()
+          foo = insert_ $ person "Alice"
+          bar :: MonadSqlQuery m => m ()
+          bar = insert_ $ person "Bob"
+          fooAndBar :: MonadSqlQuery m => m ()
+          fooAndBar = withTransaction $ foo >> bar
+      runMockSqlQueryT fooAndBar
+        [ withRecord @Person $ \case
+            Insert_ _ -> Just ()
+            _ -> Nothing
+        , withRecord @Person $ \case
+            Insert_ _ -> Just ()
+            _ -> Nothing
+        ]
+  ]

test/Main.hs

@@ -1,5 +1,6 @@
 import Test.Tasty
 
+import qualified Basic
 import qualified Integration
 import qualified MockSqlQueryT
 import qualified Mocked
@@ -10,7 +11,8 @@ main = defaultMain tests
 
 tests :: TestTree
 tests = testGroup "persistent-mtl"
-  [ Mocked.tests
+  [ Basic.tests
+  , Mocked.tests
   , Integration.tests
   , MockSqlQueryT.tests
   , SqlQueryRepTest.tests