Merge pull request #152 from rofinn/rf/sort-join-readdir

Support join and sort kwargs to both readdir and readpath

Author: rofinn

Project.toml

@@ -1,7 +1,7 @@
 name = "FilePathsBase"
 uuid = "48062228-2e41-5def-b9a4-89aafe57970f"
 authors = ["Rory Finnegan"]
-version = "0.9.15"
+version = "0.9.16"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/path.jl

@@ -702,10 +702,16 @@ function Base.download(url::AbstractPath, localfile::AbstractString)
 end
 
 """
-    readpath(fp::P) where {P <: AbstractPath} -> Vector{P}
+    readpath(fp::P; join=true, sort=true) where {P <: AbstractPath} -> Vector{P}
 """
-function readpath(p::P)::Vector{P} where P <: AbstractPath
-    return P[join(p, f) for f in readdir(p)]
+function readpath(p::P; join=true, sort=true)::Vector{P} where P <: AbstractPath
+    @static if VERSION < v"1.4"
+        results = readdir(p)
+        sort && sort!(results)
+        return join ? joinpath.(p, results) : parse.(P, results)
+    else
+        return parse.(P, readdir(p; join=join, sort=sort))
+    end
 end
 
 """

src/system.jl

@@ -383,7 +383,7 @@ function Base.write(fp::SystemPath, x::Union{String, Vector{UInt8}}, mode="w")
     end
 end
 
-Base.readdir(fp::SystemPath) = readdir(string(fp))
+Base.readdir(fp::SystemPath; kwargs...) = readdir(string(fp); kwargs...)
 
 function Base.download(url::AbstractString, dest::T) where T<:SystemPath
     return parse(T, download(url, string(dest)))

test/testpkg.jl

@@ -65,10 +65,21 @@ Base.cd(f::Function, fp::TestPath) = cd(f, test2posix(fp))
 Base.mkdir(fp::TestPath; kwargs...) = posix2test(mkdir(test2posix(fp); kwargs...))
 Base.symlink(src::TestPath, dest::TestPath; kwargs...) = symlink(test2posix(src), test2posix(dest); kwargs...)
 Base.rm(fp::TestPath; kwargs...) = rm(test2posix(fp); kwargs...)
-Base.readdir(fp::TestPath) = readdir(test2posix(fp))
 Base.read(fp::TestPath) = read(test2posix(fp))
 Base.write(fp::TestPath, x) = write(test2posix(fp), x)
 Base.chown(fp::TestPath, args...; kwargs...) = chown(test2posix(fp), args...; kwargs...)
 Base.chmod(fp::TestPath, args...; kwargs...) = chmod(test2posix(fp), args...; kwargs...)
 
+function Base.readdir(fp::TestPath; join=false, sort=true)
+    p = test2posix(fp)
+    @static if VERSION < v"1.4"
+        return readdir(p)
+    else
+        results = readdir(p; join=join, sort=sort)
+        join || return results
+        # Awkward wrapper that converts the readdir output back to a TestPath string.
+        return string.(posix2test.(parse.(PosixPath, results)))
+    end
+end
+
 end