cli-ui 2.2.3 → 2.3.1

data/lib/cli/ui/work_queue.rb

@@ -0,0 +1,146 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CLI
+  module UI
+    class WorkQueue
+      extend T::Sig
+
+      class Future
+        extend T::Sig
+
+        sig { void }
+        def initialize
+          @mutex = T.let(Mutex.new, Mutex)
+          @condition = T.let(ConditionVariable.new, ConditionVariable)
+          @completed = T.let(false, T::Boolean)
+          @started = T.let(false, T::Boolean)
+          @result = T.let(nil, T.untyped)
+          @error = T.let(nil, T.nilable(Exception))
+        end
+
+        sig { params(result: T.untyped).void }
+        def complete(result)
+          @mutex.synchronize do
+            @completed = true
+            @result = result
+            @condition.broadcast
+          end
+        end
+
+        sig { params(error: Exception).void }
+        def fail(error)
+          @mutex.synchronize do
+            return if @completed
+
+            @completed = true
+            @error = error
+            @condition.broadcast
+          end
+        end
+
+        sig { returns(T.untyped) }
+        def value
+          @mutex.synchronize do
+            @condition.wait(@mutex) until @completed
+            raise @error if @error
+
+            @result
+          end
+        end
+
+        sig { returns(T::Boolean) }
+        def completed?
+          @mutex.synchronize { @completed }
+        end
+
+        sig { returns(T::Boolean) }
+        def started?
+          @mutex.synchronize { @started }
+        end
+
+        sig { void }
+        def start
+          @mutex.synchronize do
+            @started = true
+            @condition.broadcast
+          end
+        end
+      end
+
+      sig { params(max_concurrent: Integer).void }
+      def initialize(max_concurrent)
+        @max_concurrent = max_concurrent
+        @queue = T.let(Queue.new, Queue)
+        @mutex = T.let(Mutex.new, Mutex)
+        @condition = T.let(ConditionVariable.new, ConditionVariable)
+        @workers = T.let([], T::Array[Thread])
+      end
+
+      sig { params(block: T.proc.returns(T.untyped)).returns(Future) }
+      def enqueue(&block)
+        future = Future.new
+        @mutex.synchronize do
+          start_worker if @workers.size < @max_concurrent
+        end
+        @queue.push([future, block])
+        future
+      end
+
+      sig { void }
+      def close
+        @queue.close
+      end
+
+      sig { void }
+      def wait
+        @queue.close
+        @workers.each(&:join)
+      end
+
+      sig { void }
+      def interrupt
+        @mutex.synchronize do
+          @queue.close
+          # Fail any remaining tasks in the queue
+          until @queue.empty?
+            future, _block = @queue.pop(true)
+            future&.fail(Interrupt.new)
+          end
+          # Interrupt all worker threads
+          @workers.each { |worker| worker.raise(Interrupt) if worker.alive? }
+          @workers.each(&:join)
+          @workers.clear
+        end
+      end
+
+      private
+
+      sig { void }
+      def start_worker
+        @workers << Thread.new do
+          loop do
+            work = @queue.pop
+            break if work.nil?
+
+            future, block = work
+
+            begin
+              future.start
+              result = block.call
+              future.complete(result)
+            rescue Interrupt => e
+              future.fail(e)
+              raise # Always re-raise interrupts to terminate the worker
+            rescue StandardError => e
+              future.fail(e)
+              # Don't re-raise standard errors - allow worker to continue
+            end
+          end
+        rescue Interrupt
+          # Clean exit on interrupt
+        end
+      end
+    end
+  end
+end

data/lib/cli/ui/wrap.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
-
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 require 'cli/ui/frame/frame_stack'
@@ -16,9 +16,9 @@ module CLI
         @input = input
       end
 
-      sig { returns(String) }
-      def wrap
-        max_width = Terminal.width - Frame.prefix_width
+      sig { params(total_width: Integer).returns(String) }
+      def wrap(total_width = Terminal.width)
+        max_width = total_width - Frame.prefix_width
         width = T.let(0, Integer)
         final = []
         # Create an alternation of format codes of parameter lengths 1-20, since + and {1,n} not allowed in lookbehind

data/lib/cli/ui.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 unless defined?(T)
   require('cli/ui/sorbet_runtime_stub')
@@ -16,6 +17,7 @@ module CLI
     autoload :Printer,   'cli/ui/printer'
     autoload :Progress,  'cli/ui/progress'
     autoload :Prompt,    'cli/ui/prompt'
+    autoload :Table,     'cli/ui/table'
     autoload :Terminal,  'cli/ui/terminal'
     autoload :Truncater, 'cli/ui/truncater'
     autoload :Formatter, 'cli/ui/formatter'
@@ -145,10 +147,11 @@ module CLI
       #
       # * +input+ - input to format
       # * +truncate_to+ - number of characters to truncate the string to (or nil)
+      # * +enable_color+ - should color be used? default to true unless output is redirected.
       #
