From bf56f6dd8c0b0fc34770135819caa54a6410b1df Mon Sep 17 00:00:00 2001
From: Luke Lau <luke_lau@icloud.com>
Date: Wed, 6 Jun 2018 11:47:13 -0400
Subject: [PATCH] Rename recorded to replay

---
 example/Recorded.hs                                  |  6 ------
 haskell-lsp-test.cabal                               | 12 ++----------
 src/Language/Haskell/LSP/Test.hs                     |  2 +-
 src/{ => Language/Haskell/LSP/Test}/Compat.hs        |  2 +-
 .../Haskell/LSP/Test/{Recorded.hs => Replay.hs}      |  8 +++++---
 test/Test.hs                                         |  2 +-
 6 files changed, 10 insertions(+), 22 deletions(-)
 delete mode 100644 example/Recorded.hs
 rename src/{ => Language/Haskell/LSP/Test}/Compat.hs (87%)
 rename src/Language/Haskell/LSP/Test/{Recorded.hs => Replay.hs} (97%)

diff --git a/example/Recorded.hs b/example/Recorded.hs
deleted file mode 100644
index e9b1621..0000000
--- a/example/Recorded.hs
+++ /dev/null
@@ -1,6 +0,0 @@
-import           Language.Haskell.LSP.Test.Recorded
-import           System.Directory
-import           System.Environment
-import           Control.Monad.IO.Class
-
-main = undefined
\ No newline at end of file
diff --git a/haskell-lsp-test.cabal b/haskell-lsp-test.cabal
index 2cd5ce3..2e5969e 100644
--- a/haskell-lsp-test.cabal
+++ b/haskell-lsp-test.cabal
@@ -16,7 +16,7 @@ extra-source-files:  README.md
 library
   hs-source-dirs:      src
   exposed-modules:     Language.Haskell.LSP.Test
-                     , Language.Haskell.LSP.Test.Recorded
+                     , Language.Haskell.LSP.Test.Replay
   default-language:    Haskell2010
   build-depends:       base >= 4.7 && < 5
                      , haskell-lsp-types
@@ -36,7 +36,7 @@ library
     build-depends:     win32
   else
     build-depends:     unix
-  other-modules:       Compat
+  other-modules:       Language.Haskell.LSP.Test.Compat
                        Language.Haskell.LSP.Test.Files
                        Language.Haskell.LSP.Test.Parsing
   ghc-options:         -W
@@ -64,11 +64,3 @@ executable example
                      , lens
                      , text
                      , directory
\ No newline at end of file
-
-executable recorded-example
-  hs-source-dirs:      example
-  main-is:             Recorded.hs
-  default-language:    Haskell2010
-  build-depends:       base >= 4.7 && < 5
-                     , haskell-lsp-test
-                     , directory
diff --git a/src/Language/Haskell/LSP/Test.hs b/src/Language/Haskell/LSP/Test.hs
index 22a6746..ce061e9 100644
--- a/src/Language/Haskell/LSP/Test.hs
+++ b/src/Language/Haskell/LSP/Test.hs
@@ -45,7 +45,7 @@ import Data.Maybe
 import Data.Proxy
 import System.Process
 import Language.Haskell.LSP.Types hiding (error, id)
-import Compat
+import Language.Haskell.LSP.Test.Compat
 import System.IO
 import System.Directory
 import System.FilePath
diff --git a/src/Compat.hs b/src/Language/Haskell/LSP/Test/Compat.hs
similarity index 87%
rename from src/Compat.hs
rename to src/Language/Haskell/LSP/Test/Compat.hs
index 23a3ff1..00f2c0b 100644
--- a/src/Compat.hs
+++ b/src/Language/Haskell/LSP/Test/Compat.hs
@@ -1,6 +1,6 @@
 {-# LANGUAGE CPP #-}
 
-module Compat where
+module Language.Haskell.LSP.Test.Compat where
 
 
 #ifdef mingw32_HOST_OS
diff --git a/src/Language/Haskell/LSP/Test/Recorded.hs b/src/Language/Haskell/LSP/Test/Replay.hs
similarity index 97%
rename from src/Language/Haskell/LSP/Test/Recorded.hs
rename to src/Language/Haskell/LSP/Test/Replay.hs
index 35bd6f3..c9507b5 100644
--- a/src/Language/Haskell/LSP/Test/Recorded.hs
+++ b/src/Language/Haskell/LSP/Test/Replay.hs
@@ -1,9 +1,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE RankNTypes #-}
--- | A testing tool for replaying recorded client logs back to a server,
+-- | A testing tool for replaying captured client logs back to a server,
 -- and validating that the server output matches up with another log.
-module Language.Haskell.LSP.Test.Recorded
+module Language.Haskell.LSP.Test.Replay
   ( replaySession
   )
 where
@@ -27,8 +27,10 @@ import           Language.Haskell.LSP.Test.Files
 import           Language.Haskell.LSP.Test.Parsing
 
 
--- | Replays a recorded client output and 
+-- | Replays a captured client output and 
 -- makes sure it matches up with an expected response.
+-- The session directory should have a captured session file in it
+-- named "session.log".
 replaySession :: FilePath -- ^ The recorded session directory.
               -> IO Bool
 replaySession sessionDir = do
diff --git a/test/Test.hs b/test/Test.hs
index 2bd8f4e..95e3d5e 100644
--- a/test/Test.hs
+++ b/test/Test.hs
@@ -5,7 +5,7 @@ import           Data.Proxy
 import           Control.Monad.IO.Class
 import           Control.Lens hiding (List)
 import           Language.Haskell.LSP.Test
-import           Language.Haskell.LSP.Test.Recorded
+import           Language.Haskell.LSP.Test.Replay
 import           Language.Haskell.LSP.TH.DataTypesJSON
 
 main = hspec $ do
-- 
2.30.2