tty-spinner 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fcc097a53cf0eecf886ee4784e264033b035e5f
-  data.tar.gz: 749c0703578a4f0fd260c930eee3f1adf7e6c502
+  metadata.gz: ec461cddc1750681eca2382e8dff48841aa7dd95
+  data.tar.gz: 0c83312cf2d05f2c359b9b871cf5d2316078d66e
 SHA512:
-  metadata.gz: eb546b547b98b0630006660873fe0224ac839c82c67481d0b3711a453898bee0601f037fdbac596cbff54f1a33d62efb951f084c15a8100459a57ac08023aefb
-  data.tar.gz: c8b6121dccdbfbe8d3f0e1f04f662df51940d1ef2b3d42e227835e2c6394f95399bd9ed30db759be67bd615be19c81bbbb812781619f3db26ff5ee4dd0ac45a7
+  metadata.gz: e26527de9ece30e50817e6c2f96caa165e93146aaadedf3c5be9327a218ddb1c1be7f00a9f802b944448946ae48876c46f3b3de39b98d75e9d8225f5395db387
+  data.tar.gz: 0c6530fb8490ef81e9c8ae787adbd0cc342775c4b5e1d09b2755029f21c2b884fc1c6360db3eaf44a0ec83dca7e5bc9e22865673d913729330067914f9128942

data/README.md

@@ -127,9 +127,9 @@ sp2.success
 which when done will display:
 
 ```ruby
-┌[✔]] top
-├──[✔] one
-└──[✔] two
+┌ [✔] top
+├── [✔] one
+└── [✔] two
 ```
 
 For more usage examples please see [examples directory](https://github.com/piotrmurach/tty-spinner/tree/master/examples)

data/lib/tty/spinner.rb

@@ -24,7 +24,7 @@ module TTY
     TICK = '✔'.freeze
     CROSS = '✖'.freeze
 
-    CURSOR_USAGE_LOCK = Monitor.new
+    CURSOR_LOCK = Monitor.new
 
     # The object that responds to print call defaulting to stderr
     #
@@ -109,20 +109,18 @@ module TTY
       @thread      = nil
       @job         = nil
       @multispinner= nil
-      @index       = nil
+      @row         = nil
       @succeeded   = false
-      @first_run  = true
+      @first_run   = true
     end
 
     # Notifies the TTY::Spinner that it is running under a multispinner
     #
     # @param [TTY::Spinner::Multi] the multispinner that it is running under
-    # @param [Integer] the index of this spinner in the multispinner
     #
     # @api private
-    def add_multispinner(multispinner, index)
+    def add_multispinner(multispinner)
       @multispinner = multispinner
-      @index = index
     end
 
     # Whether the spinner has completed spinning
@@ -165,6 +163,11 @@ module TTY
 
     # Register callback
     #
+    # @param [Symbol] name
+    #   the name for the event to listen for, e.i. :complete
+    #
+    # @return [self]
+    #
     # @api public
     def on(name, &block)
       synchronize do
@@ -219,7 +222,7 @@ module TTY
     #
     # @api public
     def auto_spin
-      CURSOR_USAGE_LOCK.synchronize do
+      CURSOR_LOCK.synchronize do
         start
         sleep_time = 1.0 / @interval
 
@@ -465,14 +468,14 @@ module TTY
     # @api private
     def execute_on_line
       if @multispinner
-        CURSOR_USAGE_LOCK.synchronize do
-          lines_up = @multispinner.count_line_offset(@index)
-
+        CURSOR_LOCK.synchronize do
           if @first_run
+            @row = @multispinner.next_row
             yield if block_given?
             output.print "\n"
             @first_run = false
           else
+            lines_up = (@multispinner.rows + 1) - @row
             output.print TTY::Cursor.save
             output.print TTY::Cursor.up(lines_up)
             yield if block_given?
@@ -492,11 +495,9 @@ module TTY
     def write(data, clear_first = false)
       execute_on_line do
         output.print(TTY::Cursor.column(1)) if clear_first
-
         # If there's a top level spinner, print with inset
-        characters_in = @multispinner.nil? ? "" : @multispinner.line_inset(self)
-
-        output.print(characters_in + data)
+        characters_in = @multispinner.line_inset(self) if @multispinner
+        output.print("#{characters_in}#{data}")
         output.flush
       end
     end
@@ -505,8 +506,8 @@ module TTY
     #
     # @api private
     def emit(name, *args)
-      @callbacks[name].each do |block|
-        block.call(*args)
+      @callbacks[name].each do |callback|
+        callback.call(*args)
       end
     end
 

data/lib/tty/spinner/multi.rb

@@ -19,10 +19,15 @@ module TTY
 
       DEFAULT_INSET = {
         top:    Gem.win_platform? ? '+ '   : "\u250c ",
-        middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500",
-        bottom: Gem.win_platform? ? '|__ ' : "\u2514\u2500\u2500"
+        middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500 ",
+        bottom: Gem.win_platform? ? '|__ ' : "\u2514\u2500\u2500 "
       }.freeze
 
+      # The current count of all rendered rows
+      #
+      # @api public
+      attr_reader :rows
+
       # Initialize a multispinner
       #
       # @example
@@ -59,6 +64,7 @@ module TTY
           error:   [],
           done:    []
         }
