Add getEntity helper method.

This method is similar to `insertEntity`. Closes #616.
yesodweb · Oct 11, 2016 · d8b53d5 · d8b53d5
1 parent f90dd96
commit d8b53d5
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/persistent-test/src/PersistentTest.hs b/persistent-test/src/PersistentTest.hs
@@ -688,6 +688,12 @@ specs = describe "persistent" $ do
       Just p2 <- get k
       p2 @== p
 
+  it "getEntity" $ db $ do
+      Entity k p <- insertEntity $ Person "name" 1 Nothing
+      Just (Entity k2 p2) <- getEntity k
+      p @== p2
+      k @== k2
+
   it "repsert" $ db $ do
       k <- liftIO (PersonKey `fmap` generateKey)
       Nothing <- selectFirst [PersonName ==. "Repsert"] []

diff --git a/persistent/Database/Persist/Class.hs b/persistent/Database/Persist/Class.hs
@@ -11,6 +11,7 @@ module Database.Persist.Class
     , BaseBackend(..)
     , PersistRecordBackend
     , getJust
+    , getEntity
     , belongsTo
     , belongsToJust
     , insertEntity

diff --git a/persistent/Database/Persist/Class/PersistStore.hs b/persistent/Database/Persist/Class/PersistStore.hs
@@ -10,6 +10,7 @@ module Database.Persist.Class.PersistStore
     , PersistCore (..)
     , PersistStoreRead (..)
     , PersistStoreWrite (..)
+    , getEntity
     , getJust
     , belongsTo
     , belongsToJust
@@ -216,3 +217,13 @@ insertEntity ::
 insertEntity e = do
     eid <- insert e
     return $ Entity eid e
+
+-- | Like @get@, but returns the complete @Entity@.
+getEntity ::
+    ( PersistStoreWrite backend
+    , PersistRecordBackend e backend
+    , MonadIO m
+    ) => Key e -> ReaderT backend m (Maybe (Entity e))
+getEntity key = do
+    maybeModel <- get key
+    return $ fmap (key `Entity`) maybeModel