-      sig { params(input: String, truncate_to: T.nilable(Integer)).returns(String) }
-      def resolve_text(input, truncate_to: nil)
-        formatted = CLI::UI::Formatter.new(input).format
+      sig { params(input: String, truncate_to: T.nilable(Integer), enable_color: T::Boolean).returns(String) }
+      def resolve_text(input, truncate_to: nil, enable_color: enable_color?)
+        formatted = CLI::UI::Formatter.new(input).format(enable_color: enable_color)
         return formatted unless truncate_to
 
         CLI::UI::Truncater.call(formatted, truncate_to)
@@ -231,6 +234,7 @@ module CLI
           success_text: T.nilable(String),
           timing: T.any(T::Boolean, Numeric),
           frame_style: FrameStylable,
+          to: IOLike,
           block: T.nilable(T.proc.returns(T.type_parameter(:T))),
         ).returns(T.nilable(T.type_parameter(:T)))
       end
@@ -241,6 +245,7 @@ module CLI
         success_text: nil,
         timing: block_given?,
         frame_style: Frame.frame_style,
+        to: $stdout,
         &block
       )
         CLI::UI::Frame.open(
@@ -250,6 +255,7 @@ module CLI
           success_text: success_text,
           timing: timing,
           frame_style: frame_style,
+          to: to,
           &block
         )
       end
@@ -262,11 +268,15 @@ module CLI
       # * +block+ - block for +Spinner.open+
       #
       sig do
-        params(title: String, auto_debrief: T::Boolean, block: T.proc.params(task: Spinner::SpinGroup::Task).void)
-          .returns(T::Boolean)
+        params(
+          title: String,
+          auto_debrief: T::Boolean,
+          to: IOLike,
+          block: T.proc.params(task: Spinner::SpinGroup::Task).void,
+        ).returns(T::Boolean)
       end
-      def spinner(title, auto_debrief: true, &block)
-        CLI::UI::Spinner.spin(title, auto_debrief: auto_debrief, &block)
+      def spinner(title, auto_debrief: true, to: $stdout, &block)
+        CLI::UI::Spinner.spin(title, auto_debrief: auto_debrief, to: to, &block)
       end
 
       # Convenience Method to override frame color using +CLI::UI::Frame.with_frame_color+
@@ -329,16 +339,16 @@ module CLI
         Thread.current[:no_cliui_frame_inset] = prev
       end
 
-      # Check whether colour is enabled in Formatter output. By default, colour
-      # is enabled when STDOUT is a TTY; that is, when output has not been
-      # redirected to another program or to a file.
+      # Check whether colour is enabled in Formatter, Frame, and Spinner output.
+      # By default, colour is enabled when STDOUT is a TTY; that is, when output
+      # has not been directed to another program or to a file.
       #
       sig { returns(T::Boolean) }
       def enable_color?
         @enable_color
       end
 
-      # Turn colour output in Formatter on or off.
+      # Turn colour in Formatter, Frame, and Spinner output on or off.
       #
       # ==== Attributes
       #
@@ -349,6 +359,26 @@ module CLI
         @enable_color = !!bool
       end
 
+      # Check whether cursor control is enabled in Formatter, Frame, and Spinner output.
+      # By default, cursor control is enabled when STDOUT is a TTY; that is, when output
+      # has not been directed to another program or to a file.
+      #
+      sig { returns(T::Boolean) }
+      def enable_cursor?
+        @enable_cursor
+      end
+
+      # Turn cursor control in Formatter, Frame, and Spinner output on or off.
+      #
+      # ==== Attributes
+      #
+      # * +bool+ - true or false; enable or disable cursor control.
+      #
+      sig { params(bool: T::Boolean).void }
+      def enable_cursor=(bool)
+        @enable_cursor = !!bool
+      end
+
       # Set the default frame style.
       # Convenience method for setting the default frame style with +CLI::UI::Frame.frame_style=+
       #
@@ -375,6 +405,9 @@ module CLI
     end
 
     self.enable_color = $stdout.tty?
+
+    # Shopify's CI system supports color, but not cursor control
+    self.enable_cursor = T.must($stdout.tty? && ENV['CI'].nil? && ENV['JOURNAL_STREAM'].nil?)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-ui
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.1
 platform: ruby
 authors:
 - Burke Libbey
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -72,12 +72,14 @@ files:
 - lib/cli/ui/spinner/async.rb
 - lib/cli/ui/spinner/spin_group.rb
 - lib/cli/ui/stdout_router.rb
+- lib/cli/ui/table.rb
 - lib/cli/ui/terminal.rb
 - lib/cli/ui/truncater.rb
 - lib/cli/ui/version.rb
 - lib/cli/ui/widgets.rb
 - lib/cli/ui/widgets/base.rb
 - lib/cli/ui/widgets/status.rb
+- lib/cli/ui/work_queue.rb
 - lib/cli/ui/wrap.rb
 - vendor/reentrant_mutex.rb
 homepage: https://github.com/shopify/cli-ui
@@ -99,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Terminal UI framework