tty-prompt 0.18.1 → 0.23.0

data/lib/tty/prompt/mask_question.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'symbols'
+require_relative "question"
 
 module TTY
   class Prompt
     class MaskQuestion < Question
+      # Names for delete keys
+      DELETE_KEYS = %i[backspace delete].freeze
+
       # Create masked question
       #
       # @param [Hash] options
       # @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
@@ -28,19 +30,20 @@ module TTY
       # @api public
       def mask(char = (not_set = true))
         return @mask if not_set
+
         @mask = char
       end
 
-      def keyreturn(event)
+      def keyreturn(_event)
         @done_masked = true
       end
 
-      def keyenter(event)
+      def keyenter(_event)
         @done_masked = true
       end
 
       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
@@ -76,7 +79,7 @@ module TTY
       def read_input(question)
         @done_masked = false
         @failure = false
-        @input = ''
+        @input = ""
         @prompt.print(question)
         until @done_masked
           @prompt.read_keypress

data/lib/tty/prompt/multi_list.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'list'
+require_relative "list"
+require_relative "selected_choices"
 
 module TTY
   class Prompt
@@ -9,33 +10,83 @@ module TTY
     #
     # @api private
     class MultiList < List
-      HELP = '(Use arrow%s keys, press Space to select and Enter to finish%s)'
-
       # Create instance of TTY::Prompt::MultiList menu.
       #
       # @param [Prompt] :prompt
       # @param [Hash] options
       #
       # @api public
-      def initialize(prompt, options)
+      def initialize(prompt, **options)
         super
-        @selected = []
+        @selected = SelectedChoices.new
         @help = options[:help]
         @echo = options.fetch(:echo, true)
+        @min  = options[:min]
+        @max  = options[:max]
+      end
+
+      # Set a minimum number of choices
+      #
+      # @api public
+      def min(value)
+        @min = value
       end
 
+      # Set a maximum number of choices
+      #
+      # @api public
+      def max(value)
+        @max = value
+      end
+
+      # Callback fired when enter/return key is pressed
+      #
+      # @api private
+      def keyenter(*)
+        valid = true
+        valid = @min <= @selected.size if @min
+        valid = @selected.size <= @max if @max
+
+        super if valid
+      end
+      alias keyreturn keyenter
+
       # Callback fired when space key is pressed
       #
       # @api private
       def keyspace(*)
         active_choice = choices[@active - 1]
         if @selected.include?(active_choice)
-          @selected.delete(active_choice)
+          @selected.delete_at(@active - 1)
         else
-          @selected << active_choice
+          return if @max && @selected.size >= @max
+
+          @selected.insert(@active - 1, active_choice)
         end
       end
 
+      # Selects all choices when Ctrl+A is pressed
+      #
+      # @api private
+      def keyctrl_a(*)
+        return if @max && @max < choices.size
+
+        @selected = SelectedChoices.new(choices.enabled, choices.enabled_indexes)
+      end
+
+      # Revert currently selected choices when Ctrl+I is pressed
+      #
+      # @api private
+      def keyctrl_r(*)
+        return if @max && @max < choices.size
+
+        indexes = choices.each_with_index.reduce([]) do |acc, (choice, idx)|
+                    acc << idx if !choice.disabled? && !@selected.include?(choice)
+                    acc
+                  end
+        @selected = SelectedChoices.new(choices.enabled - @selected.to_a, indexes)
+      end
+
       private
 
       # Setup default options and active selection
@@ -44,12 +95,23 @@ module TTY
       def setup_defaults
         validate_defaults
         # At this stage, @choices matches all the visible choices.
-        @selected = @choices.values_at(*@default.map { |d| d - 1 })
+        default_indexes = @default.map do |d|
+          if d.to_s =~ INTEGER_MATCHER
+            d - 1
+          else
+            choices.index(choices.find_by(:name, d.to_s))
+          end
+        end
+        @selected = SelectedChoices.new(@choices.values_at(*default_indexes),
+                                        default_indexes)
 
-        if !@default.empty?
+        if @default.empty?
+          # no default, pick the first non-disabled choice
+          @active = choices.index { |choice| !choice.disabled? } + 1
+        elsif @default.last.to_s =~ INTEGER_MATCHER
           @active = @default.last
-        else
-          @active = @choices.index { |choice| !choice.disabled? } + 1
+        elsif default_choice = choices.find_by(:name, @default.last.to_s)
+          @active = choices.index(default_choice) + 1
         end
       end
 
