tty-spinner 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec461cddc1750681eca2382e8dff48841aa7dd95
-  data.tar.gz: 0c83312cf2d05f2c359b9b871cf5d2316078d66e
+  metadata.gz: 3e159c565080b22ece86e4771413feb3edcd39b3
+  data.tar.gz: 890c0f15b5b77de235f25295cbb861745c514b60
 SHA512:
-  metadata.gz: e26527de9ece30e50817e6c2f96caa165e93146aaadedf3c5be9327a218ddb1c1be7f00a9f802b944448946ae48876c46f3b3de39b98d75e9d8225f5395db387
-  data.tar.gz: 0c6530fb8490ef81e9c8ae787adbd0cc342775c4b5e1d09b2755029f21c2b884fc1c6360db3eaf44a0ec83dca7e5bc9e22865673d913729330067914f9128942
+  metadata.gz: 88a4bbd2545b596b43ff8ad0ffc9790a125da1a00c2bc4f436e4aa6879536767b3b32ae8de98e928adc785d9e55ff1120ef3c68270db265d691726b522a6606d
+  data.tar.gz: 7a138538758b9805c098e397d136dbfafb69bfcd596272078eb5294d3ad5df3a595cd547afe69fc6ba19ab3fd8fc552e9406a99cabfbab3176e098fa36559e59

data/README.md

@@ -407,14 +407,14 @@ If options are passed, they will override any options given to the multi spinner
 
 ### 5.2 auto_spin
 
-The multispinner has to have been given a message on initialization.
-To perform automatic spinning animation use `auto_spin` method like so:
+To create a top level spinner that tracks activity of all the registered spinners, the multispinner has to have been given a message on initialization:
 
 ```ruby
 multi_spinner = TTY::Spinner::Multi.new("[:spinner] Top level spinner")
-multi_spinner.auto_spin
 ```
 
