cli-ui 2.2.3 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140781de33cc19ef1c5bc946a0a887b3707e54475823affad8f5568e98fbc0dd
-  data.tar.gz: b754caad8da6b0d37ea17d807aef78351518c4f17d511a39decbfb29b0512791
+  metadata.gz: 99ed2ae4a35b13db165864297acf7cfc4e636283e51683a7954ca2e2f43ac94c
+  data.tar.gz: 30eb1a74cdbd50b95d9c48209c97258261970c9678eb71e089bb894a018bcb0b
 SHA512:
-  metadata.gz: 8d841fb206c3de7427c4903aa5bb350241c5fe10bbf39c04cb1980eada288deda4b235bf1d5d99a293ebaa6cd78482dd2f49849d65ddd3e7929d63d2f35894bc
-  data.tar.gz: 6a99dc71d996abbff3fccdda8ce9ede069a7868ba467d86296bed3575e5726f50f76b65d4d427757f5ddaea211b7926d25045402ae5304e1593ae2fb6bc656fb
+  metadata.gz: 219e73a9baa10649b9cd14280ce9fe8d2f18a614006c9b4f5c8c79b3df3da3ef236c00ec290816ab866ff3d67cf058ecf5c88f0034e331a1ab77cdef1df25111
+  data.tar.gz: 79de546a04f2ca9fe49246be7df31582cafc791799bbacd868af7fa1e381e42a462685e619a734745500203a25587a7eb6eaee04465b269cee8242ad67334a1b

data/README.md

@@ -162,7 +162,7 @@ CLI::UI.frame_style = :box
 To style an individual frame:
 
 ```ruby
-CLI::UI.frame('New Style!', frame_style: :bracket) { puts 'It's pretty cool!' }
+CLI::UI.frame('New Style!', frame_style: :bracket) { puts "It's pretty cool!" }
 ```
 
 The default style - `:box` - is what has been used up until now.  The other style - `:bracket` - looks like this:

data/lib/cli/ui/ansi.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 
@@ -45,7 +46,7 @@ module CLI
         #
         sig { params(str: String).returns(String) }
         def strip_codes(str)