@@ -59,23 +121,63 @@ module TTY
       #
       # @api private
       def selected_names
-        @selected.map(&:name).join(', ')
+        @selected.map(&:name).join(", ")
+      end
+
+      # Header part showing the minimum/maximum number of choices
+      #
+      # @return [String]
+      #
+      # @api private
+      def minmax_help
+        help = []
+        help << "min. #{@min}" if @min
+        help << "max. #{@max}" if @max
+        "(%s) " % [help.join(", ")]
+      end
+
+      # Build a default help text
+      #
+      # @return [String]
+      #
+      # @api private
+      def default_help
+        str = []
+        str << "(Press "
+        str << "#{arrows_help} arrow"
+        str << " or 1-#{choices.size} number" if enumerate?
+        str << " to move, Space"
+        str << "/Ctrl+A|R" if @max.nil?
+        str << " to select"
+        str << " (all|rev)" if @max.nil?
+        str << (filterable? ? "," : " and")
+        str << " Enter to finish"
+        str << " and letters to filter" if filterable?
+        str << ")"
+        str.join
       end
 
       # Render initial help text and then currently selected choices
       #
       # @api private
       def render_header
-        instructions = @prompt.decorate(help, :bright_black)
+        instructions = @prompt.decorate(help, @help_color)
+        minmax_suffix = @min || @max ? minmax_help : ""
+        print_selected = @selected.size.nonzero? && @echo
+
         if @done && @echo
           @prompt.decorate(selected_names, @active_color)
-        elsif @selected.size.nonzero? && @echo
-          help_suffix = filterable? && @filter.any? ? " #{filter_help}" : ""
-          selected_names + (@first_render ? " #{instructions}" : help_suffix)
-        elsif @first_render
-          instructions
+        elsif (@first_render && (help_start? || help_always?)) ||
+              (help_always? && !@filter.any? && !@done)
+          minmax_suffix +
+            (print_selected ? "#{selected_names} " : "") +
+            instructions
         elsif filterable? && @filter.any?
-          filter_help
+          minmax_suffix +
+            (print_selected ? "#{selected_names} " : "") +
+            @prompt.decorate(filter_help, @help_color)
+        else
+          minmax_suffix + (print_selected ? selected_names : "")
         end
       end
 
@@ -96,21 +198,22 @@ module TTY
       def render_menu
         output = []
 
-        @paginator.paginate(choices, @active, @per_page) do |choice, index|
-          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
-          indicator = (index + 1 == @active) ?  @marker : ' '
-          indicator += ' '
+        sync_paginators if @paging_changed
+        paginator.paginate(choices, @active, @per_page) do |choice, index|
+          num = enumerate? ? (index + 1).to_s + @enum + " " : ""
+          indicator = (index + 1 == @active) ?  @symbols[:marker] : " "
+          indicator += " "
           message = if @selected.include?(choice) && !choice.disabled?
-                      selected = @prompt.decorate(symbols[:radio_on], @active_color)
+                      selected = @prompt.decorate(@symbols[:radio_on], @active_color)
                       "#{selected} #{num}#{choice.name}"
                     elsif choice.disabled?
-                      @prompt.decorate(symbols[:cross], :red) +
+                      @prompt.decorate(@symbols[:cross], :red) +
                         " #{num}#{choice.name} #{choice.disabled}"
                     else
-                      "#{symbols[:radio_off]} #{num}#{choice.name}"
+                      "#{@symbols[:radio_off]} #{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 << indicator + message + newline
         end
 

data/lib/tty/prompt/multiline.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'symbols'
+require_relative "question"
+require_relative "symbols"
 
 module TTY
   class Prompt
@@ -9,9 +9,9 @@ module TTY
     #
     # @api private
     class Multiline < Question
-      HELP = '(Press CTRL-D or CTRL-Z to finish)'.freeze
+      HELP = "(Press Ctrl+D or Ctrl+Z to finish)".freeze
 
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         super
         @help         = options[:help] || self.class::HELP
         @first_render = true
@@ -25,6 +25,7 @@ module TTY
       # @api public
       def help(value = (not_set = true))
         return @help if not_set
+
         @help = value
       end
 
@@ -42,7 +43,7 @@ module TTY
         if !echo?
           header
         elsif @done
-          header << @prompt.decorate("#{@input}", @active_color)
+          header << @prompt.decorate(@input.to_s, @active_color)
         elsif @first_render
           header << @prompt.decorate(help, @help_color)
           @first_render = false
