tty-progressbar 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aedcd9e5ed7d14d3b50023577a864d973f136c24210d9fb3257ef31fb0a17d14
-  data.tar.gz: 5415df0a28f43df5fdcee7c154537d4cec6e47af4a30360f1c840a428ef494d3
+  metadata.gz: d266b064379d48a7f7efa620115e1de7d289d7d469f09ef3879cc1ccaceb71db
+  data.tar.gz: 14ec207136b4910387f398f443351632e12c60744d389c1747a90ddf90cae5cd
 SHA512:
-  metadata.gz: fe9efc020a6f6303fb217858ffc5fb2dd5c6a227e4eb6d02f27b546d02e59efb8022c9fe8d1331651fbf5f384071717063a1cb36ccd8929900f25bbd4a6f58b4
-  data.tar.gz: 3320f20951540bbebb844a2634fc5e2a772b90b0073292b6f464c43737ee01e1cc636b8001b3b271ba264847aa9af68d6b55424c63bdd44cfb43f367f0f776d6
+  metadata.gz: e872707b643d2b01f89fb056f31654f0d6aef50c9665936442c8c9f9cb8310f6bb8af447506d6ff3197284b4365595d475c799dc9d1c4dd20f0bc2d9fc395412
+  data.tar.gz: d695aa270398d79899aea3dcaa58964f6f24ea8888d84cecbb191982cb52717b82526eeb92561ee50af1ec00e1ddba8d0b378c6d5484c8ed70e2e6890f0e07f4

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Change log
 
+## [v0.18.0] - 2021-01-20
+
+### Added
+* Add #resume to allow stopped or paused bar to continue progressing
+* Add :clear_head option to remove head when progress is done
+* Add #configure to allow runtime configuration
+* Add Multi#done? to check if all bar are stopped or finished
+* Add indeterminate progress support when no total is given
+* Add :bar_format option to allow selecting preconfigured bar displays
+* Add :eta_time format token to display the estimated time of day at completion
+* Add measurement of the total elapsed time that ignores stopped time intervals
+* Add #pause to prevent bar from continuing progression and suspend time measurements
+* Add Multi#pause to allow suspending progression of all registered bars at once
+* Add Multi#resume to start again all registered bars that are stopped or paused
+* Add Timer class to handle the total elapsed time measurements
+
+### Changed
+* Change Multi#stopped? to check that all bars are stopped
+* Change gemspec to load version directly and remove test artifacts
+* Change to update strings-ansi and tty-screen dependencies
+* Change Pipeline to inject progress bar instance only once
+* Change :elapsed and :eta to show days after running for 24 hours
+* Change to ensure complete, incomplete and unknown option cannot be an empty string
+* Change to allow setting total to nil via accessor
+* Change gemspec to allow version 2.0 of unicode-display_width dependency
+* Change #stop to show hidden cursor after render similar to #finish
+
+### Fixed
+* Fix MultiBar top bar to allow resuming progress when stopped/done (@d4be4st)
+* Fix MultiBar to only set width when top bar present
+
 ## [v0.17.0] - 2019-05-31
 
 ### Changed
@@ -201,6 +232,7 @@
 
 * Initial implementation and release
 
+[v0.18.0]: https://github.com/piotrmurach/tty-progressbar/compare/v0.17.0...v0.18.0
 [v0.17.0]: https://github.com/piotrmurach/tty-progressbar/compare/v0.16.0...v0.17.0
 [v0.16.0]: https://github.com/piotrmurach/tty-progressbar/compare/v0.15.1...v0.16.0
 [v0.15.1]: https://github.com/piotrmurach/tty-progressbar/compare/v0.15.0...v0.15.1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Piotr Murach
+Copyright (c) 2014 Piotr Murach (piotrmurach.com)
 
 MIT License
 

data/README.md

