cli-ui 2.4.0 → 2.6.0

data/lib/cli/ui/work_queue.rb

@@ -4,22 +4,18 @@
 module CLI
   module UI
     class WorkQueue
-      extend T::Sig
-
       class Future
-        extend T::Sig
-
-        sig { void }
+        #: -> 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))
+          @mutex = Mutex.new #: Mutex
+          @condition = ConditionVariable.new #: ConditionVariable
+          @completed = false #: bool
+          @started = false #: bool
+          @result = nil #: untyped
+          @error = nil #: Exception?
         end
 
-        sig { params(result: T.untyped).void }
+        #: (untyped result) -> void
         def complete(result)
           @mutex.synchronize do
             @completed = true
@@ -28,7 +24,7 @@ module CLI
           end
         end
 
-        sig { params(error: Exception).void }
+        #: (Exception error) -> void
         def fail(error)
           @mutex.synchronize do
             return if @completed
@@ -39,7 +35,7 @@ module CLI
           end
         end
 
-        sig { returns(T.untyped) }
+        #: -> untyped
         def value
           @mutex.synchronize do
             @condition.wait(@mutex) until @completed
@@ -49,17 +45,17 @@ module CLI
           end
         end
 
-        sig { returns(T::Boolean) }
+        #: -> bool
         def completed?
           @mutex.synchronize { @completed }
         end
 
-        sig { returns(T::Boolean) }
+        #: -> bool
         def started?
           @mutex.synchronize { @started }
         end
 
-        sig { void }
+        #: -> void
         def start
           @mutex.synchronize do
             @started = true
@@ -68,16 +64,16 @@ module CLI
         end
       end
 
-      sig { params(max_concurrent: Integer).void }
+      #: (Integer max_concurrent) -> 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])
+        @queue = Queue.new #: Queue
+        @mutex = Mutex.new #: Mutex
+        @condition = ConditionVariable.new #: ConditionVariable
+        @workers = [] #: Array[Thread]
       end
 
-      sig { params(block: T.proc.returns(T.untyped)).returns(Future) }
+      #: { -> untyped } -> Future
       def enqueue(&block)
         future = Future.new
         @mutex.synchronize do
@@ -87,18 +83,18 @@ module CLI
         future
       end
 
-      sig { void }
+      #: -> void
       def close
         @queue.close
       end
 
-      sig { void }
+      #: -> void
       def wait
         @queue.close
         @workers.each(&:join)
       end
 
-      sig { void }
+      #: -> void
       def interrupt
         @mutex.synchronize do
           @queue.close
@@ -116,7 +112,7 @@ module CLI
 
       private
 
-      sig { void }
+      #: -> void
       def start_worker
         @workers << Thread.new do
           loop do

data/lib/cli/ui/wrap.rb

@@ -9,17 +9,15 @@ require 'cli/ui/frame/frame_style'
 module CLI
   module UI
     class Wrap
-      extend T::Sig
-
-      sig { params(input: String).void }
+      #: (String input) -> void
       def initialize(input)
         @input = input
       end
 
-      sig { params(total_width: Integer).returns(String) }
+      #: (?Integer total_width) -> String
       def wrap(total_width = Terminal.width)
         max_width = total_width - Frame.prefix_width
