piotrmurach / tty-progressbar / 155

100%

Pull #27

travis-ci

Do not reset multibar state

I want to use the multibar with docker image push and pull.  The image
push and pull progress shows information for many layers with many
different states.  The same layer will transition through download wait,
downloading, verifying, extract wait, extracting, then completed states

For the downloading and extracting states of a layer I wish to re-use
the same progress bar location in the multibar, but with a different
title.  I can accomplish this with a single progress bar with code like
the following:

	bar = TTY::ProgressBar.new "downloading [:bar] :eta", ...

	bar.start

	n.times do
	  sleep 0.1
	  bar.advance 1
	end

	bar.format.replace "extracting  [:bar] :eta"

	bar.reset

	n.times do
	  sleep 0.1
	  bar.advance 1
	end

This stretches the API of the progress bar a bit by using
String#replace, but otherwise appears to be all-OK for the intended use
of the API.

This does not work with the multibar as the rendering information is
reset.

The documentation says:

> In order to reset currently running or finished progress bar to its
> original configuration and initial position use reset

Since I created the bar I wish to reset through
TTY::ProgressBar::Multi#register I expect the "original configuration" to
include the multibar rendering configuration.

This was not the case.  In #1 the entire configuration is reset
including the multibar rendering configuration.  This means the bars I
reset to show a new stage do not render as part of a multibar.

In order to allow my expected behavior the multibar rendering state
setup is moved to ProgressBar#initialize and never reset.  The only way
to configure a ProgressBar to render as a multi-bar is through
Multi#register and ProgressBar#attach_to (another way to create a
multi-bar), so this seems OK.

3 of 3 new or added lines in 1 file covered. (100.0%)

573 of 595 relevant lines covered (96.3%)

652.42 hits per line