Rename doesExist to doesItExist

Author: harendra-kumar

README.md

@@ -15,11 +15,11 @@ contents concurrently for improved performance.
 Currently, this library provides implementations for the
 following coreutils-inspired as well as some additional commands:
 
-Filesystem: `cp`, `rm`, `mv`, `ln`, `readlink`, `test`, `stat`, `touch`
-Directories: `ls`, `dirname`, `mkdir`, `cd`, `pwd`, `home` and others
-Text Processing: `cut`, `tail`
-Processes: `sleep`
-Shell: `which`, executing shell commands with streaming
+* Filesystem: `cp`, `rm`, `mv`, `ln`, `readlink`, `test`, `stat`, `touch`
+* Directories: `ls`, `dirname`, `mkdir`, `cd`, `pwd`, `home` and others
+* Text Processing: `cut`, `tail`
+* Processes: `sleep`
+* Shell: `which`, executing shell commands with streaming
 
 ## Important API Notice
 

appveyor.yml

@@ -55,7 +55,7 @@ environment:
     # If you have not committed packcheck.sh in your repo at PACKCHECK_LOCAL_PATH
     # then it is automatically pulled from this URL.
     PACKCHECK_GITHUB_URL: "https://raw.githubusercontent.com/composewell/packcheck"
-    PACKCHECK_GITHUB_COMMIT: "4efa717bc63b4bbd0501a07df5c610849e5d6281"
+    PACKCHECK_GITHUB_COMMIT: "b91dd7daf50d91047ca8c1cce47e8634e34dfcbc"
 
     # Override the temp directory to avoid sed escaping issues
     # See https://github.com/haskell/cabal/issues/5386

src/Streamly/Coreutils/Cp.hs

@@ -112,10 +112,10 @@ cpShouldOverwrite :: CpOverwrite -> FilePath -> FilePath -> IO Bool
 cpShouldOverwrite option src dest =
     case option of
         OverwriteAlways -> return True
-        OverwriteOnly -> test dest doesExist
-        OverwriteNever -> not <$> test dest doesExist
+        OverwriteOnly -> test dest doesItExist
+        OverwriteNever -> not <$> test dest doesItExist
         OverwriteUpdate -> do
-            r <- test dest doesExist
+            r <- test dest doesItExist
             if r
             then test src $ newerThanFile dest
             else return True

src/Streamly/Coreutils/FileTest.hs

@@ -39,7 +39,7 @@
 -- > test -b file        -> isBlockDevice
 -- > test -c file        -> isCharDevice
 -- > test -d file        -> isDir
--- > test -e file        -> doesExist
+-- > test -e file        -> doesItExist
 -- > test -f file        -> isFile
 -- > test -g file        -> hasSetGid
 -- > test -G file        -> isOwnedByCurrentGroup
@@ -63,7 +63,7 @@
 --
 -- Example:
 --
--- > test path doesExist
+-- > test path doesItExist
 -- > test path isReadable
 -- > test path (size (> 4096))
 -- > test path (modifyTimeComparedTo (>) "reference.txt")
@@ -97,7 +97,7 @@ module Streamly.Coreutils.FileTest
 
     -- ** General
     -- , predicate -- exposes FileStatus
-    , doesExist -- XXX doesItExist or doesPathExist
+    , doesItExist
 
     -- ** File Type
     , isDir

src/Streamly/Coreutils/FileTest/Common.hs

@@ -46,7 +46,7 @@
 --
 -- Naming: unary predicates are either isSomething or hasSomething. Binary
 -- predicates are nouns. Predicates are named so that they read well on the
--- call site e.g. "test path doesExist" or "test path isReadable".
+-- call site e.g. "test path doesItExist" or "test path isReadable".
 --
 -- Files supported by windows:
 --
@@ -102,7 +102,7 @@ module Streamly.Coreutils.FileTest.Common
     -- * Predicates
 
     -- ** General
-    , doesExist
+    , doesItExist
 
     -- ** File Type
     , isDir
@@ -418,7 +418,7 @@ applyCatchENOENT f fs =
 -- to lack of permissions. The exception type can be used to determine the
 -- reason for failure.
 --  * test 'isSymLink' always returns false.