-        width = T.let(0, Integer)
+        width = 0 #: Integer
         final = []
         # Create an alternation of format codes of parameter lengths 1-20, since + and {1,n} not allowed in lookbehind
         format_codes = (1..20).map { |n| /\x1b\[[\d;]{#{n}}m/ }.join('|')

data/lib/cli/ui.rb

@@ -1,40 +1,33 @@
 # typed: true
 # frozen_string_literal: true
 
-unless defined?(T)
-  require('cli/ui/sorbet_runtime_stub')
-end
-
 module CLI
   module UI
-    extend T::Sig
-
-    autoload :ANSI,      'cli/ui/ansi'
-    autoload :Glyph,     'cli/ui/glyph'
-    autoload :Color,     'cli/ui/color'
-    autoload :Frame,     'cli/ui/frame'
-    autoload :OS,        'cli/ui/os'
-    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'
-    autoload :Spinner,   'cli/ui/spinner'
-    autoload :Widgets,   'cli/ui/widgets'
-    autoload :Wrap,      'cli/ui/wrap'
+    autoload :ANSI,             'cli/ui/ansi'
+    autoload :Glyph,            'cli/ui/glyph'
+    autoload :Color,            'cli/ui/color'
+    autoload :Frame,            'cli/ui/frame'
+    autoload :OS,               'cli/ui/os'
+    autoload :Printer,          'cli/ui/printer'
+    autoload :Progress,         'cli/ui/progress'
+    autoload :ProgressReporter, 'cli/ui/progress_reporter'
+    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'
+    autoload :Spinner,          'cli/ui/spinner'
+    autoload :Widgets,          'cli/ui/widgets'
+    autoload :Wrap,             'cli/ui/wrap'
 
     # Convenience accessor to +CLI::UI::Spinner::SpinGroup+
     SpinGroup = Spinner::SpinGroup
 
-    Colorable = T.type_alias { T.any(Symbol, String, CLI::UI::Color) }
-    FrameStylable = T.type_alias { T.any(Symbol, String, CLI::UI::Frame::FrameStyle) }
-    IOLike = T.type_alias { T.any(IO, StringIO) }
+    #: type colorable = Symbol | String | CLI::UI::Color
+    #: type frame_stylable = Symbol | String | CLI::UI::Frame::FrameStyle
+    #: type io_like = IO | StringIO
 
     class << self
-      extend T::Sig
-
       # Glyph resolution using +CLI::UI::Glyph.lookup+
       # Look at the method signature for +Glyph.lookup+ for more details
       #
@@ -42,7 +35,7 @@ module CLI
       #
       # * +handle+ - handle of the glyph to resolve
       #
-      sig { params(handle: String).returns(Glyph) }
+      #: (String handle) -> Glyph
       def glyph(handle)
         CLI::UI::Glyph.lookup(handle)
       end
@@ -54,7 +47,7 @@ module CLI
       #
       # * +input+ - color to resolve
       #
-      sig { params(input: Colorable).returns(CLI::UI::Color) }
+      #: (colorable input) -> CLI::UI::Color
       def resolve_color(input)
         case input
         when CLI::UI::Color
@@ -70,7 +63,7 @@ module CLI
       # ==== Attributes
       #
       # * +input+ - frame style to resolve
-      sig { params(input: FrameStylable).returns(CLI::UI::Frame::FrameStyle) }
+      #: (frame_stylable input) -> CLI::UI::Frame::FrameStyle
       def resolve_style(input)
         case input
         when CLI::UI::Frame::FrameStyle
@@ -86,7 +79,7 @@ module CLI
       #
       # * +question+ - question to confirm
       #
-      sig { params(question: String, default: T::Boolean).returns(T::Boolean) }
+      #: (String question, ?default: bool) -> bool
       def confirm(question, default: true)
         CLI::UI::Prompt.confirm(question, default: default)
       end
@@ -97,25 +90,13 @@ module CLI
       #
       # * +prompt+ - prompt to present
       #
-      sig { params(prompt: String).returns(T.nilable(String)) }
+      #: (?String prompt) -> String?
       def any_key(prompt = 'Press any key to continue')
         CLI::UI::Prompt.any_key(prompt)
       end
 
       # Convenience Method for +CLI::UI::Prompt.ask+
-      sig do
-        params(
-          question: String,
-          options: T.nilable(T::Array[String]),
-          default: T.nilable(T.any(String, T::Array[String])),
-          is_file: T::Boolean,
-          allow_empty: T::Boolean,
-          multiple: T::Boolean,
-          filter_ui: T::Boolean,
-          select_ui: T::Boolean,
-          options_proc: T.nilable(T.proc.params(handler: Prompt::OptionsHandler).void),
-        ).returns(T.any(String, T::Array[String]))
-      end
+      #: (String question, ?options: Array[String]?, ?default: (String | Array[String])?, ?is_file: bool, ?allow_empty: bool, ?multiple: bool, ?filter_ui: bool, ?select_ui: bool) ?{ (Prompt::OptionsHandler handler) -> void } -> (String | Array[String])
       def ask(
         question,
         options: nil,
@@ -149,7 +130,7 @@ module CLI
       # * +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), enable_color: T::Boolean).returns(String) }
+      #: (String input, ?truncate_to: Integer?, ?enable_color: bool) -> 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
@@ -171,12 +152,12 @@ module CLI
       #
       # * +enable_color+ - should color be used? default to true unless output is redirected.
       #
-      sig { params(input: String, enable_color: T::Boolean).returns(String) }
+      #: (String input, ?enable_color: bool) -> String
       def fmt(input, enable_color: enable_color?)
         CLI::UI::Formatter.new(input).format(enable_color: enable_color)
       end
 
-      sig { params(input: String).returns(String) }
+      #: (String input) -> String
       def wrap(input)
         CLI::UI::Wrap.new(input).wrap
       end
@@ -188,17 +169,7 @@ module CLI
       # * +msg+ - Message to print
       # * +kwargs+ - keyword arguments for +Printer.puts+
       #
-      sig do
-        params(
-          msg: String,
-          frame_color: T.nilable(Colorable),
-          to: IOLike,
-          encoding: Encoding,
-          format: T::Boolean,
-          graceful: T::Boolean,
-          wrap: T::Boolean,
-        ).void
-      end
+      #: (String msg, ?frame_color: colorable?, ?to: io_like, ?encoding: Encoding, ?format: bool, ?graceful: bool, ?wrap: bool) -> void
       def puts(
         msg,
         frame_color: nil,
@@ -226,18 +197,7 @@ module CLI
       # * +args+ - arguments for +Frame.open+
       # * +block+ - block for +Frame.open+
       #
-      sig do
-        type_parameters(:T).params(
-          text: String,
-          color: T.nilable(Colorable),
-          failure_text: T.nilable(String),
-          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
+      #: [T] (String text, ?color: colorable?, ?failure_text: String?, ?success_text: String?, ?timing: (Numeric | bool), ?frame_style: frame_stylable, ?to: io_like) ?{ -> T } -> T?
       def frame(
         text,
         color: Frame::DEFAULT_FRAME_COLOR,
@@ -267,14 +227,7 @@ module CLI
       # * +args+ - arguments for +Spinner.open+
       # * +block+ - block for +Spinner.open+
       #
-      sig do
-        params(
-          title: String,
-          auto_debrief: T::Boolean,
-          to: IOLike,
-          block: T.proc.params(task: Spinner::SpinGroup::Task).void,
-        ).returns(T::Boolean)
-      end
+      #: (String title, ?auto_debrief: bool, ?to: io_like) { (Spinner::SpinGroup::Task task) -> void } -> bool
       def spinner(title, auto_debrief: true, to: $stdout, &block)
         CLI::UI::Spinner.spin(title, auto_debrief: auto_debrief, to: to, &block)
       end
@@ -286,11 +239,7 @@ module CLI
       # * +color+ - color to override to
       # * +block+ - block for +Frame.with_frame_color_override+
       #
-      sig do
-        type_parameters(:T)
-          .params(color: Colorable, block: T.proc.returns(T.type_parameter(:T)))
-          .returns(T.type_parameter(:T))
-      end
+      #: [T] (colorable color) { -> T } -> T
       def with_frame_color(color, &block)
         CLI::UI::Frame.with_frame_color_override(color, &block)
       end
@@ -301,11 +250,7 @@ module CLI
       #
       # * +path+ - path to duplicate output to
       #
-      sig do
-        type_parameters(:T)
-          .params(path: String, block: T.proc.returns(T.type_parameter(:T)))
-          .returns(T.type_parameter(:T))
-      end
+      #: [T] (String path) { -> T } -> T
       def log_output_to(path, &block)
         if CLI::UI::StdoutRouter.duplicate_output_to
           raise 'multiple logs not allowed'
@@ -330,7 +275,7 @@ module CLI
       #
       # * +block+ - block in which to disable frames
       #
-      sig { type_parameters(:T).params(block: T.proc.returns(T.type_parameter(:T))).returns(T.type_parameter(:T)) }
+      #: [T] { -> T } -> T
       def raw(&block)
         prev = Thread.current[:no_cliui_frame_inset]
         Thread.current[:no_cliui_frame_inset] = true
@@ -343,7 +288,7 @@ module CLI
       # 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) }
+      #: -> bool
       def enable_color?
         @enable_color
       end
@@ -354,7 +299,7 @@ module CLI
       #
       # * +bool+ - true or false; enable or disable colour.
       #
-      sig { params(bool: T::Boolean).void }
+      #: (bool bool) -> void
       def enable_color=(bool)
         @enable_color = !!bool
       end
@@ -363,7 +308,7 @@ module CLI
       # 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) }
+      #: -> bool
       def enable_cursor?
         @enable_cursor
       end
@@ -374,7 +319,7 @@ module CLI
       #
       # * +bool+ - true or false; enable or disable cursor control.
       #
-      sig { params(bool: T::Boolean).void }
+      #: (bool bool) -> void
       def enable_cursor=(bool)
         @enable_cursor = !!bool
       end
@@ -388,13 +333,13 @@ module CLI
       #
       # * +symbol+ - the default frame style to use for frames
       #
-      sig { params(frame_style: FrameStylable).void }
+      #: (frame_stylable frame_style) -> void
       def frame_style=(frame_style)
         Frame.frame_style = frame_style
       end
 
       # Create a terminal link
-      sig { params(url: String, text: String, format: T::Boolean, blue_underline: T::Boolean).returns(String) }
+      #: (String url, String text, ?format: bool, ?blue_underline: bool) -> String
       def link(url, text, format: true, blue_underline: format)
         raise 'cannot use blue_underline without format' if blue_underline && !format
 
@@ -404,10 +349,10 @@ module CLI
       end
     end
 
-    self.enable_color = T.must($stdout.tty? && ENV['TERM'] != 'dumb')
+    self.enable_color = $stdout.tty? && ENV['TERM'] != 'dumb' #: as !nil
 
     # Shopify's CI system supports color, but not cursor control
-    self.enable_cursor = T.must($stdout.tty? && ENV['TERM'] != 'dumb' && ENV['CI'].nil? && ENV['JOURNAL_STREAM'].nil?)
+    self.enable_cursor = $stdout.tty? && ENV['TERM'] != 'dumb' && ENV['CI'].nil? && ENV['JOURNAL_STREAM'].nil? #: as !nil
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-ui
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Burke Libbey
@@ -9,7 +9,7 @@ authors:
 - Lisa Ugray
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -63,10 +63,10 @@ files:
 - lib/cli/ui/os.rb
 - lib/cli/ui/printer.rb
 - lib/cli/ui/progress.rb
+- lib/cli/ui/progress_reporter.rb
 - lib/cli/ui/prompt.rb
 - lib/cli/ui/prompt/interactive_options.rb
 - lib/cli/ui/prompt/options_handler.rb
-- lib/cli/ui/sorbet_runtime_stub.rb
 - lib/cli/ui/spinner.rb
 - lib/cli/ui/spinner/async.rb
 - lib/cli/ui/spinner/spin_group.rb

data/lib/cli/ui/sorbet_runtime_stub.rb

@@ -1,168 +0,0 @@
-# typed: ignore
-# frozen_string_literal: true
-
-module T
-  class << self
-    def absurd(value); end
-    def all(type_a, type_b, *types); end
-    def any(type_a, type_b, *types); end
-    def attached_class; end
-    def class_of(klass); end
-    def enum(values); end
-    def nilable(type); end
-    def noreturn; end
-    def self_type; end
-    def type_alias(type = nil, &_blk); end
-    def type_parameter(name); end
-    def untyped; end
-
-    def assert_type!(value, _type, _checked: true)
-      value
-    end
-
-    def cast(value, _type, _checked: true)
-      value
-    end
-
-    def let(value, _type, _checked: true)
-      value
-    end
-
-    def must(arg, _msg = nil)
-      arg
-    end
-
-    def proc
-      T::Proc.new
-    end
-
-    def reveal_type(value)
-      value
-    end
-
-    def unsafe(value)
-      value
-    end
-  end
-
-  module Sig
-    def sig(arg0 = nil, &blk); end
-  end
-
-  module Helpers
-    def abstract!;  end
-    def interface!; end
-    def final!; end
-    def sealed!; end
-    def mixes_in_class_methods(mod); end
-  end
-
-  module Generic
-    include(T::Helpers)
-
-    def type_parameters(*params); end
-    def type_member(variance = :invariant, fixed: nil, lower: nil, upper: BasicObject); end
-    def type_template(variance = :invariant, fixed: nil, lower: nil, upper: BasicObject); end
-
-    def [](*types)
-      self
-    end
-  end
-
-  module Array
-    class << self
-      def [](type); end
-    end
-  end
-
-  Boolean = Object.new.freeze
-
-  module Configuration
-    class << self
-      def call_validation_error_handler(signature, opts); end
-      def call_validation_error_handler=(value); end
-      def default_checked_level=(default_checked_level); end
-      def enable_checking_for_sigs_marked_checked_tests; end
-      def enable_final_checks_on_hooks; end
-      def enable_legacy_t_enum_migration_mode; end
-      def reset_final_checks_on_hooks; end
-      def hard_assert_handler(str, extra); end
-      def hard_assert_handler=(value); end
-      def inline_type_error_handler(error); end
-      def inline_type_error_handler=(value); end
-      def log_info_handler(str, extra); end
-      def log_info_handler=(value); end
-      def scalar_types; end
-      def scalar_types=(values); end
-      def sealed_violation_whitelist; end
-      def sealed_violation_whitelist=(sealed_violation_whitelist); end
-      # rubocop:enable Naming/InclusiveLanguage
-      def sig_builder_error_handler(error, location); end
-      def sig_builder_error_handler=(value); end
-      def sig_validation_error_handler(error, opts); end
-      def sig_validation_error_handler=(value); end
-      def soft_assert_handler(str, extra); end
-      def soft_assert_handler=(value); end
-    end
-  end
-
-  module Enumerable
-    class << self
-      def [](type); end
-    end
-  end
-
-  module Enumerator
-    class << self
-      def [](type); end
-    end
-  end
-
-  module Hash
-    class << self
-      def [](keys, values); end
-    end
-  end
-
-  class Proc
-    def bind(*_)
-      self
-    end
-
-    def params(*_param)
-      self
-    end
-
-    def void
-      self
-    end
-
-    def returns(_type)
-      self
-    end
-  end
-
-  module Range
-    class << self
-      def [](type); end
-    end
-  end
-
-  module Set
-    class << self
-      def [](type); end
-    end
-  end
-
-  class << self
-    def const_added(name)
-      super
-      raise 'When using both cli-ui and sorbet, you must require sorbet before cli-ui'
-    end
-
-    def method_added(name)
-      super
-      raise 'When using both cli-ui and sorbet, you must require sorbet before cli-ui'
-    end
-  end
-end