tty-prompt 0.19.0 → 0.23.1

data/lib/tty/prompt/evaluator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'result'
+require_relative "result"
 
 module TTY
   class Prompt
@@ -23,7 +23,7 @@ module TTY
       def check(proc = nil, &block)
         results << (proc || block)
       end
-      alias_method :<<, :check
+      alias << check
     end # Evaluator
   end # Prompt
 end # TTY

data/lib/tty/prompt/expander.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'choices'
+require_relative "choices"
 
 module TTY
   class Prompt
@@ -10,21 +10,25 @@ module TTY
     # @api private
     class Expander
       HELP_CHOICE = {
-        key: 'h',
-        name: 'print help',
+        key: "h",
+        name: "print help",
         value: :help
       }.freeze
 
+      # Names for delete keys
+      DELETE_KEYS = %i[backspace delete].freeze
+
       # Create instance of Expander
       #
       # @api public
       def initialize(prompt, options = {})
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
-        @default      = options.fetch(:default) { 1 }
-        @auto_hint    = options.fetch(:auto_hint) { false }
+        @default      = options.fetch(:default, 1)
+        @auto_hint    = options.fetch(:auto_hint, false)
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
         @choices      = Choices.new
         @selected     = nil
         @done         = false
@@ -56,16 +60,16 @@ module TTY
 
         selected = select_choice(@input)
 
-        if selected && selected.key.to_s == 'h'
+        if selected && selected.key.to_s == "h"
           expand
           @selected = nil
-          @input = ''
+          @input = ""
         elsif selected
           @done = true
           @selected = selected
           @hint = nil
         else
-          @input = ''
+          @input = ""
         end
       end
       alias keyreturn keyenter
@@ -74,7 +78,7 @@ module TTY
       #
       # @api public
       def keypress(event)
-        if [:backspace, :delete].include?(event.key.name)
+        if DELETE_KEYS.include?(event.key.name)
           @input.chop! unless @input.empty?
         elsif event.value =~ /^[^\e\n\r]/
           @input += event.value
@@ -100,9 +104,17 @@ module TTY
       # @api public
       def default(value = (not_set = true))
         return @default if not_set
+
         @default = value
       end
 
+      # Set quiet mode.
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -154,19 +166,19 @@ module TTY
         elsif @input.to_s.empty? && default_key
           keys[@default - 1] = @prompt.decorate(default_key, @active_color)
         end
-        keys.join(',')
+        keys.join(",")
       end
 
       # @api private
       def render
-        @input = ''
+        @input = ""
         until @done
           question = render_question
           @prompt.print(question)
           read_input
           @prompt.print(refresh(question.lines.count))
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       end
 
@@ -199,7 +211,7 @@ module TTY
       #
       # @api private
       def render_hint
-        "\n" + @prompt.decorate('>> ', @active_color) +
+        "\n" + @prompt.decorate(">> ", @active_color) +
           @hint +
           @prompt.cursor.prev_line +
           @prompt.cursor.forward(@prompt.strip(render_header).size)
@@ -274,7 +286,7 @@ module TTY
           if @selected && @selected.key == choice.key
             chosen = @prompt.decorate(chosen, @active_color)
           end
-          output << '  ' + chosen + "\n"
+          output << "  " + chosen + "\n"
         end
         output.join
       end
@@ -294,7 +306,7 @@ module TTY
           if choice.key.length != 1
             errors << "Choice key `#{choice.key}` is more than one character long."
           end
-          if choice.key.to_s == 'h'
+          if choice.key.to_s == "h"
             errors << "Choice key `#{choice.key}` is reserved for help menu."
           end
           if keys.include?(choice.key)

data/lib/tty/prompt/keypress.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'timer'
+require_relative "question"
+require_relative "timer"
 
 module TTY
   class Prompt
@@ -20,7 +20,7 @@ module TTY
         @interval = options.fetch(:interval) {
           (@timeout != UndefinedSetting && @timeout < 1) ? @timeout : 1
         }
-        @decimals = (@interval.to_s.split('.')[1] || []).size
+        @decimals = (@interval.to_s.split(".")[1] || []).size
         @countdown = @timeout
         time = timeout? ? Float(@timeout) : nil
         @timer = Timer.new(time, Float(@interval))
@@ -30,6 +30,7 @@ module TTY
 
       def countdown(value = (not_set = true))
         return @countdown if not_set
+
         @countdown = value
       end
 
@@ -81,6 +82,7 @@ module TTY
 
         @timer.while_remaining do |remaining|
           break if @done
+
           @input = @prompt.read_keypress(nonblock: true)
         end
         countdown(0) unless @done

data/lib/tty/prompt/list.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'English'
+require "English"
 
-require_relative 'choices'
-require_relative 'paginator'
-require_relative 'block_paginator'
+require_relative "choices"
+require_relative "paginator"
+require_relative "block_paginator"
 
 module TTY
   class Prompt
@@ -13,11 +13,12 @@ module TTY
     #
     # @api private
     class List
-      HELP = '(Use %s arrow%s keys, press Enter to select%s)'
-
       # Allowed keys for filter, along with backspace and canc.
       FILTER_KEYS_MATCHER = /\A([[:alnum:]]|[[:punct:]])\Z/.freeze
 
+      # Checks type of default parameter to be integer
+      INTEGER_MATCHER = /\A\d+\Z/.freeze
+
       # Create instance of TTY::Prompt::List menu.
       #
       # @param Hash options
@@ -45,9 +46,11 @@ module TTY
         @cycle        = options.fetch(:cycle) { false }
         @filterable   = options.fetch(:filter) { false }
         @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
         @filter       = []
         @filter_cache = {}
         @help         = options[:help]
+        @show_help    = options.fetch(:show_help) { :start }
         @first_render = true
         @done         = false
         @per_page     = options[:per_page]
@@ -65,6 +68,7 @@ module TTY
       # @api public
       def symbols(new_symbols = (not_set = true))
         return @symbols if not_set
+
         @symbols.merge!(new_symbols)
       end
 
@@ -135,6 +139,15 @@ module TTY
         @help = (@help.nil? && !not_set) ? value : default_help
       end
 
+      # Change when help is displayed
+      #
+      # @api public
+      def show_help(value = (not_set = true))
+        return @show_ehlp if not_set
+
+        @show_help = value
+      end
+
       # Information about arrow keys
       #
       # @return [String]
@@ -145,25 +158,27 @@ module TTY
         left_right = @symbols[:arrow_left] + "/" + @symbols[:arrow_right]
 
         arrows = [up_down]
-        arrows << " and " if paginated?
+        arrows << "/" if paginated?
         arrows << left_right if paginated?
         arrows.join
       end
 
       # Default help text
       #
-      # @api public
+      # Note that enumeration and filter are mutually exclusive
+      #
+      # @a public
       def default_help
-        # Note that enumeration and filter are mutually exclusive
-        tokens = if enumerate?
-                   [" or number (1-#{choices.size})", '']
-                 elsif filterable?
-                   ['', ', and letter keys to filter']
-                 else
-                   ['', '']
-                 end
-
-        format(self.class::HELP, arrows_help, *tokens)
+        str = []
+        str << "(Press "
+        str << "#{arrows_help} arrow"
+        str << " or 1-#{choices.size} number" if enumerate?
+        str << " to move"
+        str << (filterable? ? "," : " and")
+        str << " Enter to select"
+        str << " and letters to filter" if filterable?
+        str << ")"
+        str.join
       end
 
       # Set selecting active index using number pad
@@ -173,6 +188,13 @@ module TTY
         @enum = value
       end
 
+      # Set whether selected answers are echoed
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -198,9 +220,8 @@ module TTY
             @choices
           else
             filter_value = @filter.join.downcase
-            @filter_cache[filter_value] ||= @choices.select do |choice|
-              !choice.disabled? &&
-                choice.name.downcase.include?(filter_value)
+            @filter_cache[filter_value] ||= @choices.enabled.select do |choice|
+              choice.name.to_s.downcase.include?(filter_value)
             end
           end
         else
@@ -238,6 +259,7 @@ module TTY
         value = event.value.to_i
         return unless (1..choices.count).cover?(value)
         return if choices[value - 1].disabled?
+
         @active = value
       end
 
@@ -291,17 +313,19 @@ module TTY
       # When the choice on a page is outside of next page range then
       # adjust it to the last item, otherwise leave unchanged.
       def keyright(*)
-        if (@active + page_size) <= @choices.size
-          searchable = ((@active + page_size)..choices.length)
+        choices_size = choices.size
+        if (@active + page_size) <= choices_size
+          searchable = ((@active + page_size)..choices_size)
           @active = search_choice_in(searchable)
-        elsif @active <= @choices.size # last page shorter
+        elsif @active <= choices_size # last page shorter
           current   = @active % page_size
-          remaining = @choices.size % page_size
+          remaining = choices_size % page_size
+
           if current.zero? || (remaining > 0 && current > remaining)
-            searchable = @choices.size.downto(0).to_a
+            searchable = choices_size.downto(0).to_a
             @active = search_choice_in(searchable)
           elsif @cycle
-            searchable = ((current.zero? ? page_size : current)..choices.length)
+            searchable = ((current.zero? ? page_size : current)..choices_size)
             @active = search_choice_in(searchable)
           end
         end
@@ -313,10 +337,10 @@ module TTY
 
       def keyleft(*)
         if (@active - page_size) > 0
-          searchable = ((@active - page_size)..choices.length)
+          searchable = ((@active - page_size)..choices.size)
           @active = search_choice_in(searchable)
         elsif @cycle
-          searchable = @choices.size.downto(1).to_a
+          searchable = choices.size.downto(1).to_a
           @active = search_choice_in(searchable)
         end
         @paging_changed = !@by_page
@@ -358,14 +382,19 @@ module TTY
 
       # Setup default option and active selection
       #
+      # @return [Integer]
+      #
       # @api private
       def setup_defaults
         validate_defaults
 
-        if !@default.empty?
+        if @default.empty?
+          # no default, pick the first non-disabled choice
+          @active = choices.index { |choice| !choice.disabled? } + 1
+        elsif @default.first.to_s =~ INTEGER_MATCHER
           @active = @default.first
-        else
-          @active = @choices.index { |choice| !choice.disabled? } + 1
+        elsif default_choice = choices.find_by(:name, @default.first)
+          @active = choices.index(default_choice) + 1
         end
       end
 
@@ -380,16 +409,35 @@ module TTY
         @default.each do |d|
           msg = if d.nil? || d.to_s.empty?
                   "default index must be an integer in range (1 - #{choices.size})"
+                elsif d.to_s !~ INTEGER_MATCHER
+                  validate_default_name(d)
                 elsif d < 1 || d > choices.size
                   "default index `#{d}` out of range (1 - #{choices.size})"
-                elsif choices[d - 1] && choices[d - 1].disabled?
-                  "default index `#{d}` matches disabled choice item"
+                elsif (dflt_choice = choices[d - 1]) && dflt_choice.disabled?
+                  "default index `#{d}` matches disabled choice"
                 end
 
           raise(ConfigurationError, msg) if msg
         end
       end
 
+      # Validate default choice name
+      #
+      # @param [String] name
+      #   the name to verify
+      #
+      # @return [String]
+      #
+      # @api private
+      def validate_default_name(name)
+        default_choice = choices.find_by(:name, name.to_s)
+        if default_choice.nil?
+          "no choice found for the default name: #{name.inspect}"
+        elsif default_choice.disabled?
+          "default name #{name.inspect} matches disabled choice"
+        end
+      end
+
       # Render a selection list.
       #
       # By default the result is printed out.
@@ -411,7 +459,7 @@ module TTY
 
           @prompt.print(refresh(question_lines_count(question_lines)))
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       ensure
         @prompt.print(@prompt.show)
@@ -478,6 +526,20 @@ module TTY
         "(Filter: #{@filter.join.inspect})"
       end
 
+      # Check if help is shown only on start
+      #
+      # @api private
+      def help_start?
+        @show_help =~ /start/i
+      end
+
+      # Check if help is always displayed
+      #
+      # @api private
+      def help_always?
+        @show_help =~ /always/i
+      end
+
       # Render initial help and selected choice
       #
       # @return [String]
@@ -487,7 +549,8 @@ module TTY
         if @done
           selected_item = choices[@active - 1].name
           @prompt.decorate(selected_item.to_s, @active_color)
-        elsif @first_render
+        elsif (@first_render && (help_start? || help_always?)) ||
+              (help_always? && !@filter.any?)
           @prompt.decorate(help, @help_color)
         elsif filterable? && @filter.any?
           @prompt.decorate(filter_help, @help_color)
@@ -504,7 +567,7 @@ module TTY
 
         sync_paginators if @paging_changed
         paginator.paginate(choices, @active, @per_page) do |choice, index|
-          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
+          num = enumerate? ? (index + 1).to_s + @enum + " " : ""
           message = if index + 1 == @active && !choice.disabled?
                       selected = "#{@symbols[:marker]} #{num}#{choice.name}"
                       @prompt.decorate(selected.to_s, @active_color)
@@ -515,7 +578,7 @@ module TTY
                       "  #{num}#{choice.name}"
                     end
           end_index = paginated? ? paginator.end_index : choices.size - 1
-          newline = (index == end_index) ? '' : "\n"
+          newline = (index == end_index) ? "" : "\n"
           output << (message + newline)
         end