cli-ui 1.5.1 → 2.2.3

data/lib/cli/ui/progress.rb

@@ -1,41 +1,54 @@
+# typed: true
+
 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"
 
-      # Add a progress bar to the terminal output
-      #
-      # https://user-images.githubusercontent.com/3074765/33799794-cc4c940e-dd00-11e7-9bdc-90f77ec9167c.gif
-      #
-      # ==== Example Usage:
-      #
-      # Set the percent to X
-      #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick(set_percent: percent)
-      #   end
-      #
-      # Increase the percent by 1 percent
-      #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick
-      #   end
-      #
-      # Increase the percent by X
-      #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick(percent: 0.05)
-      #   end
-      def self.progress(width: Terminal.width)
-        bar = Progress.new(width: width)
-        print(CLI::UI::ANSI.hide_cursor)
-        yield(bar)
-      ensure
-        puts bar.to_s
-        CLI::UI.raw do
-          print(ANSI.show_cursor)
+      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
+        #
+        # ==== Example Usage:
+        #
+        # Set the percent to X
+        #   CLI::UI::Progress.progress do |bar|
+        #     bar.tick(set_percent: percent)
+        #   end
+        #
+        # Increase the percent by 1 percent
+        #   CLI::UI::Progress.progress do |bar|
+        #     bar.tick
+        #   end
+        #
+        # Increase the percent by X
+        #   CLI::UI::Progress.progress do |bar|
+        #     bar.tick(percent: 0.05)
+        #   end
+        sig do
+          type_parameters(:T)
+            .params(width: Integer, block: T.proc.params(bar: Progress).returns(T.type_parameter(:T)))
+            .returns(T.type_parameter(:T))
+        end
+        def progress(width: Terminal.width, &block)
+          bar = Progress.new(width: width)
+          print(CLI::UI::ANSI.hide_cursor)
+          yield(bar)
+        ensure
+          puts(bar)
+          CLI::UI.raw do
+            print(ANSI.show_cursor)
+          end
         end
       end
 
@@ -46,8 +59,9 @@ module CLI
       #
       # * +:width+ - The width of the terminal
       #
+      sig { params(width: Integer).void }
       def initialize(width: Terminal.width)
-        @percent_done = 0
+        @percent_done = T.let(0, Numeric)
         @max_width = width
       end
 
@@ -61,18 +75,21 @@ module CLI
       #
       # *Note:* The +:percent+ and +:set_percent must be between 0.00 and 1.0
       #
-      def tick(percent: 0.01, set_percent: nil)
-        raise ArgumentError, 'percent and set_percent cannot both be specified' if percent != 0.01 && set_percent
-        @percent_done += percent
+      sig { params(percent: T.nilable(Numeric), set_percent: T.nilable(Numeric)).void }
+      def tick(percent: nil, set_percent: nil)
+        raise ArgumentError, 'percent and set_percent cannot both be specified' if percent && set_percent
+
+        @percent_done += percent || 0.01
         @percent_done = set_percent if set_percent
         @percent_done = [@percent_done, 1.0].min # Make sure we can't go above 1.0
 
-        print(to_s)
+        print(self)
         print(CLI::UI::ANSI.previous_line + "\n")
       end
 
       # Format the progress bar to be printed to terminal
       #
+      sig { returns(String) }
       def to_s
         suffix = " #{(@percent_done * 100).floor}%".ljust(5)
         workable_width = @max_width - Frame.prefix_width - suffix.size

data/lib/cli/ui/prompt/interactive_options.rb

@@ -1,34 +1,48 @@
 # coding: utf-8
+
+# typed: true
+
 require 'io/console'
 
 module CLI
   module UI
     module Prompt
       class InteractiveOptions
+        extend T::Sig
+
         DONE = 'Done'
         CHECKBOX_ICON = { false => '☐', true => '☑' }
 
