tty-spinner 0.8.0 → 0.9.0

data/examples/multi/pause.rb

@@ -0,0 +1,26 @@
+require_relative '../../lib/tty-spinner'
+
+spinners = TTY::Spinner::Multi.new("[:spinner]")
+
+sp1 = spinners.register("[:spinner] one")
+sp2 = spinners.register("[:spinner] two")
+sp3 = spinners.register("[:spinner] three")
+
+sp1.auto_spin
+sp2.auto_spin
+sp3.auto_spin
+
+sleep(1)
+
+spinners.pause
+
+sleep(1)
+
+spinners.resume
+
+sleep(1)
+
+sp1.stop
+sp2.stop
+sp3.stop
+spinners.stop

data/examples/multi/threaded.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/tty-spinner'
+
+def spinner_options
+  [
+    ":spinner \e[1mNo\e[0m :number Row :line",
+    format: :dots,
+    error_mark: '✖',
+    success_mark: "\e[1m\e[32m✓\e[0m\e[0m"
+  ]
+end
+
+spinners = TTY::Spinner::Multi.new(*spinner_options)
+threads = []
+
+20.times do |i|
+  threads << Thread.new do
+    spinner = spinners.register(*spinner_options)
+    sleep Random.rand(0.1..0.3)
+
+    10.times do
+      sleep Random.rand(0.1..0.3)
+      spinner.update(number: "(#{i})", line: spinner.row)
+      spinner.spin
+    end
+  end
+end
+
+threads.each(&:join)

data/examples/pause.rb

@@ -0,0 +1,19 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("[:spinner] Task name")
+
+spinner.auto_spin
+
+sleep(2)
+
+spinner.pause
+
+sleep(2)
+
+spinner.resume
+
+sleep(2)
+
+spinner.stop
+
+puts

data/examples/run.rb

@@ -0,0 +1,18 @@
+require_relative '../lib/tty-spinner'
+
+# without block
+spinner = TTY::Spinner.new(":title :spinner ...", format: :pulse_3)
+
+def long_task
+  10000000.times do |n|
+    n * n
+  end
+end
+
+spinner.update(title: 'Task 1')
+spinner.run 'done' do
+  long_task
+end
+
+spinner.update(title: 'Task 2')
+spinner.run('done') { long_task }

data/examples/success.rb

@@ -0,0 +1,9 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("[:spinner] Task name")
+20.times do
+  spinner.spin
+  sleep(0.1)
+end
+
+spinner.success('(successful)')

data/examples/threaded.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new("[:spinner]")
+
+th1 = Thread.new { 10.times { spinner.spin; sleep(0.1) } }
+th2 = Thread.new { 10.times { spinner.spin; sleep(0.1) } }
+th3 = Thread.new { 10.times { spinner.spin; sleep(0.1) } }
+
+[th1, th2, th3].each(&:join)
+
+spinner.success

data/examples/update.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/tty-spinner'
+
+spinner = TTY::Spinner.new(":spinner :title", format: :pulse_3)
+
+spinner.update(title: 'task aaaaa')
+
+20.times { spinner.spin; sleep(0.1) }
+
+spinner.update(title: 'task b')
+
+20.times { spinner.spin; sleep(0.1) }

data/lib/tty-spinner.rb

@@ -1,4 +1,2 @@
-# encoding: utf-8
-
 require_relative 'tty/spinner'
 require_relative 'tty/spinner/multi'

data/lib/tty/spinner.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'monitor'
@@ -18,11 +17,11 @@ module TTY
     # @raised when attempting to join dead thread
     NotSpinningError = Class.new(StandardError)
 
-    ECMA_CSI = "\x1b[".freeze
+    ECMA_CSI = "\x1b["
 
     MATCHER = /:spinner/
-    TICK = '✔'.freeze
-    CROSS = '✖'.freeze
+    TICK = '✔'
+    CROSS = '✖'
 
     CURSOR_LOCK = Monitor.new
 
@@ -61,8 +60,16 @@ module TTY
     # @api public
     attr_reader :tokens
 
+    # The amount of time between frames in auto spinning
+    #
+    # @api public
     attr_reader :interval
 
+    # The current row inside the multi spinner
+    #
+    # @api public
+    attr_reader :row
+
     # Initialize a spinner
     #
     # @example
@@ -106,14 +113,23 @@ module TTY
 
       @callbacks   = Hash.new { |h, k| h[k] = [] }
       @length      = @frames.length
-      @current     = 0
-      @done        = false
-      @state       = :stopped
       @thread      = nil
       @job         = nil
       @multispinner= nil
-      @succeeded   = false
-      @first_run   = true
+      reset
+    end
+
+    # Reset the spinner to initial frame
+    #
+    # @api public
+    def reset
+      synchronize do
+        @current   = 0
+        @done      = false
+        @state     = :stopped
+        @succeeded = false
+        @first_run = true
+      end
     end
 
     # Notifies the TTY::Spinner that it is running under a multispinner
@@ -202,13 +218,11 @@ module TTY
 
     # Execute this spinner job
     #
+    # @yield [TTY::Spinner]
+    #
     # @api public
     def execute_job
-      if job.arity.zero?
-        instance_eval(&job)
-      else
-        job.(self)
-      end
+      job.(self) if job?
     end
 
     # Check if this spinner has a scheduled job
@@ -241,6 +255,10 @@ module TTY
           end
         end
       end
