tty-progressbar 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11bc77d708ba9f54e6efc5870c1865ce8937a0fc
-  data.tar.gz: 64d970dec5a9324a5639c5713ab922447afbb1b8
+  metadata.gz: 4da140c43179f280941fdc51b4c7927fd9dcd648
+  data.tar.gz: 76f93a77ce8edc4ee982476ae19f1c9c2372a5d0
 SHA512:
-  metadata.gz: 01ac6ab2668fea2bec216aa095e226e1c08ef388e442ddbe9a72c9772cf19f749a93e54085a5fac9488fc65c5c363e9f4500f2c4f4d01194abc571885ae47ac2
-  data.tar.gz: 81c443f7bf90e2f14a4ae9cd44e8fb5ea180598cae273000e4b5b335b0302cb911dbf84c440f5559bb5e8b8cd890e12378a32d8a5280a499f51e40b2edc3deab
+  metadata.gz: 4478e6b69a5d1531867f16808abd03dfbdfe2a86dc3faf789b94a33dd56d449d7e4058ac58958c994af442002e661be2b932fe72c253d03390c7c4edd04e34c2
+  data.tar.gz: cf73492360d38934724f208ef727100444c5e6c73efdebb928edfbaec0ad790d5cf8f40bebb889c9f70136cea8512a29c9e291b91a9e047d28b4528a2f8b186e

data/.travis.yml

@@ -2,6 +2,7 @@
 language: ruby
 sudo: false
 cache: bundler
+before_install: "gem update bundler"
 script: "bundle exec rake ci"
 rvm:
   - 1.9.3

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.12.1] - 2017-09-09
+
+### Added
+* Add rspec to gem development dependencies
+
+### Changed
+* Change line clearing to rely on tty-cursor
+
+### Fixed
+* Fix multi bar finishing before registered progress bars
+
 ## [v0.12.0] - 2017-09-03
 
 ### Added
@@ -127,6 +138,7 @@
 
 * Initial implementation and release
 
