Merge pull request #89 from rofinn/rf/filebuffer-io

Add byte I/O support for FileBuffer

Author: rofinn

Project.toml

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

src/buffer.jl

@@ -61,6 +61,14 @@ function Base.read(buffer::FileBuffer, ::Type{String})
     read(buffer.io, String)
 end
 
+function Base.read(buffer::FileBuffer, ::Type{UInt8})
+    if buffer.io.size == 0
+        write(buffer.io, read(buffer.path))
+        seekstart(buffer)
+    end
+    read(buffer.io, UInt8)
+end
+
 #=
 NOTE: We need to define multiple methods because of ambiguity error with base IO methods.
 =#
@@ -74,6 +82,11 @@ function Base.write(buffer::FileBuffer, x::String)
     write(buffer.io, x)
 end
 
+function Base.write(buffer::FileBuffer, x::UInt8)
+    iswritable(buffer) || throw(ArgumentError("write failed, FileBuffer is not writeable"))
+    write(buffer.io, x)
+end
+
 function Base.flush(buffer::FileBuffer)
     if iswritable(buffer)
         seekstart(buffer)

test/buffer.jl

@@ -17,6 +17,16 @@ using FilePathsBase: FileBuffer
         finally
             close(io)
         end
+
+        io = FileBuffer(p)
+        try
+            for b in read(p)
+                @test read(io, UInt8) == b
+            end
+            @test eof(io)
+        finally
+            close(io)
+        end
     end
 
     @testset "write" begin
@@ -45,6 +55,23 @@ using FilePathsBase: FileBuffer
                 finally
                     close(io)
                 end
+
+                rm(p2)
+
+                io = FileBuffer(p2; read=true,write=true)
+                try
+                    write(io, read(p1))
+                    flush(io)
+
+                    seekstart(io)
+                    for b in read(p1)
+                        write(io, b)
+                    end
+                    flush(io)
+                    @test read(p1) == read(p2)
+                finally
+                    close(io)
+                end
             end
         end
     end

test/system.jl

@@ -384,7 +384,6 @@ ps = PathSet(; symlink=true)
                     @test ispath("cpstr")
 
                     # Recursive directory
-                    @show docsdir
                     @test cp(docsdir, p"cpdstpath"; force=true) == p"cpdstpath"
                     @test ispath(p"cpdstpath")
                     @test ispath(p"cpdstpath/src/api.md")