Remove path manipulation functions

These will be published in a separate module.

Author: tarleb

README.md

@@ -258,239 +258,6 @@ Returns:
 
 - The result(s) of the call to `callback`
 
-### Path Manipulation Functions
-
-This library includes wrappers around the following functions from
-the [filepath] library for the current platform (POSIX or
-Windows). All examples below are for [POSIX systems].
-
-#### drop_extension
-
-`drop_extension (filepath)`
-
-Remove last extension, and the `.` preceding it.
-
-```lua
-drop_extension("/directory/path.ext") == "/directory/path"
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- The modified filepath without extension (string).
-
-This function wraps [System.FilePath.dropExtension].
-
-#### has_extension
-
-`has_extensions (filepath)`
-
-Does the given filename have an extension?
-
-```lua
-has_extension("/directory/path.ext") == true
-has_extension("/directory/path") == false
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- `true` iff `filepath` has an extension, `false` otherwise
-  (boolean).
-
-This function wraps [System.FilePath.hasExtension].
-
-#### is_absolute
-
-`is_absolute (filepath)`
-
-Is a path absolute? (same as `not is_relative(filepath)`)
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- `true` iff `filepath` is an absolute path, `false` otherwise
-  (boolean).
-
-This function wraps [System.FilePath.isAbsolute].
-
-#### is_relative
-
-`ìs_relative (filepath)`
-
-Is a path relative, or is it fixed to the root?
-
-```lua
-is_relative("test/path") == true
-is_relative("/test") == false
-is_relative("/") == false
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- `true` iff `filepath` is a relative path, `false` otherwise
-  (boolean).
-
-This function wraps [System.FilePath.isRelative].
-
-#### join_path
-
-`join_path (filepaths)`
-
-Join path elements back together by the directory separator.
-
-```lua
-join_path({"/","directory/","file.ext"}) == "/directory/file.ext"
-```
-
-Parameters:
-
-`filepaths`
-:   list of path strings
-
-Returns:
-
-- The joined path (string).
-
-This function wraps [System.FilePath.joinPath].
-
-#### normalise
-
-`normalise (filepath)`
-
-Normalise a path. See examples [here][System.FilePath.normalize].
-<!-- TODO explain so it becomes understandable without a link -->
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- The normalised path (string).
-
-This function wraps [System.FilePath.normalise].
-
-#### split_directories
-
-`split_directories (filepath)`
-
-Split a path by the directory separator.
-
-```lua
-split_directories("/directory/file.ext") == {"/","directory","file.ext"}
-split_directories("test/file") == {"test","file"}
-split_directories("/test/file") == {"/","test","file"}
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- A list of all directory paths (list of strings).
-
-This function wraps [System.FilePath.splitDirectories].
-
-#### take_directory
-
-`take_directory (filepath)`
-
-Get the directory name, move up one level.
-
-```lua
-take_directory("/foo/bar/baz") == "/foo/bar"
-take_directory("/foo/bar/baz/") == "/foo/bar/baz"
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- The filepath up to the last directory separator (string).
-
-This function wraps [System.FilePath.takeDirectory].
-
-#### take_extensions
-
-`take_extensions (filepath)`
-
-Get all extensions.
-
-```lua
-take_extensions("/directory/path.ext") == ".ext"
-take_extensions("file.tar.gz") == ".tar.gz"
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- String of all extensions (string).
-
-This function wraps [System.FilePath.takeExtensions].
-
-#### take_filename
-
-`take_filename (filepath)`
-
-Get the file name.
-
-```lua
-take_filename("/directory/file.ext") == "file.ext"
-take_filename("test/") == ""
-```
-
-Parameters:
-
-`filepath`
-:   path (string)
-
-Returns:
-
-- The file name (string).
-
-This function wraps [System.FilePath.takeFileName].
-
-
-[filepath]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath.html
-[POSIX systems]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html
-[System.FilePath.dropExtension]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:dropExtension
-[System.FilePath.hasExtension]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:hasExtension
-[System.FilePath.isAbsolute]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:isAbsolute
-[System.FilePath.isRelative]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:isRelative
-[System.FilePath.joinPath]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:joinPath
-[System.FilePath.normalise]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:normalise
-[System.FilePath.splitDirectories]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:splitDirectories.
-[System.FilePath.takeDirectory]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeDirectory
-[System.FilePath.takeExtensions]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeExtensions.
-[System.FilePath.takeFileName]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeFileName.
 
 License
 -------

hslua-module-system.cabal

@@ -36,7 +36,6 @@ library
                      , containers >= 0.5    && < 0.7
                      , directory  >= 1.3    && < 1.4
                      , exceptions >= 0.8    && < 0.11
-                     , filepath   >= 1.4    && < 1.5
                      , hslua      >= 1.0.3  && < 1.2
                      , temporary  >= 1.2    && < 1.4
   default-extensions:  LambdaCase

src/Foreign/Lua/Module/System.hs

@@ -33,18 +33,6 @@ module Foreign.Lua.Module.System (
   , with_env
   , with_tmpdir
   , with_wd
-
-  -- * Path manipulations
-  , drop_extensions
-  , has_extension
-  , is_absolute
-  , is_relative
-  , join_path
-  , normalise
-  , split_directories
-  , take_directory
-  , take_extensions
-  , take_filename
   )
 where
 
