tty-prompt 0.18.1 → 0.19.0

data/lib/tty/prompt/expander.rb

@@ -22,6 +22,7 @@ module TTY
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @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 }
         @choices      = Choices.new
@@ -62,6 +63,7 @@ module TTY
         elsif selected
           @done = true
           @selected = selected
+          @hint = nil
         else
           @input = ''
         end
@@ -77,6 +79,7 @@ module TTY
         elsif event.value =~ /^[^\e\n\r]/
           @input += event.value
         end
+
         @selected = select_choice(@input)
         if @selected && !@default_key && collapsed?
           @hint = @selected.name
@@ -208,6 +211,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 +223,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 +253,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

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 '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,18 +20,10 @@ 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
@@ -55,10 +46,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 +55,42 @@ 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

@@ -4,7 +4,7 @@ require 'English'
 
 require_relative 'choices'
 require_relative 'paginator'
-require_relative 'symbols'
+require_relative 'block_paginator'
 
 module TTY
   class Prompt
@@ -13,11 +13,7 @@ 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)'
+      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
@@ -36,7 +32,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 +42,30 @@ 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, {}))
         @filter       = []
+        @filter_cache = {}
         @help         = options[:help]
         @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 +75,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 +121,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,6 +135,21 @@ module TTY
         @help = (@help.nil? && !not_set) ? value : default_help
       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]
+
+        arrows = [up_down]
+        arrows << " and " if paginated?
+        arrows << left_right if paginated?
+        arrows.join
+      end
+
       # Default help text
       #
       # @api public
@@ -126,7 +163,7 @@ module TTY
                    ['', '']
                  end
 
-        format(self.class::HELP, *tokens)
+        format(self.class::HELP, arrows_help, *tokens)
       end
 
       # Set selecting active index using number pad
@@ -140,6 +177,7 @@ module TTY
       #
       # @api public
       def choice(*value, &block)
+        @filter_cache = {}
         if block
           @choices << (value << block)
         else
@@ -159,12 +197,14 @@ module TTY
           if !filterable? || @filter.empty?
             @choices
           else
-            @choices.select do |choice|
+            filter_value = @filter.join.downcase
+            @filter_cache[filter_value] ||= @choices.select do |choice|
               !choice.disabled? &&
-                choice.name.downcase.include?(@filter.join.downcase)
+                choice.name.downcase.include?(filter_value)
             end
           end
         else
+          @filter_cache = {}
           values.each { |val| @choices << val }
         end
       end
@@ -223,6 +263,9 @@ module TTY
 
           @active = prev_active if prev_active
         end
+
+        @paging_changed = @by_page
+        @by_page = false
       end
 
       def keydown(*)
@@ -237,9 +280,50 @@ 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(*)
+        if (@active + page_size) <= @choices.size
+          searchable = ((@active + page_size)..choices.length)
+          @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.length)
+            @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.length)
+          @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?
 
@@ -372,7 +456,6 @@ module TTY
         @first_render = false
         unless @done
           header << render_menu
-          header << render_footer
         end
         header.join
       end
@@ -419,36 +502,25 @@ module TTY
       def render_menu
         output = []
 
-        @paginator.paginate(choices, @active, @per_page) do |choice, index|
+        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

data/lib/tty/prompt/mask_question.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'question'
-require_relative 'symbols'
 
 module TTY
   class Prompt
@@ -12,9 +11,9 @@ module TTY
       # @option options [String] :mask
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         super
-        @mask        = options.fetch(:mask) { Symbols.symbols[:dot] }
+        @mask        = options.fetch(:mask) { @prompt.symbols[:dot] }
         @done_masked = false
         @failure     = false
       end