cli-ui 2.4.0 → 2.6.0

data/lib/cli/ui/frame/frame_style.rb

@@ -6,11 +6,9 @@ require 'cli/ui/frame'
 module CLI
   module UI
     module Frame
+      # @abstract
       module FrameStyle
         include Kernel
-        extend T::Sig
-        extend T::Helpers
-        abstract!
 
         autoload(:Box, 'cli/ui/frame/frame_style/box')
         autoload(:Bracket, 'cli/ui/frame/frame_style/bracket')
@@ -21,14 +19,12 @@ module CLI
         }
 
         class << self
-          extend T::Sig
-
           # Lookup a frame style via its name
           #
           # ==== Attributes
           #
           # * +symbol+ - frame style name to lookup
-          sig { params(name: T.any(String, Symbol)).returns(FrameStyle) }
+          #: ((String | Symbol) name) -> FrameStyle
           def lookup(name)
             MAP.fetch(name.to_sym).call
           rescue KeyError
@@ -36,16 +32,22 @@ module CLI
           end
         end
 
-        sig { abstract.returns(Symbol) }
-        def style_name; end
+        # @abstract
+        #: -> Symbol
+        def style_name
+          raise(NotImplementedError)
+        end
 
         # Returns the character(s) that should be printed at the beginning
         # of lines inside this frame
-        sig { abstract.returns(String) }
-        def prefix; end
+        # @abstract
+        #: -> String
+        def prefix
+          raise(NotImplementedError)
+        end
 
         # Returns the printing width of the prefix
-        sig { returns(Integer) }
+        #: -> Integer
         def prefix_width
           CLI::UI::ANSI.printing_width(prefix)
         end
@@ -60,8 +62,11 @@ module CLI
         #
         # * +:color+ - (required) The color of the frame.
         #
-        sig { abstract.params(text: String, color: CLI::UI::Color).returns(String) }
-        def start(text, color:); end
+        # @abstract
+        #: (String, color: CLI::UI::Color) -> String
+        def start(text, color:)
+          raise(NotImplementedError)
+        end
 
         # Draws the "Close" line for this frame style
         #
@@ -74,8 +79,11 @@ module CLI
         # * +:color+ - (required) The color of the frame.
         # * +:right_text+ - Text to print at the right of the line. Defaults to nil
         #
-        sig { abstract.params(text: String, color: CLI::UI::Color, right_text: T.nilable(String)).returns(String) }
-        def close(text, color:, right_text: nil); end
+        # @abstract
+        #: (String, color: CLI::UI::Color, ?right_text: String?) -> String
+        def close(text, color:, right_text: nil)
+          raise(NotImplementedError)
+        end
 
         # Draws a "divider" line for the current frame style
         #
@@ -87,24 +95,25 @@ module CLI
         #
         # * +:color+ - (required) The color of the frame.
         #
-        sig { abstract.params(text: String, color: CLI::UI::Color).returns(String) }
-        def divider(text, color:); end
+        # @abstract
+        #: (String, color: CLI::UI::Color) -> String
+        def divider(text, color:)
+          raise(NotImplementedError)
+        end
 
-        sig { params(x: Integer, str: String).returns(String) }
+        #: (Integer x, String str) -> String
         def print_at_x(x, str)
           CLI::UI::ANSI.cursor_horizontal_absolute(1 + x) + str
         end
 
         class InvalidFrameStyleName < ArgumentError
-          extend T::Sig
-
-          sig { params(name: T.any(String, Symbol)).void }
+          #: ((String | Symbol) name) -> void
           def initialize(name)
             super
             @name = name
           end
 
-          sig { returns(String) }
+          #: -> String
           def message
             keys = FrameStyle::MAP.keys.map(&:inspect).join(', ')
             "invalid frame style: #{@name.inspect} " \

data/lib/cli/ui/frame.rb

@@ -12,9 +12,7 @@ module CLI
       DEFAULT_FRAME_COLOR = CLI::UI.resolve_color(:cyan)
 
       class << self
-        extend T::Sig
-
-        sig { returns(FrameStyle) }
+        #: -> FrameStyle
         def frame_style
           @frame_style ||= FrameStyle::Box
         end