-        # Prompts the user with options
-        # 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
-        # For more than 9 options, hitting 'e', ':', or 'G' will enter select
-        # mode allowing the user to type in longer numbers
-        # Pressing 'f' or '/' will allow the user to filter the results
-        #
-        # https://user-images.githubusercontent.com/3074765/33797984-0ebb5e64-dcdf-11e7-9e7e-7204f279cece.gif
-        #
-        # ==== Example Usage:
-        #
-        # Ask an interactive question
-        #   CLI::UI::Prompt::InteractiveOptions.call(%w(rails go python))
-        #
-        def self.call(options, multiple: false, default: nil)
-          list = new(options, multiple: multiple, default: default)
-          selected = list.call
-          if multiple
-            selected.map { |s| options[s - 1] }
-          else
-            options[selected - 1]
+        class << self
+          extend T::Sig
+
+          # Prompts the user with options
+          # 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
+          # For more than 9 options, hitting 'e', ':', or 'G' will enter select
+          # mode allowing the user to type in longer numbers
+          # Pressing 'f' or '/' will allow the user to filter the results
+          #
+          # https://user-images.githubusercontent.com/3074765/33797984-0ebb5e64-dcdf-11e7-9e7e-7204f279cece.gif
+          #
+          # ==== Example Usage:
+          #
+          # Ask an interactive question
+          #   CLI::UI::Prompt::InteractiveOptions.call(%w(rails go python))
+          #
+          sig do
+            params(options: T::Array[String], multiple: T::Boolean, default: T.nilable(T.any(String, T::Array[String])))
+              .returns(T.any(String, T::Array[String]))
+          end
+          def call(options, multiple: false, default: nil)
+            list = new(options, multiple: multiple, default: default)
+            selected = list.call
+            case selected
+            when Array
+              selected.map { |s| T.must(options[s - 1]) }
+            else
+              T.must(options[selected - 1])
+            end
           end
         end
 
@@ -39,6 +53,10 @@ module CLI
         #
         #   CLI::UI::Prompt::InteractiveOptions.new(%w(rails go python))
         #
+        sig do
+          params(options: T::Array[String], multiple: T::Boolean, default: T.nilable(T.any(String, T::Array[String])))
+            .void
+        end
         def initialize(options, multiple: false, default: nil)
           @options = options
           @active = 1
@@ -60,12 +78,13 @@ module CLI
             end
           end
           @redraw = true
-          @presented_options = []
+          @presented_options = T.let([], T::Array[[String, T.nilable(Integer)]])
         end
 
         # Calls the +InteractiveOptions+ and asks the question
         # Usually used from +self.call+
         #
+        sig { returns(T.any(Integer, T::Array[Integer])) }
         def call
           calculate_option_line_lengths
           CLI::UI.raw { print(ANSI.hide_cursor) }
@@ -85,31 +104,40 @@ module CLI
 
         private
 
+        sig { void }
         def calculate_option_line_lengths
           @terminal_width_at_calculation_time = CLI::UI::Terminal.width
           # options will be an array of questions but each option can be multi-line
           # so to get the # of lines, you need to join then split
 
           # since lines may be longer than the terminal is wide, we need to
-          # determine how many extra lines would be taken up by them
-          max_width = (@terminal_width_at_calculation_time -
-                       @options.count.to_s.size - # Width of the displayed number
-                       5 -                        # Extra characters added during rendering
-                       (@multiple ? 1 : 0)        # Space for the checkbox, if rendered
-                      ).to_f
+          # determine how many extra lines would be taken up by them.
+          #
+          # To accomplish this we split the string by new lines and add the
+          # extra characters to the first line.
+          # Then we calculate how many lines would be needed to render the string
+          # based on the terminal width
+          # 3 = space before the number, the . after the number, the space after the .
+          # multiple check is for the space for the checkbox, if rendered
+          # options.count.to_s.size gets us the max size of the number we will display
+          extra_chars = @marker.length + 3 + @options.count.to_s.size + (@multiple ? 1 : 0)
 
           @option_lengths = @options.map do |text|
-            width = 1 if text.empty?
-            width ||= text
-              .split("\n")
-              .reject(&:empty?)
-              .map { |l| (CLI::UI.fmt(l, enable_color: false).length / max_width).ceil }
-              .reduce(&:+)
-
-            width
+            next 1 if text.empty?
+
+            # Find the length of all the lines in this string
+            non_empty_line_lengths = text.split("\n").reject(&:empty?).map do |line|
+              CLI::UI.fmt(line, enable_color: false).length
+            end
+            # The first line has the marker and number, so we add that so we can take it into account
+            non_empty_line_lengths[0] += extra_chars
+            # Finally, we need to calculate how many lines each one will take. We can do that by dividing each one
+            # by the width of the terminal, rounding up to the nearest natural number
+            non_empty_line_lengths.sum { |length| (length.to_f / @terminal_width_at_calculation_time).ceil }
           end
         end
 
+        sig { params(number_of_lines: Integer).void }
         def reset_position(number_of_lines = num_lines)
           # This will put us back at the beginning of the options
           # When we redraw the options, they will be overwritten
@@ -118,6 +146,7 @@ module CLI
           end
         end
 