+        @rows = 0
       end
 
       # Register a new spinner
@@ -71,9 +77,9 @@ module TTY
         spinner = TTY::Spinner.new(pattern, @options.merge(options))
 
         @create_spinner_lock.synchronize do
-          spinner.add_multispinner(self, @spinners.length)
+          spinner.add_multispinner(self)
           spinner.job(&job) if block_given?
-          observe_events(spinner) if @top_spinner
+          observe(spinner)
           @spinners << spinner
           if @top_spinner
             @spinners.each { |sp| sp.redraw_indent if sp.spinning? || sp.done? }
@@ -83,16 +89,13 @@ module TTY
         spinner
       end
 
-      # Observe all child events to notify top spinner of current state
+      # Increase a row count
       #
-      # @param [TTY::Spinner] spinner
-      #   the spinner to listen to for events
-      #
-      # @api private
-      def observe_events(spinner)
-        spinner.on(:success) { @top_spinner.success if success? }
-               .on(:error)   { @top_spinner.error if error? }
-               .on(:done)    { @top_spinner.stop if done? && !success? && !error? }
+      # @api public
+      def next_row
+        @create_spinner_lock.synchronize do
+          @rows += 1
+        end
       end
 
       # Get the top level spinner if it exists
@@ -124,6 +127,15 @@ module TTY
         jobs.each(&:join)
       end
 
+      # Perform a single spin animation
+      #
+      # @api public
+      def spin
+        raise "No top level spinner" if @top_spinner.nil?
+
+        @top_spinner.spin
+      end
+
       # Pause all spinners
       #
       # @api public
@@ -138,27 +150,6 @@ module TTY
         @spinners.dup.each(&:resume)
       end
 
-      # Find relative offset position to which to move the current cursor
-      #
-      # The position is found among the registered spinners given the current
-      # position the spinner is at provided its index
-      #
-      # @param [Integer] index
-      #   the position to search from
-      #
-      # @return [Integer]
-      #   the current position
-      #
-      # @api public
-      def count_line_offset(index)
-        Array(@spinners[index..-1]).reduce(0) do |acc, spinner|
-          if spinner.spinning? || spinner.done?
-            acc += 1
-          end
-          acc
-        end
-      end
-
       # Find the number of characters to move into the line
       # before printing the spinner
       #
@@ -213,8 +204,8 @@ module TTY
       #
       # @api public
       def stop
+        @top_spinner.stop if @top_spinner
         @spinners.dup.each(&:stop)
-        emit :done
       end
 
       # Stop all spinners with success status
@@ -223,7 +214,6 @@ module TTY
       def success
         @top_spinner.success if @top_spinner
         @spinners.dup.each(&:success)
-        emit :success
       end
 
       # Stop all spinners with error status
@@ -232,7 +222,6 @@ module TTY
       def error
         @top_spinner.error if @top_spinner
         @spinners.dup.each(&:error)
-        emit :error
       end
 
       # Listen on event
@@ -254,6 +243,54 @@ module TTY
           block.call(*args)
         end
       end
+
+      # Observe spinner for events to notify top spinner of current state
+      #
+      # @param [TTY::Spinner] spinner
+      #   the spinner to listen to for events
+      #
+      # @api private
+      def observe(spinner)
+        spinner.on(:success, &success_handler)
+               .on(:error, &error_handler)
+               .on(:done, &done_handler)
+      end
+
+      # Handle the success state
+      #
+      # @api private
+      def success_handler
+        proc do
+          if success?
+            @top_spinner.success if @top_spinner
+            emit(:success)
+          end
+        end
+      end
+
+      # Handle the error state
+      #
+      # @api private
+      def error_handler
+        proc do
+          if error?
+            @top_spinner.error if @top_spinner
+            @fired ||= emit(:error) # fire once
+          end
+        end
+      end
+
+      # Handle the done state
+      #
+      # @api private
+      def done_handler
+        proc do
+          if done?
+            @top_spinner.done if @top_spinner && !error? && !success?
+            emit(:done)
+          end
+        end
+      end
     end # MultiSpinner
   end # Spinner
 end # TTY

data/lib/tty/spinner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-spinner
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-09 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
 description: A terminal spinner for tasks that have non-deterministic time frame.
 email:
 - pmurach@gmail.com