tty-progressbar 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff767a06ae19986026a9fc6bf8542246a66aa114
-  data.tar.gz: ee1b4fdfcf5e032a0f57b45edfc6076b7e44478f
+  metadata.gz: 352677d511081780de389f441c94367e9c43439d
+  data.tar.gz: a76e419403efc5d4e86987272ce365df173edb57
 SHA512:
-  metadata.gz: 8e30d01509fe132b2af4ae89138723a6e8f3fd55a9cd212b83d7a4bcac299d1ca46bb28051d039c75eaf57f30217bd518e4e2727629a5c954896811c4f199a97
-  data.tar.gz: 023f9de9dc08949e1754ffc1caab86d5ad2d06c9f538577049a658e243a5680ae9fbd04a31a07c64e56d9d7cff8cad1d687a07d18ee2576d75342725901e4963
+  metadata.gz: 682bcc03f3f85f5825331b0caf3c41df49d089d19db7168ae1f1f34e624ca7f14b6c89a16b6aa6348f8f951851b1ff758ff9d36e1e9424dda2ecb70772f82a38
+  data.tar.gz: b520bc8143e6736f7214ac6bac1b9b187769c635fecec636a6ac3c8288cb20c5fc6a78d935b251f8521942aa0c68e40d5898eb6325f7b81783c96c275c0ab7ce

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.5.0 (January 1, 2015)
+
+* Add ability to reset progress
+* Add start method for manually setting the timer
+* Fix bug with finish not rendering the bar full
+* Add meter to measure speed rate
+* Add to_seconds converter
+* Add :rate, :mean_rate, :byte_rate & :mean_byte formatters
+
 0.4.0 (December 25, 2014)
 
 * Add :total_byte, :current_byte formatters by @vincentjames501

data/README.md

