fix TermLogger and ProgressLogging compatibility (#263)

Author: brendanjohnharris

src/_tables.jl

@@ -111,10 +111,8 @@ function assert_table_arguments(
     # check footer
     if !isnothing(footer)
         isa(footer, Function) ||
-            (length(footer)) != N_cols && push!(
-                problems,
-                "Got footer with length $(length(footer)), expected $N_cols",
-            )
+            (length(footer)) != N_cols &&
+            push!(problems, "Got footer with length $(length(footer)), expected $N_cols")
         (!isa(footer_style, String) && length(footer_style) != N_cols) && push!(
             problems,
             "Got footer_style with length $(length(footer_style)), expected $N_cols",

src/logs.jl

@@ -1,6 +1,6 @@
 module Logs
 
-using ProgressLogging: asprogress
+using ProgressLogging: asprogress, ProgressLevel
 using InteractiveUtils
 using Dates: Dates
 using Logging
@@ -78,7 +78,7 @@ function TermLogger(io::IO, theme::Theme = TERM_THEME[])
 end
 
 # set logger beavior
-Logging.min_enabled_level(logger::TermLogger) = Logging.Info
+Logging.min_enabled_level(logger::TermLogger) = ProgressLevel
 
 Logging.shouldlog(logger::TermLogger, level, _module, group, id) = true
 Logging.catch_exceptions(logger::TermLogger) = true
@@ -146,10 +146,12 @@ function handle_progress(logger::TermLogger, prog)
 
     # render
     if all(map(j -> j.finished, pbar.jobs))
-        map(j -> removejob!(pbar, j), pbar.jobs)
+        while length(pbar.jobs) > 0
+            removejob!(pbar, first(pbar.jobs))
+        end
         stop!(pbar)
     else
-        render(pbar)
+        render(pbar, logger.io)
     end
 end
 
@@ -322,8 +324,10 @@ function Logging.handle_message(
     _progress = asprogress(lvl, msg, _mod, group, id, file, line; kwargs...)
     isnothing(_progress) || return handle_progress(logger, _progress)
 
-    # generate log 
+    # generate log
     logged = sprint(print_log_message, logger, lvl, msg, _mod, file, line, kwargs)
+    write(logger.io, logged)
+    flush(logger.io)
 
     # restore stdout
     NOCOLOR[] && (logged = cleantext(logged))

src/markdown.jl

@@ -330,8 +330,10 @@ function parse_md(tb::Markdown.Table; width = console_width())::String
     )
 end
 
-parse_md(link::Markdown.Link; kwargs...)::String =
-    "{white bold}$(parse_md(link.text; inline=true)){/white bold} {dim}($(link.url)){/dim}"
+parse_md(
+    link::Markdown.Link;
+    kwargs...,
+)::String = "{white bold}$(parse_md(link.text; inline=true)){/white bold} {dim}($(link.url)){/dim}"
 
 """
     function parse_md(ad::Markdown.Admonition; width = console_width(), kwargs...)::String

src/progress.jl

@@ -186,7 +186,7 @@ function update!(job::ProgressJob; i = nothing)
     if !isnothing(job.N) && job.i ≥ job.N
         stop!(job)
     else
-        job.i += something(i, 1)
+        job.i = something(i, 1 + job.i)
     end
     return nothing
 end
@@ -465,22 +465,22 @@ function render(job::ProgressJob)::String
 end
 
 """
-    render(job::ProgressJob, pbar::ProgressBar)::String
+    render(pbar::ProgressBar, [io=stdout])::String
 
 Render a `ProgressBar`.
 
 When a progress bar is first rendered, this function uses
 ANSI codes to change the scrolling region of the terminal
 window to create a space at the bottom where the bar's visuals
-can be displayed. This allows for thext printed to `stdout` to
+can be displayed. This allows for text printed to `stdout` to
 still be visualized. On subsequent calls, this function
 ensures that the height of the reserved space matches the
 number of running jobs.
 
-All fo this requires a bit of careful work in moving the
+All of this requires a bit of careful work in moving the
 cursor around and doing ANSI magic.
 """
-function render(pbar::ProgressBar)
+function render(pbar::ProgressBar, io = stdout)
     # check if running
     pbar.running || return nothing
 
@@ -539,7 +539,8 @@ function render(pbar::ProgressBar)
 
     # restore position and write
     move_to_line(iob, pbar.renderstatus.scrollline)
-    return print(String(take!(iob)))
+    write(io, String(take!(iob)))
+    return flush(io)
 end
 
 # ---------------------------------------------------------------------------- #

src/renderables.jl

@@ -35,8 +35,9 @@ abstract type AbstractRenderable end
 
 Measure(renderable::AbstractRenderable) = renderable.measure
 
-info(r::AbstractRenderable)::String =
-    "\e[38;5;117m$(typeof(r)) <: AbstractRenderable\e[0m \e[2m(h:$(r.measure.h), w:$(r.measure.w))\e[0m"
+info(
+    r::AbstractRenderable,
+)::String = "\e[38;5;117m$(typeof(r)) <: AbstractRenderable\e[0m \e[2m(h:$(r.measure.h), w:$(r.measure.w))\e[0m"
 
 """
     Base.string(r::AbstractRenderable)::String

src/repr.jl

@@ -113,17 +113,15 @@ function termshow(io::IO, obj::AbstractDict; kwargs...)
 
     # prepare text renderables
     _keys = RenderableText.(short_string.(keys(obj)); style = theme.repr_accent * " bold")
-    ktypes =
-        RenderableText.(
-            map(k -> "{{" * short_string(typeof(k)) * "}}", collect(keys(obj)));
-            style = theme.repr_type * " dim",
-        )
+    ktypes = RenderableText.(
+        map(k -> "{{" * short_string(typeof(k)) * "}}", collect(keys(obj)));
+        style = theme.repr_type * " dim",
+    )
     vals = RenderableText.(short_string.(values(obj)); style = theme.repr_values * " bold")
-    vtypes =
-        RenderableText.(
-            map(k -> "{{" * short_string(typeof(k)) * "}}", collect(values(obj)));
-            style = theme.repr_type * " dim",
-        )
+    vtypes = RenderableText.(
+        map(k -> "{{" * short_string(typeof(k)) * "}}", collect(values(obj)));
+        style = theme.repr_type * " dim",
+    )
 
     content = OrderedDict(
         :type => ktypes,

test/15_test_progress.jl

@@ -5,6 +5,7 @@ import Term.Progress:
     CompletedColumn, SeparatorColumn, ProgressColumn, DescriptionColumn, TextColumn
 
 using ProgressLogging
+import ProgressLogging.Logging.global_logger
 
 @testset "\e[34mProgress - jobs" begin
     pbar = ProgressBar()
@@ -27,7 +28,7 @@ using ProgressLogging
     update!(j1)
     @test j1.i == 1
     update!(j1; i = 10)
-    @test j1.i == 11
+    @test j1.i == 10 # ? In what situation would we want to += i?
 
     @test getjob(pbar, j1.id).id == j1.id
 
@@ -142,12 +143,27 @@ end
         end
     end
 end
-# @testset "\e[34mProgress ProgressLogging" begin
-#     install_term_logger()
-
-#     @test_nothrow begin
-#         @progress "inner... $i" for j in  1:10
-#             sleep(0.01)
-#         end
-#     end
-# end
+@testset "\e[34mProgress ProgressLogging" begin
+    install_term_logger()
+
+    @progress "loop" for j in 1:10
+        sleep(0.01)
+    end
+end
+@testset "\e[34mProgress ProgressLogging custom io" begin
+    buffer = IOBuffer()
+    io = IOContext(buffer, :displaysize => (30, 1000), :color => false)
+
+    logger = Term.Logs.TermLogger(io, Term.TERM_THEME[])
+    global_logger(logger)
+
+    @info "logger message"
+    out = String(take!(buffer))
+    @test occursin("logger message", out)
+
+    @progress "loop" for j in 1:10
+        sleep(0.1)
+    end
+    out = String(take!(buffer))
+    @test occursin("90%", out) # Check it runs to completion
+end