@@ -55,8 +56,9 @@ module TTY
         @prompt.print(question)
         @lines = read_input
         @input = "#{@lines.first.strip} ..." unless @lines.first.to_s.empty?
-        if Utils.blank?(@input)
-          @input = default? ? default : nil
+        if Utils.blank?(@input) && default?
+          @input = default
+          @lines = default
         end
         @evaluator.(@lines)
       end

data/lib/tty/prompt/paginator.rb

@@ -5,23 +5,33 @@ module TTY
     class Paginator
       DEFAULT_PAGE_SIZE = 6
 
+      # The 0-based index of the first item on this page
+      attr_accessor :start_index
+
+      # The 0-based index of the last item on this page
+      attr_reader :end_index
+
+      # The 0-based index of the active item on this page
+      attr_reader :current_index
+
+      # The 0-based index of the previously active item on this page
+      attr_reader :last_index
+
       # Create a Paginator
       #
       # @api private
-      def initialize(options = {})
+      def initialize(**options)
         @last_index  = Array(options[:default]).flatten.first || 0
         @per_page    = options[:per_page]
-        @lower_index = Array(options[:default]).flatten.first
+        @start_index = Array(options[:default]).flatten.first
       end
 
-      # Maximum index for current pagination
+      # Reset current page indexes
       #
-      # @return [Integer]
-      #
-      # @api public
-      def max_index
-        raise ArgumentError, 'no max index' unless @per_page
-        @lower_index + @per_page - 1
+      # @api private
+      def reset!
+        @start_index = nil
+        @end_index   = nil
       end
 
       # Check if page size is valid
@@ -30,7 +40,7 @@ module TTY
       #
       # @api private
       def check_page_size!
-        raise InvalidArgument, 'per_page must be > 0' if @per_page < 1
+        raise InvalidArgument, "per_page must be > 0" if @per_page < 1
       end
 
       # Paginate collection given an active index
@@ -43,21 +53,21 @@ module TTY
       #   number of choice items per page
       #
       # @return [Enumerable]
+      #   the list between start and end index
       #
       # @api public
       def paginate(list, active, per_page = nil, &block)
         current_index = active - 1
         default_size = (list.size <= DEFAULT_PAGE_SIZE ? list.size : DEFAULT_PAGE_SIZE)
         @per_page = @per_page || per_page || default_size
-        @lower_index ||= current_index
-        @upper_index ||= max_index
-
         check_page_size!
+        @start_index ||= (current_index / @per_page) * @per_page
+        @end_index ||= @start_index + @per_page - 1
 
         # Don't paginate short lists
         if list.size <= @per_page
-          @lower_index = 0
-          @upper_index = list.size - 1
+          @start_index = 0
+          @end_index = list.size - 1
           if block
             return list.each_with_index(&block)
           else
@@ -65,33 +75,35 @@ module TTY
           end
         end
 
+        step = (current_index - @last_index).abs
         if current_index > @last_index # going up
-          if current_index > @upper_index && current_index < list.size - 1
-            @lower_index += 1
+          if current_index >= @end_index && current_index < list.size - 1
+            last_page = list.size - @per_page
+            @start_index = [@start_index + step, last_page].min
           end
         elsif current_index < @last_index # going down
-          if current_index < @lower_index && current_index > 0
-            @lower_index -= 1
+          if current_index <= @start_index && current_index > 0
+            @start_index = [@start_index - step, 0].max
           end
         end
 
         # Cycle list
         if current_index.zero?
-          @lower_index = 0
+          @start_index = 0
         elsif current_index == list.size - 1
-          @lower_index = list.size - 1 - (@per_page - 1)
+          @start_index = list.size - 1 - (@per_page - 1)
         end
 
-        @upper_index = @lower_index + (@per_page - 1)
+        @end_index = @start_index + (@per_page - 1)
         @last_index = current_index
 
-        sliced_list = list[@lower_index..@upper_index]
-        indices = (@lower_index..@upper_index)
+        sliced_list = list[@start_index..@end_index]
+        page_range = (@start_index..@end_index)
 
-        return sliced_list.zip(indices).to_enum unless block_given?
+        return sliced_list.zip(page_range).to_enum unless block_given?
 
         sliced_list.each_with_index do |item, index|
-          block[item, @lower_index + index]
+          block[item, @start_index + index]
         end
       end
     end # Paginator