@@ -42,16 +42,20 @@ Or install it yourself as:
   * [1.1 advance](#11-advance)
   * [1.2 current=](#12-current)
   * [1.3 ratio=](#13-ratio)
-  * [1.4 finish](#14-finish)
-  * [1.5 complete?](#15-complete)
-  * [1.6 resize](#16-resize)
+  * [1.4 start](#14-start)
+  * [1.5 finish](#15-finish)
+  * [1.6 complete?](#16-complete)
+  * [1.7 reset](#17-reset)
+  * [1.8 resize](#18-resize)
 * [2. Configuration](#2-configuration)
   * [2.1 Frequency](#21-frequency)
+  * [2.2 Interval](#22-interval)
 * [3. Formatting](#3-formatting)
   * [3.1 Tokens](#31-tokens)
   * [3.2 Custom Formatters](#31-custom-formatters)
 * [4. Logging](#4-logging)
 * [5. Examples](#5-examples)
+  * [5.1 Color](#51-color)
 
 ## 1. Usage
 
@@ -105,7 +109,15 @@ In order to update overall completion of a progress bar as an exact percentage u
 bar.ratio = 0.5
 ```
 
-### 1.4 finish
+### 1.4 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:
+
+```ruby
+bar.start  # => sets timer and draws initial progress bar
+```
+
+### 1.5 finish
 
 In order to immediately stop and finish the progress call `finish`. This will finish drawing the progress and return to new line.
 
@@ -113,7 +125,7 @@ In order to immediately stop and finish the progress call `finish`. This will fi
 bar.finish
 ```
 
-### 1.5 complete?
+### 1.6 complete?
 
 During progresion you can check if bar is finished or not by calling `complete?`.
 
@@ -121,7 +133,15 @@ During progresion you can check if bar is finished or not by calling `complete?`
 bar.complete? # => false
 ```
 
-### 1.6 resize
+### 1.7 reset
+
+In order to reset currently running or finished progress bar to its original configuration and initial position use `reset` like so:
+
+```ruby
+bar.reset
+```
+
+### 1.8 resize
 
 If you wish for a progress bar to change it's current width, you can use `resize` by passing in a new desired length:
 
@@ -139,6 +159,7 @@ There are number of configuration options that can be provided:
 * `incomplete` incomplete character by default single space
 * `output` the output stream defaulting to `stderr`
 * `frequency` used to throttle the output, by default `0` (see [Frequency](#21-frequency))
+* `interval` used to measure the speed, by default `1 sec` (see [Interval](#22-interval))
 * `hide_cursor` to hide display cursor defaulting to `false`
 * `clear` to clear the finished bar defaulting to `false`
 
@@ -162,6 +183,18 @@ The `frequency` option accepts `integer` representing number of `Hz` units, for
 TTY::ProgressBar.new("[:bar]", total: 30, frequency: 10) # 10 Hz
 ```
 
+### 2.2 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.
+
+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.
+
+```ruby
+TTY::ProgressBar.new(":rate/minute", total: 100, interval: 60) # 1 minute
+
+TTY::ProgressBar.new(":rate/hour", total: 100, interval: 3600) # 1 hour
+```
+
 ## 3. 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:
@@ -182,6 +215,10 @@ These are the tokens that are currently supported:
 * `:percent` the completion percentage
 * `:elapsed` the elapsed time in seconds
 * `:eta` the esitmated time to completion in seconds
+* `:rate` the current rate of progression per second
+* `:byte_rate` the current rate of pregression in bytes per second
+* `:mean_rate` the averaged rate of progression per second
+* `:mean_byte` the averaged rate of progression in bytes per second
 
 ### 3.2 Custom Formatters
 
@@ -277,6 +314,23 @@ To see how a progress bar is reported in terminal you can do:
 end
 ```
 
+### 5.2 Speed
+
+Commonly a progress bar is utilized to measure download speed per second. This can be done like so:
+
+```ruby
+TTY::ProgressBar.new("[:bar] :byte_rate/s") do |config|
+  config.total = 300000
+  config.interval = 1     # => 1 sec
+end
+```
+
+This will result in output similar to:
+
+```ruby
+downloading [=======================       ] 4.12MB/s
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/peter-murach/tty-progressbar/fork )
@@ -287,4 +341,4 @@ end
 
 ## Copyright
 
-Copyright (c) 2014 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015 Piotr Murach. See LICENSE for further details.

data/examples/speed.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+require 'tty-progressbar'
+
+bar = TTY::ProgressBar.new "downloading [:bar] :rate/s :mean_rate/s" do |conf|
+  conf.total = 100
+  conf.interval = 1
+end
+
+30.times do
+  sleep(0.1)
+  bar.advance(Random.rand(10))
+end

data/lib/tty/progressbar/configuration.rb

@@ -22,6 +22,8 @@ module TTY
 
       attr_accessor :frequency
 
+      attr_accessor :interval
+
       def initialize(options)
         self.total   = options[:total] if options[:total]
         @width       = options.fetch(:width) { total }

data/lib/tty/progressbar/converter.rb

@@ -31,6 +31,20 @@ module TTY
         end
       end
 
+      # Convert seconds to set precision
+      #
+      # @param [Numeric] seconds
+      #   the seconds to convert
+      #
+      # @return [String]
+      #   the formatted result
+      #
+      # @api public
+      def to_seconds(seconds, precision = nil)
+        precision ||= (seconds < 1 && !seconds.zero?) ? 5 : 2
+        sprintf "%5.#{precision}f", seconds
+      end
+
       KILOBYTE = 1024
       MEGABYTE = KILOBYTE * 1024
       GIGABYTE = MEGABYTE * 1024

data/lib/tty/progressbar/formatter/byte_rate.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :current token
+    #
+    # @api private
+    class ByteRateFormatter
+      MATCHER = /:byte_rate/i
+
+      def initialize(progress)
+        @progress  = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      # Format :byte_rate token
+      #
+      # @param [String] value
+      #  the value being formatted
+      #
+      # @api public
+      def format(value)
+        formatted = @converter.to_bytes(@progress.rate)
+        value.gsub(MATCHER, formatted)
+      end
+    end # ByteRateFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/formatter/current.rb

@@ -6,7 +6,7 @@ module TTY
     #
     # @api private
     class CurrentFormatter
-      MATCHER = /:current(?!_)/
+      MATCHER = /:current\b/i.freeze
 
       def initialize(progress)
         @progress = progress

data/lib/tty/progressbar/formatter/current_byte.rb

@@ -3,7 +3,7 @@
 module TTY
   class ProgressBar
     class ByteFormatter
-      MATCHER = /:current_byte|:byte/.freeze
+      MATCHER = /(:current_byte|:byte)\b/i.freeze
       # Used by {Pipeline} to format :byte token
       #
       # @api private

data/lib/tty/progressbar/formatter/mean_byte.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :current token
+    #
+    # @api private
+    class MeanByteFormatter
+      MATCHER = /:mean_byte/i.freeze
+
+      def initialize(progress)
+        @progress  = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      # Format :rate token
+      #
+      # @param [String] value
+      #  the value being formatted
+      #
+      # @api public
+      def format(value)
+        formatted = @converter.to_bytes(@progress.mean_rate)
+        value.gsub(MATCHER, formatted)
+      end
+    end # MeanByteFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/formatter/mean_rate.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :current token
+    #
+    # @api private
+    class MeanRateFormatter
+      MATCHER = /:mean_rate/i.freeze
+
+      def initialize(progress)
+        @progress  = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      # Format :rate token
+      #
+      # @param [String] value
+      #  the value being formatted
+      #
+      # @api public
+      def format(value)
+        formatted = @converter.to_seconds(@progress.mean_rate)
+        value.gsub(MATCHER, formatted)
+      end
+    end # MeanRateFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/formatter/percent.rb

@@ -6,7 +6,7 @@ module TTY
     #
     # @api private
     class PercentFormatter
-      MATCHER = /:percent/.freeze
+      MATCHER = /:percent\b/.freeze
 
       def initialize(progress, *args, &block)
         @progress = progress

data/lib/tty/progressbar/formatter/rate.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :current token
+    #
+    # @api private
+    class RateFormatter
+      MATCHER = /:rate/i.freeze
+
+      def initialize(progress)
+        @progress  = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      # Format :rate token
+      #
+      # @param [String] value
+      #  the value being formatted
+      #
+      # @api public
+      def format(value)
+        formatted = @converter.to_seconds(@progress.rate)
+        value.gsub(MATCHER, formatted)
+      end
+    end # RateFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/formatter/total.rb

@@ -3,7 +3,7 @@
 module TTY
   class ProgressBar
     class TotalFormatter
-      MATCHER = /:total(?!_)/.freeze
+      MATCHER = /:total\b/i.freeze
 
       def initialize(progress, *args, &block)
         @progress = progress

data/lib/tty/progressbar/formatter/total_byte.rb

@@ -6,7 +6,7 @@ module TTY
     #
     # @api private
     class TotalByteFormatter
-      MATCHER = /:total_byte/.freeze
+      MATCHER = /:total_byte/i.freeze
 
       def initialize(progress, *args, &block)
         @progress = progress

data/lib/tty/progressbar/formatter.rb

@@ -23,6 +23,10 @@ module TTY
         @pipeline.use TTY::ProgressBar::EstimatedFormatter
         @pipeline.use TTY::ProgressBar::PercentFormatter
         @pipeline.use TTY::ProgressBar::ByteFormatter
+        @pipeline.use TTY::ProgressBar::ByteRateFormatter
+        @pipeline.use TTY::ProgressBar::RateFormatter
+        @pipeline.use TTY::ProgressBar::MeanRateFormatter
+        @pipeline.use TTY::ProgressBar::MeanByteFormatter
         @pipeline.use TTY::ProgressBar::BarFormatter
       end
     end # Formatter

data/lib/tty/progressbar/meter.rb

@@ -0,0 +1,81 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {ProgressBar} to measure progress rate per interval
+    # by default 1s
+    #
+    # @api privatek
+    class Meter
+      # Create Meter
+      #
+      # @param [Integer] interval
+      #   the interval for measurement samples
+      #
+      # @api private
+      def initialize(interval)
+        @samples  = Hash.new { |h, el| h[el] = [] }
+        @interval = interval || 1 # 1 sec
+        @marker   = 0
+
+        @start_time     = Time.now.to_f
+        @last_sample_at = @start_time
+      end
+
+      def start
+        @start_time     = Time.now.to_f
+        @last_sample_at = @start_time
+      end
+
+      # Update meter with value
+      #
+      # @api public
+      def sample(at, value)
+        if @interval < at.to_f - @last_sample_at
+          @marker += 1
+        end
+        @samples[@marker] << value
+
+        @last_sample_at = at.to_f
+      end
+
+      # The rate of sampling
+      #
+      # @api public
+      def rate
+        samples = @samples[@marker]
+        result = samples.inject(:+).to_f / samples.size
+        result.nan? ? 0 : result
+      end
+
+      # Group all rates per interval
+      #
+      # @api public
+      def rates
+        @samples.reduce([]) do |acc, (key, _)|
+          acc << @samples[key].reduce(:+)
+        end
+      end
+
+      # The mean rate
+      #
+      # @api public
+      def mean_rate
+        if rates.size == 1
+          rate
+        else
+          rates.reduce(:+).to_f / rates.size
+        end
+      end
+      alias_method :avg_rate, :mean_rate
+
+      # Reset the meter by clearing out it's metrics
+      #
+      # @api public
+      def clear
+        @marker = 0
+        @samples.clear
+      end
+    end # Meter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = "0.4.0"
+    VERSION = '0.5.0'
   end # ProgressBar
 end # TTY

data/lib/tty/progressbar.rb

@@ -1,24 +1,5 @@
 # coding: utf-8
 
-require 'io/console'
-require 'forwardable'
-require 'tty-screen'
-
-require 'tty/progressbar/configuration'
-require 'tty/progressbar/converter'
-require 'tty/progressbar/version'
-require 'tty/progressbar/pipeline'
-require 'tty/progressbar/formatter'
-
-require 'tty/progressbar/formatter/bar'
-require 'tty/progressbar/formatter/current'
-require 'tty/progressbar/formatter/current_byte'
-require 'tty/progressbar/formatter/elapsed'
-require 'tty/progressbar/formatter/estimated'
-require 'tty/progressbar/formatter/percent'
-require 'tty/progressbar/formatter/total'
-require 'tty/progressbar/formatter/total_byte'
-
 module TTY
   # Used for creating terminal progress bar
   #
@@ -45,6 +26,8 @@ module TTY
                    :complete, :incomplete, :hide_cursor, :clear,
                    :output, :frequency
 
+    def_delegators :@meter, :rate, :mean_rate
+
     def_delegator :@formatter, :use
 
     # Create progress bar
@@ -83,12 +66,25 @@ module TTY
       @last_render_width = 0
       @done              = false
       @start_at          = Time.now
+      @started           = false
       @formatter         = TTY::ProgressBar::Formatter.new
+      @meter             = Meter.new(options.fetch(:interval, 1))
 
       @formatter.load
       register_callbacks
     end
 
+    # Start progression by drawing bar and setting time
+    #
+    # @api public
+    def start
+      @started    = true
+      @started_at = Time.now
+      @meter.start
+
+      advance(0)
+    end
+
     # Advance the progress bar
     #
     # @param [Object|Number] progress
@@ -97,9 +93,10 @@ module TTY
     def advance(progress = 1)
       return if @done
 
-      @start_at = Time.now if @current.zero?
+      @start_at  = Time.now if @current.zero? && !@started
       @readings += 1
       @current  += progress
+      @meter.sample(Time.now, progress)
 
       if !no_width && @current >= total
         finish && return
@@ -196,9 +193,10 @@ module TTY
         write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
       end
       return if @done
-      @current = width if no_width
+      @current = total unless no_width
       render
       clear ? clear_line : write("\n", false)
+      @meter.clear
       @done = true
     end
 
@@ -209,6 +207,18 @@ module TTY
       output.print(ECMA_CSI + '0m' + ECMA_CSI + '1000D' + ECMA_CSI + ECMA_CLR)
     end
 
+    # Reset progress to default configuration
+    #
+    # @api public
+    def reset
+      @current  = 0
+      @readings = 0
+      @done     = false
+      @meter.clear
+
+      advance(0) # rerender with new configuration
+    end
+
     # Check if progress is finised
     #
     # @return [Boolean]
@@ -257,6 +267,8 @@ module TTY
       message
     end
 
+    EXIT_SIGS = [:QUIT, :TERM, :INT]
+
     # Handle resize and kill signals
     #
     # @api private
@@ -267,7 +279,9 @@ module TTY
       end
       Signal.trap('WINCH', &callback)
 
-      Signal.trap('INT') { finish }
+      EXIT_SIGS.each do |sig|
+        Signal.trap(sig) { finish && fail(Interrupt) }
+      end
     end
   end # ProgressBar
 end # TTY

data/lib/tty-progressbar.rb

@@ -1,3 +1,27 @@
 # coding: utf-8
 
+require 'io/console'
+require 'forwardable'
+require 'tty-screen'
+
+require 'tty/progressbar/configuration'
+require 'tty/progressbar/converter'
+require 'tty/progressbar/version'
+require 'tty/progressbar/pipeline'
+require 'tty/progressbar/formatter'
+require 'tty/progressbar/meter'
+
+require 'tty/progressbar/formatter/bar'
+require 'tty/progressbar/formatter/current'
+require 'tty/progressbar/formatter/current_byte'
+require 'tty/progressbar/formatter/elapsed'
+require 'tty/progressbar/formatter/estimated'
+require 'tty/progressbar/formatter/percent'
+require 'tty/progressbar/formatter/rate'
+require 'tty/progressbar/formatter/byte_rate'
+require 'tty/progressbar/formatter/mean_rate'
+require 'tty/progressbar/formatter/mean_byte'
+require 'tty/progressbar/formatter/total'
+require 'tty/progressbar/formatter/total_byte'
+
 require 'tty/progressbar'

data/spec/unit/converter/to_seconds_spec.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar::Converter, '.to_seconds' do
+  subject(:converter) { described_class.new }
+
+  it "ensure 5 digit precision for < 1" do
+    expect(converter.to_seconds(0.000005)).to eq("0.00001")
+  end
+
+  it "rounds 0 to 0.00" do
+    expect(converter.to_seconds(0)).to eq(" 0.00")
+  end
+
+  it "ensures 2 digit precision for > 1" do
+    expect(converter.to_seconds(11.2)).to eq("11.20")
+  end
+end

data/spec/unit/finish_spec.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.finish' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it 'finishes progress' do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.advance
+    progress.finish
+    expect(progress.complete?).to be(true)
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=         ]",
+      "\e[1G[==========]\n"
+    ].join)
+  end
+end

data/spec/unit/formatter/byte_rate_spec.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'byte_rate' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  before { Timecop.safe_mode = false }
+
+  it "shows current rate in bytes per sec" do
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+    progress = TTY::ProgressBar.new(":byte_rate", output: output, total: 10000, interval: 1)
+    5.times do |i|
+      time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
+      Timecop.freeze(time_now)
+      progress.advance(i * 1000)
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G0.0B",
+      "\e[1G1000.0B",
+      "\e[1G1.95KB",
+      "\e[1G2.93KB",
+      "\e[1G3.91KB\n"
+    ].join)
+    Timecop.return
+  end
+end

data/spec/unit/formatter/elapsed_spec.rb

@@ -28,4 +28,36 @@ RSpec.describe TTY::ProgressBar, 'elapsed' do
     ].join)
     Timecop.return
   end
+
+  it "resets elapsed time" do
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+    progress = TTY::ProgressBar.new(":elapsed", output: output, total: 5)
+
+    5.times do |sec|
+      time_now = Time.local(2014, 10, 5, 12, 0, sec)
+      Timecop.freeze(time_now)
+      progress.advance
+    end
+    expect(progress.complete?).to be(true)
+    progress.reset
+    2.times do |sec|
+      time_now = Time.local(2014, 10, 5, 13, 0, sec)
+      Timecop.freeze(time_now)
+      progress.advance
+    end
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G 0s",
+      "\e[1G 1s",
+      "\e[1G 2s",
+      "\e[1G 3s",
+      "\e[1G 4s\n",
+      "\e[1G 0s",
+      "\e[1G 0s",
+      "\e[1G 1s"
+    ].join)
+    Timecop.return
+  end
 end

data/spec/unit/formatter/mean_byte_spec.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'mean_byte' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  before { Timecop.safe_mode = false }
+
+  it "shows mean rate in bytes per sec" do
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+    progress = TTY::ProgressBar.new(":mean_byte", output: output, total: 10000, interval: 1)
+    5.times do |i|
+      time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
+      Timecop.freeze(time_now)
+      progress.advance(i * 1000)
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G0.0B",
+      "\e[1G500.0B",
+      "\e[1G1000.0B",
+      "\e[1G1.46KB",
+      "\e[1G1.95KB\n"
+    ].join)
+    Timecop.return
+  end
+end

data/spec/unit/formatter/mean_rate_spec.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'mean_rate' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  before { Timecop.safe_mode = false }
+
+  it "shows current rate per sec" do
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+    progress = TTY::ProgressBar.new(":mean_rate", output: output, total: 100, interval: 1)
+    5.times do |i|
+      time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
+      Timecop.freeze(time_now)
+      progress.advance(i * 10)
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G 0.00",
+      "\e[1G 5.00",
+      "\e[1G10.00",
+      "\e[1G15.00",
+      "\e[1G20.00\n"
+    ].join)
+    Timecop.return
+  end
+end

data/spec/unit/formatter/rate_spec.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'rate' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  before { Timecop.safe_mode = false }
+
+  it "shows current rate per sec" do
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+    progress = TTY::ProgressBar.new(":rate", output: output, total: 100, interval: 1)
+    5.times do |i|
+      time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
+      Timecop.freeze(time_now)
+      progress.advance(i * 10)
+    end
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G 0.00",
+      "\e[1G10.00",
+      "\e[1G20.00",
+      "\e[1G30.00",
+      "\e[1G40.00\n"
+    ].join)
+    Timecop.return
+  end
+end

data/spec/unit/frequency_spec.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require 'spec_helper'
 
 RSpec.describe TTY::ProgressBar, 'frequency' do

data/spec/unit/meter_spec.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar::Meter, '' do
+
+  before { Timecop.safe_mode = false }
+
+  after { Timecop.return }
+
+  it "measures rate per second" do
+    meter = TTY::ProgressBar::Meter.new(1)
+    meter.start
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+
+    # First sample batch
+    time_now = Time.local(2014, 10, 5, 12, 0, 0, 100)
+    meter.sample time_now, 1000
+    expect(meter.rate).to eq(1000)
+    expect(meter.mean_rate).to eq(1000)
+
+    time_now = Time.local(2014, 10, 5, 12, 0, 0, 200)
+    meter.sample time_now, 2000
+    expect(meter.rate).to eq(1500)
+    expect(meter.mean_rate).to eq(1500)
+
+    time_now = Time.local(2014, 10, 5, 12, 0, 0, 300)
+    meter.sample time_now, 1000
+    expect(meter.rate).to be_within(0.5).of(1333)
+    expect(meter.mean_rate).to be_within(0.5).of(1333)
+
+    # Second sample batch after 1s
+    time_now = Time.local(2014, 10, 5, 12, 0, 1, 400)
+    meter.sample time_now, 500
+    expect(meter.rate).to eq(500)
+    expect(meter.mean_rate).to eq(2250)
+
+    time_now = Time.local(2014, 10, 5, 12, 0, 1, 500)
+    meter.sample time_now, 500
+    expect(meter.rate).to eq(500)
+    expect(meter.mean_rate).to eq(2500)
+
+    # Third sample batch after 3s
+    time_now = Time.local(2014, 10, 5, 12, 0, 2, 600)
+    meter.sample time_now, 3000
+    expect(meter.rate).to eq(3000)
+    expect(meter.mean_rate).to be_within(0.7).of(2666)
+
+    time_now = Time.local(2014, 10, 5, 12, 0, 2, 700)
+    meter.sample time_now, 3000
+    expect(meter.rate).to eq(3000)
+    expect(meter.mean_rate).to be_within(0.7).of(3666)
+  end
+
+  it "clears measurements" do
+    meter = TTY::ProgressBar::Meter.new(1)
+    meter.start
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+
+    time_now = Time.local(2014, 10, 5, 12, 0, 0, 100)
+    meter.sample time_now, 1000
+    expect(meter.rates).to eq([1000])
+    expect(meter.rate).to eq(1000)
+
+    meter.clear
+    expect(meter.rates).to eq([])
+    expect(meter.rate).to eq(0)
+  end
+end
+

data/spec/unit/reset_spec.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.reset' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "resets current progress" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.advance(5)
+    progress.reset
+    2.times { progress.advance(3) }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=====     ]",
+      "\e[1G[          ]",
+      "\e[1G[===       ]",
+      "\e[1G[======    ]"
+    ].join)
+  end
+
+  it "resets finished progress" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.advance(10)
+    expect(progress.complete?).to be(true)
+    progress.reset
+    expect(progress.complete?).to be(false)
+    2.times { progress.advance(3) }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[==========]\n",
+      "\e[1G[          ]",
+      "\e[1G[===       ]",
+      "\e[1G[======    ]"
+    ].join)
+  end
+end