---  * test 'doesExist' returns false if the path is symlink but it does not
+--  * test 'doesItExist' returns false if the path is symlink but it does not
 --  point to an existing file.
 --
 test :: FilePath -> FileTest -> IO Bool
@@ -430,7 +430,7 @@ test path (FileTest (Predicate f)) = do
 -- symlink.
 --
 --  * 'isSymLink' returns true if path is a symlink, false otherwise.
---  * 'doesExist' returns true if the link exists irrespective of whether it
+--  * 'doesItExist' returns true if the link exists irrespective of whether it
 --  points to an existing file.
 --  * Predicates related to file permission mode bits are meaningless, and
 --  should not be used.
@@ -493,19 +493,17 @@ false = FileTest $ Predicate $ const (pure False)
 -- with anything else. But as a FileTest the same predicate can be used with
 -- either "test" or "testl" to execute the predicate.
 
--- XXX Rename to doesItExist or pathExists
-
 -- | True if the path exists. In case of symlink whether it tests the link file
 -- or the file pointed to by it depends on whether you use 'test' or 'testl' to
 -- execute the predicate.
 --
 -- Like coreutil @test -e file@
-doesExist :: FileTest
-doesExist = withStatus (const True)
+doesItExist :: FileTest
+doesItExist = withStatus (const True)
 
-{-# DEPRECATED isExisting "Use doesExist instead." #-}
+{-# DEPRECATED isExisting "Use doesItExist instead." #-}
 isExisting :: FileTest
-isExisting = doesExist
+isExisting = doesItExist
 
 ---------------
 -- Type of file

src/Streamly/Coreutils/Ln.hs

@@ -19,7 +19,7 @@ module Streamly.Coreutils.Ln
 where
 
 import Control.Monad (when)
-import Streamly.Coreutils.FileTest (test, doesExist)
+import Streamly.Coreutils.FileTest (test, doesItExist)
 
 import qualified System.PosixCompat.Files as Posix
 
@@ -41,7 +41,7 @@ ln :: (Ln -> Ln) -> FilePath -> FilePath -> IO ()
 ln f src tgt = do
     let opt = f defaultConfig
     when (lnForce opt == False) $ do
-        found <- test tgt doesExist
+        found <- test tgt doesItExist
         when found $ error msg
     case lnSymbolic opt of
         False -> Posix.createLink src tgt

src/Streamly/Coreutils/Rm.hs

@@ -86,7 +86,7 @@ where
 
 import Control.Monad (forM_, when)
 import Streamly.Coreutils.FileTest
-    (doesExist, test, testl, isDir, isWritableByMode)
+    (doesItExist, test, testl, isDir, isWritableByMode)
 #if defined(mingw32_HOST_OS)
 import Streamly.Coreutils.FileTest.Windows (isDirSymLink)
 #endif
@@ -259,7 +259,7 @@ rm f path = do
     -- Note this test is required not just for existence check but also so that
     -- we fail if there is no permission to access the path.
     --
-    found <- testl path doesExist
+    found <- testl path doesItExist
     if found
     then performRm options path
     else

src/Streamly/Coreutils/Touch.hs

@@ -20,7 +20,7 @@ module Streamly.Coreutils.Touch
 where
 
 import Control.Monad (unless)
-import Streamly.Coreutils.FileTest (test, doesExist)
+import Streamly.Coreutils.FileTest (test, doesItExist)
 import System.IO (openFile, IOMode(WriteMode), hClose)
 
 #if !defined (CABAL_OS_WINDOWS)
@@ -65,7 +65,7 @@ touch f path = do
     let opt = f defaultConfig
     if (createNew opt == True && deRef opt == True)
     then do
-        found <- test path doesExist
+        found <- test path doesItExist
         unless found $ openFile path WriteMode >>= hClose
     else
         case deRef opt of

streamly-coreutils.cabal

@@ -184,7 +184,6 @@ test-suite Streamly.Coreutils.Rm
     , hspec
     , streamly-coreutils
     , temporary
-    -- , unix
     , unix-compat
   default-language: Haskell2010
   ghc-options: -main-is Streamly.Test.Coreutils.Rm.main