Merge pull request #151 from rofinn/rf/include

Add include methods for path types

Author: rofinn

Project.toml

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

README.md

@@ -129,4 +129,10 @@ julia> rm(tmpfp; recursive=true)
 
 julia> exists(tmpfp)
 false
+
+# Loading code from paths (e.g., S3Path)
+julia> FilePathsBase.@__INCLUDE__()
+
+julia> include(p"test/testpkg.jl")
+Main.TestPkg
 ```

src/path.jl

@@ -848,3 +848,22 @@ systems as it should limit the number of remote calls where possible.
 """
 diskusage(fp::AbstractPath) = isfile(fp) ? filesize(fp) : diskusage(walkpath(fp))
 diskusage(itr) = mapreduce(filesize, +, itr)
+
+Base.include(m::Module, path::AbstractPath) = Base.include(identity, m, path)
+function Base.include(mapexpr::Function, m::Module, path::AbstractPath)
+    tmp_file = cwd() / string(uuid4(), "-", basename(path))
+    try
+        cp(path, tmp_file; force = true)
+        Base.include(mapexpr, m, string(tmp_file))
+    finally
+        rm(tmp_file; force = true)
+    end
+end
+
+macro __INCLUDE__()
+    return quote
+        m = @__MODULE__
+        m.include(path::AbstractPath) = Base.include(identity, m, path)
+        m.include(mapexpr::Function, path::AbstractPath) = Base.include(mapexpr, m, path)
+    end
+end

src/system.jl

@@ -398,3 +398,7 @@ function canonicalize(fp::T) where T<:SystemPath
 end
 
 Mmap.mmap(fp::SystemPath, args...; kwargs...) = Mmap.mmap(string(fp), args...; kwargs...)
+
+function Base.include(mapexpr::Function, m::Module, path::SystemPath)
+    Base.include(mapexpr, m, string(path))
+end

src/test.jl

@@ -53,6 +53,7 @@ testsets = [
     test_mktmp,
     test_mktmpdir,
     test_download,
+    test_include,
 ]
 
 # Run all the tests
@@ -120,7 +121,8 @@ module TestPaths
         test_mktmpdir,
         test_chown,
         test_chmod,
-        test_download
+        test_download,
+        test_include
 
     """
         PathSet(root::AbstractPath=tmpdir(); symlink=false)
@@ -918,6 +920,14 @@ module TestPaths
         end
     end
 
+    function test_include(ps::PathSet)
+        @testset "include" begin
+            write(ps.quux, "2 + 2\n")
+            res = include(ps.quux)
+            @test res == 4
+        end
+    end
+
     TESTALL = [
         test_registration,
         test_show,
@@ -970,6 +980,7 @@ module TestPaths
         test_chown,
         test_chmod,
         test_download,
+        test_include,
     ]
 
     function test(ps::PathSet, test_sets=TESTALL)

test/runtests.jl

@@ -8,12 +8,15 @@ using Test
 
 using FilePathsBase.TestPaths
 
-include("testpkg.jl")
+# Support including filepaths code
+FilePathsBase.@__INCLUDE__()
+
+include(p"testpkg.jl")
 
 @testset "FilePathsBase" begin
-    include("mode.jl")
-    include("buffer.jl")
-    include("system.jl")
+    include(p"mode.jl")
+    include(p"buffer.jl")
+    include(p"system.jl")
 
     @static if Sys.isunix()
         # Test that our weird registered path works
@@ -23,7 +26,7 @@ include("testpkg.jl")
             @test propertynames(ps.root) == (:drive, :root, :anchor, :separator)
             @test propertynames(ps.root, true) == (:drive, :root, :anchor, :separator, :segments)
         end
-        
+
         @testset "$(typeof(ps.root))" begin
             testsets = [
                 test_registration,
@@ -80,6 +83,7 @@ include("testpkg.jl")
                 test_iswritable,
                 test_chown,
                 test_chmod,
+                test_include,
             ]
 
             # Run all of the automated tests

test/system.jl

@@ -45,6 +45,7 @@ ps = PathSet(; symlink=true)
         test_mktmp,
         test_mktmpdir,
         test_download,
+        test_include,
     ]
 
     if isa(ps.root, PosixPath)
@@ -284,10 +285,10 @@ ps = PathSet(; symlink=true)
             @testset "User/Group constructors" begin
                 my_user = FilePathsBase.User()
                 my_group = FilePathsBase.Group()
-            
+
                 u_int = FilePathsBase.User(UInt(my_user.uid))
                 g_int = FilePathsBase.Group(UInt(my_group.gid))
-            
+
                 @test u_int isa FilePathsBase.User
                 @test g_int isa FilePathsBase.Group
                 @test u_int.uid isa Unsigned