+[v0.12.1]: https://github.com/peter-murach/tty-progressbar/compare/v0.12.0...v0.12.1
 [v0.12.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.11.0...v0.12.0
 [v0.11.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.10.1...v0.11.0
 [v0.10.1]: https://github.com/peter-murach/tty-progressbar/compare/v0.10.0...v0.10.1

data/Gemfile

@@ -3,7 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rspec',   '~> 3.5.0'
   gem 'timecop', '~> 0.8.1'
   gem 'pastel',  '~> 0.7.0'
   gem 'coveralls', '~> 0.8.13'

data/examples/multi/main_bar.rb

@@ -4,14 +4,14 @@ require 'tty-progressbar'
 
 bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
 
-bar1 = bars.register "foo [:bar] :percent", total: 20
-bar2 = bars.register "bar [:bar] :percent", total: 30
-bar3 = bars.register "baz [:bar] :percent", total: 10
+bar1 = bars.register "foo [:bar] :percent", total: 15
+bar2 = bars.register "bar [:bar] :percent", total: 15
+bar3 = bars.register "baz [:bar] :percent", total: 45
 
 bars.start
 
-th1 = Thread.new { 20.times { sleep(0.2); bar1.advance } }
-th2 = Thread.new { 30.times { sleep(0.1); bar2.advance } }
-th3 = Thread.new { 10.times { sleep(0.3); bar3.advance } }
+th1 = Thread.new { 15.times { sleep(0.1); bar1.advance } }
+th2 = Thread.new { 15.times { sleep(0.1); bar2.advance } }
+th3 = Thread.new { 45.times { sleep(0.1); bar3.advance } }
 
 [th1, th2, th3].each(&:join)

data/lib/tty/progressbar.rb

@@ -20,13 +20,7 @@ module TTY
     extend Forwardable
     include MonitorMixin
 
-    ECMA_ESC = "\e".freeze
     ECMA_CSI = "\e[".freeze
-    ECMA_CLR = 'K'.freeze
-
-    DEC_RST  = 'l'.freeze
-    DEC_SET  = 'h'.freeze
-    DEC_TCEM = '?25'.freeze
 
     CURSOR_LOCK = Monitor.new
 
@@ -242,7 +236,7 @@ module TTY
     def render
       return if done?
       if hide_cursor && @last_render_width == 0 && !(@current >= total)
-        write(ECMA_CSI + DEC_TCEM + DEC_RST)
+        write(TTY::Cursor.hide)
       end
 
       formatted = @formatter.decorate(self, @format)
@@ -316,7 +310,7 @@ module TTY
     def finish
       # reenable cursor if it is turned off
       if hide_cursor && @last_render_width != 0
-        write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
+        write(TTY::Cursor.show, false)
       end
       return if done?
       @current = total unless no_width
@@ -334,7 +328,7 @@ module TTY
     def stop
       # reenable cursor if it is turned off
       if hide_cursor && @last_render_width != 0
-        write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
+        write(TTY::Cursor.show, false)
       end
       return if done?
       render
@@ -349,7 +343,7 @@ module TTY
     #
     # @api public
     def clear_line
-      output.print(ECMA_CSI + '0m' + ECMA_CSI + '1000D' + ECMA_CSI + ECMA_CLR)
+      output.print(ECMA_CSI + '0m' + TTY::Cursor.clear_line)
     end
 
     # Check if progress is finised

data/lib/tty/progressbar/multi.rb

@@ -50,7 +50,7 @@ module TTY
         @bars = []
         @rows = 0
         @top_bar = nil
-        @top_bar = register(format) if format
+        @top_bar = register(format, observable: false) if format
 
         @callbacks = {
           progress: [],
@@ -66,15 +66,15 @@ module TTY
       #
       # @api public
       def register(format, options = {})
+        observable = options.delete(:observable) { true }
         bar = TTY::ProgressBar.new(format, @options.merge(options))
 
         synchronize do
           bar.attach_to(self)
           @bars << bar
-
+          observe(bar) if observable
           if @top_bar
             @top_bar.update(total: total, width: total)
-            observe(bar)
           end
         end
 
@@ -95,11 +95,21 @@ module TTY
       # @param [TTY::ProgressBar] bar
       #   the bar to observe for events
       #
-      # @api public
+      # @api private
       def observe(bar)
-        bar.on(:progress) { top_bar.current = current; emit(:progress) }
-           .on(:done)     { top_bar.finish; emit(:done) if complete?  }
-           .on(:stopped)  { top_bar.stop; emit(:stopped) if stopped? }
+        bar.on(:progress, &progress_handler)
+           .on(:done) { emit(:done) if complete? }
+           .on(:stopped)  { emit(:stopped) if stopped? }
+      end
+
+      # Handle the progress event
+      #
+      # @api private
+      def progress_handler
+        proc do
+          @top_bar.current = current if @top_bar
+          emit(:progress)
+        end
       end
 
       # Get the top level bar if it exists
@@ -123,7 +133,9 @@ module TTY
       #
       # @api public
       def total
-        (@bars - [@top_bar]).dup.map(&:total).reduce(&:+)
+        synchronize do
+          (@bars - [@top_bar]).dup.map(&:total).reduce(&:+)
+        end
       end
 
       # Calculate total current progress of all bars
@@ -132,7 +144,9 @@ module TTY
       #
       # @api public
       def current
-        (@bars - [@top_bar]).dup.map(&:current).reduce(&:+)
+        synchronize do
+          (@bars - [@top_bar]).dup.map(&:current).reduce(&:+)
+        end
       end
 
       # Check if all progress bars are complete
@@ -141,7 +155,9 @@ module TTY
       #
       # @api public
       def complete?
-        (@bars - [@top_bar]).dup.all?(&:complete?)
+        synchronize do
+          (@bars - [@top_bar]).dup.all?(&:complete?)
+        end
       end
 
       # Check if any of the registered progress bars is stopped
@@ -150,7 +166,9 @@ module TTY
       #
       # @api public
       def stopped?
-        (@bars - [@top_bar]).dup.any?(&:stopped?)
+        synchronize do
+          (@bars - [@top_bar]).dup.any?(&:stopped?)
+        end
       end
 
       # Stop all progress bars
@@ -164,7 +182,6 @@ module TTY
       #
       # @api public
       def finish
-        @top_bar.finish if @top_bar
         @bars.dup.each(&:finish)
       end
 

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = '0.12.0'
+    VERSION = '0.12.1'
   end # ProgressBar
 end # TTY

data/spec/unit/clear_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe TTY::ProgressBar, 'clear' do
       "\e[1G[==   ]",
       "\e[1G[===  ]",
       "\e[1G[==== ]",
-      "\e[1G[=====]\e[0m\e[1000D\e[K"
+      "\e[1G[=====]\e[0m\e[2K\e[1G"
     ].join)
   end
 end

data/spec/unit/multi/events_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe TTY::ProgressBar::Multi, 'events' do
   let(:output) { StringIO.new('', 'w+') }
 
-  it "emits :progress eent when any of the registerd bars advances" do
+  it "emits :progress event when any of the registerd bars advances" do
     events = []
     bars = TTY::ProgressBar::Multi.new("[:bar]", output: output, total: 5)
     bars.on(:progress) { events << :progress }
@@ -14,31 +14,57 @@ RSpec.describe TTY::ProgressBar::Multi, 'events' do
     expect(events).to eq([:progress])
   end
 
-  it "emits :done event when all progress bars finished" do
+  it "emits :done event when all progress bars finished under top level" do
     events = []
     bars = TTY::ProgressBar::Multi.new("[:bar]", output: output, total: 5)
     bars.on(:done) { events << :done }
-
     bar = bars.register "one [:bar]"
 
     bar.finish
 
     expect(events).to eq([:done])
+    expect(bar.complete?).to eq(true)
   end
 
-  it "emits :done event when top level bar finished" do
+  it "emits :done event when all progress bars finished without top level" do
+    events = []
+    bars = TTY::ProgressBar::Multi.new(output: output)
+    bars.on(:done) { events << :done }
+    bar = bars.register "one [:bar]", total: 5
+
+    bar.finish
+
+    expect(events).to eq([:done])
+    expect(bars.complete?).to eq(true)
+  end
+
+  it "emits :done event when top level registered bar finished" do
     events = []
     bars = TTY::ProgressBar::Multi.new("[:bar]", output: output, total: 5)
     bars.on(:done) { events << :done }
 
-    bars.register "one [:bar]"
+    bar = bars.register "one [:bar]", total: 5
 
     bars.finish
 
     expect(events).to eq([:done])
+    expect(bar.complete?).to eq(true)
   end
 
-  it "emits :stopped event when all registerd bars are stopped" do
+  it "emits :done event when top level bar finished" do
+    events = []
+    bars = TTY::ProgressBar::Multi.new(output: output)
+    bars.on(:done) { events << :done }
+
+    bar = bars.register "one [:bar]", total: 5
+
+    bars.finish
+
+    expect(events).to eq([:done])
+    expect(bar.complete?).to eq(true)
+  end
+
+  it "emits :stopped event when all registerd bars are stopped under top level" do
     events = []
     bars = TTY::ProgressBar::Multi.new("[:bar]", output: output, total: 5)
     bars.on(:stopped) { events << :stopped }
@@ -48,9 +74,23 @@ RSpec.describe TTY::ProgressBar::Multi, 'events' do
     bar.stop
 
     expect(events).to eq([:stopped])
+    expect(bars.stopped?).to eq(true)
+  end
+
+  it "emits :stopped event when all registerd bars are stopped without top level" do
+    events = []
+    bars = TTY::ProgressBar::Multi.new(output: output)
+    bars.on(:stopped) { events << :stopped }
+
+    bar = bars.register "one [:bar]", total: 5
+
+    bar.stop
+
+    expect(events).to eq([:stopped])
+    expect(bars.stopped?).to eq(true)
   end
 
-  it "emits :stopped event when top level bar finished" do
+  it "emits :stopped event when registerd multi bar finished" do
     events = []
     bars = TTY::ProgressBar::Multi.new("[:bar]", output: output, total: 5)
     bars.on(:stopped) { events << :stopped }
@@ -61,4 +101,17 @@ RSpec.describe TTY::ProgressBar::Multi, 'events' do
 
     expect(events).to eq([:stopped])
   end
+
+  it "emits :stopped event when multi bar finished" do
+    events = []
+    bars = TTY::ProgressBar::Multi.new(output: output)
+    bars.on(:stopped) { events << :stopped }
+
+    bars.register "one [:bar]", total: 5
+
+    bars.stop
+
+    expect(events).to eq([:stopped])
+    expect(bars.stopped?).to eq(true)
+  end
 end

data/spec/unit/multi/finish_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe TTY::ProgressBar::Multi, '#finish' do
   let(:output) { StringIO.new('', 'w+') }
 
-  it "finishes all bars" do
+  it "finishes all bars with top level" do
     bars = TTY::ProgressBar::Multi.new("main [:bar]", output: output)
 
     bar1 = bars.register("[:bar]", total: 5)
@@ -16,4 +16,28 @@ RSpec.describe TTY::ProgressBar::Multi, '#finish' do
 
     expect(bars.complete?).to eq(true)
   end
+
+  it "finishes all bars without top level" do
+    bars = TTY::ProgressBar::Multi.new(output: output)
+
+    bar1 = bars.register("[:bar]", total: 5)
+    bar2 = bars.register("[:bar]", total: 10)
+
+    bar1.finish
+    bar2.finish
+
+    expect(bars.complete?).to eq(true)
+  end
+
+  it "finishes top level" do
+    bars = TTY::ProgressBar::Multi.new(output: output)
+
+    bar1 = bars.register("[:bar]", total: 5)
+    bar2 = bars.register("[:bar]", total: 10)
+
+    bars.finish
+
+    expect(bar1.complete?).to eq(true)
+    expect(bar2.complete?).to eq(true)
+  end
 end

data/spec/unit/multi/register_spec.rb

@@ -17,6 +17,7 @@ RSpec.describe TTY::ProgressBar::Multi, '#register' do
   it "uses global options to register instance" do
     bars = TTY::ProgressBar::Multi.new(output: output, total: 100)
     bar = double(:bar, attach_to: nil)
+    allow(bar).to receive(:on).and_return(bar)
     allow(TTY::ProgressBar).to receive(:new).and_return(bar)
 
     bars.register("[:bar]")

data/spec/unit/resize_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe TTY::ProgressBar, '#resize' do
     expect(output.read).to eq([
       "\e[1G[==        ]",
       "\e[1G[====      ]",
-      "\e[0m\e[1000D\e[K",
+      "\e[0m\e[2K\e[1G",
       "\e[1G[===  ]",
       "\e[1G[==== ]",
       "\e[1G[=====]\n"
@@ -28,7 +28,7 @@ RSpec.describe TTY::ProgressBar, '#resize' do
     expect(output.read).to eq([
       "\e[1G[==        ]",
       "\e[1G[====      ]",
-      "\e[0m\e[1000D\e[K",
+      "\e[0m\e[2K\e[1G",
       "\e[1G[============        ]",
       "\e[1G[================    ]",
       "\e[1G[====================]\n"

data/tty-progressbar.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "tty-screen", '~> 0.5.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-03 00:00:00.000000000 Z
+date: 2017-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement