cli-ui 1.3.0 → 1.4.0

data/lib/cli/ui/os.rb

@@ -0,0 +1,63 @@
+module CLI
+  module UI
+    module OS
+      # Determines which OS is currently running the UI, to make it easier to
+      # adapt its behaviour to the features of the OS.
+      def self.current
+        @current_os ||= case RUBY_PLATFORM
+        when /darwin/
+          Mac
+        when /linux/
+          Linux
+        when /mingw32/
+          Windows
+        else
+          raise "Could not determine OS from platform #{RUBY_PLATFORM}"
+        end
+      end
+
+      class Mac
+        class << self
+          def supports_emoji?
+            true
+          end
+
+          def supports_color_prompt?
+            true
+          end
+
+          def supports_arrow_keys?
+            true
+          end
+
+          def shift_cursor_on_line_reset?
+            false
+          end
+        end
+      end
+
+      class Linux < Mac
+      end
+
+      class Windows
+        class << self
+          def supports_emoji?
+            false
+          end
+
+          def supports_color_prompt?
+            false
+          end
+
+          def supports_arrow_keys?
+            false
+          end
+
+          def shift_cursor_on_line_reset?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cli/ui/printer.rb

@@ -0,0 +1,47 @@
+require 'cli/ui'
+
+module CLI
+  module UI
+    class Printer
+      # 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.
+      #
+      # ==== Attributes
+      #
+      # * +msg+ - (required) the string to output. Can be frozen.
+      #
+      # ==== Options
+      #
+      # * +:frame_color+ - Override the frame color. Defaults to nil.
+      # * +:to+ - Target stream, like $stdout or $stderr. Can be anything with a puts method. Defaults to $stdout.
+      # * +:encoding+ - Force the output to be in a certain encoding. Defaults to UTF-8.
+      # * +:format+ - Whether to format the string using CLI::UI.fmt. Defaults to true.
+      # * +:graceful+ - Whether to gracefully ignore common I/O errors. Defaults to true.
+      #
+      # ==== Returns
+      # Returns whether the message was successfully printed,
+      # which can be useful if +:graceful+ is set to true.
+      #
+      # ==== Example
+      #
+      #   CLI::UI::Printer.puts('{x} Ouch', stream: $stderr, color: :red)
+      #
+      def self.puts(msg, frame_color: nil, to: $stdout, encoding: Encoding::UTF_8, format: true, graceful: true)
+        msg = (+msg).force_encoding(encoding) if encoding
+        msg = CLI::UI.fmt(msg) if format
+
+        if frame_color
+          CLI::UI::Frame.with_frame_color_override(frame_color) { to.puts(msg) }
+        else
+          to.puts(msg)
+        end
+
+        true
+      rescue Errno::EIO, Errno::EPIPE, IOError => e
+        raise(e) unless graceful
+        false
+      end
+    end
+  end
+end

data/lib/cli/ui/progress.rb

@@ -26,11 +26,11 @@ module CLI
       #
       # Increase the percent by X
       #   CLI::UI::Progress.progress do |bar|
-      #     bar.tick(percent: 5)
+      #     bar.tick(percent: 0.05)
       #   end
       def self.progress(width: Terminal.width)
         bar = Progress.new(width: width)
-        print CLI::UI::ANSI.hide_cursor
+        print(CLI::UI::ANSI.hide_cursor)
         yield(bar)
       ensure
         puts bar.to_s
@@ -59,14 +59,16 @@ module CLI
       # * +:percent+ - Increment progress by a specific percent amount
       # * +:set_percent+ - Set progress to a specific percent
       #
+      # *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
         @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 CLI::UI::ANSI.previous_line + "\n"
+        print(to_s)
+        print(CLI::UI::ANSI.previous_line + "\n")
       end
 
       # Format the progress bar to be printed to terminal
@@ -77,11 +79,11 @@ module CLI
         filled = [(@percent_done * workable_width.to_f).ceil, 0].max
         unfilled = [workable_width - filled, 0].max
 
-        CLI::UI.resolve_text [
+        CLI::UI.resolve_text([
           FILLED_BAR + ' ' * filled,
           UNFILLED_BAR + ' ' * unfilled,
-          CLI::UI::Color::RESET.code + suffix
-        ].join
+          CLI::UI::Color::RESET.code + suffix,
+        ].join)
       end
     end
   end

data/lib/cli/ui/prompt.rb

@@ -36,7 +36,8 @@ module CLI
         # * +:select_ui+ - Enable long-form option selection (default: true)
         #
         # Note:
-        # * +:options+ or providing a +Block+ conflicts with +:default+ and +:is_file+, you cannot set options with either of these keywords
+        # * +:options+ or providing a +Block+ conflicts with +:default+ and +:is_file+,
+        #              you cannot set options with either of these keywords
         # * +:default+ conflicts with +:allow_empty:, you cannot set these together
         # * +:options+ conflicts with providing a +Block+ , you may only set one
         # * +:multiple+ can only be used with +:options+ or a +Block+; it is ignored, otherwise.
@@ -49,7 +50,7 @@ module CLI
         # ==== Return Value
         #
         # * If a +Block+ was not provided, the selected option or response to the free form question will be returned
-        # * If a +Block+ was provided, the evaluted value of the +Block+ will be returned
+        # * If a +Block+ was provided, the evaluated value of the +Block+ will be returned
         #
         # ==== Example Usage:
         #
@@ -76,13 +77,35 @@ module CLI
         #     handler.option('python') { |selection| selection }
         #   end
         #
-        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true, multiple: false, filter_ui: true, select_ui: true, &options_proc)
-          if ((options || block_given?) && (default || is_file))
+        def ask(
+          question,
+          options: nil,
+          default: nil,
+          is_file: nil,
+          allow_empty: true,
+          multiple: false,
+          filter_ui: true,
+          select_ui: true,
+          &options_proc
+        )
+          if (options || block_given?) && ((default && !multiple) || is_file)
             raise(ArgumentError, 'conflicting arguments: options provided with default or is_file')
           end
 
+          if options && multiple && default && !(default - options).empty?
+            raise(ArgumentError, 'conflicting arguments: default should only include elements present in options')
+          end
+
           if options || block_given?
-            ask_interactive(question, options, multiple: multiple, filter_ui: filter_ui, select_ui: select_ui, &options_proc)
+            ask_interactive(
+              question,
+              options,
+              multiple: multiple,
+              default: default,
+              filter_ui: filter_ui,
+              select_ui: select_ui,
+              &options_proc
+            )
           else
             ask_free_form(question, default, is_file, allow_empty)
           end
@@ -132,7 +155,9 @@ module CLI
         private
 
         def ask_free_form(question, default, is_file, allow_empty)
-          raise(ArgumentError, 'conflicting arguments: default enabled but allow_empty is false') if (default && !allow_empty)
+          if default && !allow_empty
+            raise(ArgumentError, 'conflicting arguments: default enabled but allow_empty is false')
+          end
 
           if default
             puts_question("#{question} (empty = #{default})")
@@ -155,7 +180,7 @@ module CLI
           end
         end
 
-        def ask_interactive(question, options = nil, multiple: false, filter_ui: true, select_ui: true)
+        def ask_interactive(question, options = nil, multiple: false, default: nil, filter_ui: true, select_ui: true)
           raise(ArgumentError, 'conflicting arguments: options and block given') if options && block_given?
 
           options ||= if block_given?
@@ -165,16 +190,22 @@ module CLI
           end
 
           raise(ArgumentError, 'insufficient options') if options.nil? || options.empty?
-          instructions = (multiple ? "Toggle options. " : "") + "Choose with ↑ ↓ ⏎"
+          navigate_text = if CLI::UI::OS.current.supports_arrow_keys?
+            "Choose with ↑ ↓ ⏎"
+          else
+            "Navigate up with 'k' and down with 'j', press Enter to select"
+          end
+
+          instructions = (multiple ? "Toggle options. " : "") + navigate_text
           instructions += ", filter with 'f'" if filter_ui
-          instructions += ", enter option with 'e'" if select_ui and options.size > 9
+          instructions += ", enter option with 'e'" if select_ui && (options.size > 9)
           puts_question("#{question} {{yellow:(#{instructions})}}")
-          resp = interactive_prompt(options, multiple: multiple)
+          resp = interactive_prompt(options, multiple: multiple, default: default)
 
           # Clear the line
-          print ANSI.previous_line + ANSI.clear_to_end_of_line
+          print(ANSI.previous_line + ANSI.clear_to_end_of_line)
           # Force StdoutRouter to prefix
-          print ANSI.previous_line + "\n"
+          print(ANSI.previous_line + "\n")
 
           # reset the question to include the answer
           resp_text = resp
@@ -195,8 +226,8 @@ module CLI
         end
 
         # Useful for stubbing in tests
-        def interactive_prompt(options, multiple: false)
-          InteractiveOptions.call(options, multiple: multiple)
+        def interactive_prompt(options, multiple: false, default: nil)
+          InteractiveOptions.call(options, multiple: multiple, default: default)
         end
 
         def write_default_over_empty_input(default)
@@ -231,11 +262,14 @@ module CLI
           # thread to manage output, but the current strategy feels like a
           # better tradeoff.
           prefix = CLI::UI.with_frame_color(:blue) { CLI::UI::Frame.prefix }
-          prompt = prefix + CLI::UI.fmt('{{blue:> }}') + CLI::UI::Color::YELLOW.code
+          # If a prompt is interrupted on Windows it locks the colour of the terminal from that point on, so we should
+          # not change the colour here.
+          prompt = prefix + CLI::UI.fmt('{{blue:> }}')
+          prompt += CLI::UI::Color::YELLOW.code if CLI::UI::OS.current.supports_color_prompt?
 
           begin
             line = Readline.readline(prompt, true)
-            print CLI::UI::Color::RESET.code
+            print(CLI::UI::Color::RESET.code)
             line.to_s.chomp
           rescue Interrupt
             CLI::UI.raw { STDERR.puts('^C' + CLI::UI::Color::RESET.code) }

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

@@ -22,8 +22,8 @@ module CLI
         # Ask an interactive question
         #   CLI::UI::Prompt::InteractiveOptions.call(%w(rails go python))
         #
-        def self.call(options, multiple: false)
-          list = new(options, multiple: multiple)
+        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] }
@@ -39,7 +39,7 @@ module CLI
         #
         #   CLI::UI::Prompt::InteractiveOptions.new(%w(rails go python))
         #
-        def initialize(options, multiple: false)
+        def initialize(options, multiple: false, default: nil)
           @options = options
           @active = 1
           @marker = '>'
@@ -52,7 +52,13 @@ module CLI
           @filter = ''
           # 0-indexed array representing if selected
           # @options[0] is selected if @chosen[0]
-          @chosen = Array.new(@options.size) { false } if multiple
+          if multiple
+            @chosen = if default
+              @options.map { |option| default.include?(option) }
+            else
+              Array.new(@options.size) { false }
+            end
+          end
           @redraw = true
           @presented_options = []
         end
@@ -95,16 +101,16 @@ module CLI
           @option_lengths = @options.map do |text|
             width = 1 if text.empty?
             width ||= text
-                        .split("\n")
-                        .reject(&:empty?)
-                        .map { |l| (l.length / max_width).ceil }
-                        .reduce(&:+)
+              .split("\n")
+              .reject(&:empty?)
+              .map { |l| (CLI::UI.fmt(l, enable_color: false).length / max_width).ceil }
+              .reduce(&:+)
 
             width
           end
         end
 
-        def reset_position(number_of_lines=num_lines)
+        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
           CLI::UI.raw do
@@ -112,12 +118,12 @@ module CLI
           end
         end
 
-        def clear_output(number_of_lines=num_lines)
+        def clear_output(number_of_lines = num_lines)
           CLI::UI.raw do
             # Write over all lines with whitespace
             number_of_lines.times { puts(' ' * CLI::UI::Terminal.width) }
           end
-          reset_position number_of_lines
+          reset_position(number_of_lines)
 
           # Update if metadata is being displayed
           # This must be done _after_ the output is cleared or it won't draw over
@@ -128,7 +134,7 @@ module CLI
         # Don't use this in place of +@displaying_metadata+, this updates too
         # quickly to be useful when drawing to the screen.
         def display_metadata?
-          filtering? or selecting? or has_filter?
+          filtering? || selecting? || has_filter?
         end
 
         def num_lines
@@ -136,7 +142,7 @@ module CLI
 
           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? or option_number.zero?
+            next total_length + 1 if option_number.nil? || option_number.zero?
             total_length + @option_lengths[option_number - 1]
           end
 
@@ -153,7 +159,7 @@ module CLI
         CTRL_D = "\u0004"
 
         def up
-          active_index = @filtered_options.index { |_,num| num == @active } || 0
+          active_index = @filtered_options.index { |_, num| num == @active } || 0
 
           previous_visible = @filtered_options[active_index - 1]
           previous_visible ||= @filtered_options.last
@@ -163,7 +169,7 @@ module CLI
         end
 
         def down
-          active_index = @filtered_options.index { |_,num| num == @active } || 0
+          active_index = @filtered_options.index { |_, num| num == @active } || 0
 
           next_visible = @filtered_options[active_index + 1]
           next_visible ||= @filtered_options.first
@@ -216,7 +222,7 @@ module CLI
           @redraw = true
 
           # Control+D or Backspace on empty search closes search
-          if char == CTRL_D or (@filter.empty? and char == BACKSPACE)
+          if (char == CTRL_D) || (@filter.empty? && (char == BACKSPACE))
             @filter = ''
             @state = :root
             return
@@ -231,7 +237,7 @@ module CLI
 
         def select_current
           # Prevent selection of invisible options
-          return unless presented_options.any? { |_,num| num == @active }
+          return unless presented_options.any? { |_, num| num == @active }
           select_n(@active)
         end
 
@@ -240,7 +246,7 @@ module CLI
           wait_for_user_input until @redraw
         end
 
-        # rubocop:disable Style/WhenThen,Layout/SpaceBeforeSemicolon
+        # rubocop:disable Style/WhenThen,Layout/SpaceBeforeSemicolon,Style/Semicolon
         def wait_for_user_input
           char = read_char
           @last_char = char
@@ -250,22 +256,24 @@ module CLI
           when CTRL_C   ; raise Interrupt
           end
 
+          max_digit = [@options.size, 9].min.to_s
           case @state
           when :root
             case char
-            when ESC                       ; @state = :esc
-            when 'k'                       ; up
-            when 'j'                       ; down
-            when 'e', ':', 'G'             ; start_line_select
-            when 'f', '/'                  ; start_filter
-            when ('0'..@options.size.to_s) ; select_n(char.to_i)
-            when 'y', 'n'                  ; select_bool(char)
-            when " ", "\r", "\n"           ; select_current  # <enter>
+            when ESC              ; @state = :esc
+            when 'k'              ; up
+            when 'j'              ; down
+            when 'e', ':', 'G'    ; start_line_select
+            when 'f', '/'         ; start_filter
+            when ('0'..max_digit) ; select_n(char.to_i)
+            when 'y', 'n'         ; select_bool(char)
+            when " ", "\r", "\n"  ; select_current # <enter>
             end
           when :filter
             case char
             when ESC        ; @state = :esc
             when "\r", "\n" ; select_current
+            when "\b"       ; update_search(BACKSPACE) # Happens on Windows
             else            ; update_search(char)
             end
           when :line_select
@@ -273,9 +281,9 @@ module CLI
             when ESC             ; @state = :esc
             when 'k'             ; up   ; @state = :root
             when 'j'             ; down ; @state = :root
-            when 'e',':','G','q' ; stop_line_select
+            when 'e', ':', 'G', 'q' ; stop_line_select
             when '0'..'9'        ; build_selection(char)
-            when BACKSPACE       ; chop_selection  # Pop last input on backspace
+            when BACKSPACE       ; chop_selection # Pop last input on backspace
             when ' ', "\r", "\n" ; select_current
             end
           when :esc
@@ -347,16 +355,27 @@ module CLI
 
           @presented_options = @options.zip(1..Float::INFINITY)
           if has_filter?
-            @presented_options.select! { |option,_| option.downcase.include?(@filter.downcase) }
+            @presented_options.select! { |option, _| option.downcase.include?(@filter.downcase) }
           end
 
           # Used for selection purposes
+          @presented_options.push([DONE, 0]) if @multiple
           @filtered_options = @presented_options.dup
 
-          @presented_options.unshift([DONE, 0]) if @multiple
-
           ensure_visible_is_active if has_filter?
 
+          # Must have more lines before the selection than we can display
+          if distance_from_start_to_selection > max_lines
+            @presented_options.shift(distance_from_start_to_selection - max_lines)
+            ensure_first_item_is_continuation_marker
+          end
+
+          # Must have more lines after the selection than we can display
+          if distance_from_selection_to_end > max_lines
+            @presented_options.pop(distance_from_selection_to_end - max_lines)
+            ensure_last_item_is_continuation_marker
+          end
+
           while num_lines > max_lines
             # try to keep the selection centered in the window:
             if distance_from_selection_to_end > distance_from_start_to_selection
@@ -388,7 +407,7 @@ module CLI
         end
 
         def index_of_active_option
-          @presented_options.index { |_,num| num == @active }.to_i
+          @presented_options.index { |_, num| num == @active }.to_i
         end
 
         def ensure_last_item_is_continuation_marker
@@ -415,14 +434,14 @@ module CLI
           max_num_length = (@options.size + 1).to_s.length
 
           metadata_text = if selecting?
-                            select_text = @active
-                            select_text = '{{info:e, q, or up/down anytime to exit}}' if @active == 0
-                            "Select: #{select_text}"
-                          elsif filtering? or has_filter?
-                            filter_text = @filter
-                            filter_text = '{{info:Ctrl-D anytime or Backspace now to exit}}' if @filter.empty?
-                            "Filter: #{filter_text}"
-                          end
+            select_text = @active
+            select_text = '{{info:e, q, or up/down anytime to exit}}' if @active == 0
+            "Select: #{select_text}"
+          elsif filtering? || has_filter?
+            filter_text = @filter
+            filter_text = '{{info:Ctrl-D anytime or Backspace now to exit}}' if @filter.empty?
+            "Filter: #{filter_text}"
+          end
 
           if metadata_text
             CLI::UI.with_frame_color(:blue) do
@@ -431,7 +450,7 @@ module CLI
           end
 
           options.each do |choice, num|
-            is_chosen = @multiple && num && @chosen[num - 1]
+            is_chosen = @multiple && num && @chosen[num - 1] && num != 0
 
             padding = ' ' * (max_num_length - num.to_s.length)
             message = "  #{num}#{num ? '.' : ' '}#{padding}"
@@ -442,12 +461,12 @@ module CLI
             format = "{{cyan:#{format}}}" if @multiple && is_chosen && num != @active
             format = " #{format}"
 
-            message += sprintf(format, CHECKBOX_ICON[is_chosen]) if @multiple && num && num > 0
+            message += format(format, CHECKBOX_ICON[is_chosen]) if @multiple && num && num > 0
             message += format_choice(format, choice)
 
             if num == @active
 
-              color = (filtering? or selecting?) ? 'green' : 'blue'
+              color = filtering? || selecting? ? 'green' : 'blue'
               message = message.split("\n").map { |l| "{{#{color}:> #{l.strip}}}" }.join("\n")
             end
 
@@ -463,7 +482,7 @@ module CLI
 
           return eol if lines.empty? # Handle blank options
 
-          lines.map! { |l| sprintf(format, l) + eol }
+          lines.map! { |l| format(format, l) + eol }
           lines.join("\n")
         end
       end