Add Compat.readuntil

This is to allow for the `keep` keyword argument.

README.md

@@ -179,6 +179,8 @@ Currently, the `@compat` macro supports the following syntaxes:
 
 * `Compat.eachline` with `keep` keyword argument ([#25646])
 
+* `Compat.readuntil` with `keep` keyword argument ([#25646])
+
 * `take!` method for `Task`s since some functions now return `Channel`s instead of `Task`s ([#19841])
 
 * The `isabstract`, `parameter_upper_bound`, `typename` reflection methods were added in Julia 0.6. This package re-exports these from the `Compat.TypeUtils` submodule. On earlier versions of julia, that module contains the same functions, but operating on the pre-0.6 type system representation.

src/Compat.jl

@@ -341,6 +341,25 @@ end
     # chomp parameter preserved for compatibility with earliear Compat versions
     readline(s::IO=STDIN; chomp::Bool=true, keep::Bool=!chomp) = Base.readline(s; chomp=!keep)
     eachline(s; keep::Bool=false) = Base.eachline(s; chomp=!keep)
+
+    stripdelim(s, d::Union{Char,UInt8}) = s[end] == Char(d) ? s[1:prevind(s,lastindex(s))] : s
+    function stripdelim(s, d::AbstractString)
+        !endswith(s, d) && return s
+        i = lastindex(s)
+        for k = 1:length(d)
+            i = prevind(s, i)
+        end
+        return s[1:i]
+    end
+    function readuntil(f, d; keep::Bool = false)
+        s = Base.readuntil(f, d)
+        if keep || isempty(s)
+            return s
+        else
+            return stripdelim(s, d)
+        end
+    end
+    readuntil(f, d::T; keep::Bool = false) where {T<:AbstractVector} = convert(T, readuntil(f, String(d), keep=keep))
 end
 
 # https://github.com/JuliaLang/julia/pull/18727

test/runtests.jl

@@ -577,6 +577,39 @@ end
 @test collect(Compat.eachline(IOBuffer("x\ny"), keep=false)) == ["x", "y"]
 @test collect(Compat.eachline(IOBuffer("x\ny"), keep=true))  == ["x\n", "y"]
 
+# PR 25646
+for (t, s, m, kept) in [
+        ("a", "ab", "a", "a"),
+        ("b", "ab", "b", "b"),
+        ("α", "αγ", "α", "α"),
+        ("ab", "abc", "ab", "ab"),
+        ("bc", "abc", "bc", "bc"),
+        ("αβ", "αβγ", "αβ", "αβ"),
+        ("aaabc", "ab", "aa", "aaab"),
+        ("aaabc", "ac", "aaabc", "aaabc"),
+        ("aaabc", "aab", "a", "aaab"),
+        ("aaabc", "aac", "aaabc", "aaabc"),
+        ("αααβγ", "αβ", "αα", "αααβ"),
+        ("αααβγ", "ααβ", "α", "αααβ"),
+        ("αααβγ", "αγ", "αααβγ", "αααβγ"),
+        ("barbarbarians", "barbarian", "bar", "barbarbarian"),
+        ("abcaabcaabcxl", "abcaabcx", "abca", "abcaabcaabcx"),
+        ("abbaabbaabbabbaax", "abbaabbabbaax", "abba", "abbaabbaabbabbaax"),
+        ("abbaabbabbaabbaabbabbaax", "abbaabbabbaax", "abbaabbabba", "abbaabbabbaabbaabbabbaax"),
+       ]
+    local t, s, m, kept
+    @test Compat.readuntil(IOBuffer(t), s) == m
+    @test Compat.readuntil(IOBuffer(t), s, keep=true) == kept
+    @test Compat.readuntil(IOBuffer(t), SubString(s, firstindex(s))) == m
+    @test Compat.readuntil(IOBuffer(t), SubString(s, firstindex(s)), keep=true) == kept
+    @test Compat.readuntil(IOBuffer(t), GenericString(s)) == m
+    @test Compat.readuntil(IOBuffer(t), GenericString(s), keep=true) == kept
+    @test Compat.readuntil(IOBuffer(t), Vector{UInt8}(codeunits(s))) == Vector{UInt8}(codeunits(m))
+    @test Compat.readuntil(IOBuffer(t), Vector{UInt8}(codeunits(s)), keep=true) == Vector{UInt8}(codeunits(kept))
+    @test Compat.readuntil(IOBuffer(t), collect(s)::Vector{Char}) == Vector{Char}(m)
+    @test Compat.readuntil(IOBuffer(t), collect(s)::Vector{Char}, keep=true) == Vector{Char}(kept)
+end
+
 # PR 18727
 let
     iset = Set([17, 4711])