Implement IOContextCarrier to bundle

arguments to IOContext with an object.
tkf · Jan 14, 2021 · 4d8c443 · 4d8c443
1 parent 47e75ea
commit 4d8c443
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 18 deletions.
diff --git a/src/DisplayAs.jl b/src/DisplayAs.jl
@@ -107,35 +107,35 @@ for (name, mime) in _showables
 end
 
 """
-    Unlimited
+    IOContextCarrier(x, kv::Pair...)
 
-Unlimit display size.  Useful for, e.g., printing all contents of
-dataframes in a Jupyter notebook.
+Bundle arguments for `IOContext` with an object `x`.
 
 # Examples
-```
-julia> using DisplayAs, VegaDatasets
+```julia-repl
+julia> using DisplayAs
 
-julia> data = dataset("cars");
+julia> data = rand(2, 2)
+2×2 Array{Float64,2}:
+ 0.786992  0.576265
+ 0.321868  0.791263
 
-julia> data |> DisplayAs.Unlimited
+julia> DisplayAs.IOContextCarrier(data, :compact => false)
+2×2 Array{Float64,2}:
+ 0.7869920812675713   0.5762653628115182
+ 0.32186846202784314  0.791263230914472
 ```
 """
-struct Unlimited
+struct IOContextCarrier
     content
+    context::Dict{Symbol,Any}
 end
+IOContextCarrier(obj, kv::Pair...) = IOContextCarrier(obj, Dict{Symbol,Any}(kv...))
 
-Base.showable(::MIME{mime}, x::Unlimited) where {mime} =
+Base.showable(::MIME{mime}, x::IOContextCarrier) where {mime} =
     hasmethod(show, Tuple{IO, MIME{mime}, typeof(x)}) &&
     showable(MIME(mime), x.content)
 
-unlimit(io) = IOContext(
-    io,
-    :compact => false,
-    :limit => false,
-    :displaysize => (typemax(Int), typemax(Int)),
-)
-
 _textmimes = [m for (_, m) in _showables if startswith(m, "text/")]
 _textmimes = [
     _textmimes
@@ -160,8 +160,30 @@ _textmimes = [
 
 for mime in _textmimes
     mimetype = MIME{Symbol(mime)}
-    @eval Base.show(io::IO, ::$mimetype, obj::Unlimited) =
-        show(unlimit(io), $mimetype(), obj.content)
+    @eval function Base.show(io::IO, ::$mimetype, obj::IOContextCarrier)
+        ioc = IOContext(io, obj.context...)
+        show(ioc, $mimetype(), obj.content)
+    end
+end
+
+"""
+    Unlimited
+
+Unlimit display size. Useful for, e.g., printing all contents of
+dataframes in a Jupyter notebook.
+
+# Examples
+```
+julia> using DisplayAs, VegaDatasets
+
+julia> data = dataset("cars");
+
+julia> data |> DisplayAs.Unlimited
+```
+"""
+function Unlimited(x)
+    IOContextCarrier(x, :compact => false, :limit => false,
+                        :displaysize => (typemax(Int), typemax(Int)))
 end
 
 end # module
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,6 +1,13 @@
 using DisplayAs
 using Test
 
+struct PrintContext end
+function Base.show(io::IO, ::MIME"text/plain", ::PrintContext)
+    print(io, get(io, :compact, "-"), "/")
+    print(io, get(io, :limit, "-"), "/")
+    print(io, get(io, :displaysize, "-"))
+end
+
 @testset "DisplayAs.jl" begin
     @test showable("text/plain", DisplayAs.Text(nothing))
     @test showable("text/html", DisplayAs.HTML(nothing))
@@ -10,6 +17,18 @@ using Test
     @test showable("text/plain", text_png)
     @test showable("image/png", text_png)
     @test !showable("image/html", text_png)
+    # IOContextCarrier
+    iob = IOBuffer()
+    ioc = IOContext(iob, :compact=>true, :limit=>true, :displaysize=>(24, 80))
+    show(ioc, MIME"text/plain"(), PrintContext())
+    @test String(take!(iob)) == "true/true/(24, 80)"
+    show(ioc, MIME"text/plain"(), DisplayAs.IOContextCarrier(PrintContext()))
+    @test String(take!(iob)) == "true/true/(24, 80)"
+    show(ioc, MIME"text/plain"(), DisplayAs.IOContextCarrier(PrintContext(), :limit=>false))
+    @test String(take!(iob)) == "true/false/(24, 80)"
+    # Unlimited
+    show(ioc, MIME"text/plain"(), DisplayAs.Unlimited(PrintContext()))
+    @test String(take!(iob)) == "false/false/($(typemax(Int)), $(typemax(Int)))"
 end
 
 using Aqua