@@ -62,7 +50,6 @@ import qualified System.Directory as Directory
 import qualified System.Environment as Env
 import qualified System.Info as Info
 import qualified System.IO.Temp as Temp
-import qualified System.FilePath as Fp
 
 --
 -- Module
@@ -88,17 +75,6 @@ pushModule = do
   Lua.addfunction "with_env" with_env
   Lua.addfunction "with_tmpdir" with_tmpdir
   Lua.addfunction "with_wd" with_wd
-  -- * Path manipulations
-  Lua.addfunction "take_directory"    take_directory
-  Lua.addfunction "take_filename"     take_filename
-  Lua.addfunction "take_extensions"   take_extensions
-  Lua.addfunction "split_directories" split_directories
-  Lua.addfunction "has_extension"     has_extension
-  Lua.addfunction "drop_extensions"   drop_extensions
-  Lua.addfunction "join_path"         join_path
-  Lua.addfunction "is_relative"       is_relative
-  Lua.addfunction "is_absolute"       is_absolute
-  Lua.addfunction "normalise"         normalise
   return 1
 
 -- | Add the @system@ module under the given name to the table of
@@ -229,47 +205,3 @@ with_tmpdir parentDir tmpl callback =
       -- all args given. Second value must be converted to a string.
       tmpl' <- Lua.peek (fromAnyValue tmpl)
       Temp.withTempDirectory parentDir tmpl' (invokeWithFilePath callback')
-
---
--- Path manipulations
---
-
--- | See @System.FilePath.dropExtension@
-drop_extensions :: FilePath -> Lua String
-drop_extensions fp = return (Fp.dropExtensions fp)
-
--- | See @System.FilePath.hasExtension@
-has_extension :: FilePath -> Lua Bool
-has_extension fp = return (Fp.hasExtension fp)
-
--- | See @System.FilePath.isAbsolute@
-is_absolute :: FilePath -> Lua Bool
-is_absolute fp = return (Fp.isAbsolute fp)
-
--- | See @System.FilePath.isRelative@
-is_relative :: FilePath -> Lua Bool
-is_relative fp = return (Fp.isRelative fp)
-
--- | See @System.FilePath.joinPath@
-join_path :: [FilePath] -> Lua FilePath
-join_path fps = return (Fp.joinPath fps)
-
--- | See @System.FilePath.normalise@
-normalise :: FilePath -> Lua FilePath
-normalise fp = return (Fp.normalise fp)
-
--- | See @System.FilePath.splitDirectories@
-split_directories :: FilePath -> Lua [FilePath]
-split_directories fp = return (Fp.splitDirectories fp)
-
--- | See @System.FilePath.takeDirectory@
-take_directory :: FilePath -> Lua FilePath
-take_directory fp = return (Fp.takeDirectory fp)
-
--- | See @System.FilePath.takeExtensions@
-take_extensions :: FilePath -> Lua String
-take_extensions fp = return (Fp.takeExtensions fp)
-
--- | See @System.FilePath.takeFilename@
-take_filename :: FilePath -> Lua FilePath
-take_filename fp = return (Fp.takeFileName fp)

test/test-system.lua

@@ -196,56 +196,4 @@ return {
       end)
     end),
   },
-
-  group 'path-manipulations' {
-    test('take_directory', function ()
-      local r = system.take_directory("/a/b/c/d.ext.png")
-      assert.are_equal(r, '/a/b/c')
-    end),
-    test('take_filename', function ()
-      local r = system.take_filename("/a/b/c/d.ext.png")
-      assert.are_equal(r, "d.ext.png")
-    end),
-    test('take_extensions', function ()
-      local r = system.take_extensions("/a/b/c/d.ext.png")
-      assert.are_equal(r, ".ext.png")
-    end),
-    test('drop_extensions', function ()
-      local r = system.drop_extensions("/a/b/c/d.ext.png")
-      assert.are_equal(r, "/a/b/c/d")
-    end),
-    test('has_extension', function ()
-      local r = system.has_extension("/a/b/c/d.ext.png")
-      assert.is_truthy(r)
-      r = system.has_extension("/a/b/c/d")
-      assert.is_falsy(r)
-    end),
-    test('split_directories', function ()
-      local r = system.split_directories("/a/b/c/d.ext.png")
-      local ref = {"/", "a", "b", "c", "d.ext.png"}
-      for index, value in ipairs(r) do
-        assert.are_equal(value, ref[index])
-      end
-    end),
-    test('join_path', function ()
-      local r = system.join_path({"/", "a", "b", "c", "d.ext.png"})
-      assert.are_equal(r, "/a/b/c/d.ext.png")
-    end),
-    test('is_relative', function ()
-      local r = system.is_relative("/a/b/c/d.ext.png")
-      assert.is_falsy(r)
-      r = system.is_relative("a/b/c/d.ext.png")
-      assert.is_truthy(r)
-    end),
-    test('is_absolute', function ()
-      local r = system.is_absolute("/a/b/c/d.ext.png")
-      assert.is_truthy(r)
-      r = system.is_absolute("a/b/c/d.ext.png")
-      assert.is_falsy(r)
-    end),
-    test('normalise', function ()
-      local r = system.normalise("//a/b//././c////d.ext.png")
-      assert.are_equal(r, "/a/b/c/d.ext.png")
-    end)
-  }
 }