rework default_rendermode and add tests for render

The previous `default_rendermode(format, data)` is problematic that
the render pipeline is showing the original data instead of
the encoded data. That said, `default_rendermode(::SHA256, img)` is wrongly
set to `BeforeAfterFull` -- we shoud never print the whole image array.

Author: johnnychen94

src/render.jl

@@ -9,57 +9,57 @@ struct BeforeAfterLimited <: BeforeAfter end
 struct BeforeAfterFull <: BeforeAfter end
 struct BeforeAfterImage <: BeforeAfter end
 
-render_item(::RenderMode, item) = println(item)
-function render_item(::BeforeAfterLimited, item)
-    show(IOContext(stdout, :limit=>true, :displaysize=>(20,80)), "text/plain", item)
-    println()
+render_item(mode::RenderMode, item) = render_item(stdout, mode, item)
+render_item(io::IO, ::RenderMode, item) = println(io, item)
+function render_item(io::IO, ::BeforeAfterLimited, item)
+    show(IOContext(io, :limit=>true, :displaysize=>(20,80)), "text/plain", item)
+    println(io)
 end
-function render_item(::BeforeAfterImage, item)
+function render_item(io::IO, ::BeforeAfterImage, item::AbstractMatrix)
+    # FIXME: encodeimg only support 2d cases right now
     str_item = @withcolor ImageInTerminal.encodeimg(ImageInTerminal.SmallBlocks(), ImageInTerminal.TermColor256(), item, 20, 40)[1]
-    println("eltype: ", eltype(item))
-    println("size: ", map(length, axes(item)))
-    println("thumbnail:")
-    println.(str_item)
+    println(io, "eltype: ", eltype(item))
+    println(io, "size: ", map(length, axes(item)))
+    println(io, "thumbnail:")
+    foreach(x->println(io, x), str_item)
 end
 
 ## 2 arg form render for comparing
-function render(mode::BeforeAfter, reference, actual)
-    println("- REFERENCE -------------------")
-    render_item(mode, reference)
-    println("-------------------------------")
-    println("- ACTUAL ----------------------")
-    render_item(mode, actual)
-    println("-------------------------------")
+render(mode::RenderMode, args...) = render(stdout, mode, args...)
+function render(io::IO, mode::BeforeAfter, reference, actual)
+    println(io, "- REFERENCE -------------------")
+    render_item(io, mode, reference)
+    println(io, "-------------------------------")
+    println(io, "- ACTUAL ----------------------")
+    render_item(io, mode, actual)
+    println(io, "-------------------------------")
 end
-function render(::Diff, reference, actual)
-    println("- DIFF ------------------------")
-    @withcolor println(deepdiff(reference, actual))
-    println("-------------------------------")
+function render(io::IO, ::Diff, reference, actual)
+    println(io, "- DIFF ------------------------")
+    @withcolor println(io, deepdiff(reference, actual))
+    println(io, "-------------------------------")
 end
 
 ## 1 arg form render for new content
-function render(mode::RenderMode, actual)
-    println("- NEW CONTENT -----------------")
-    render_item(mode, actual)
-    println("-------------------------------")
+function render(io::IO, mode::RenderMode, actual)
+    println(io, "- NEW CONTENT -----------------")
+    render_item(io, mode, actual)
+    println(io, "-------------------------------")
 end
 
+# We set the fallback as limited mode because it is not safe/efficient to fully render anything unless
+#   * we have prior information that it is not long -- numbers
+#   * or, we know how to fully render it efficiently without sending too much noise to IO
+#      - Diff mode for strings
+#      - BeforeAfterImage for images
+# Arrays, in general, should be rendered using limited mode.
 """
-    default_rendermode(::DataFormat, actual)
+    default_rendermode(actual)
 
-Infer the most appropriate render mode according to type of reference file and `actual`.
+Infer the most appropriate render mode according to type of `actual`.
 """