@@ -27,7 +25,7 @@ module CLI
         #
         # * +symbol+ or +FrameStyle+ - 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_style = CLI::UI.resolve_style(frame_style)
         end
@@ -75,18 +73,7 @@ module CLI
         #   ┏━━ Open ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
         #
         #
-        sig do
-          type_parameters(:T).params(
-            text: String,
-            color: 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 open(
           text,
           color: DEFAULT_FRAME_COLOR,
@@ -121,7 +108,7 @@ module CLI
 
           closed = false
           begin
-            success = false
+            success = false #: untyped
             success = yield
           rescue
             closed = true
@@ -133,7 +120,8 @@ module CLI
           ensure
             unless closed
               t_diff = elapsed(t_start, timing)
-              if T.unsafe(success) != false
+              success_bool = success #: as untyped
+              if success_bool != false
                 close(success_text, color: color, elapsed: t_diff, to: to)
               else
                 close(failure_text, color: :red, elapsed: t_diff, to: to)
@@ -169,14 +157,7 @@ module CLI
         #
         # MUST be inside an open frame or it raises a +UnnestedFrameException+
         #
-        sig do
-          params(
-            text: T.nilable(String),
-            color: T.nilable(Colorable),
-            frame_style: T.nilable(FrameStylable),
-            to: IOLike,
-          ).void
-        end
+        #: (String? text, ?color: colorable?, ?frame_style: frame_stylable?, ?to: io_like) -> void
         def divider(text, color: nil, frame_style: nil, to: $stdout)
           fs_item = FrameStack.pop
           raise UnnestedFrameException, 'No frame nesting to unnest' unless fs_item
@@ -218,15 +199,7 @@ module CLI
         #
         # MUST be inside an open frame or it raises a +UnnestedFrameException+
         #
-        sig do
-          params(
-            text: T.nilable(String),
-            color: T.nilable(Colorable),
-            elapsed: T.nilable(Numeric),
-            frame_style: T.nilable(FrameStylable),
-            to: IOLike,
-          ).void
-        end
+        #: (String? text, ?color: colorable?, ?elapsed: Numeric?, ?frame_style: frame_stylable?, ?to: io_like) -> void
         def close(text, color: nil, elapsed: nil, frame_style: nil, to: $stdout)
           fs_item = FrameStack.pop
           raise UnnestedFrameException, 'No frame nesting to unnest' unless fs_item
@@ -247,7 +220,7 @@ module CLI
         #
         # * +:color+ - The color of the prefix. Defaults to +Thread.current[:cliui_frame_color_override]+
         #
-        sig { params(color: T.nilable(Colorable)).returns(String) }
+        #: (?color: colorable?) -> String
         def prefix(color: Thread.current[:cliui_frame_color_override])
           (+'').tap do |output|
             items = FrameStack.items
@@ -269,7 +242,7 @@ module CLI
         end
 
         # The width of a prefix given the number of Frames in the stack
-        sig { returns(Integer) }
+        #: -> Integer
         def prefix_width
           w = FrameStack.items.reduce(0) do |width, item|
             width + item.frame_style.prefix_width
@@ -284,11 +257,7 @@ module CLI
         #
         # * +color+ - The color to override to
         #
-        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_override(color, &block)
           prev = Thread.current[:cliui_frame_color_override]
           Thread.current[:cliui_frame_color_override] = color
@@ -303,7 +272,7 @@ module CLI
         #   Numeric: return it
         #   false: return nil
         #   true: defaults to Time.new
-        sig { params(start: Time, timing: T.any(Numeric, T::Boolean)).returns(T.nilable(Numeric)) }
+        #: (Time start, (Numeric | bool) timing) -> Numeric?
         def elapsed(start, timing)
           return timing if timing.is_a?(Numeric)
           return if timing.is_a?(FalseClass)

data/lib/cli/ui/glyph.rb

@@ -6,18 +6,14 @@ require 'cli/ui'
 module CLI
   module UI
     class Glyph
-      extend T::Sig
-
       class InvalidGlyphHandle < ArgumentError
-        extend T::Sig
-
-        sig { params(handle: String).void }
+        #: (String handle) -> void
         def initialize(handle)
           super
           @handle = handle
         end
 
-        sig { returns(String) }
+        #: -> String
         def message
           keys = Glyph.available.join(',')
           "invalid glyph handle: #{@handle} " \
@@ -25,13 +21,13 @@ module CLI
         end
       end
 
-      sig { returns(String) }
+      #: String
       attr_reader :handle, :to_s, :fmt, :char
 
-      sig { returns(T.any(Integer, T::Array[Integer])) }
+      #: (Integer | Array[Integer])
       attr_reader :codepoint
 
-      sig { returns(Color) }
+      #: Color
       attr_reader :color
 
       # Creates a new glyph
@@ -43,7 +39,7 @@ module CLI
       # * +plain+ - A fallback plain string to be used in case glyphs are disabled
       # * +color+ - What color to output the glyph. Check +CLI::UI::Color+ for options.
       #
-      sig { params(handle: String, codepoint: T.any(Integer, T::Array[Integer]), plain: String, color: Color).void }
+      #: (String handle, (Integer | Array[Integer]) codepoint, String plain, Color color) -> void
       def initialize(handle, codepoint, plain, color)
         @handle    = handle
         @codepoint = codepoint
@@ -68,8 +64,6 @@ module CLI
       WARNING   = new('!', [0x26a0, 0xfe0f], '!', Color::YELLOW) # WARNING SIGN + VARIATION SELECTOR 16 (⚠️ )
 
       class << self
-        extend T::Sig
-
         # Looks up a glyph by name
         #
         # ==== Raises
@@ -79,7 +73,7 @@ module CLI
         # ==== Returns
         # Returns a terminal output-capable string
         #
-        sig { params(name: String).returns(Glyph) }
+        #: (String name) -> Glyph
         def lookup(name)
           MAP.fetch(name.to_s)
         rescue KeyError
@@ -88,7 +82,7 @@ module CLI
 
         # All available glyphs by name
         #
-        sig { returns(T::Array[String]) }
+        #: -> Array[String]
         def available
           MAP.keys
         end

data/lib/cli/ui/os.rb

@@ -6,9 +6,7 @@ require 'rbconfig'
 module CLI
   module UI
     class OS
-      extend T::Sig
-
-      sig { params(emoji: T::Boolean, color_prompt: T::Boolean, arrow_keys: T::Boolean, shift_cursor: T::Boolean).void }
+      #: (?emoji: bool, ?color_prompt: bool, ?arrow_keys: bool, ?shift_cursor: bool) -> void
       def initialize(emoji: true, color_prompt: true, arrow_keys: true, shift_cursor: false)
         @emoji = emoji
         @color_prompt = color_prompt
@@ -16,30 +14,28 @@ module CLI
         @shift_cursor = shift_cursor
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def use_emoji?
         @emoji
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def use_color_prompt?
         @color_prompt
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def suggest_arrow_keys?
         @arrow_keys
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def shift_cursor_back_on_horizontal_absolute?
         @shift_cursor
       end
 
       class << self
-        extend T::Sig
-
-        sig { returns(OS) }
+        #: -> OS
         def current
           @current_os ||= case RbConfig::CONFIG['host_os']
           when /darwin/

data/lib/cli/ui/printer.rb

@@ -6,11 +6,7 @@ require 'cli/ui'
 module CLI
   module UI
     class Printer
-      extend T::Sig
-
       class << self
-        extend T::Sig
-
         # Print a message to a stream with common utilities.
         # Allows overriding the color, encoding, and target stream.
         # By default, it formats the string using CLI:UI and rescues common stream errors.
@@ -36,17 +32,7 @@ module CLI
         #
         #   CLI::UI::Printer.puts('{{x}} Ouch', to: $stderr)
         #
-        sig do
-          params(
-            msg: String,
-            frame_color: T.nilable(Colorable),
-            to: IOLike,
-            encoding: T.nilable(Encoding),
-            format: T::Boolean,
-            graceful: T::Boolean,
-            wrap: T::Boolean,
-          ).returns(T::Boolean)
-        end
+        #: (String msg, ?frame_color: colorable?, ?to: io_like, ?encoding: Encoding?, ?format: bool, ?graceful: bool, ?wrap: bool) -> bool
         def puts(
           msg,
           frame_color: nil,

data/lib/cli/ui/progress.rb

@@ -6,16 +6,12 @@ require 'cli/ui'
 module CLI
   module UI
     class Progress
-      extend T::Sig
-
       # A Cyan filled block
       FILLED_BAR = "\e[46m"
       # A bright white block
       UNFILLED_BAR = "\e[1;47m"
 
       class << self
-        extend T::Sig
-
         # Add a progress bar to the terminal output
         #
         # https://user-images.githubusercontent.com/3074765/33799794-cc4c940e-dd00-11e7-9bdc-90f77ec9167c.gif
@@ -42,21 +38,17 @@ module CLI
         #     bar.tick(percent: 0.05)
         #     bar.update_title('New title')
         #   end
-        sig do
-          type_parameters(:T)
-            .params(
-              title: T.nilable(String),
-              width: Integer,
-              block: T.proc.params(bar: Progress).returns(T.type_parameter(:T)),
-            )
-            .returns(T.type_parameter(:T))
-        end
+        #: [T] (?String? title, ?width: Integer) { (Progress bar) -> T } -> T
         def progress(title = nil, width: Terminal.width, &block)
-          bar = Progress.new(title, width: width)
-          print(CLI::UI::ANSI.hide_cursor)
-          yield(bar)
+          bar = nil #: Progress?
+          CLI::UI::ProgressReporter.with_progress(mode: :progress) do |reporter|
+            bar = Progress.new(title, width: width, reporter: reporter)
+            print(CLI::UI::ANSI.hide_cursor)
+            yield(bar)
+          end
         ensure
-          puts(bar)
+          puts(bar) if bar
+
           CLI::UI.raw do
             print(ANSI.show_cursor)
           end
@@ -69,12 +61,14 @@ module CLI
       #
       # * +:title+ - The title of the progress bar
       # * +:width+ - The width of the terminal
+      # * +:reporter+ - The progress reporter instance
       #
-      sig { params(title: T.nilable(String), width: Integer).void }
-      def initialize(title = nil, width: Terminal.width)
-        @percent_done = T.let(0, Numeric)
+      #: (?String? title, ?width: Integer, ?reporter: ProgressReporter::Reporter?) -> void
+      def initialize(title = nil, width: Terminal.width, reporter: nil)
+        @percent_done = 0 #: Numeric
         @title = title
         @max_width = width
+        @reporter = reporter
       end
 
       # Set the progress of the bar. Typically used in a +Progress.progress+ block
@@ -87,7 +81,7 @@ module CLI
       #
       # *Note:* The +:percent+ and +:set_percent must be between 0.00 and 1.0
       #
-      sig { params(percent: T.nilable(Numeric), set_percent: T.nilable(Numeric)).void }
+      #: (?percent: Numeric?, ?set_percent: Numeric?) -> void
       def tick(percent: nil, set_percent: nil)
         raise ArgumentError, 'percent and set_percent cannot both be specified' if percent && set_percent
 
@@ -95,6 +89,9 @@ module CLI
         @percent_done = set_percent if set_percent
         @percent_done = [@percent_done, 1.0].min # Make sure we can't go above 1.0
 
+        # Update terminal progress reporter with current percentage
+        @reporter&.set_progress((@percent_done * 100).floor)
+
         print(self)
 
         printed_lines = @title ? 2 : 1
@@ -107,14 +104,14 @@ module CLI
       #
       # * +new_title+ - title to change the progress bar to
       #
-      sig { params(new_title: String).void }
+      #: (String new_title) -> void
       def update_title(new_title)
         @title = new_title
       end
 
       # Format the progress bar to be printed to terminal
       #
-      sig { returns(String) }
+      #: -> String
       def to_s
         suffix = " #{(@percent_done * 100).floor}%".ljust(5)
         workable_width = @max_width - Frame.prefix_width - suffix.size