tty-prompt 0.18.1 → 0.23.0

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,20 +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 }
+        @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
@@ -55,15 +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
@@ -72,11 +78,12 @@ 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
         end
+
         @selected = select_choice(@input)
         if @selected && !@default_key && collapsed?
           @hint = @selected.name
@@ -97,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
@@ -151,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
 
@@ -196,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)
@@ -208,6 +223,7 @@ module TTY
       #
       # @api private
       def render_question
+        load_auto_hint if @auto_hint
         header = render_header
         header << render_hint if @hint
         header << "\n" if @done
@@ -219,6 +235,20 @@ module TTY
         header
       end
 
+      def load_auto_hint
+        if @hint.nil? && collapsed?
+          if @selected
+            @hint = @selected.name
+          else
+            if @input.empty?
+              @hint = @choices[@default - 1].name
+            else
+              @hint = "invalid option"
+            end
+          end
+        end
+      end
+
       def render_footer
         "  Choice [#{@choices[@default - 1].key}]: #{@input}"
       end
@@ -235,7 +265,7 @@ module TTY
       #
       # @api private
       def refresh(lines)
-        if @hint && (!@selected || @done)
+        if (@hint && (!@selected || @done)) || (@auto_hint && collapsed?)
           @hint = nil
           @prompt.clear_lines(lines, :down) +
             @prompt.cursor.prev_line
@@ -256,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
@@ -276,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,8 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'symbols'
-require_relative 'timeout'
+require_relative "question"
+require_relative "timer"
 
 module TTY
   class Prompt
@@ -13,7 +12,7 @@ module TTY
       # @param [Hash] options
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         super
         @echo    = options.fetch(:echo) { false }
         @keys    = options.fetch(:keys) { UndefinedSetting }
@@ -21,24 +20,17 @@ module TTY
         @interval = options.fetch(:interval) {
           (@timeout != UndefinedSetting && @timeout < 1) ? @timeout : 1
         }
+        @decimals = (@interval.to_s.split(".")[1] || []).size
         @countdown = @timeout
-        @interval_handler = proc { |time|
-          unless @done
-            question = render_question
-            line_size = question.size
-            total_lines = @prompt.count_screen_lines(line_size)
-            @prompt.print(refresh(question.lines.count, total_lines))
-            countdown(time)
-            @prompt.print(render_question)
-          end
-        }
-        @scheduler = Timeout.new(interval_handler: @interval_handler)
+        time = timeout? ? Float(@timeout) : nil
+        @timer = Timer.new(time, Float(@interval))
 
         @prompt.subscribe(self)
       end
 
       def countdown(value = (not_set = true))
         return @countdown if not_set
+
         @countdown = value
       end
 
@@ -55,10 +47,8 @@ module TTY
       def keypress(event)
         if any_key?
           @done = true
-          @scheduler.cancel
         elsif @keys.is_a?(Array) && @keys.include?(event.key.name)
           @done = true
-          @scheduler.cancel
         else
           @done = false
         end
@@ -66,36 +56,43 @@ module TTY
 
       def render_question
         header = super
-        header.gsub!(/:countdown/, countdown.to_s)
+        if timeout?
+          header.gsub!(/:countdown/, format("%.#{@decimals}f", countdown))
+        end
         header
       end
 
+      def interval_handler(time)
+        return if @done
+
+        question = render_question
+        line_size = question.size
+        total_lines = @prompt.count_screen_lines(line_size)
+        @prompt.print(refresh(question.lines.count, total_lines))
+        countdown(time)
+        @prompt.print(render_question)
+      end
+
       def process_input(question)
-        time do
-          @prompt.print(render_question)
-          until @done
-            @input = @prompt.read_keypress
-          end
+        @prompt.print(render_question)
+
+        @timer.on_tick do |time|
+          interval_handler(time)
+        end
+
+        @timer.while_remaining do |remaining|
+          break if @done
+
+          @input = @prompt.read_keypress(nonblock: true)
         end