data/spec/unit/start_spec.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.start' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "starts timer and draws initial progress" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.start
+    progress.advance
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[          ]",
+      "\e[1G[=         ]"
+    ].join)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2015-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -56,19 +56,25 @@ files:
 - Rakefile
 - examples/color.rb
 - examples/simple.rb
+- examples/speed.rb
 - lib/tty-progressbar.rb
 - lib/tty/progressbar.rb
 - lib/tty/progressbar/configuration.rb
 - lib/tty/progressbar/converter.rb
 - lib/tty/progressbar/formatter.rb
 - lib/tty/progressbar/formatter/bar.rb
+- lib/tty/progressbar/formatter/byte_rate.rb
 - lib/tty/progressbar/formatter/current.rb
 - lib/tty/progressbar/formatter/current_byte.rb
 - lib/tty/progressbar/formatter/elapsed.rb
 - lib/tty/progressbar/formatter/estimated.rb
+- lib/tty/progressbar/formatter/mean_byte.rb
+- lib/tty/progressbar/formatter/mean_rate.rb
 - lib/tty/progressbar/formatter/percent.rb
+- lib/tty/progressbar/formatter/rate.rb
 - lib/tty/progressbar/formatter/total.rb
 - lib/tty/progressbar/formatter/total_byte.rb
