tty-progressbar 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 439fab8fa2f01250536b13ccc0449b45666cc5b4
-  data.tar.gz: 71ba8ed5afc229ce963fbb0024c1412b3aa03a2c
+  metadata.gz: ae9ad2ae6d8a85a713de8ee733bcee99f30363ae
+  data.tar.gz: bf7550f7709ecf82fed2760ba04c15aca402fa10
 SHA512:
-  metadata.gz: da558151e07076430689c8342ddafb2960d8ef8f15cffc0cb9dc70c3d2b20f07b9c51361ffad8990d0d0985ee5df07db7da3530676d020f4bd32bfeceb8b3728
-  data.tar.gz: 5ac177be8d609806e52c83ae78e2cda8d9a1990c0376f6febb06a783d4d30d4f2dbfab427bcf26b2b41319ed1e967503837fb30f43413ef78391474cd05ba212
+  metadata.gz: 9a2ccc30badc32c66c6c83c98be1ec9509ab79ecec0cd79ed72f9c85c331d73f74403a40744db0489de026b7b9a2ba05d8875eedda7368dbe0dc1ae3ca1bde71
+  data.tar.gz: 211f366e8a8fefc4741da94388d783b98204c633826d652674c65827b01398c9d4aa08fa84d7dc6930050b3a8c6a58ab682b6da23e38dc19d4d6563da9212ef7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## [v0.10.0] - 2016-06-25
+
+### Fixed
+* Fix Meter#sample to accurately calculate rate and mean_rate by Sylvain Joyeux
+
 ## [v0.9.0] - 2016-04-09
 
 ### Fixed
@@ -85,6 +90,8 @@
 
 * Initial implementation and release
 
