cli-ui 1.5.1 → 2.2.3

data/lib/cli/ui/spinner/spin_group.rb

@@ -1,35 +1,88 @@
+# typed: true
+
 module CLI
   module UI
     module Spinner
       class SpinGroup
+        DEFAULT_FINAL_GLYPH = ->(success) { success ? CLI::UI::Glyph::CHECK.to_s : CLI::UI::Glyph::X.to_s }
+
+        class << self
+          extend T::Sig
+
+          sig { returns(Mutex) }
+          attr_reader :pause_mutex
+
+          sig { returns(T::Boolean) }
+          def paused?
+            @paused
+          end
+
+          sig do
+            type_parameters(:T)
+              .params(block: T.proc.returns(T.type_parameter(:T)))
+              .returns(T.type_parameter(:T))
+          end
+          def pause_spinners(&block)
+            previous_paused = T.let(nil, T.nilable(T::Boolean))
+            @pause_mutex.synchronize do
+              previous_paused = @paused
+              @paused = true
+            end
+            block.call
+          ensure
+            @pause_mutex.synchronize do
+              @paused = previous_paused
+            end
+          end
+        end
+
+        @pause_mutex = Mutex.new
+        @paused = false
+
+        extend T::Sig
+
         # Initializes a new spin group
         # This lets you add +Task+ objects to the group to multi-thread work
         #
         # ==== Options
         #
-        # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+        # * +:auto_debrief+ - Automatically debrief exceptions or through success_debrief? Default to true
         #
         # ==== Example Usage
         #
-        #  spin_group = CLI::UI::SpinGroup.new
-        #  spin_group.add('Title')   { |spinner| sleep 3.0 }
-        #  spin_group.add('Title 2') { |spinner| sleep 3.0; spinner.update_title('New Title'); sleep 3.0 }
-        #  spin_group.wait
+        #  CLI::UI::SpinGroup.new do |spin_group|
+        #    spin_group.add('Title')   { |spinner| sleep 3.0 }
+        #    spin_group.add('Title 2') { |spinner| sleep 3.0; spinner.update_title('New Title'); sleep 3.0 }
+        #  end
         #
         # Output:
         #
         # https://user-images.githubusercontent.com/3074765/33798558-c452fa26-dce8-11e7-9e90-b4b34df21a46.gif
         #
+        sig { params(auto_debrief: T::Boolean).void }
         def initialize(auto_debrief: true)
           @m = Mutex.new
           @consumed_lines = 0
           @tasks = []
           @auto_debrief = auto_debrief
           @start = Time.new
+          if block_given?
+            yield self
+            wait
+          end
         end
 
         class Task
-          attr_reader :title, :exception, :success, :stdout, :stderr
+          extend T::Sig
+
+          sig { returns(String) }
+          attr_reader :title, :stdout, :stderr
+
+          sig { returns(T::Boolean) }
+          attr_reader :success
+
+          sig { returns(T.nilable(Exception)) }
+          attr_reader :exception
 
           # Initializes a new Task
           # This is managed entirely internally by +SpinGroup+
@@ -39,11 +92,23 @@ module CLI
           # * +title+ - Title of the task
           # * +block+ - Block for the task, will be provided with an instance of the spinner
           #
-          def initialize(title, &block)
+          sig do
+            params(
+              title: String,
+              final_glyph: T.proc.params(success: T::Boolean).returns(String),
+              merged_output: T::Boolean,
+              duplicate_output_to: IO,
+              block: T.proc.params(task: Task).returns(T.untyped),
+            ).void
+          end
+          def initialize(title, final_glyph:, merged_output:, duplicate_output_to:, &block)
             @title = title
+            @final_glyph = final_glyph
             @always_full_render = title =~ Formatter::SCAN_WIDGET
             @thread = Thread.new do
-              cap = CLI::UI::StdoutRouter::Capture.new(self, with_frame_inset: false, &block)
+              cap = CLI::UI::StdoutRouter::Capture.new(
+                merged_output: merged_output, duplicate_output_to: duplicate_output_to,
+              ) { block.call(self) }
               begin
                 cap.run
               ensure
@@ -61,6 +126,7 @@ module CLI
 
           # Checks if a task is finished
           #
+          sig { returns(T::Boolean) }
           def check
             return true if @done
             return false if @thread.alive?
@@ -96,6 +162,7 @@ module CLI
           # * +force+ - force rerender of the task
           # * +width+ - current terminal width to format for
           #
+          sig { params(index: Integer, force: T::Boolean, width: Integer).returns(String) }
           def render(index, force = true, width: CLI::UI::Terminal.width)
             @m.synchronize do
               if force || @always_full_render || @force_full_render
@@ -114,6 +181,7 @@ module CLI
           #
           # * +title+ - title to change the spinner to
           #
+          sig { params(new_title: String).void }
           def update_title(new_title)
             @m.synchronize do
               @always_full_render = new_title =~ Formatter::SCAN_WIDGET