+    ensure
+      if @hide_cursor
+        write(TTY::Cursor.show, false)
+      end
     end
 
     # Checked if current spinner is paused
@@ -370,9 +388,6 @@ module TTY
       mon_enter
       return if done?
 
-      if @hide_cursor
-        write(TTY::Cursor.show, false)
-      end
       clear_line
       return if @clear
 
@@ -388,6 +403,11 @@ module TTY
       @state      = :stopped
       @done       = true
       @started_at = nil
+
+      if @hide_cursor
+        write(TTY::Cursor.show, false)
+      end
+
       emit(:done)
       kill
       mon_exit
@@ -454,16 +474,6 @@ module TTY
       end
     end
 
-    # Reset the spinner to initial frame
-    #
-    # @api public
-    def reset
-      synchronize do
-        @current = 0
-        @first_run = true
-      end
-    end
-
     private
 
     # Execute a block on the proper terminal line if the spinner is running
@@ -472,7 +482,7 @@ module TTY
     # @api private
     def execute_on_line
       if @multispinner
-        CURSOR_LOCK.synchronize do
+        @multispinner.synchronize do
           if @first_run
             @row ||= @multispinner.next_row
             yield if block_given?
@@ -502,7 +512,7 @@ module TTY
       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.line_inset(self) if @multispinner
+        characters_in = @multispinner.line_inset(@row) if @multispinner
         output.print("#{characters_in}#{data}")
         output.flush
       end
@@ -553,7 +563,7 @@ module TTY
     def replace_tokens(string)
       data = string.dup
       @tokens.each do |name, val|
-        data.gsub!(/\:#{name}/, val)
+        data.gsub!(/\:#{name}/, val.to_s)
       end
       data
     end

data/lib/tty/spinner/formats.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module TTY
   module Formats
@@ -21,7 +21,7 @@ module TTY
       },
       spin_4: {
         interval: 10,
-        frames: %w{╫ ╪'}
+        frames: %w{╫ ╪}
       },
       pulse: {
         interval: 10,
@@ -164,7 +164,7 @@ module TTY
       },
       flip: {
         interval: 10,
-        frames: '-◡⊙-◠'.freeze
+        frames: '-◡⊙-◠'
       },
       burger: {
         interval: 6,

data/lib/tty/spinner/multi.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'monitor'
@@ -23,7 +22,7 @@ module TTY
         top:    Gem.win_platform? ? '+ '   : "\u250c ",
         middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500 ",
         bottom: Gem.win_platform? ? '|__ ' : "\u2514\u2500\u2500 "
-      }.freeze
+      }
 
       # The current count of all rendered rows
       #
@@ -59,6 +58,7 @@ module TTY
         @inset_opts  = @options.delete(:style) { DEFAULT_INSET }
         @rows        = 0
         @spinners    = []
+        @spinners_count = 0
         @top_spinner = nil
         @last_spin_at = nil
         unless message.nil?
@@ -75,19 +75,21 @@ module TTY
 
       # Register a new spinner
       #
-      # @param [String] pattern
-      #   the pattern used for creating spinner
+      # @param [String, TTY::Spinner] pattern_or_spinner
+      #   the pattern used for creating spinner, or a spinner instance
       #
       # @api public
-      def register(pattern, options = {}, &job)
+      def register(pattern_or_spinner, **options, &job)
         observable = options.delete(:observable) { true }
-        spinner = TTY::Spinner.new(pattern, @options.merge(options))
+        spinner = nil
 
         synchronize do
+          spinner = create_spinner(pattern_or_spinner, options)
           spinner.attach_to(self)
           spinner.job(&job) if block_given?
           observe(spinner) if observable
           @spinners << spinner
+          @spinners_count += 1
           if @top_spinner
             @spinners.each { |sp| sp.redraw_indent if sp.spinning? || sp.done? }
           end
@@ -96,6 +98,24 @@ module TTY
         spinner
       end
 
+      # Create a spinner instance
+      #
+      # @api private
+      def create_spinner(pattern_or_spinner, options)
+        case pattern_or_spinner
+        when ::String
+          TTY::Spinner.new(
+            pattern_or_spinner,
+            @options.merge(options)
+          )
+        when ::TTY::Spinner
+          pattern_or_spinner
+        else
+          raise ArgumentError, "Expected a pattern or spinner, " \
+            "got: #{pattern_or_spinner.class}"
+        end
+      end
+
       # Increase a row count
       #
       # @api public
@@ -161,20 +181,19 @@ module TTY
       # Find the number of characters to move into the line
       # before printing the spinner
       #
-      # @param [TTY::Spinner] spinner
-      #   the spinner for which line inset is calculated
+      # @param [Integer] line_no
+      #   the current spinner line number for which line inset is calculated
       #
       # @return [String]
       #   the inset
       #
       # @api public
-      def line_inset(spinner)
+      def line_inset(line_no)
         return '' if @top_spinner.nil?
 
-        case spinner
-        when @top_spinner
+        if line_no == 1
           @inset_opts[:top]
-        when @spinners.last
+        elsif line_no == @spinners_count
           @inset_opts[:bottom]
         else
           @inset_opts[:middle]

data/lib/tty/spinner/version.rb

@@ -1,7 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Spinner
-    VERSION = '0.8.0'.freeze
+    VERSION = '0.9.0'
   end # Spinner
 end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require 'tty-spinner'
+
+class StringIO
+  def tty?
+    true
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end