+[v0.10.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.9.0...v0.10.0
+[v0.9.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.8.2...v0.9.0
 [v0.8.2]: https://github.com/peter-murach/tty-progressbar/compare/v0.8.1...v0.8.2
 [v0.8.1]: https://github.com/peter-murach/tty-progressbar/compare/v0.8.0...v0.8.1
 [v0.8.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.7.0...v0.8.0

data/README.md

@@ -1,10 +1,11 @@
-# TTY::ProgressBar
+# 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]
 [![Code Climate](https://codeclimate.com/github/piotrmurach/tty-progressbar/badges/gpa.svg)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-progressbar/badge.svg)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/tty-progressbar.svg?branch=master)][inchpages]
 
+[gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-progressbar
 [travis]: http://travis-ci.org/piotrmurach/tty-progressbar
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty-progressbar

data/lib/tty/progressbar/meter.rb

@@ -14,32 +14,56 @@ module TTY
       #
       # @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
+        start
       end
 
       # Start sampling timer
       #
       # @api public
       def start
-        @start_time     = Time.now.to_f
-        @last_sample_at = @start_time
+        @start_time = Time.now
+        @current    = 0
+        @samples    = [[@start_time, 0]]
+        @rates      = []
+        @start_time
       end
 
       # Update meter with value
       #
+      # @param [Time] at
+      #   the time of the sampling
+      #
+      # @param [Integer] value
+      #   the current value of progress
+      #
       # @api public
       def sample(at, value)
-        if @interval < (at.to_f - @last_sample_at)
-          @marker += 1
+        @current += value
+        prune_samples(at)
+        @samples << [at, @current]
+        save_rate(at)
+      end
+
+      # Remove samples that are obsolete
+      #
+      # @api private
+      def prune_samples(at)
+        cutoff = at - @interval
+        while @samples.size > 1 && (@samples.first.first < cutoff)
+          @samples.shift
         end
-        @samples[@marker] << value
+      end
 
-        @last_sample_at = at.to_f
+      # If we crossed a period boundary since @start_time,
+      # save the rate for {#rates}
+      #
+      # @api private
+      def save_rate(at)
+        period_index = ((at - @start_time) / @interval).floor
+        while period_index > @rates.size
+          @rates << rate
+        end
       end
 
       # The current rate of sampling for a given interval
@@ -49,18 +73,20 @@ module TTY
       #
       # @api public
       def rate
-        samples = @samples[@marker]
-        result = samples.inject(:+).to_f / samples.size
-        result.nan? ? 0 : result
+        first_at, first_value = @samples.first
+        last_at,  last_value  = @samples.last
+        if first_at == last_at
+          0
+        else
+          (last_value - first_value) / (last_at - first_at)
+        end
       end
 
       # Group all rates per interval
       #
       # @api public
       def rates
-        @samples.reduce([]) do |acc, (key, _)|
-          acc << @samples[key].reduce(:+)
-        end
+        @rates + [rate]
       end
 
       # The mean rate of all the sampled rates
@@ -70,10 +96,11 @@ module TTY
       #
       # @api public
       def mean_rate
-        if rates.size == 1
-          rate
+        last_at, last_value = @samples.last
+        if last_at == @start_time
+          0
         else
-          rates.reduce(:+).to_f / rates.size
+          last_value / (last_at - @start_time)
         end
       end
       alias_method :avg_rate, :mean_rate
@@ -82,8 +109,7 @@ module TTY
       #
       # @api public
       def clear
-        @marker = 0
-        @samples.clear
+        start
       end
     end # Meter
   end # ProgressBar

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   end # ProgressBar
 end # TTY

data/spec/unit/formatter/byte_rate_spec.rb

@@ -9,6 +9,13 @@ RSpec.describe TTY::ProgressBar, ':byte_rate token' 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)
+    # Generate a serie of advances at 2s intervals
+    #   t+0     advance=0         total=0
+    #   t+2     advance=1000      total=1000
+    #   t+4     advance=2000      total=3000
+    #   t+6     advance=3000      total=6000
+    #   t+8     advance=4000      total=10_000
+    # NOTE: mean_byte uses 1024 for the scale in K, M ...
     5.times do |i|
       time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
       Timecop.freeze(time_now)
@@ -16,11 +23,11 @@ RSpec.describe TTY::ProgressBar, ':byte_rate token' do
     end
     output.rewind
     expect(output.read).to eq([
-      "\e[1G0.0B",
+      "\e[1G0B",
+      "\e[1G500.0B",
       "\e[1G1000.0B",
-      "\e[1G1.95KB",
-      "\e[1G2.93KB",
-      "\e[1G3.91KB\n"
+      "\e[1G1.46KB",
+      "\e[1G1.95KB\n"
     ].join)
     Timecop.return
   end

data/spec/unit/formatter/mean_byte_spec.rb

@@ -9,6 +9,13 @@ RSpec.describe TTY::ProgressBar, ':mean_byte token' 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)
+    # Generate a serie of advances at 2s intervals
+    #   t+0     advance=0         total=0
+    #   t+2     advance=1000      total=1000
+    #   t+4     advance=2000      total=3000
+    #   t+6     advance=3000      total=6000
+    #   t+8     advance=4000      total=10_000
+    # NOTE: mean_byte uses 1024 for the scale in K, M ...
     5.times do |i|
       time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
       Timecop.freeze(time_now)
@@ -16,11 +23,11 @@ RSpec.describe TTY::ProgressBar, ':mean_byte token' do
     end
     output.rewind
     expect(output.read).to eq([
-      "\e[1G0.0B",
+      "\e[1G0B",
       "\e[1G500.0B",
+      "\e[1G750.0B",
       "\e[1G1000.0B",
-      "\e[1G1.46KB",
-      "\e[1G1.95KB\n"
+      "\e[1G1.22KB\n"
     ].join)
     Timecop.return
   end

data/spec/unit/formatter/mean_rate_spec.rb

@@ -9,6 +9,12 @@ RSpec.describe TTY::ProgressBar, ':mean_rate token' 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)
+    # Generate a serie of advances at 2s intervals
+    #   t+0     advance=0       total=0
+    #   t+2     advance=10      total=10
+    #   t+4     advance=20      total=30
+    #   t+6     advance=30      total=60
+    #   t+8     advance=40      total=100
     5.times do |i|
       time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
       Timecop.freeze(time_now)
@@ -18,9 +24,9 @@ RSpec.describe TTY::ProgressBar, ':mean_rate token' do
     expect(output.read).to eq([
       "\e[1G 0.00",
       "\e[1G 5.00",
+      "\e[1G 7.50",
       "\e[1G10.00",
-      "\e[1G15.00",
-      "\e[1G20.00\n"
+      "\e[1G12.50\n"
     ].join)
     Timecop.return
   end

data/spec/unit/formatter/rate_spec.rb

@@ -9,6 +9,12 @@ RSpec.describe TTY::ProgressBar, ':rate token' 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)
+    # Generate a serie of advances at 2s intervals
+    #   t+0     advance=0       total=0
+    #   t+2     advance=10      total=10
+    #   t+4     advance=20      total=30
+    #   t+6     advance=30      total=60
+    #   t+8     advance=40      total=100
     5.times do |i|
       time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
       Timecop.freeze(time_now)
@@ -17,10 +23,10 @@ RSpec.describe TTY::ProgressBar, ':rate token' do
     output.rewind
     expect(output.read).to eq([
       "\e[1G 0.00",
+      "\e[1G 5.00",
       "\e[1G10.00",
-      "\e[1G20.00",
-      "\e[1G30.00",
-      "\e[1G40.00\n"
+      "\e[1G15.00",
+      "\e[1G20.00\n"
     ].join)
     Timecop.return
   end

data/spec/unit/meter_spec.rb

@@ -6,64 +6,67 @@ RSpec.describe TTY::ProgressBar::Meter, '#rate' do
 
   after { Timecop.return }
 
+  it "measures with no samples" do
+    meter = TTY::ProgressBar::Meter.new(1)
+
+    meter.start
+
+    expect(meter.rate).to eq(0)
+    expect(meter.mean_rate).to eq(0)
+  end
+
+  it "measures with a single sample" do
+    meter = TTY::ProgressBar::Meter.new(1)
+    start_time = Time.at(10, 0)
+    Timecop.freeze(start_time)
+    meter.start
+
+    meter.sample(Time.at(10, 100_000), 10)
+
+    expect(meter.rate).to eq(100)
+    expect(meter.mean_rate).to eq(100)
+  end
+
   it "measures rate per second" do
     meter = TTY::ProgressBar::Meter.new(1)
+    start_time = Time.at(10, 0)
+    Timecop.freeze(start_time)
     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)
+    meter.sample Time.at(10, 100_000), 5
+    expect(meter.rate).to eq(50)
+    expect(meter.mean_rate).to eq(50)
+
+    meter.sample Time.at(10, 500_000), 5
+    expect(meter.rate).to eq(20)
+    expect(meter.mean_rate).to eq(20)
+
+    meter.sample Time.at(11, 000_000), 5
+    expect(meter.rate).to eq(15)
+    expect(meter.mean_rate).to eq(15)
+
+    meter.sample Time.at(11, 500_000), 5
+    expect(meter.rate).to eq(10)
+    expect(meter.mean_rate).to be_within(0.001).of(13.333)
+
+    meter.sample Time.at(12, 000_000), 10
+    expect(meter.rate).to eq(15)
+    expect(meter.mean_rate).to eq(15)
   end
 
   it "clears measurements" do
     meter = TTY::ProgressBar::Meter.new(1)
+    start_time = Time.at(10, 0)
+    Timecop.freeze(start_time)
     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])
+    meter.sample(start_time + 1, 1000)
+    expect(meter.rates).to eq([1000, 1000])
     expect(meter.rate).to eq(1000)
 
     meter.clear
-    expect(meter.rates).to eq([])
+    expect(meter.rates).to eq([0])
     expect(meter.rate).to eq(0)
   end
 end

metadata

@@ -1,61 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-09 00:00:00.000000000 Z
+date: 2016-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A flexible progress bars drawing in terminal emulators.
@@ -65,10 +65,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .codeclimate.yml
-- .gitignore
-- .rspec
-- .travis.yml
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -147,17 +147,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A flexible progress bars drawing in terminal emulators.