@@ -122,8 +190,14 @@ module CLI
             end
           end
 
+          sig { void }
+          def interrupt
+            @thread.raise(Interrupt)
+          end
+
           private
 
+          sig { params(index: Integer, terminal_width: Integer).returns(String) }
           def full_render(index, terminal_width)
             prefix = inset +
               glyph(index) +
@@ -137,22 +211,26 @@ module CLI
               "\e[K"
           end
 
+          sig { params(index: Integer).returns(String) }
           def partial_render(index)
             CLI::UI::ANSI.cursor_forward(inset_width) + glyph(index) + CLI::UI::Color::RESET.code
           end
 
+          sig { params(index: Integer).returns(String) }
           def glyph(index)
             if @done
-              @success ? CLI::UI::Glyph::CHECK.to_s : CLI::UI::Glyph::X.to_s
+              @final_glyph.call(@success)
             else
               GLYPHS[index]
             end
           end
 
+          sig { returns(String) }
           def inset
             @inset ||= CLI::UI::Frame.prefix
           end
 
+          sig { returns(Integer) }
           def inset_width
             @inset_width ||= CLI::UI::ANSI.printing_width(inset)
           end
@@ -170,9 +248,30 @@ module CLI
         #   spin_group.add('Title') { |spinner| sleep 1.0 }
         #   spin_group.wait
         #
-        def add(title, &block)
+        sig do
+          params(
+            title: String,
+            final_glyph: T.proc.params(success: T::Boolean).returns(String),
+            merged_output: T::Boolean,
+            duplicate_output_to: IO,
+            block: T.proc.params(task: Task).void,
+          ).void
+        end
+        def add(
+          title,
+          final_glyph: DEFAULT_FINAL_GLYPH,
+          merged_output: false,
+          duplicate_output_to: File.new(File::NULL, 'w'),
+          &block
+        )
           @m.synchronize do
-            @tasks << Task.new(title, &block)
+            @tasks << Task.new(
+              title,
+              final_glyph: final_glyph,
+              merged_output: merged_output,
+              duplicate_output_to: duplicate_output_to,
+              &block
+            )
           end
         end
 
@@ -183,36 +282,41 @@ module CLI
         #   spin_group.add('Title') { |spinner| sleep 1.0 }
         #   spin_group.wait
         #
+        sig { returns(T::Boolean) }
         def wait
           idx = 0
 
           loop do
-            all_done = true
+            done_count = 0
 
             width = CLI::UI::Terminal.width
 
-            @m.synchronize do
-              CLI::UI.raw do
-                @tasks.each.with_index do |task, int_index|
-                  nat_index = int_index + 1
-                  task_done = task.check
-                  all_done = false unless task_done
-
-                  if nat_index > @consumed_lines
-                    print(task.render(idx, true, width: width) + "\n")
-                    @consumed_lines += 1
-                  else
-                    offset = @consumed_lines - int_index
-                    move_to = CLI::UI::ANSI.cursor_up(offset) + "\r"
-                    move_from = "\r" + CLI::UI::ANSI.cursor_down(offset)
-
-                    print(move_to + task.render(idx, idx.zero?, width: width) + move_from)
+            self.class.pause_mutex.synchronize do
+              next if self.class.paused?
+
+              @m.synchronize do
+                CLI::UI.raw do
+                  @tasks.each.with_index do |task, int_index|
+                    nat_index = int_index + 1
+                    task_done = task.check
+                    done_count += 1 if task_done
+
+                    if nat_index > @consumed_lines
+                      print(task.render(idx, true, width: width) + "\n")
+                      @consumed_lines += 1
+                    else
+                      offset = @consumed_lines - int_index
+                      move_to = CLI::UI::ANSI.cursor_up(offset) + "\r"
+                      move_from = "\r" + CLI::UI::ANSI.cursor_down(offset)
+
+                      print(move_to + task.render(idx, idx.zero?, width: width) + move_from)
+                    end
                   end
                 end
               end
             end
 
-            break if all_done
+            break if done_count == @tasks.size
 
             idx = (idx + 1) % GLYPHS.size
             Spinner.index = idx
@@ -222,24 +326,58 @@ module CLI
           if @auto_debrief
             debrief
           else
-            @m.synchronize do
-              @tasks.all?(&:success)
-            end
+            all_succeeded?
+          end
+        rescue Interrupt
+          @tasks.each(&:interrupt)
+          raise
+        end
+
+        # Provide an alternative debriefing for failed tasks
+        sig do
+          params(
+            block: T.proc.params(title: String, exception: T.nilable(Exception), out: String, err: String).void,
+          ).void
+        end
+        def failure_debrief(&block)
+          @failure_debrief = block
+        end
+
+        # Provide a debriefing for successful tasks
+        sig do
+          params(
+            block: T.proc.params(title: String, out: String, err: String).void,
+          ).void
+        end
+        def success_debrief(&block)
+          @success_debrief = block
+        end
+
+        sig { returns(T::Boolean) }
+        def all_succeeded?
+          @m.synchronize do
+            @tasks.all?(&:success)
           end
         end
 
         # Debriefs failed tasks is +auto_debrief+ is true
         #