+- lib/tty/progressbar/meter.rb
 - lib/tty/progressbar/pipeline.rb
 - lib/tty/progressbar/version.rb
 - spec/spec_helper.rb
@@ -76,24 +82,33 @@ files:
 - spec/unit/clear_spec.rb
 - spec/unit/complete_spec.rb
 - spec/unit/converter/to_bytes_spec.rb
+- spec/unit/converter/to_seconds_spec.rb
 - spec/unit/converter/to_time_spec.rb
 - spec/unit/custom_formatter_spec.rb
+- spec/unit/finish_spec.rb
 - spec/unit/formatter/bar_spec.rb
+- spec/unit/formatter/byte_rate_spec.rb
 - spec/unit/formatter/current_byte_spec.rb
 - spec/unit/formatter/current_spec.rb
 - spec/unit/formatter/elapsed_spec.rb
 - spec/unit/formatter/estimated_spec.rb
+- spec/unit/formatter/mean_byte_spec.rb
+- spec/unit/formatter/mean_rate_spec.rb
 - spec/unit/formatter/percent_spec.rb
+- spec/unit/formatter/rate_spec.rb
 - spec/unit/formatter/total_byte_spec.rb
 - spec/unit/formatter/total_spec.rb
 - spec/unit/frequency_spec.rb
 - spec/unit/hide_cursor_spec.rb
 - spec/unit/log_spec.rb
