Rename mkSimErrorHasFS to simErrorHasFS

Author: jorisdral

fs-sim/CHANGELOG.md

@@ -20,6 +20,8 @@
   breaking changes:
   * Add a `PrimMonad m` constraint to `runSimErrorFS`, `mkSimErrorHasFS'` and `mkSimErrorHasFS`.
   * Change the `StrictTVar` argument to `mkSimErrorHasFS` to a `StrictTMVar`.
+* Rename `mkSimErrorHasFS` to `simErrorHasFS`.
+* Rename `mkSimErrorHasFS'` to `simErrorHasFS'`.
 
 ### Non-breaking
 

fs-sim/src/System/FS/Sim/Error.hs

@@ -10,8 +10,8 @@
 -- testing error handling.
 module System.FS.Sim.Error (
     -- * Simulate Errors monad
-    mkSimErrorHasFS
-  , mkSimErrorHasFS'
+    simErrorHasFS
+  , simErrorHasFS'
   , runSimErrorFS
   , withErrors
     -- * Streams
@@ -481,22 +481,21 @@ instance Arbitrary Errors where
   Simulate Errors monad
 -------------------------------------------------------------------------------}
 
--- | Alternative to 'mkSimErrorHasFS' that creates 'TVar's internally.
-mkSimErrorHasFS' :: (MonadSTM m, MonadThrow m, PrimMonad m)
+-- | Alternative to 'simErrorHasFS' that creates 'TVar's internally.
+simErrorHasFS' :: (MonadSTM m, MonadThrow m, PrimMonad m)
                  => MockFS
                  -> Errors
                  -> m (HasFS m HandleMock)
-mkSimErrorHasFS' mockFS errs =
-    mkSimErrorHasFS <$> newTMVarIO mockFS <*> newTVarIO errs
+simErrorHasFS' mockFS errs =
+    simErrorHasFS <$> newTMVarIO mockFS <*> newTVarIO errs
 
 -- | Introduce possibility of errors
---
--- TODO: Lenses would be nice for the setters
-mkSimErrorHasFS :: forall m. (MonadSTM m, MonadThrow m, PrimMonad m)
+simErrorHasFS :: forall m. (MonadSTM m, MonadThrow m, PrimMonad m)
                 => StrictTMVar m MockFS
                 -> StrictTVar m Errors
                 -> HasFS m HandleMock
-mkSimErrorHasFS fsVar errorsVar =
+simErrorHasFS fsVar errorsVar =
+    -- TODO: Lenses would be nice for the setters
     case Sim.simHasFS fsVar of
       hfs@HasFS{..} -> HasFS{
           dumpState =
@@ -547,7 +546,7 @@ mkSimErrorHasFS fsVar errorsVar =
             withErr errorsVar p1 (renameFile p1 p2) "renameFile"
             renameFileE (\e es -> es { renameFileE = e })
         , mkFsErrorPath = fsToFsErrorPathUnmounted
-        , unsafeToFilePath = error "mkSimErrorHasFS:unsafeToFilePath"
+        , unsafeToFilePath = error "simErrorHasFS:unsafeToFilePath"
           -- File I\/O with user-supplied buffers
         , hGetBufSome   = hGetBufSomeWithErr   errorsVar hfs
         , hGetBufSomeAt = hGetBufSomeAtWithErr errorsVar hfs
@@ -565,7 +564,7 @@ runSimErrorFS :: (MonadSTM m, MonadThrow m, PrimMonad m)
 runSimErrorFS mockFS errors action = do
     fsVar     <- newTMVarIO mockFS
     errorsVar <- newTVarIO errors
-    a         <- action errorsVar $ mkSimErrorHasFS fsVar errorsVar
+    a         <- action errorsVar $ simErrorHasFS fsVar errorsVar
     fs'       <- atomically $ takeTMVar fsVar
     return (a, fs')
 

fs-sim/src/System/FS/Sim/MockFS.hs

@@ -859,9 +859,8 @@ renameFile fpOld fpNew =
 -------------------------------------------------------------------------------}
 
 -- | Renders the 'MockFS' in a human-readable fashion.
---
--- TODO: Right now does this not show the state of the handles.
 pretty :: MockFS -> String
+-- TODO: Right now does this not show the state of the handles.
 pretty = FS.pretty renderFile . mockFiles
   where
     renderFile :: ByteString -> String

fs-sim/src/System/FS/Sim/Prim.hs

@@ -42,7 +42,7 @@ runFSSimT act !st = runExceptT $ flip runStateT st $ unFSSimT act
 --
 -- This implementation runs in a primitive monad @m@ extended with an 'FSSimT'
 -- monad transformer. It is recommended to use 'System.FS.Sim.STM.simHasFS' or
--- 'System.FS.Sim.Error.mkSimErrorHasFS' instead because they hide the monad
+-- 'System.FS.Sim.Error.simErrorHasFS' instead because they hide the monad
 -- transformer. The caveat is that @m@ should be IO-like.
 primHasMockFS :: PrimMonad m => HasFS (FSSimT m) Mock.HandleMock
 -- An alternative design could have fixed this implementation to

fs-sim/test/Test/System/FS/Sim/Error.hs

@@ -175,7 +175,7 @@ propPutterPutsAll getCounter put toInput (SometimesPartialWrites errStream) bs =
       fsVar <- newTMVarIO MockFS.empty
       errVar <- newTVarIO onlyPutErrors
       counters <- zeroEntryCounters
-      let hfs = withEntryCounters counters $ mkSimErrorHasFS fsVar errVar
+      let hfs = withEntryCounters counters $ simErrorHasFS fsVar errVar
       withFile hfs (mkFsPath ["file1"]) (ReadWriteMode MustBeNew) $ \h -> do
         inp <- toInput bs
         n' <- put hfs h inp
@@ -222,7 +222,7 @@ propGetterGetsAll getCounter get fromOutput (SometimesPartialReads errStream) bs
       fsVar <- newTMVarIO MockFS.empty
       errVar <- newTVarIO onlyGetErrors
       counters <- zeroEntryCounters
-      let hfs = withEntryCounters counters $ mkSimErrorHasFS fsVar errVar
+      let hfs = withEntryCounters counters $ simErrorHasFS fsVar errVar
       withFile hfs (mkFsPath ["file1"]) (ReadWriteMode MustBeNew) $ \h -> do
         n' <- Strict.hPutAllStrict hfs h bs
         let n = fromIntegral $ BS.length bs