+        sig { returns(T::Boolean) }
         def debrief
           @m.synchronize do
             @tasks.each do |task|
-              next if task.success
-
-              e = task.exception
+              title = task.title
               out = task.stdout
               err = task.stderr
 
-              CLI::UI::Frame.open('Task Failed: ' + task.title, color: :red, timing: Time.new - @start) do
+              if task.success
+                next @success_debrief&.call(title, out, err)
+              end
+
+              e = task.exception
+              next @failure_debrief.call(title, e, out, err) if @failure_debrief
+
+              CLI::UI::Frame.open('Task Failed: ' + title, color: :red, timing: Time.new - @start) do
                 if e
                   puts "#{e.class}: #{e.message}"
                   puts "\tfrom #{e.backtrace.join("\n\tfrom ")}"

data/lib/cli/ui/spinner.rb

@@ -1,22 +1,33 @@
-# frozen-string-literal: true
+# typed: true
+# frozen_string_literal: true
+
 require 'cli/ui'
 
 module CLI
   module UI
     module Spinner
+      extend T::Sig
+
       autoload :Async,      'cli/ui/spinner/async'
       autoload :SpinGroup,  'cli/ui/spinner/spin_group'
 
       PERIOD = 0.1 # seconds
       TASK_FAILED = :task_failed
 
-      RUNES = CLI::UI::OS.current.supports_emoji? ? %w(⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏).freeze : %w(\\ | / - \\ | / -).freeze
+      RUNES = if CLI::UI::OS.current.use_emoji?
+        ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'].freeze
+      else
+        ['\\', '|', '/', '-', '\\', '|', '/', '-'].freeze
+      end
 
       colors = [CLI::UI::Color::CYAN.code] * (RUNES.size / 2).ceil +
         [CLI::UI::Color::MAGENTA.code] * (RUNES.size / 2).to_i
       GLYPHS = colors.zip(RUNES).map(&:join)
 
       class << self
+        extend T::Sig
+
+        sig { returns(T.nilable(Integer)) }
         attr_accessor(:index)
 
         # We use this from CLI::UI::Widgets::Status to render an additional
@@ -29,37 +40,46 @@ module CLI
         # While it would be possible to stitch through some connection between
         # the SpinGroup and the Widgets included in its title, this is simpler
         # in practice and seems unlikely to cause issues in practice.
+        sig { returns(String) }
         def current_rune
           RUNES[index || 0]
         end
       end
 
-      # Adds a single spinner
-      # Uses an interactive session to allow the user to pick an answer
-      # Can use arrows, y/n, numbers (1/2), and vim bindings to control
-      #
-      # https://user-images.githubusercontent.com/3074765/33798295-d94fd822-dce3-11e7-819b-43e5502d490e.gif
-      #
-      # ==== Attributes
-      #
-      # * +title+ - Title of the spinner to use
-      #
-      # ==== Options
-      #
-      # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
-      #
-      # ==== Block
-      #
-      # * *spinner+ - Instance of the spinner. Can call +update_title+ to update the user of changes
-      #
-      # ==== Example Usage:
-      #
-      #   CLI::UI::Spinner.spin('Title') { sleep 1.0 }
-      #
-      def self.spin(title, auto_debrief: true, &block)
-        sg = SpinGroup.new(auto_debrief: auto_debrief)
-        sg.add(title, &block)
-        sg.wait
+      class << self
+        extend T::Sig
+
+        # Adds a single spinner
+        # Uses an interactive session to allow the user to pick an answer
+        # Can use arrows, y/n, numbers (1/2), and vim bindings to control
+        #
+        # https://user-images.githubusercontent.com/3074765/33798295-d94fd822-dce3-11e7-819b-43e5502d490e.gif
+        #
+        # ==== Attributes
+        #
+        # * +title+ - Title of the spinner to use
+        #
+        # ==== Options
+        #
+        # * +:auto_debrief+ - Automatically debrief exceptions or through success_debrief? Default to true
+        #
+        # ==== Block
+        #
+        # * *spinner+ - Instance of the spinner. Can call +update_title+ to update the user of changes
+        #
+        # ==== Example Usage:
+        #
+        #   CLI::UI::Spinner.spin('Title') { sleep 1.0 }
+        #
+        sig do
+          params(title: String, auto_debrief: T::Boolean, block: T.proc.params(task: SpinGroup::Task).void)
+            .returns(T::Boolean)
+        end
+        def spin(title, auto_debrief: true, &block)
+          sg = SpinGroup.new(auto_debrief: auto_debrief)
+          sg.add(title, &block)
+          sg.wait
+        end
       end
     end
   end