+- spec/unit/meter_spec.rb
 - spec/unit/new_spec.rb
 - spec/unit/pipeline_spec.rb
 - spec/unit/ratio_spec.rb
+- spec/unit/reset_spec.rb
 - spec/unit/resize_spec.rb
 - spec/unit/set_current_spec.rb
+- spec/unit/start_spec.rb
 - spec/unit/width_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
@@ -129,23 +144,32 @@ test_files:
 - spec/unit/clear_spec.rb
 - spec/unit/complete_spec.rb
 - spec/unit/converter/to_bytes_spec.rb
+- spec/unit/converter/to_seconds_spec.rb
 - spec/unit/converter/to_time_spec.rb
 - spec/unit/custom_formatter_spec.rb
+- spec/unit/finish_spec.rb
 - spec/unit/formatter/bar_spec.rb
+- spec/unit/formatter/byte_rate_spec.rb
 - spec/unit/formatter/current_byte_spec.rb
 - spec/unit/formatter/current_spec.rb
 - spec/unit/formatter/elapsed_spec.rb
 - spec/unit/formatter/estimated_spec.rb
+- spec/unit/formatter/mean_byte_spec.rb
+- spec/unit/formatter/mean_rate_spec.rb
 - spec/unit/formatter/percent_spec.rb
+- spec/unit/formatter/rate_spec.rb
 - spec/unit/formatter/total_byte_spec.rb
 - spec/unit/formatter/total_spec.rb
 - spec/unit/frequency_spec.rb
 - spec/unit/hide_cursor_spec.rb
 - spec/unit/log_spec.rb
+- spec/unit/meter_spec.rb
 - spec/unit/new_spec.rb
 - spec/unit/pipeline_spec.rb
 - spec/unit/ratio_spec.rb
+- spec/unit/reset_spec.rb
 - spec/unit/resize_spec.rb
 - spec/unit/set_current_spec.rb
+- spec/unit/start_spec.rb
 - spec/unit/width_spec.rb
 has_rdoc: