Merge pull request #39 from rofinn/rf/sync

Added a default sync function

Author: rofinn

src/FilePathsBase.jl

@@ -36,7 +36,7 @@ export
     islink,
     cp,
     mv,
-    remove,
+    sync,
     tmpname,
     tmpdir,
     mktmp,

src/path.jl

@@ -513,6 +513,41 @@ function Base.mv(src::AbstractPath, dst::AbstractPath; force=false)
     rm(src; recursive=true)
 end
 
+"""
+    sync(src::AbstractPath, dst::AbstractPath; delete=false)
+
+Recursively copy new and updated files from the source path to the
+destination. If delete is true then files at the destination that don't
+exist at the source will be removed.
+"""
+function sync(src::AbstractPath, dst::AbstractPath; delete=false)
+    # Create an index of all of the source files
+    index = Dict(Tuple(setdiff(p.segments, src.segments)) => p for p in walkpath(src))
+
+    if exists(dst)
+        for p in walkpath(dst)
+            k = Tuple(setdiff(p.segments, dst.segments))
+
+            if haskey(index, k)
+                if modified(index[k]) > modified(p)
+                    cp(index[k], p; force=true)
+                end
+
+                delete!(index, k)
+            elseif delete
+                rm(p; recursive=true)
+            end
+        end
+
+        # Finally, copy over files that don't exist at the destination
+        for (seg, p) in index
+            cp(p, Path(dst, tuple(dst.segments..., seg...)); force=true)
+        end
+    else
+        cp(src, dst)
+    end
+end
+
 """
     download(url::Union{AbstractString, AbstractPath}, localfile::AbstractPath)
 

src/test.jl

@@ -43,6 +43,7 @@ testsets = [
     test_mkdir,
     test_cp,
     test_mv,
+    test_sync,
     test_symlink,
     test_touch,
     test_tmpname,
@@ -103,6 +104,7 @@ module TestPaths
         test_mkdir,
         test_cp,
         test_mv,
+        test_sync,
         test_symlink,
         test_touch,
         test_tmpname,
@@ -608,6 +610,39 @@ module TestPaths
         end
     end
 
+    function test_sync(ps::PathSet)
+        @testset "sync" begin
+            # Base cp case
+            sync(ps.foo, ps.qux / "foo")
+            @test exists(ps.qux / "foo" / "baz.txt")
+
+            # Test that the copied baz file has a newer modified time
+            baz_t = modified(ps.qux / "foo" / "baz.txt")
+            @test modified(ps.baz) < baz_t
+
+            # Don't cp unchanged files when a new file is added
+            # NOTE: sleep before we make a new file, so it's clear tha the
+            # modified time has changed.
+            sleep(1)
+            write(ps.foo / "test.txt", "New File")
+            sync(ps.foo, ps.qux / "foo")
+            @test exists(ps.qux / "foo" / "test.txt")
+            @test read(ps.qux / "foo" / "test.txt", String) == "New File"
+            @test modified(ps.qux / "foo" / "baz.txt") == baz_t
+            @test modified(ps.qux / "foo" / "test.txt") > baz_t
+
+            # Test not deleting a file on sync
+            rm(ps.foo / "test.txt")
+            sync(ps.foo, ps.qux / "foo")
+            @test exists(ps.qux / "foo" / "test.txt")
+
+            # Test passing delete flag
+            sync(ps.foo, ps.qux / "foo"; delete=true)
+            @test !exists(ps.qux / "foo" / "test.txt")
+            rm(ps.qux / "foo"; recursive=true)
+        end
+    end
+
     function test_symlink(ps::PathSet)
         if ps.link
             @testset "symlink" begin

test/system.jl

@@ -32,6 +32,7 @@ ps = PathSet(; symlink=true)
         test_mkdir,
         test_cp,
         test_mv,
+        test_sync,
         test_symlink,
         test_touch,
         test_tmpname,