+        countdown(0) unless @done
+
         @evaluator.(@input)
       end
 
       def refresh(lines, lines_to_clear)
         @prompt.clear_lines(lines)
       end
-
-      # Wait for keypress or timeout
-      #
-      # @api private
-      def time(&job)
-        if timeout?
-          time = Float(@timeout)
-          interval = Float(@interval)
-          @scheduler.timeout(time, interval, &job)
-        else
-          job.()
-        end
-      end
     end # Keypress
   end # Prompt
 end # TTY

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 'symbols'
+require_relative "choices"
+require_relative "paginator"
+require_relative "block_paginator"
 
 module TTY
   class Prompt
@@ -13,15 +13,12 @@ module TTY
     #
     # @api private
     class List
-      include Symbols
-
-      HELP = '(Use arrow%s keys, press Enter to select%s)'
-
-      PAGE_HELP = '(Move up or down to reveal more choices)'
-
       # 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
@@ -36,7 +33,7 @@ module TTY
       #   the delimiter for the item index
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         check_options_consistency(options)
 
         @prompt       = prompt
@@ -46,23 +43,33 @@ module TTY
         @choices      = Choices.new
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
-        @marker       = options.fetch(:marker) { symbols[:pointer] }
         @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]
-        @page_help    = options[:page_help] || PAGE_HELP
         @paginator    = Paginator.new
+        @block_paginator = BlockPaginator.new
+        @by_page      = false
+        @paging_changed = false
       end
 
-      # Set marker
+      # Change symbols used by this prompt
+      #
+      # @param [Hash] new_symbols
+      #   the new symbols to use
       #
       # @api public
-      def marker(value)
-        @marker = value
+      def symbols(new_symbols = (not_set = true))
+        return @symbols if not_set
+
+        @symbols.merge!(new_symbols)
       end
 
       # Set default option selected
@@ -72,6 +79,32 @@ module TTY
         @default = default_values
       end
 
+      # Select paginator based on the current navigation key
+      #
+      # @return [Paginator]
+      #
+      # @api private
+      def paginator
+        @by_page ? @block_paginator : @paginator
+      end
+
+      # Synchronize paginators start positions
+      #
+      # @api private
+      def sync_paginators
+        if @by_page
+          if @paginator.start_index
+            @block_paginator.reset!
+            @block_paginator.start_index = @paginator.start_index
+          end
+        else
+          if @block_paginator.start_index
+            @paginator.reset!
+            @paginator.start_index = @block_paginator.start_index
+          end
+        end
+      end
+
       # Set number of items per page
       #
       # @api public
@@ -92,13 +125,6 @@ module TTY
         choices.size > page_size
       end
 
-      # @param [String] text
-      #   the help text to display per page
-      # @api pbulic
-      def page_help(text)
-        @page_help = text
-      end
-
       # Provide help information
       #
       # @param [String] value
@@ -113,20 +139,46 @@ module TTY
         @help = (@help.nil? && !not_set) ? value : default_help
       end
 
-      # Default help text
+      # Change when help is displayed
       #
       # @api 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
+      def show_help(value = (not_set = true))
+        return @show_ehlp if not_set
+
+        @show_help = value
+      end
+
+      # Information about arrow keys
+      #
+      # @return [String]
+      #
+      # @api private
+      def arrows_help
+        up_down = @symbols[:arrow_up] + "/" + @symbols[:arrow_down]
+        left_right = @symbols[:arrow_left] + "/" + @symbols[:arrow_right]
 
-        format(self.class::HELP, *tokens)
+        arrows = [up_down]
+        arrows << "/" if paginated?
+        arrows << left_right if paginated?
+        arrows.join
+      end
+
+      # Default help text
+      #
+      # Note that enumeration and filter are mutually exclusive
+      #
+      # @a public
+      def default_help
+        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
@@ -136,10 +188,18 @@ 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
       def choice(*value, &block)
+        @filter_cache = {}
         if block
           @choices << (value << block)
         else