+        sig { params(number_of_lines: Integer).void }
         def clear_output(number_of_lines = num_lines)
           CLI::UI.raw do
             # Write over all lines with whitespace
@@ -133,22 +162,26 @@ module CLI
 
         # Don't use this in place of +@displaying_metadata+, this updates too
         # quickly to be useful when drawing to the screen.
+        sig { returns(T::Boolean) }
         def display_metadata?
           filtering? || selecting? || has_filter?
         end
 
+        sig { returns(Integer) }
         def num_lines
           calculate_option_line_lengths if terminal_width_changed?
 
           option_length = presented_options.reduce(0) do |total_length, (_, option_number)|
             # Handle continuation markers and "Done" option when multiple is true
             next total_length + 1 if option_number.nil? || option_number.zero?
+
             total_length + @option_lengths[option_number - 1]
           end
 
           option_length + (@displaying_metadata ? 1 : 0)
         end
 
+        sig { returns(T::Boolean) }
         def terminal_width_changed?
           @terminal_width_at_calculation_time != CLI::UI::Terminal.width
         end
@@ -158,6 +191,7 @@ module CLI
         CTRL_C = "\u0003"
         CTRL_D = "\u0004"
 
+        sig { void }
         def up
           active_index = @filtered_options.index { |_, num| num == @active } || 0
 
@@ -168,6 +202,7 @@ module CLI
           @redraw = true
         end
 
+        sig { void }
         def down
           active_index = @filtered_options.index { |_, num| num == @active } || 0
 
@@ -180,6 +215,7 @@ module CLI
 
         # n is 1-indexed selection
         # n == 0 if "Done" was selected in @multiple mode
+        sig { params(n: Integer).void }
         def select_n(n)
           if @multiple
             if n == 0
@@ -200,24 +236,29 @@ module CLI
           @redraw = true
         end
 
+        sig { params(char: String).void }
         def select_bool(char)
-          return unless (@options - %w(yes no)).empty?
-          opt = @options.detect { |o| o.start_with?(char) }
-          @active = @options.index(opt) + 1
-          @answer = @options.index(opt) + 1
+          return unless (@options - ['yes', 'no']).empty?
+
+          index = T.must(@options.index { |o| o.start_with?(char) })
+          @active = index + 1
+          @answer = index + 1
           @redraw = true
         end
 
+        sig { params(char: String).void }
         def build_selection(char)
           @active = (@active.to_s + char).to_i
           @redraw = true
         end
 
+        sig { void }
         def chop_selection
           @active = @active.to_s.chop.to_i
           @redraw = true
         end
 
+        sig { params(char: String).void }
         def update_search(char)
           @redraw = true
 
@@ -235,25 +276,28 @@ module CLI
           end
         end
 
+        sig { void }
         def select_current
           # Prevent selection of invisible options
           return unless presented_options.any? { |_, num| num == @active }
+
           select_n(@active)
         end
 
+        sig { void }
         def process_input_until_redraw_required
           @redraw = false
           wait_for_user_input until @redraw
         end
 
         # rubocop:disable Style/WhenThen,Layout/SpaceBeforeSemicolon,Style/Semicolon
+        sig { void }
         def wait_for_user_input
-          char = read_char
+          char = Prompt.read_char
           @last_char = char
 
           case char
-          when :timeout ; raise Interrupt # Timeout, use interrupt to simulate
-          when CTRL_C   ; raise Interrupt
+          when CTRL_C, nil ; raise Interrupt
           end
 
           max_digit = [@options.size, 9].min.to_s
@@ -302,51 +346,48 @@ module CLI
             end
           end
         end
-        # rubocop:enable Style/WhenThen,Layout/SpaceBeforeSemicolon
+        # rubocop:enable Style/WhenThen,Layout/SpaceBeforeSemicolon,Style/Semicolon
 
+        sig { returns(T::Boolean) }
         def selecting?
           @state == :line_select
         end
 
+        sig { returns(T::Boolean) }
         def filtering?
           @state == :filter
         end
 
+        sig { returns(T::Boolean) }
         def has_filter?
           !@filter.empty?
         end
 
+        sig { void }
         def start_filter
           @state = :filter
           @redraw = true
         end
 
+        sig { void }
         def start_line_select
           @state  = :line_select
           @active = 0
           @redraw = true
         end
 
+        sig { void }
         def stop_line_select
           @state = :root
           @active = 1 if @active.zero?
           @redraw = true
         end
 