@@ -1,11 +1,11 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit logo"/></a>
 </div>
 
 # TTY::ProgressBar [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-progressbar.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-progressbar.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/tty-progressbar/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/w3jafjeatt1ulufa?svg=true)][appveyor]
 [![Maintainability](https://api.codeclimate.com/v1/badges/e85416137d2057169575/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-progressbar/badge.svg)][coverage]
@@ -13,41 +13,46 @@
 
 [gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-progressbar
-[travis]: http://travis-ci.org/piotrmurach/tty-progressbar
+[gh_actions_ci]: https://github.com/piotrmurach/tty-progressbar/actions?query=workflow%3ACI
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-progressbar
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty-progressbar/maintainability
 [coverage]: https://coveralls.io/github/piotrmurach/tty-progressbar
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-progressbar
 
-> A flexible progress bars drawing in terminal emulators.
+> A flexible and extensible progress bar for terminal applications.
 
-**TTY::ProgressBar** provides independent progress bars component for [TTY](https://github.com/piotrmurach/tty) toolkit.
+**TTY::ProgressBar** provides independent progress bar component for [TTY](https://github.com/piotrmurach/tty) toolkit.
 
 ## Features
 
-* Fully [configurable](#3-configuration)
-* Extremely flexible progress display [formatting](#4-formatting)
-* Includes many predefined tokens to calculate ETA, Bytes ... [tokens](#41-tokens)
-* Allows to define your [custom tokens](#42-custom-formatters)
-* Supports parallel multi progress bars [multi](#6-ttyprogressbarmulti-api)
-* Handles Unicode characters in progress bar [unicode](#44-unicode)
-* Works on all ECMA-48 compatible terminals
+* **Customisable.** Choose from many [configuration](#3-configuration) options to get the behaviour you want.
+* **Flexible.** Describe bar [format](#4-formatting) and pick from many predefined [tokens](#41-tokens) and [bar styles](#37-bar_format).
+* **Extensible.** Define [custom tokens](#42-custom-formatters) to fit your needs.
+* **Powerful.** Display [multi](#6-ttyprogressbarmulti-api) progress bars in parallel.
+* Show an unbounded operation with [indeterminate](#31-total) progress.
+* [Pause](#210-pause) and [resume](#212-resume) progress at any time.
+* Include [Unicode](#44-unicode) characters in progress bar.
+* Works on all ECMA-48 compatible terminals.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-progressbar'
+gem "tty-progressbar"
 ```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install tty-progressbar
+```
+$ gem install tty-progressbar
+```
 
 ## Contents
 
@@ -62,15 +67,29 @@ Or install it yourself as:
   * [2.7 update](#27-update)
   * [2.8 finish](#28-finish)
   * [2.9 stop](#29-stop)
-  * [2.10 reset](#210-reset)
-  * [2.11 complete?](#211-complete)
-  * [2.12 resize](#212-resize)
-  * [2.13 on](#213-on)
+  * [2.10 pause](#210-pause)
+  * [2.11 reset](#211-reset)
+  * [2.12 resume](#212-resume)
+  * [2.13 complete?](#213-complete)
+  * [2.14 paused?](#214-paused)
+  * [2.15 stopped?](#215-stopped)
+  * [2.16 indeterminate?](#216-indeterminate)
+  * [2.17 resize](#217-resize)
+  * [2.18 on](#218-on)
 * [3. Configuration](#3-configuration)
-  * [3.1 :head](#31-head)
-  * [3.2 :output](#32-output)
-  * [3.3 :frequency](#33-frequency)
-  * [3.4 :interval](#34-interval)
+  * [3.1 :total](#31-total)
+  * [3.1 :width](#32-width)
+  * [3.3 :complete](#33-complete)
+  * [3.4 :incomplete](#34-incomplete)
+  * [3.5 :head](#35-head)
+  * [3.6 :unknown](#36-unknown)
+  * [3.7 :bar_format](#37-bar_format)
+  * [3.8 :output](#38-output)
+  * [3.9 :frequency](#39-frequency)
+  * [3.10 :interval](#310-interval)
+  * [3.11 :hide_cursor](#311-hide_cursor)
+  * [3.12 :clear](#312-clear)
+  * [3.13 :clear_head](#313-clear_head)
 * [4. Formatting](#4-formatting)
   * [4.1 Tokens](#41-tokens)
   * [4.2 Custom Formatters](#42-custom-formatters)
@@ -84,40 +103,63 @@ Or install it yourself as:
   * [6.4 start](#64-start)
   * [6.5 finish](#65-finish)
   * [6.6 stop](#66-stop)
-  * [6.7 complete?](#67-complete)
-  * [6.8 on](#68-on)
-  * [6.9 :style](#69-style)
+  * [6.7 pause](#67-pause)
+  * [6.8 resume](#68-resume)
+  * [6.9 complete?](#69-complete)
+  * [6.10 paused?](#610-paused)
+  * [6.11 stopped?](#611-stopped)
+  * [6.12 on](#612-on)
+  * [6.13 :style](#613-style)
 * [7. Examples](#7-examples)
   * [7.1 Color](#71-color)
   * [7.2 Speed](#72-speed)
 
 ## 1. Usage
 
-**TTY::ProgressBar** requires only format string and total number of steps to completion. Once initialized, use `advance` method to indicated the progress like so:
+**TTY::ProgressBar** requires only a format string with `:bar` [token](#41-tokens) and total number of steps to completion:
 
 ```ruby
 bar = TTY::ProgressBar.new("downloading [:bar]", total: 30)
+```
+
+Once initialized, use [advance](#21-advance) method to indicated progress:
+
+```ruby
 30.times do
   sleep(0.1)
-  bar.advance(1)
+  bar.advance  # by default increases by 1
 end
 ```
 
-This would produce animation in your terminal:
+This would produce the following animation in your terminal:
 
 ```ruby
 # downloading [=======================       ]
 ```
 
-Use **TTY::ProgressBar::Multi** to display multiple parallel progress bars:
+You can further change a progress bar behaviour and display by changing [configuration](#3-configuration) options and using many predefined [tokens](#41-tokens) and [bar formats](#37-bar_format).
+
+When you don't know the total yet, you can set it to `nil` to switch to [indeterminate](#31-total) progress:
+
+```ruby
+# downloading [       <=>                    ]
+```
+
+Use [TTY::ProgressBar::Multi](#6-ttyprogressbarmulti-api) to display multiple parallel progress bars.
+
+Declare a top level bar and then register child bars:
 
 ```ruby
 bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
 
 bar1 = bars.register("one [:bar] :percent", total: 15)
 bar2 = bars.register("two [:bar] :percent", total: 15)
+```
 
-bars.start
+Then progress the child bars in parallel:
+
+```ruby
+bars.start  # starts all registered bars timers
 
 th1 = Thread.new { 15.times { sleep(0.1); bar1.advance } }
 th2 = Thread.new { 15.times { sleep(0.1); bar2.advance } }
@@ -125,7 +167,7 @@ th2 = Thread.new { 15.times { sleep(0.1); bar2.advance } }
 [th1, th2].each { |t| t.join }
 ```
 
-which will produce:
+A possible terminal output may look like this:
 
 ```ruby
 # ┌ main [===============               ] 50%
@@ -137,10 +179,10 @@ which will produce:
 
 ### 2.1 advance
 
-Once you have **TTY::ProgressBar** instance, you can progress the display by calling `advance` method. By default it will increase by `1` but you can pass any number of steps, for instance, when used to advance number of bytes of downloaded file.
+Once you have **TTY::ProgressBar** instance, you can progress the display by calling `advance` method. By default, it will increase by `1` but you can pass any number of steps, for instance, a number of bytes for a downloaded file:
 
 ```ruby
-bar.advance(1000)
+bar.advance(1024)
 ```
 
 You can also pass negative steps if you wish to backtrack the progress:
@@ -149,13 +191,13 @@ You can also pass negative steps if you wish to backtrack the progress:
 bar.advance(-1)
 ```
 
-Note: If a progress bar has already finished then negative steps will not set it back to desired value.
+*Note:* If a progress bar has already finished then any negative steps will not set it back to desired value.
 
 ### 2.2 iterate
 
 To simplify progressing over an enumerable you can use `iterate` which as a first argument accepts an `Enumerable` and as a second the amount to progress the bar with.
 
-First, create a progress bar without a total which will be dynamically handled for you:
+First, create a progress bar without a total which will be automatically updated for you once iteration starts:
 
 ```ruby
 bar = TTY::ProgressBar.new("[:bar]")
@@ -167,7 +209,7 @@ Then, either directly iterate over a collection by yielding values to a block:
 bar.iterate(30.times) { |v| ... }
 ```
 
-or return an `Enumerator`:
+Or return an `Enumerator`:
 
 ```ruby
 progress = bar.iterate(30.times)
@@ -195,7 +237,7 @@ downloader = Enumerator.new do |y|
 end
 ```
 
-would be used with progress bar with the total size matching the content size like so:
+Would be used with progress bar with the total size matching the content size like so:
 
 ```ruby
 bar = TTY::ProgressBar.new("[:bar]", total: content_size)
@@ -209,17 +251,17 @@ Please run [slow_process example](examples/slow_process.rb) to see this in actio
 
 ### 2.3 current=
 
-**TTY::ProgressBar** allows you to set progress to a given value by calling `current=` method.
+A progress doesn't have to start from zero. You can set it to a given value using `current=` method:
 
 ```ruby
 bar.current = 50
 ```
 
-Note: If a progress bar has already finished then negative steps will not set it back to desired value.
+*Note:* If a progress bar has already finished then setting current value will not have any effect.
 
 ### 2.4 ratio=
 
-In order to update overall completion of a progress bar as an exact percentage use the `ratio=` method. The method accepts values between `0` and `1` inclusive. For example, a ratio of 0.5 will attempt to set the progress bar halfway:
+In order to update overall completion of a progress bar as an exact percentage use the `ratio=` method. The method accepts values between `0` and `1` inclusive. For example, a ratio of `0.5` will attempt to set the progress bar halfway:
 
 ```ruby
 bar.ratio = 0.5
@@ -227,13 +269,15 @@ bar.ratio = 0.5
 
 ### 2.5 width=
 
-You can set how many terminal columns will the `:bar` actually span excluding any other tokens and/or text. For example if you need the bar to be always 20 columns wwide do:
+You can set how many terminal columns will the `:bar` actually span excluding any other tokens and/or text.
+
+For example, if you need the bar to be always 20 columns wide do:
 
 ```ruby
 bar.width = 20
 ```
 
-or with configuration options:
+Or with configuration options:
 
 ```ruby
 bar = TTY::ProgressBar.new("[:bar]", width: 20)
@@ -241,7 +285,7 @@ bar = TTY::ProgressBar.new("[:bar]", width: 20)
 
 ### 2.6 start
 
-By default the timer for internal time esitamation is started automatically when the `advance` method is called. However, if you require control on when the progression timer is started use `start` call:
+By default the timer for internal time estimation is started automatically when the `advance` method is called. However, if you require control on when the progression timer is started use `start` call:
 
 ```ruby
 bar.start  # => sets timer and draws initial progress bar
@@ -249,15 +293,15 @@ bar.start  # => sets timer and draws initial progress bar
 
 ### 2.7 update
 
-Once the progress bar has been started you can change its configuration option(s) by calling `update`:
+Once a progress bar has been started, you can change its configuration option(s) by calling `update`:
 
 ```ruby
-bar.update(complete: '+', frequency: 10)
+bar.update(complete: "+", frequency: 10)
 ```
 
 ### 2.8 finish
 
-In order to immediately stop and finish the progress call `finish`. This will finish drawing the progress and return to new line.
+In order to immediately stop and finish progress of a bar call `finish`. This will finish drawing the progress by advancing it to 100% and returning to a new line.
 
 ```ruby
 bar.finish
@@ -265,13 +309,23 @@ bar.finish
 
 ### 2.9 stop
 
-In order to immediately stop the bar in the current position and thus finish any further progress use `stop`:
+In order to immediately stop a bar in the current position and thus prevent any further progress use `stop`:
 
 ```ruby
 bar.stop
 ```
 
-### 2.10 reset
+### 2.10 pause
+
+A running progress bar can be paused at the current position using `pause` method:
+
+```ruby
+bar.pause
+```
+
+A paused progress bar will stop accumulating any time measurements like elapsed time. It also won't return to a new line, so a progress animation can be smoothly resumed.
+
+### 2.11 reset
 
 In order to reset currently running or finished progress bar to its original configuration and initial position use `reset` like so:
 
@@ -279,23 +333,57 @@ In order to reset currently running or finished progress bar to its original con
 bar.reset
 ```
 
-After resetting the bar if you wish to draw and start the bar and its timers use `start` call.
+After resetting a progress bar, if you wish to draw and start a bar and its timers use `start` call.
+
+### 2.12 resume
+
+When a bar is stopped or paused, you can continue its progression using the `resume` method.
+
+```ruby
+bar.resume
+```
+
+A resumed progression will continue accumulating the total elapsed time without including time intervals for pausing or stopping.
 
-### 2.11 complete?
+### 2.13 complete?
 
-During progresion you can check if a bar is finished or not by calling `complete?`. The bar will only return `true` if the progression finished successfuly, otherwise `false` will be returned.
+During progression you can check whether a bar is finished or not by calling `complete?`. The bar will only return `true` if the progression finished successfully, otherwise `false` will be returned.
 
 ```ruby
 bar.complete? # => false
 ```
 
-### 2.12 resize
+### 2.14 paused?
+
+To check whether a progress bar is paused or not use `paused?`:
+
+```ruby
+bar.paused? # => true
+```
+
+### 2.15 stopped?
+
+To check whether a progress bar is stopped or not use `stopped?`:
+
+```ruby
+bar.stopped? # => true
+```
+
+### 2.16 indeterminate?
 
-If you wish for a progress bar to change it's current width, you can use `resize` by passing in a new desired length. However, if you don't provide any width the `resize` will use terminal current width as its base for scaling.
+You can make a progress bar indeterminate by setting `:total` to `nil`. In this state, a progress bar animation is displayed to show unbounded task. You can check whether the progress bar is indeterminate with the `indeterminate?` method:
 
 ```ruby
-bar.resize      # => determine terminal width and scale accordingly
-bar.resize(50)  # => will resize bar proportionately from this point onwards
+bar.indeterminate? # => false
+```
+
+### 2.17 resize
+
+If you want to change a progress bar's current width, use `resize` and pass in a new desired length. However, if you don't provide any width the `resize` will use terminal current width as its base for scaling.
+
+```ruby
+bar.resize      # determine terminal width and scale accordingly
+bar.resize(50)  # will resize bar proportionately from this point onwards
 ```
 
 To handle automatic resizing you can trap `:WINCH` signal:
@@ -304,66 +392,229 @@ To handle automatic resizing you can trap `:WINCH` signal:
 trap(:WINCH) { bar.resize }
 ```
 
-### 2.13 on
+### 2.18 on
 
-The progress bar fires events when it is progressing, stopped or finished. You can register to listen for events using the `on` message.
+A progress bar fires events when it is progressing, paused, stopped or finished. You can register to listen for these events using the `on` message.
 
-Every time an `advance` is called the `:progress` event gets fired which you can listen for inside a block which includes the actual amount of progress as a first yielded argument:
+Every time an `advance` is called the `:progress` event gets fired which you can listen for inside a block. A first yielded argument is the actual amount of progress:
 
 ```ruby
 bar.on(:progress) { |amount| ... }
 ```
 
-When the progress bar finishes and completes then the `:done` event is fired. You can listen for this event:
+When a progress bar finishes and completes then the `:done` event is fired. You can listen for this event:
 
 ```ruby
 bar.on(:done) { ... }
 ```
 
-Alternatively, when the progress bar gets stopped the `:stopped` event is fired. You can listen for this event:
+Alternatively, when a progress bar gets stopped the `:stopped` event is fired. You can listen for this event:
 
 ```ruby
 bar.on(:stopped) { ... }
 ```
 
+Anytime a progress bar is paused the `:paused` event will be fired. To listen for this event do:
+
+```ruby
+bar.on(:paused) { ... }
+```
+
 ## 3. Configuration
 
 There are number of configuration options that can be provided:
 
-* `:total` total number of steps to completion
-* `:width` of the bars display in terminal columns excluding formatting options. Defaults to total steps
-* `:complete` completion character by default `=`
-* `:incomplete` incomplete character by default single space
-* [:head](#31-head) the head character by default `=`
-* [:output](#32-output) the output stream defaulting to `stderr`
-* [:frequency](#33-frequency) used to throttle the output, by default `0`
-* [:interval](#34-interval) used to measure the speed, by default `1 sec`
-* `:hide_cursor` to hide display cursor defaulting to `false`
-* `:clear` to clear the finished bar defaulting to `false`
+* [:total](#31-total) - the total number of steps to completion.
+* [:width](#32-width) - the number of terminal columns for displaying a bar excluding other tokens. Defaults to total steps.
+* [:complete](#33-complete) - the completion character, by default `=`.
+* [:incomplete](#34-incomplete) - the incomplete character, by default single space.
+* [:head](#35-head) - the head character, by default `=`.
+* [:unknown](#36-unknown) - the character(s) used to show indeterminate progress, defaults to `<=>`.
+* [:bar_format](#37-bar_format) - the predefined bar format, by default `:classic`.
+* [:output](#38-output) - the output stream defaulting to `stderr`.
+* [:frequency](#39-frequency) - used to throttle the output, by default `0`.
+* [:interval](#310-interval) - the time interval used to measure rate, by default `1 sec`.
+* [:hide_cursor](#311-hide_cursor) - whether to hide the console cursor or not, defaults to `false`.
+* [:clear](#312-clear) - whether to clear the finished bar or not, defaults to `false`.
+* [:clear_head](#313-clear_head) - whether to clear the head character when the progress is done or not, defaults to `false`.
 
 All the above options can be passed in as hash options or block parameters:
 
 ```ruby
-TTY::ProgressBar.new "[:bar]" do |config|
+bar = TTY::ProgressBar.new("[:bar]") do |config|
   config.total = 30
   config.frequency = 10
   config.clear = true
 end
 ```
 
-### 3.1 :head
+The progress bar's configuration can also be changed at runtime with `configure`:
+
+```ruby
+bar.configure do |config|
+  config.total = 100   # takes precedence over the original value
+  config.frequencye = 20
+end
+```
+
+Or with the [update](#27-update) method:
+
+```ruby
+bar.update(total: 100, frequency: 20)
+```
+
+### 3.1 :total
+
+The `:total` option determines the final value at which the progress bar fills up and stops.
+
+```ruby
+TTY::ProgressBar.new("[:bar]", total: 30)
+```
+
+Setting `:total` to `nil` or leaving it out will cause the progress bar to switch to indeterminate mode. Instead of showing completeness for a task, it will render animation like `<=>` that moves left and right:
+
+```ruby
+# [                    <=>                 ]
+```
+
+The indeterminate mode is useful to show time-consuming and unbounded task.
+
+Run [examples/indeterminate](https://github.com/piotrmurach/tty-progressbar/blob/master/examples/indeterminate.rb) to see indeterminate progress animation in action.
+
+### 3.2 :width
+
+The progress bar width defaults to the total value and is capped at the maximum terminal width minus all the labels. If you want to enforce the bar to have a specific length use the `:width` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", width: 30)
+```
+
+### 3.3 :complete
+
+By default, the `=` character is used to mark progression but this can be changed with `:complete` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", complete: "x")
+```
+
+Then the output could look like this:
+
+```ruby
+# [xxxxxxxx      ]
+```
+
+### 3.4 :incomplete
+
+By default no characters are shown to mark the remaining progress in the `:classic` bar format. Other [bar styles](#37-bar_format) often have incomplete character. You can change this with `:incomplete` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", incomplete: "_")
+```
+
+A possible output may look like this:
+
+```ruby
+# [======_________]
+```
+
+### 3.5 :head
 
 If you prefer for the animated bar to display a specific character for a head of progression then use `:head` option:
 
 ```ruby
-bar = TTY::ProressBar.new("[:bar]", head: '>')
-#
+TTY::ProgressBar.new("[:bar]", head: ">")
+```
+
+This could result in output like this:
+
+```ruby
 # [=======>      ]
 ```
 
-### 3.2 :output
+### 3.6 :unknown
+
+By default, a progress bar shows indeterminate progress using `<=>` characters:
+
+```ruby
+# [     <=>      ]
+```
+
+Other [bar formats](#37-bar_format) use different characters.
 
-The progress bar only outputs to a console and when output is redirected to a file or a pipe it does nothing. This is so, for example, your error logs do not overflow with progress bars output.
+You can change this with the `:unknown` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", unknown: "<?>")
+```
+
+This may result in the following output:
+
+```ruby
+# [     <?>      ]
+````
+
+### 3.7 :bar_format
+
+There are number of preconfigured bar formats you can choose from.
+
+| Name       | Determinate  | Indeterminate |
+|:-----------|:-------------|:--------------|
+| `:arrow`   | `▸▸▸▸▸▹▹▹▹▹` | `◂▸`          |
+| `:asterisk`| `✱✱✱✱✱✳✳✳✳✳` | `✳✱✳`         |
+| `:blade`   | `▰▰▰▰▰▱▱▱▱▱` | `▱▰▱`         |
+| `:block`   | `█████░░░░░` | `█`           |
+| `:box`     | `■■■■■□□□□□` | `□■□`         |
+| `:bracket` | `❭❭❭❭❭❭❭❭❭❭` | `❬=❭`         |
+| `:burger`  | `≡≡≡≡≡≡≡≡≡≡` | `<≡>`         |
+| `:button`  | `⦿⦿⦿⦿⦿⦾⦾⦾⦾⦾` | `⦾⦿⦾`         |
+| `:chevron` | `››››››››››` | `‹=›`         |
+| `:circle`  | `●●●●●○○○○○` | `○●○`         |
+| `:classic` | `==========` | `<=>`         |
+| `:crate`   | `▣▣▣▣▣⬚⬚⬚⬚⬚` | `⬚▣⬚`         |
+| `:diamond` | `♦♦♦♦♦♢♢♢♢♢` | `♢♦♢`         |
+| `:dot`     | `･･････････` | `･･･`         |
+| `:heart`   | `♥♥♥♥♥♡♡♡♡♡` | `♡♥♡`         |
+| `:rectangle` | `▮▮▮▮▮▯▯▯▯▯` | `▯▮▯`       |
+| `:square`  | `▪▪▪▪▪▫▫▫▫▫` | `▫▪▫`         |
+| `:star`    | `★★★★★☆☆☆☆☆` | `☆★☆`         |
+| `:track`   | `▬▬▬▬▬═════` | `═▬═`         |
+| `:tread`   | `❱❱❱❱❱❱❱❱❱❱` | `❰=❱`         |
+| `:triangle`| `▶▶▶▶▶▷▷▷▷▷` | `◀▶`          |
+| `:wave`    | `~~~~~_____` | `<~>`         |
+
+For example, you can specify `:box` format with the `:bar_format` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", bar_format: :box)
+```
+
+This will result in output like this:
+
+```ruby
+# [■■■■■□□□□□□□□□□]
+```
+
+You can overwrite `:complete`, `:incomplete`, `:head` and `:unknown` characters:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", bar_format: :box, incomplete: " ", unknown: "?")
+```
+
+This will display the following when total is given:
+
+```ruby
+# [■■■■■          ]
+```
+
+And for the unknown progress the `?` character will move from left to right:
+
+```ruby
+# [   ?           ]
+```
+
+### 3.8 :output
+
+A progress bar only outputs to a console. When the output is, for example, redirected to a file or a pipe, the progress bar doesn't get printed. This is so, for example, your error logs do not overflow with progress bar output.
 
 You can change where console output is streamed with `:output` option:
 
@@ -373,7 +624,7 @@ bar = TTY::ProgressBar.new(output: $stdout)
 
 The output stream defaults to `stderr`.
 
-### 3.3 :frequency
+### 3.9 :frequency
 
 Each time the `advance` is called it causes the progress bar to repaint. In cases when there is a huge number of updates per second, you may need to limit the rendering process by using the `frequency` option.
 
@@ -383,9 +634,9 @@ The `frequency` option accepts `integer` representing number of `Hz` units, for
 TTY::ProgressBar.new("[:bar]", total: 30, frequency: 10) # 10 Hz
 ```
 
-### 3.4 :interval
+### 3.10 :interval
 
-For every call of `advance` method the **ProgressBar** takes a sample for speed measurement. By default the samples are grouped per second but you can change that by passing the `interval` option.
+Every time `advance` method is called, a time sample is taken for speed measurement. By default, all the samples are grouped in second intervals to provide a rate of speed. You can change this by passing the `interval` option.
 
 The `interval` option is an `integer` that represents the number of seconds, for example, interval of `60` would mean that speed is measured per 1 minute.
 
@@ -395,6 +646,55 @@ TTY::ProgressBar.new(":rate/minute", total: 100, interval: 60) # 1 minute
 TTY::ProgressBar.new(":rate/hour", total: 100, interval: 3600) # 1 hour
 ```
 
+### 3.11 :hide_cursor
+
+By default the cursor is visible during progress bar rendering. If you wish to hide it, you can do so with the `:hide_cursor` option.
+
+Please note that hiding cursor changes user's terminal and you need to ensure that the cursor is made visible after your code finishes. This means also handling premature interrupt signals and other unpredictable events.
+
+One solution is to wrap your progress rendering inside the `begin` and `ensure` like so:
+
+```ruby
+progress = TTY::ProgressBar.new("[:bar]", hide_cursor: true)
+
+begin
+  # logic to advance progress bar
+ensure
+  progress.stop # or progress.finish
+  # both methods will ensure that cursor is made visible again
+end
+```
+
+### 3.12 :clear
+
+By default, when a progress bar finishes it returns to a new line leaving the last progress output behind.
+
+If you prefer to erase a progress bar when it is finished use `:clear` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", clear: true)
+```
+
+### 3.13 :clear_head
+
+When a progress bar finishes and its animation includes [:head](#35-head) character, the character will remain in the output:
+
+```ruby
+# [=============>]
+```
+
+To replace a head character when a progress bar is finished use `:clear_head` option:
+
+```ruby
+TTY::ProgressBar.new("[:bar]", clear_head: true)
+```
+
+This will result in the following output:
+
+```ruby
+# [==============]
+```
+
 ## 4. Formatting
 
 Every **TTY::ProgressBar** instance requires a format string, which apart from regular characters accepts special tokens to display dynamic information. For instance, a format to measure download progress could be:
@@ -414,38 +714,55 @@ These are the tokens that are currently supported:
 * `:total_byte` the total progress in bytes
 * `:percent` the completion percentage
 * `:elapsed` the elapsed time in seconds
-* `:eta` the esitmated time to completion in seconds
+* `:eta` the estimated time to completion in seconds
+* `:eta_time` the estimated time of day at completion
 * `:rate` the current rate of progression per second
-* `:byte_rate` the current rate of pregression in bytes per second
+* `:byte_rate` the current rate of progression in bytes per second
 * `:mean_rate` the averaged rate of progression per second
 * `:mean_byte` the averaged rate of progression in bytes per second
 
+In the indeterminate mode, the progress bar displays `-` for tokens that cannot be calculated like `:total`, `:total_byte`, `:percent` and `:eta`. The following format:
+
+```ruby
+"[:bar] :current/:total :total_byte :percent ET::elapsed ETA::eta :rate/s"
+```
+
+Will result in:
+
+```ruby
+# [                 <=>                    ] 23/- -B -% ET: 1s ETA:--s 18.01/s
+```
+
 ### 4.2 Custom Formatters
 
 If the provided tokens do not meet your needs, you can write your own formatter and instrument formatting pipeline to use a formatter you prefer. This option is preferred if you are going to rely on progress bar internal data such as `rate`, `current` etc. which will all be available on the passed in progress bar instance.
 
-For example, begin by creating custom formatter called `TimeFormatter` that will dynamicly update `:time` token in format string. The methods that you need to specify are `initialize`, `matches?` and `format` like follows:
+For example, let's say you want to add `:time` token. First, start by creating a custom formatter class called `TimeFormatter` that will dynamically update `:time` token in the formatted string. In order for the `TimeFormatter` to recognise the `:time` token, you'll need to include the `TTY::ProgressBar::Formatter` module with a regular expression matching the token like so:
 
 ```ruby
 class TimeFormatter
-  def initialize(progress)
-    @progress = progress # current progress bar instance
-  end
+  include TTY::ProgressBar::Formatter[/:time/i]
+  ...
+end
+```
 
-  def matches?(value)  # specify condition to match for in display string
-    value.to_s =~ /:time/
-  end
+Next, add `call` method that will substitute the matched token with an actual value. For example, to see the time elapsed since the start do:
+
+```ruby
+class TimeFormatter
+  include TTY::ProgressBar::Formatter[/:time/i]
 
-  def format(value)  # specify how display string is formatted
-    transformed = (Time.now - @progress.start_at).to_s
-    value.gsub(/:time/, transformed)   # => :time token replacement
+  def call(value)  # specify how display string is formatted
+    # access current progress bar instance to read start time
+    elapsed = (Time.now - progress.start_time).to_s
+    value.gsub(matcher, elapsed)   # replace :time token with a value
   end
 end
 ```
 
-Notice that you have access to all the configuration options inside the formatter by simply invoking them on the `@progress` instance.
+Notice that you have access to all the configuration options inside the formatter by simply invoking them on the `progress` instance.
 
-Create **TTY::ProgressBar** instance with new token:
+Create **TTY::ProgressBar** instance using the new token:
 
 ```ruby
 bar = TTY::ProgressBar.new(":time", total: 30)
@@ -457,7 +774,7 @@ Then add `TimeFormatter` to the pipeline like so:
 bar.use TimeFormatter
 ```
 
-and then invoke progression:
+Then invoke progression:
 
 ```ruby
 bar.advance
@@ -465,39 +782,47 @@ bar.advance
 
 ### 4.3 Custom Tokens
 
-You can define custom tokens by passing pairs `name: value` to `advance` method in order to dynamically update formatted bar. This option is useful for lightweight content replacement such as titles that doesn't depend on the internal data of progressbar. For example:
+You can define custom tokens by passing pairs `name: value` to `advance` method in order to dynamically update formatted bar. This option is useful for lightweight content replacement such as titles that doesn't depend on the internal data of a progress bar. For example:
 
 ```ruby
 bar = TTY::ProgressBar.new("(:current) :title", total: 4)
-bar.advance(title: 'Hello Piotr!')
-bar.advance(3, title: 'Bye Piotr!')
+bar.advance(title: "Hello Piotr!")
+bar.advance(3, title: "Bye Piotr!")
 ```
 
-which outputs:
+This will output:
 
 ```ruby
-(1) Hello Piotr!
-(4) Bye Piotr!
+# (1) Hello Piotr!
+# (4) Bye Piotr!
 ```
 
 ### 4.4 Unicode
 
-The format string as well as `:complete`, `:head` and `:incomplete` configuration options can contain Unicode characters that aren't monospaced.
+The format string as well as [:complete](#33-complete), [:head](#35-head), [:incomplete](#34-incomplete) and [:unknown](#36-unknown) configuration options can contain Unicode characters that aren't monospaced.
 
 For example, you can specify complete bar progression character to be Unicode non-monospaced:
 
 ```ruby
-bar = TTY::ProgressBar.new("Unicode [:bar]", total: 30, complete: 'あ')
-#
-# => Unicode [あああああああああああああああ]
+bar = TTY::ProgressBar.new("Unicode [:bar]", total: 30, complete: "あ")
+```
+
+Advancing above progress bar to completion will fit `あ` characters in 30 terminal columns:
+
+```ruby
+# Unicode [あああああああああああああああ]
 ```
 
 Similarly, the formatted string can include Unicode characters:
 
 ```ruby
 bar = TTY::ProgressBar.new("あめかんむり[:bar]", total: 20)
-#
-# => あめかんむり[==    ]
+```
+
+A finished progress bar will also fit within allowed width:
+
+```ruby
+# あめかんむり[==    ]
 ```
 
 ## 5. Logging
@@ -505,11 +830,11 @@ bar = TTY::ProgressBar.new("あめかんむり[:bar]", total: 20)
 If you want to print messages out to terminal along with the progress bar use the `log` method. The messages will appear above the progress bar and will continue scrolling up as more are logged out.
 
 ```ruby
-bar.log('Piotrrrrr')
+bar.log("Piotrrrrr")
 bar.advance
 ```
 
-will result in:
+This could result in the following output:
 
 ```ruby
 # Piotrrrrr
@@ -520,14 +845,13 @@ will result in:
 
 ### 6.1 new
 
-The multi progress bar can be created in two ways. If you simply want to group multiple progress bars you can create multi bar like so:
+The multi progress bar can be created in two ways. If you simply want to group multiple progress bars together, you can create multi bar without a format string like so:
 
 ```ruby
 TTY::ProgressBar::Multi.new
 ```
 
-
-However, if you want a top level multibar that tracks all the registered progress bars then provide a formatted string:
+However, if you want a top level multibar that tracks progress of all the registered progress bars then you need to provide a formatted string:
 
 ```ruby
 TTY::ProgressBar::Multi.new("main [:bar] :percent")
@@ -542,15 +866,15 @@ multibar = TTY::ProgressBar::Multi.new
 bar = multibar.register("[:bar]", total: 30)
 ```
 
-The `register` call returns the newly created progress bar which answers all the progress bar api messages.
+The `register` call returns the newly created progress bar that can be changed using all the available [progress bar API](#2-ttyprogressbar-api) methods.
 
-Please remember to specify total value for each registered progress bar, either when sending `register` message or when using `update` to dynamicaly assign the total value.
+*Note:* Remember to specify total value for each registered progress bar, either when sending `register` message or when using `update` to dynamically assign the total value.
 
 ### 6.3 advance
 
 Once multi progress bar has been created you can advance each registered progress bar individually, either by executing them one after the other synchronously or by placing them in separate threads thus progressing each bar asynchronously. The multi bar handles synchronization and display of all bars as they continue their respective rendering.
 
-For example, to display two bars async, first register them with the multi bar:
+For example, to display two bars asynchronously, first register them with the multi bar:
 
 ```ruby
 bar1 = multibar.register("one [:bar]", total: 20)
@@ -572,7 +896,7 @@ Finally, wait for the threads to finish:
 
 ### 6.4 start
 
-By default the top level multi bar will be rendered as the first bar and have its timer started when on of the regsitered bars advances. However, if you wish to start timers and draw the top level multi bar do:
+By default the top level multi bar will be rendered as the first bar and have its timer started when one of the registered bars advances. However, if you wish to start timers and draw the top level multi bar do:
 
 ```ruby
 multibar.start  # => sets timer and draws top level multi progress bar
@@ -580,7 +904,7 @@ multibar.start  # => sets timer and draws top level multi progress bar
 
 ### 6.5 finish
 
-In order to finish all progress bars call `finish`. This will finish the top level progress bar, if it exists, all any registered progress bars still in progress.
+In order to finish all progress bars call `finish`. This will finish the top level progress bar, if it exists, and any registered progress bar still in progress.
 
 ```ruby
 multibar.finish
@@ -594,7 +918,23 @@ Use `stop` to terminate immediately all progress bars registered with the multib
 multibar.stop
 ```
 
-### 6.7 complete?
+### 6.7 pause
+
+All running progress bars can be paused at their current positions using the `pause` method:
+
+```ruby
+multibar.pause
+````
+
+### 6.8 resume
+
+When one or more registered progress bar is stopped or paused, they can be resumed all at once using the `resume` method:
+
+```ruby
+multibar.resume
+```
+
+### 6.9 complete?
 
 To check if all registered progress bars have been successfully finished use `complete?`
 
@@ -602,7 +942,23 @@ To check if all registered progress bars have been successfully finished use `co
 multibar.complete? # => true
 ```
 
-### 6.8 on
+### 6.10 paused?
+
+To check whether all progress bars are paused or not use `paused?`:
+
+```ruby
+multibar.paused? # => true
+```
+
+### 6.11 stopped?
+
+To check whether all progress bars are stopped or not use `stopped?`:
+
+```ruby
+multibar.stopped? # => true
+```
+
+### 6.12 on
 
 Similar to `TTY::ProgressBar` the multi bar fires events when it is progressing, stopped or finished. You can register to listen for events using the `on` message.
 
@@ -618,21 +974,27 @@ When all the registered progress bars finish and complete then the `:done` event
 multibar.on(:done) { ... }
 ```
 
-Finally, when any of the progress bars gets stopped the `:stopped` event is fired. You can listen for this event:
+When any of the progress bars gets stopped the `:stopped` event is fired. You can listen for this event:
 
 ```ruby
 multibar.on(:stopped) { ... }
 ```
 
-### 6.9 :style
+Anytime a registered progress bar pauses, a `:paused` event will be fired. To listen for this event do:
+
+```ruby
+multibar.on(:paused) { ... }
+```
+
+### 6.13 :style
 
 In addition to all [configuration options](#3-configuration) you can style multi progress bar:
 
 ```ruby
 TTY::ProgressBar::Multi.new("[:bar]", style: {
-  top: '. '
-  middle: '|-> '
-  bottom: '|__ '
+  top: ". ",
+  middle: "|-> ",
+  bottom: "|__ "
 })
 ```
 
@@ -645,7 +1007,7 @@ This section demonstrates some of the possible uses for the **TTY::ProgressBar**
 Creating a progress bar that displays in color is as simple as coloring the `:complete` and `:incomplete` character options. In order to help with coloring you can use [pastel](https://github.com/piotrmurach/pastel) library like so:
 
 ```ruby
-require 'pastel'
+require "pastel"
 
 pastel = Pastel.new
 green  = pastel.on_green(" ")
@@ -698,6 +1060,10 @@ This will result in output similar to:
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Code of Conduct
+
+Everyone interacting in the TTY::ProgressBar project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-progressbar/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
-Copyright (c) 2014-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014 Piotr Murach. See LICENSE for further details.