@@ -159,12 +219,13 @@ module TTY
           if !filterable? || @filter.empty?
             @choices
           else
-            @choices.select do |choice|
-              !choice.disabled? &&
-                choice.name.downcase.include?(@filter.join.downcase)
+            filter_value = @filter.join.downcase
+            @filter_cache[filter_value] ||= @choices.enabled.select do |choice|
+              choice.name.to_s.downcase.include?(filter_value)
             end
           end
         else
+          @filter_cache = {}
           values.each { |val| @choices << val }
         end
       end
@@ -198,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
 
@@ -223,6 +285,9 @@ module TTY
 
           @active = prev_active if prev_active
         end
+
+        @paging_changed = @by_page
+        @by_page = false
       end
 
       def keydown(*)
@@ -237,9 +302,52 @@ module TTY
 
           @active = next_active if next_active
         end
+        @paging_changed = @by_page
+        @by_page = false
       end
       alias keytab keydown
 
+      # Moves all choices page by page keeping the current selected item
+      # at the same level on each page.
+      #
+      # When the choice on a page is outside of next page range then
+      # adjust it to the last item, otherwise leave unchanged.
+      def keyright(*)
+        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
+          current   = @active % page_size
+          remaining = choices_size % page_size
+
+          if current.zero? || (remaining > 0 && current > remaining)
+            searchable = choices_size.downto(0).to_a
+            @active = search_choice_in(searchable)
+          elsif @cycle
+            searchable = ((current.zero? ? page_size : current)..choices_size)
+            @active = search_choice_in(searchable)
+          end
+        end
+
+        @paging_changed = !@by_page
+        @by_page = true
+      end
+      alias keypage_down keyright
+
+      def keyleft(*)
+        if (@active - page_size) > 0
+          searchable = ((@active - page_size)..choices.size)
+          @active = search_choice_in(searchable)
+        elsif @cycle
+          searchable = choices.size.downto(1).to_a
+          @active = search_choice_in(searchable)
+        end
+        @paging_changed = !@by_page
+        @by_page = true
+      end
+      alias keypage_up keyleft
+
       def keypress(event)
         return unless filterable?
 
@@ -274,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
 
@@ -296,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.
@@ -327,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)
@@ -372,7 +504,6 @@ module TTY
         @first_render = false
         unless @done
           header << render_menu
-          header << render_footer
         end
         header.join
       end
@@ -395,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]
@@ -404,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)
@@ -419,36 +565,25 @@ module TTY
       def render_menu
         output = []
 
-        @paginator.paginate(choices, @active, @per_page) do |choice, index|
-          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
+        sync_paginators if @paging_changed
+        paginator.paginate(choices, @active, @per_page) do |choice, index|
+          num = enumerate? ? (index + 1).to_s + @enum + " " : ""
           message = if index + 1 == @active && !choice.disabled?
-                      selected = "#{@marker} #{num}#{choice.name}"
+                      selected = "#{@symbols[:marker]} #{num}#{choice.name}"
                       @prompt.decorate(selected.to_s, @active_color)
                     elsif choice.disabled?
-                      @prompt.decorate(symbols[:cross], :red) +
+                      @prompt.decorate(@symbols[:cross], :red) +
                         " #{num}#{choice.name} #{choice.disabled}"
                     else
                       "  #{num}#{choice.name}"
                     end
-          max_index = paginated? ? @paginator.max_index : choices.size - 1
-          newline = (index == max_index) ? '' : "\n"
+          end_index = paginated? ? paginator.end_index : choices.size - 1
+          newline = (index == end_index) ? "" : "\n"
           output << (message + newline)
         end
 
         output.join
       end
-
-      # Render page info footer
-      #
-      # @return [String]
-      #
-      # @api private
-      def render_footer
-        return '' unless paginated?
-
-        colored_footer = @prompt.decorate(@page_help, @help_color)
-        "\n" + colored_footer
-      end
     end # List
   end # Prompt
 end # TTY