-default_rendermode(::Type{<:DataFormat}, ::Any) = BeforeAfterLimited()
-default_rendermode(::Type{<:DataFormat}, ::AbstractString) = Diff()
-default_rendermode(::Type{<:DataFormat}, ::AbstractArray{<:Colorant}) = BeforeAfterImage()
-
-# plain TXTs
-default_rendermode(::Type{DataFormat{:TXT}}, ::Any) = Diff()
-default_rendermode(::Type{DataFormat{:TXT}}, ::AbstractString) = Diff()
-default_rendermode(::Type{DataFormat{:TXT}}, ::Number) = BeforeAfterFull()
-default_rendermode(::Type{DataFormat{:TXT}}, ::AbstractArray{<:Colorant}) = BeforeAfterImage()
-
-# SHA256
-default_rendermode(::Type{DataFormat{:SHA256}}, ::Any) = BeforeAfterFull()
-default_rendermode(::Type{DataFormat{:SHA256}}, ::AbstractString) = BeforeAfterFull()
-default_rendermode(::Type{DataFormat{:SHA256}}, ::AbstractArray{<:Colorant}) = BeforeAfterLimited()
+default_rendermode(::Type) = BeforeAfterLimited()
+default_rendermode(::Type{T}) where T<:Number = BeforeAfterFull()
+default_rendermode(::Type{T}) where T<:AbstractString = Diff()
+default_rendermode(::Type{T}) where T<:AbstractArray{<:AbstractString} = Diff()
+default_rendermode(::Type{T}) where T<:AbstractArray{<:Colorant} = BeforeAfterImage()

src/test_reference.jl

@@ -103,9 +103,7 @@ function test_reference(
     # infer the default rendermode here
     # since `nothing` is always passed to this method from
     # test_reference(filename::AbstractString, raw_actual; kw...)
-    if rendermode === nothing
-        rendermode = default_rendermode(F, raw_actual)
-    end
+    rendermode === nothing && (rendermode = default_rendermode(T))
 
     actual = maybe_encode(F, raw_actual; kw...)
     # preprocessing when reference file doesn't exists

test/references/render/BeforeAfterFull/arr1_compare.txt

@@ -0,0 +1,6 @@
+- REFERENCE -------------------
+[1 3 5 7; 2 4 6 8]
+-------------------------------
+- ACTUAL ----------------------
+[1 2 3 4 5 6 7 8]
+-------------------------------

test/references/render/BeforeAfterFull/arr1_new.txt

@@ -0,0 +1,3 @@
+- NEW CONTENT -----------------
+[1 2 3 4 5 6 7 8]
+-------------------------------

test/references/render/BeforeAfterFull/arr2_compare.txt

@@ -0,0 +1,6 @@
+- REFERENCE -------------------
+[1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
+-------------------------------
+- ACTUAL ----------------------
+[1, 4, 7, 10, 13, 16, 19]
+-------------------------------

test/references/render/BeforeAfterFull/arr2_new.txt

@@ -0,0 +1,3 @@
+- NEW CONTENT -----------------
+[1, 4, 7, 10, 13, 16, 19]
+-------------------------------

test/references/render/BeforeAfterFull/arr3_compare.txt

@@ -0,0 +1,6 @@
+- REFERENCE -------------------
+[1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0]
+-------------------------------
+- ACTUAL ----------------------
+[1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0]
+-------------------------------

test/references/render/BeforeAfterFull/arr3_new.txt

@@ -0,0 +1,3 @@
+- NEW CONTENT -----------------
+[1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0]
+-------------------------------

test/references/render/BeforeAfterFull/dataframe1_compare.txt

@@ -0,0 +1,18 @@
+- REFERENCE -------------------
+3×2 DataFrame
+│ Row │ v1    │ v2     │
+│     │ Int64 │ String │
+├─────┼───────┼────────┤
+│ 1   │ 1     │ a      │
+│ 2   │ 2     │ b      │
+│ 3   │ 3     │ c      │
+-------------------------------
+- ACTUAL ----------------------
+3×2 DataFrame
+│ Row │ v2    │ v1     │
+│     │ Int64 │ String │
+├─────┼───────┼────────┤
+│ 1   │ 1     │ a      │
+│ 2   │ 2     │ b      │
+│ 3   │ 3     │ c      │
+-------------------------------

test/references/render/BeforeAfterFull/dataframe1_new.txt

@@ -0,0 +1,9 @@
+- NEW CONTENT -----------------
+3×2 DataFrame
+│ Row │ v2    │ v1     │
+│     │ Int64 │ String │
+├─────┼───────┼────────┤
+│ 1   │ 1     │ a      │
+│ 2   │ 2     │ b      │
+│ 3   │ 3     │ c      │
+-------------------------------