-          str.gsub(/\x1b\[[\d;]+[A-z]|\r/, '')
+          str.gsub(/\x1b\[[\d;]+[A-Za-z]|\x1b\][\d;]+.*?\x1b\\|\r/, '')
         end
 
         # Returns an ANSI control sequence
@@ -145,7 +146,7 @@ module CLI
 
         sig { returns(Regexp) }
         def match_alternate_screen
-          /#{Regexp.escape(control('?1049', ''))}[hl]/
+          /#{Regexp.escape(control("?1049", ""))}[hl]/
         end
 
         # Show the cursor
@@ -187,13 +188,34 @@ module CLI
         #
         sig { returns(String) }
         def previous_line
-          cursor_up + cursor_horizontal_absolute
+          previous_lines(1)
+        end
+
+        # Move to the previous n lines
+        #
+        # ==== Attributes
+        #
+        # * +n+ - number of lines by which to move the cursor up
+        #
+        sig { params(n: Integer).returns(String) }
+        def previous_lines(n = 1)
+          cursor_up(n) + cursor_horizontal_absolute
         end
 
         sig { returns(String) }
         def clear_to_end_of_line
           control('', 'K')
         end
+
+        sig { returns(String) }
+        def insert_line
+          insert_lines(1)
+        end
+
+        sig { params(n: Integer).returns(String) }
+        def insert_lines(n = 1)
+          control(n.to_s, 'L')
+        end
       end
     end
   end

data/lib/cli/ui/color.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 
@@ -42,6 +43,8 @@ module CLI
 
       # 240 is very dark gray; 255 is very light gray. 244 is somewhat dark.
       GRAY = new('38;5;244', :gray)
+      # Using color 214 from the 256-color palette for a more distinct orange
+      ORANGE = new('38;5;214', :orange)
 
       MAP = {
         red: RED,

data/lib/cli/ui/formatter.rb

@@ -28,6 +28,7 @@ module CLI
         'bold' => '1',
         'italic' => '3',
         'underline' => '4',
+        'strikethrough' => '9',
         'reset' => '0',
 
         # semantic

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

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 module CLI
   module UI

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

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 module CLI
   module UI
@@ -94,7 +95,8 @@ module CLI
 
               preamble = +''
 
-              preamble << color.code << first << (HORIZONTAL * 2)
+              preamble << color.code if CLI::UI.enable_color?
+              preamble << first << (HORIZONTAL * 2)
 
               unless text.empty?
                 preamble << ' ' << CLI::UI.resolve_text("{{#{color.name}:#{text}}}") << ' '
@@ -128,18 +130,17 @@ module CLI
 
               o = +''
 
-              # Shopify's CI system supports terminal emulation, but not some of
-              # the fancier features that we normally use to draw frames
-              # extra-reliably, so we fall back to a less foolproof strategy. This
-              # is probably better in general for cases with impoverished terminal
-              # emulators and no active user.
-              unless [0, '', nil].include?(ENV['CI'])
+              unless CLI::UI.enable_cursor?
                 linewidth = [0, termwidth - (preamble_end + suffix_width + 1)].max
 
-                o << color.code << preamble
-                o << color.code << (HORIZONTAL * linewidth)
-                o << color.code << suffix
-                o << CLI::UI::Color::RESET.code << "\n"
+                o << color.code if CLI::UI.enable_color?
+                o << preamble
+                o << color.code if CLI::UI.enable_color?
+                o << (HORIZONTAL * linewidth)
+                o << color.code if CLI::UI.enable_color?
+                o << suffix
+                o << CLI::UI::Color::RESET.code if CLI::UI.enable_color?
+                o << "\n"
                 return o
               end
 
@@ -158,12 +159,12 @@ module CLI
               # |                 |                    |            | |
               # V                 V                    V            V V
               # --- Preamble text --------------------- suffix text --
-              o << color.code
+              o << color.code if CLI::UI.enable_color?
               o << print_at_x(preamble_start, HORIZONTAL * (termwidth - preamble_start)) # draw a full line
               o << print_at_x(preamble_start, preamble)
-              o << color.code
+              o << color.code if CLI::UI.enable_color?
               o << print_at_x(suffix_start, suffix)
-              o << CLI::UI::Color::RESET.code
+              o << CLI::UI::Color::RESET.code if CLI::UI.enable_color?
               o << CLI::UI::ANSI.show_cursor
               o << "\n"
 

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

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 module CLI
   module UI
@@ -94,7 +95,8 @@ module CLI
 
               preamble = +''
 
-              preamble << color.code << first << (HORIZONTAL * 2)
+              preamble << color.code if CLI::UI.enable_color?
+              preamble << first << (HORIZONTAL * 2)
 
               unless text.empty?
                 preamble << ' ' << CLI::UI.resolve_text("{{#{color.name}:#{text}}}") << ' '
@@ -108,15 +110,12 @@ module CLI
 
               o = +''
 
-              # Shopify's CI system supports terminal emulation, but not some of
-              # the fancier features that we normally use to draw frames
-              # extra-reliably, so we fall back to a less foolproof strategy. This
-              # is probably better in general for cases with impoverished terminal
-              # emulators and no active user.
-              unless [0, '', nil].include?(ENV['CI'])
-                o << color.code << preamble
-                o << color.code << suffix
-                o << CLI::UI::Color::RESET.code
+              unless CLI::UI.enable_cursor?
+                o << color.code if CLI::UI.enable_color?
+                o << preamble
+                o << color.code if CLI::UI.enable_color?
+                o << suffix
+                o << CLI::UI::Color::RESET.code if CLI::UI.enable_color?
                 o << "\n"
 
                 return o
@@ -134,9 +133,11 @@ module CLI
               # reset to column 1 so that things like ^C don't ruin formatting
               o << "\r"
 
-              o << color.code
-              o << print_at_x(preamble_start, preamble + color.code + suffix)
-              o << CLI::UI::Color::RESET.code
+              o << color.code if CLI::UI.enable_color?
+              o << print_at_x(preamble_start, preamble)
+              o << color.code if CLI::UI.enable_color?
+              o << suffix
+              o << CLI::UI::Color::RESET.code if CLI::UI.enable_color?
               o << CLI::UI::ANSI.show_cursor
               o << "\n"
 

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

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui/frame'
 
@@ -106,8 +107,8 @@ module CLI
           sig { returns(String) }
           def message
             keys = FrameStyle::MAP.keys.map(&:inspect).join(', ')
-            "invalid frame style: #{@name.inspect}" \
-              ' -- must be one of CLI::UI::Frame::FrameStyle::MAP ' \
+            "invalid frame style: #{@name.inspect} " \
+              '-- must be one of CLI::UI::Frame::FrameStyle::MAP ' \
               "(#{keys})"
           end
         end

data/lib/cli/ui/frame.rb

@@ -1,6 +1,5 @@
-# coding: utf-8
-
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 require 'cli/ui/frame/frame_stack'
@@ -250,19 +249,21 @@ module CLI
         #
         sig { params(color: T.nilable(Colorable)).returns(String) }
         def prefix(color: Thread.current[:cliui_frame_color_override])
-          +''.tap do |output|
+          (+'').tap do |output|
             items = FrameStack.items
 
             items[0..-2].to_a.each do |item|
-              output << item.color.code << item.frame_style.prefix
+              output << item.color.code if CLI::UI.enable_color?
+              output << item.frame_style.prefix
+              output << CLI::UI::Color::RESET.code if CLI::UI.enable_color?
             end
 
             if (item = items.last)
               final_color = color || item.color
-              output << CLI::UI.resolve_color(final_color).code \
-                << item.frame_style.prefix \
-                << ' ' \
-                << CLI::UI::Color::RESET.code
+              output << CLI::UI.resolve_color(final_color).code if CLI::UI.enable_color?
+              output << item.frame_style.prefix
+              output << CLI::UI::Color::RESET.code if CLI::UI.enable_color?
+              output << ' '
             end
           end
         end

data/lib/cli/ui/glyph.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 
@@ -63,7 +64,7 @@ module CLI
       X         = new('x', 0x2717,           'X', Color::RED)    # RED BALLOT X (✗)
       BUG       = new('b', 0x1f41b,          '!', Color::WHITE)  # Bug emoji (🐛)
       CHEVRON   = new('>', 0xbb,             '»', Color::YELLOW) # RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK (»)
-      HOURGLASS = new('H', [0x231b, 0xfe0e], 'H', Color::BLUE)   # HOURGLASS + VARIATION SELECTOR 15 (⌛︎)
+      HOURGLASS = new('H', 0x29d6,           'H', Color::ORANGE) # HOURGLASS (⧖)
       WARNING   = new('!', [0x26a0, 0xfe0f], '!', Color::YELLOW) # WARNING SIGN + VARIATION SELECTOR 16 (⚠️ )
 
       class << self

data/lib/cli/ui/os.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'rbconfig'
 

data/lib/cli/ui/printer.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 

data/lib/cli/ui/progress.rb

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
 
@@ -35,13 +36,23 @@ module CLI
         #   CLI::UI::Progress.progress do |bar|
         #     bar.tick(percent: 0.05)
         #   end
+        #
+        # Update the title
+        #   CLI::UI::Progress.progress('Title') do |bar|
+        #     bar.tick(percent: 0.05)
+        #     bar.update_title('New title')
+        #   end
         sig do
           type_parameters(:T)
-            .params(width: Integer, block: T.proc.params(bar: Progress).returns(T.type_parameter(: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
-        def progress(width: Terminal.width, &block)
-          bar = Progress.new(width: width)
+        def progress(title = nil, width: Terminal.width, &block)
+          bar = Progress.new(title, width: width)
           print(CLI::UI::ANSI.hide_cursor)
           yield(bar)
         ensure
@@ -55,13 +66,14 @@ module CLI
       # Initialize a progress bar. Typically used in a +Progress.progress+ block
       #
       # ==== Options
-      # One of the follow can be used, but not both together
       #
+      # * +:title+ - The title of the progress bar
       # * +:width+ - The width of the terminal
       #
-      sig { params(width: Integer).void }
-      def initialize(width: Terminal.width)
+      sig { params(title: T.nilable(String), width: Integer).void }
+      def initialize(title = nil, width: Terminal.width)
         @percent_done = T.let(0, Numeric)
+        @title = title
         @max_width = width
       end
 
@@ -84,7 +96,20 @@ module CLI
         @percent_done = [@percent_done, 1.0].min # Make sure we can't go above 1.0
 
         print(self)
-        print(CLI::UI::ANSI.previous_line + "\n")
+
+        printed_lines = @title ? 2 : 1
+        print(CLI::UI::ANSI.previous_lines(printed_lines) + "\n")
+      end
+
+      # Update the progress bar title
+      #
+      # ==== Attributes
+      #
+      # * +new_title+ - title to change the progress bar to
+      #
+      sig { params(new_title: String).void }
+      def update_title(new_title)
+        @title = new_title
       end
 
       # Format the progress bar to be printed to terminal
@@ -96,11 +121,14 @@ module CLI
         filled = [(@percent_done * workable_width.to_f).ceil, 0].max
         unfilled = [workable_width - filled, 0].max
 
-        CLI::UI.resolve_text([
+        title = CLI::UI.resolve_text(@title, truncate_to: @max_width - Frame.prefix_width) if @title
+        bar = CLI::UI.resolve_text([
           FILLED_BAR + ' ' * filled,
           UNFILLED_BAR + ' ' * unfilled,
           CLI::UI::Color::RESET.code + suffix,
         ].join)
+
+        [title, bar].compact.join("\n")
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # coding: utf-8
-
 # typed: true
+# frozen_string_literal: true
 
 require 'io/console'
 
@@ -59,7 +59,11 @@ module CLI
         end
         def initialize(options, multiple: false, default: nil)
           @options = options
-          @active = 1
+          @active = if default && (i = options.index(default))
+            i + 1
+          else
+            1
+          end
           @marker = '>'
           @answer = nil
           @state = :root
@@ -114,23 +118,20 @@ module CLI
           # 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)
+          # prefix to the first line. We use the options count as the number since
+          # it will be the widest number we will display, and we pad the others to
+          # align with it. Then we calculate how many lines would be needed to
+          # render the string based on the terminal width.
+          prefix = "#{@marker} #{@options.count}. #{@multiple ? "☐ " : ""}"
 
           @option_lengths = @options.map do |text|
             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|
+            non_empty_line_lengths = "#{prefix}#{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 }
@@ -229,6 +230,12 @@ module CLI
             end
           elsif n == 0
             # Ignore pressing "0" when not in multiple mode
+          elsif should_enter_select_mode?(n)
+            # When we have more than 9 options, we need to enter select mode
+            # to avoid pre-selecting (e.g) 1 when the user wanted 10.
+            # This also applies to 2 and 20+ options, 3/30+, etc.
+            start_line_select
+            @active = n
           else
             @active = n
             @answer = n
@@ -236,6 +243,20 @@ module CLI
           @redraw = true
         end
 
+        sig { params(n: Integer).returns(T::Boolean) }
+        def should_enter_select_mode?(n)
+          # If we have less than 10 options, we don't need to enter select mode
+          # and we can just select the option directly. This just keeps the code easier
+          # by making the cases simpler to understand
+          return false if @options.length <= 9
+
+          # At this point we have 10+ options so always need to check if we should run.
+          # This can be simplified to checking if the length of options is >= to the option selected * 10:
+          # n == 1 && options.length >= 10 (1 * 10), n == 2 && options.length >= 20 (2 * 10), etc.
+          # which can be further simplified to just:
+          @options.length >= (n * 10)
+        end
+
         sig { params(char: String).void }
         def select_bool(char)
           return unless (@options - ['yes', 'no']).empty?

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

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 module CLI
   module UI

data/lib/cli/ui/prompt.rb

@@ -1,23 +1,13 @@
 # coding: utf-8
-
 # typed: true
+# frozen_string_literal: true
 
 require 'cli/ui'
-require 'readline'
-
-module Readline
-  unless const_defined?(:FILENAME_COMPLETION_PROC)
-    FILENAME_COMPLETION_PROC = proc do |input|
-      directory = input[-1] == '/' ? input : File.dirname(input)
-      filename = input[-1] == '/' ? '' : File.basename(input)
-
-      (Dir.entries(directory).select do |fp|
-        fp.start_with?(filename)
-      end - (input[-1] == '.' ? [] : ['.', '..'])).map do |fp|
-        File.join(directory, fp).gsub(/\A\.\//, '')
-      end
-    end
-  end
+begin
+  require 'reline' # For 2.7+
+rescue LoadError
+  require 'readline' # For 2.6
+  Object.const_set(:Reline, Readline)
 end
 
 module CLI
@@ -137,10 +127,6 @@ module CLI
           &options_proc
         )
           has_options = !!(options || block_given?)
-          if has_options && default && !multiple
-            raise(ArgumentError, 'conflicting arguments: default may not be provided with options when not multiple')
-          end
-
           if has_options && is_file
             raise(ArgumentError, 'conflicting arguments: is_file is only useful when options are not provided')
           end
@@ -310,6 +296,8 @@ module CLI
           instructions += ", filter with 'f'" if filter_ui
           instructions += ", enter option with 'e'" if select_ui && (options.size > 9)
 
+          resp = T.let([], T.any(String, T::Array[String]))
+
           CLI::UI::StdoutRouter::Capture.in_alternate_screen do
             puts_question("#{question} " + instructions_color.code + "(#{instructions})" + Color::RESET.code)
             resp = interactive_prompt(options, multiple: multiple, default: default)
@@ -334,12 +322,12 @@ module CLI
               resp
             end
             puts_question("#{question} (You chose: {{italic:#{resp_text}}})")
+          end
 
-            if block_given?
-              T.must(handler).call(resp)
-            else
-              resp
-            end
+          if block_given?
+            T.must(handler).call(resp)
+          else
+            resp
           end
         end
 
@@ -375,11 +363,20 @@ module CLI
         sig { params(is_file: T::Boolean).returns(String) }
         def readline(is_file: false)
           if is_file
-            Readline.completion_proc = Readline::FILENAME_COMPLETION_PROC
-            Readline.completion_append_character = ''
+            Reline.completion_proc = proc do |input|
+              directory = input[-1] == '/' ? input : File.dirname(input)
+              filename = input[-1] == '/' ? '' : File.basename(input)
+
+              (Dir.entries(directory).select do |fp|
+                fp.start_with?(filename)
+              end - (input[-1] == '.' ? [] : ['.', '..'])).map do |fp|
+                File.join(directory, fp).gsub(/\A\.\//, '')
+              end
+            end
+            Reline.completion_append_character = ''
           else
-            Readline.completion_proc = proc { |*| nil }
-            Readline.completion_append_character = ' '
+            Reline.completion_proc = proc {}
+            Reline.completion_append_character = ' '
           end
 
           # because Readline is a C library, CLI::UI's hooks into $stdout don't
@@ -393,7 +390,7 @@ module CLI
           prompt += CLI::UI::Color::YELLOW.code if CLI::UI::OS.current.use_color_prompt?
 
           begin
-            line = Readline.readline(prompt, true)
+            line = Reline.readline(prompt, true)
             print(CLI::UI::Color::RESET.code)
             line.to_s.chomp
           rescue Interrupt

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

@@ -1,4 +1,5 @@
 # typed: true
+# frozen_string_literal: true
 
 module CLI
   module UI