-        def read_char
-          if $stdin.tty? && !ENV['TEST']
-            $stdin.getch # raw mode for tty
-          else
-            $stdin.getc
-          end
-        rescue IOError
-          "\e"
-        end
-
+        sig { params(recalculate: T::Boolean).returns(T::Array[[String, T.nilable(Integer)]]) }
         def presented_options(recalculate: false)
           return @presented_options unless recalculate
 
-          @presented_options = @options.zip(1..Float::INFINITY)
+          @presented_options = @options.zip(1..)
           if has_filter?
             @presented_options.select! { |option, _| option.downcase.include?(@filter.downcase) }
           end
@@ -385,36 +426,44 @@ module CLI
           @presented_options
         end
 
+        sig { void }
         def ensure_visible_is_active
           unless presented_options.any? { |_, num| num == @active }
             @active = presented_options.first&.last.to_i
           end
         end
 
+        sig { returns(Integer) }
         def distance_from_selection_to_end
           @presented_options.count - index_of_active_option
         end
 
+        sig { returns(Integer) }
         def distance_from_start_to_selection
           index_of_active_option
         end
 
+        sig { returns(Integer) }
         def index_of_active_option
           @presented_options.index { |_, num| num == @active }.to_i
         end
 
+        sig { void }
         def ensure_last_item_is_continuation_marker
-          @presented_options.push(['...', nil]) if @presented_options.last.last
+          @presented_options.push(['...', nil]) if @presented_options.last&.last
         end
 
+        sig { void }
         def ensure_first_item_is_continuation_marker
-          @presented_options.unshift(['...', nil]) if @presented_options.first.last
+          @presented_options.unshift(['...', nil]) if @presented_options.first&.last
         end
 
+        sig { returns(Integer) }
         def max_lines
           CLI::UI::Terminal.height - (@displaying_metadata ? 3 : 2) # Keeps a one line question visible
         end
 
+        sig { void }
         def render_options
           previously_displayed_lines = num_lines
 
@@ -436,11 +485,7 @@ module CLI
             "Filter: #{filter_text}"
           end
 
-          if metadata_text
-            CLI::UI.with_frame_color(:blue) do
-              puts CLI::UI.fmt("  {{green:#{metadata_text}}}#{ANSI.clear_to_end_of_line}")
-            end
-          end
+          puts CLI::UI.fmt("  {{green:#{metadata_text}}}#{ANSI.clear_to_end_of_line}") if metadata_text
 
           options.each do |choice, num|
             is_chosen = @multiple && num && @chosen[num - 1] && num != 0
@@ -449,8 +494,10 @@ module CLI
             message = "  #{num}#{num ? "." : " "}#{padding}"
 
             format = '%s'
-            # If multiple, bold only selected. If not multiple, bold everything
-            format = "{{bold:#{format}}}" if !@multiple || is_chosen
+            # If multiple, bold selected. If not multiple, do not bold any options.
+            # Bolding options can cause confusion as some users may perceive bold white (default color) as selected
+            # rather than the actual selected color.
+            format = "{{bold:#{format}}}" if @multiple && is_chosen
             format = "{{cyan:#{format}}}" if @multiple && is_chosen && num != @active
             format = " #{format}"
 
@@ -460,15 +507,14 @@ module CLI
             if num == @active
 
               color = filtering? || selecting? ? 'green' : 'blue'
-              message = message.split("\n").map { |l| "{{#{color}:> #{l.strip}}}" }.join("\n")
+              message = message.split("\n").map { |l| "{{#{color}:#{@marker} #{l.strip}}}" }.join("\n")
             end
 
-            CLI::UI.with_frame_color(:blue) do
-              puts CLI::UI.fmt(message)
-            end
+            puts CLI::UI.fmt(message)
           end
         end
 
+        sig { params(format: String, choice: String).returns(String) }
         def format_choice(format, choice)
           eol = CLI::UI::ANSI.clear_to_end_of_line
           lines = choice.split("\n")

data/lib/cli/ui/prompt/options_handler.rb

@@ -1,20 +1,28 @@
+# typed: true
+
 module CLI
   module UI
     module Prompt
       # A class that handles the various options of an InteractivePrompt and their callbacks
       class OptionsHandler
+        extend T::Sig
+
+        sig { void }
         def initialize
           @options = {}
         end
 
+        sig { returns(T::Array[String]) }
         def options
           @options.keys
         end
 
+        sig { params(option: String, handler: T.proc.params(option: String).returns(String)).void }
         def option(option, &handler)
           @options[option] = handler
         end
 
+        sig { params(options: T.any(T::Array[String], String)).returns(String) }
         def call(options)
           case options
           when Array