+The top level multi spinner will perform spinning animation automatically when at least one of the registered spinners starts spinning.
+
 If you register spinners without any tasks then you will have to manually control when the `multi_spinner` finishes by calling `stop`, `success` or `error` (see [manual](#521-manual-async)).
 
 Alternatively, you can register spinners with tasks that will automatically animate and finish spinners when respective tasks are done (see [async tasks](#522-auto-async-tasks)).
@@ -441,17 +441,23 @@ spinner_2 = spinners.register "[:spinner] two"
 Once registered, you can set spinners running in separate threads:
 
 ```ruby
-multi_spinner.auto_spin
 spinner_1.auto_spin
 spinner_2.auto_spin
 ```
 
-Finnally, you need to stop each spinner manually, in our case we mark the multi spinner as failure as one of its children has been marked as failure:
+Finnally, you need to stop each spinner manually, in our case we mark the second spinner as failure which in turn will stop the top level multi spinner automatically and mark it as failure:
 
 ```ruby
 spinner_1.success
 spinner_2.error
-multi_spinner.error
+```
+
+The result may look like this:
+
+```ruby
+┌ [✖] top
+├── [✔] one
+└── [✖] two
 ```
 
 #### 5.2.2 auto async tasks

data/lib/tty/spinner.rb

@@ -61,6 +61,8 @@ module TTY
     # @api public
     attr_reader :tokens
 
+    attr_reader :interval
+
     # Initialize a spinner
     #
     # @example
@@ -100,6 +102,7 @@ module TTY
       @interval    = options.fetch(:interval) do
                        fetch_format(@format.to_sym, :interval)
                      end
+      @row         = options[:row]
 
       @callbacks   = Hash.new { |h, k| h[k] = [] }
       @length      = @frames.length
@@ -109,7 +112,6 @@ module TTY
       @thread      = nil
       @job         = nil
       @multispinner= nil
-      @row         = nil
       @succeeded   = false
       @first_run   = true
     end
@@ -119,7 +121,7 @@ module TTY
     # @param [TTY::Spinner::Multi] the multispinner that it is running under
     #
     # @api private
-    def add_multispinner(multispinner)
+    def attach_to(multispinner)
       @multispinner = multispinner
     end
 
@@ -332,6 +334,7 @@ module TTY
     def spin
       synchronize do
         return if @done
+        emit(:spin)
 
         if @hide_cursor && !spinning?
           write(TTY::Cursor.hide)
@@ -470,7 +473,7 @@ module TTY
       if @multispinner
         CURSOR_LOCK.synchronize do
           if @first_run
-            @row = @multispinner.next_row
+            @row ||= @multispinner.next_row
             yield if block_given?
             output.print "\n"
             @first_run = false

data/lib/tty/spinner/multi.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
+require 'monitor'
 require 'forwardable'
 
 require_relative '../spinner'
@@ -12,6 +13,7 @@ module TTY
     # @api public
     class Multi
       include Enumerable
+      include MonitorMixin
 
       extend Forwardable
 
@@ -51,20 +53,24 @@ module TTY
       #
       # @api public
       def initialize(*args)
+        super()
         @options = args.last.is_a?(::Hash) ? args.pop : {}
         message = args.empty? ? nil : args.pop
-        @inset_opts = @options.delete(:style) { DEFAULT_INSET }
-        @create_spinner_lock = Mutex.new
+        @inset_opts  = @options.delete(:style) { DEFAULT_INSET }
+        @rows        = 0
         @spinners    = []
         @top_spinner = nil
-        @top_spinner = register(message) unless message.nil?
+        @last_spin_at = nil
+        unless message.nil?
+          @top_spinner = register(message, observable: false, row: next_row)
+        end
 
         @callbacks = {
           success: [],
           error:   [],
-          done:    []
+          done:    [],
+          spin:    []
         }
-        @rows = 0
       end
 
       # Register a new spinner
@@ -74,12 +80,13 @@ module TTY
       #
       # @api public
       def register(pattern, options = {}, &job)
+        observable = options.delete(:observable) { true }
         spinner = TTY::Spinner.new(pattern, @options.merge(options))
 
-        @create_spinner_lock.synchronize do
-          spinner.add_multispinner(self)
+        synchronize do
+          spinner.attach_to(self)
           spinner.job(&job) if block_given?
-          observe(spinner)
+          observe(spinner) if observable
           @spinners << spinner
           if @top_spinner
             @spinners.each { |sp| sp.redraw_indent if sp.spinning? || sp.done? }
@@ -93,7 +100,7 @@ module TTY
       #
       # @api public
       def next_row
-        @create_spinner_lock.synchronize do
+        synchronize do
           @rows += 1
         end
       end
@@ -116,7 +123,6 @@ module TTY
       def auto_spin
         raise "No top level spinner" if @top_spinner.nil?
 
-        @top_spinner.auto_spin
         jobs = []
         @spinners.each do |spinner|
           if spinner.job?
@@ -133,7 +139,9 @@ module TTY
       def spin
         raise "No top level spinner" if @top_spinner.nil?
 
-        @top_spinner.spin
+        synchronize do
+          throttle { @top_spinner.spin }
+        end
       end
 
       # Pause all spinners
@@ -179,7 +187,9 @@ module TTY
       #
       # @api public
       def done?
-        (@spinners - [@top_spinner]).all?(&:done?)
+        synchronize do
+          (@spinners - [@top_spinner]).all?(&:done?)
+        end
       end
 
       # Check if all spinners succeeded
@@ -188,7 +198,9 @@ module TTY
       #
       # @api public
       def success?
-        (@spinners - [@top_spinner]).all?(&:success?)
+        synchronize do
+          (@spinners - [@top_spinner]).all?(&:success?)
+        end
       end
 
       # Check if any spinner errored
@@ -197,14 +209,15 @@ module TTY
       #
       # @api public
       def error?
-        (@spinners - [@top_spinner]).any?(&:error?)
+        synchronize do
+          (@spinners - [@top_spinner]).any?(&:error?)
+        end
       end
 
       # Stop all spinners
       #
       # @api public
       def stop
-        @top_spinner.stop if @top_spinner
         @spinners.dup.each(&:stop)
       end
 
@@ -212,7 +225,6 @@ module TTY
       #
       # @api public
       def success
-        @top_spinner.success if @top_spinner
         @spinners.dup.each(&:success)
       end
 
@@ -220,7 +232,6 @@ module TTY
       #
       # @api public
       def error
-        @top_spinner.error if @top_spinner
         @spinners.dup.each(&:error)
       end
 
@@ -230,7 +241,7 @@ module TTY
       def on(key, &callback)
         unless @callbacks.key?(key)
           raise ArgumentError, "The event #{key} does not exist. "\
-                               " Use :success, :error, or :done instead"
+                               ' Use :spin, :success, :error, or :done instead'
         end
         @callbacks[key] << callback
         self
@@ -238,6 +249,22 @@ module TTY
 
       private
 
+      # Check if this spinner should revolve to keep constant speed
+      # matching top spinner interval
+      #
+      # @api private
+      def throttle
+        sleep_time = 1.0 / @top_spinner.interval
+        if @last_spin_at && Time.now - @last_spin_at < sleep_time
+          return
+        end
+        yield if block_given?
+        @last_spin_at = Time.now
+      end
+
+      # Fire an event
+      #
+      # @api private
       def emit(key, *args)
         @callbacks[key].each do |block|
           block.call(*args)
@@ -251,11 +278,22 @@ module TTY
       #
       # @api private
       def observe(spinner)
-        spinner.on(:success, &success_handler)
+        spinner.on(:spin, &spin_handler)
+               .on(:success, &success_handler)
                .on(:error, &error_handler)
                .on(:done, &done_handler)
       end
 
+      # Handle spin event
+      #
+      # @api private
+      def spin_handler
+        proc do
+          spin if @top_spinner
+          emit(:spin)
+        end
+      end
+
       # Handle the success state
       #
       # @api private
@@ -286,7 +324,7 @@ module TTY
       def done_handler
         proc do
           if done?
-            @top_spinner.done if @top_spinner && !error? && !success?
+            @top_spinner.stop if @top_spinner && !error? && !success?
             emit(:done)
           end
         end

data/lib/tty/spinner/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Spinner
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end # Spinner
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-spinner
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor