tty-prompt 0.18.0 → 0.22.0

data/lib/tty/prompt/mask_question.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'symbols'
+require_relative "question"
 
 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
@@ -76,7 +75,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,34 +10,80 @@ module TTY
     #
     # @api private
     class MultiList < List
-      HELP = '(Use arrow%s keys, press Space to select and Enter to finish%s)'.freeze
-
       # 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 = []
-        @help    = options[:help]
-        @default = Array(options[:default])
+        @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
@@ -45,11 +92,14 @@ 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 })
-        @active = @default.last unless @selected.empty?
-        if choices[@active - 1] && choices[@active - 1].disabled?
-          raise ConfigurationError,
-                "active choice '#{choices[@active - 1]}' matches disabled item"
+        default_indexes = @default.map { |d| d - 1 }
+        @selected = SelectedChoices.new(@choices.values_at(*default_indexes),
+                                        default_indexes)
+
+        if !@default.empty?
+          @active = @default.last
+        else
+          @active = @choices.index { |choice| !choice.disabled? } + 1
         end
       end
 
@@ -59,23 +109,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 +186,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 + ' ' + num + choice.name
+                      selected = @prompt.decorate(@symbols[:radio_on], @active_color)
+                      "#{selected} #{num}#{choice.name}"
                     elsif choice.disabled?
-                      @prompt.decorate(symbols[:cross], :red) +
-                        ' ' + num + choice.name + ' ' + choice.disabled.to_s
+                      @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
@@ -55,8 +55,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

data/lib/tty/prompt/question.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'converters'
-require_relative 'evaluator'
-require_relative 'question/modifier'
-require_relative 'question/validation'
-require_relative 'question/checks'
-require_relative 'utils'
+require_relative "converters"
+require_relative "evaluator"
+require_relative "question/modifier"
+require_relative "question/validation"
+require_relative "question/checks"
+require_relative "utils"
 
 module TTY
   # A class responsible for shell prompt interactions.
@@ -34,22 +34,31 @@ module TTY
       # Initialize a Question
       #
       # @api public
-      def initialize(prompt, options = {})
-        @prompt     = prompt
-        @prefix     = options.fetch(:prefix) { @prompt.prefix }
-        @default    = options.fetch(:default) { UndefinedSetting }
-        @required   = options.fetch(:required) { false }
-        @echo       = options.fetch(:echo) { true }
-        @in         = options.fetch(:in) { UndefinedSetting }
-        @modifier   = options.fetch(:modifier) { [] }
-        @validation = options.fetch(:validation) { UndefinedSetting }
-        @convert    = options.fetch(:convert) { UndefinedSetting }
+      def initialize(prompt, **options)
+        # Option deprecation
+        if options[:validation]
+          warn "[DEPRECATION] The `:validation` option is deprecated. Use `:validate` instead."
+          options[:validate] = options[:validation]
+        end
+
+        @prompt       = prompt
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
+        @default      = options.fetch(:default) { UndefinedSetting }
+        @required     = options.fetch(:required) { false }
+        @echo         = options.fetch(:echo) { true }
+        @in           = options.fetch(:in) { UndefinedSetting }
+        @modifier     = options.fetch(:modifier) { [] }
+        @validation   = options.fetch(:validate) { UndefinedSetting }
+        @convert      = options.fetch(:convert) { UndefinedSetting }
         @active_color = options.fetch(:active_color) { @prompt.active_color }
-        @help_color = options.fetch(:help_color) { @prompt.help_color }
-        @error_color = options.fetch(:error_color) { :red }
-        @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
-        @done       = false
-        @input      = nil
+        @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @error_color  = options.fetch(:error_color) { :red }
+        @value        = options.fetch(:value) { UndefinedSetting }
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
+        @messages     = Utils.deep_copy(options.fetch(:messages) { { } })
+        @done         = false
+        @first_render = true
+        @input        = nil
 
         @evaluator = Evaluator.new(self)
 
@@ -58,6 +67,7 @@ module TTY
         @evaluator << CheckRange
         @evaluator << CheckValidation
         @evaluator << CheckModifier
+        @evaluator << CheckConversion
       end
 
       # Stores all the error messages displayed to user
@@ -83,7 +93,7 @@ module TTY
         if template && !template.match(/\%\{/).nil?
           [template % tokens]
         else
-          [template || '']
+          [template || ""]
         end
       end
 
@@ -94,8 +104,7 @@ module TTY
       # @return [self]
       #
       # @api public
-      def call(message, &block)
-        return if Utils.blank?(message)
+      def call(message = "", &block)
         @message = message
         block.call(self) if block
         @prompt.subscribe(self) do
@@ -121,8 +130,8 @@ module TTY
           total_lines = @prompt.count_screen_lines(input_line)
           @prompt.print(refresh(question.lines.count, total_lines))
         end
-        @prompt.print(render_question)
-        convert_result(result.value)
+        @prompt.print(render_question) unless @quiet
+        result.value
       end
 
       # Render question
@@ -131,13 +140,16 @@ module TTY
       #
       # @api private
       def render_question
-        header = ["#{@prefix}#{message} "]
+        header = []
+        if !Utils.blank?(@prefix) || !Utils.blank?(message)
+          header << "#{@prefix}#{message} "
+        end
         if !echo?
           header
         elsif @done
           header << @prompt.decorate(@input.to_s, @active_color)
         elsif default? && !Utils.blank?(@default)
-          header << @prompt.decorate("(#{default})", @help_color) + ' '
+          header << @prompt.decorate("(#{default})", @help_color) + " "
         end
         header << "\n" if @done
         header.join
@@ -158,7 +170,12 @@ module TTY
       #
       # @api private
       def read_input(question)
-        @prompt.read_line(question, echo: echo).chomp
+        options = {echo: echo}
+        if value? && @first_render
+          options[:value] = @value
+          @first_render = false
+        end
+        @prompt.read_line(question, **options).chomp
       end
 
       # Handle error condition
@@ -168,7 +185,7 @@ module TTY
       # @api private
       def render_error(errors)
         errors.reduce([]) do |acc, err|
-          acc << @prompt.decorate('>>', :red) + ' ' + err
+          acc << @prompt.decorate(">>", :red) + " " + err
           acc
         end.join("\n")
       end
@@ -202,8 +219,13 @@ module TTY
       #
       # @api private
       def convert_result(value)
-        if convert? & !Utils.blank?(value)
-          Converters.convert(@convert, value)
+        if convert? && !Utils.blank?(value)
+          case @convert
+          when Proc
+            @convert.call(value)
+          else
+            Converters.convert(@convert, value)
+          end
         else
           value
         end
@@ -212,8 +234,13 @@ module TTY
       # Specify answer conversion
       #
       # @api public
-      def convert(value)
-        @convert = value
+      def convert(value = (not_set = true), message = nil)
+        messages[:convert?] = message if message
+        if not_set
+          @convert
+        else
+          @convert = value
+        end
       end
 
       # Check if conversion is set
@@ -266,6 +293,21 @@ module TTY
         @validation = (value || block)
       end
 
+      # Prepopulate input with custom content
+      #
+      # @api public
+      def value(val)
+        return @value if val.nil?
+        @value = val
+      end
+
+      # Check if custom value is present
+      #
+      # @api private
+      def value?
+        @value != UndefinedSetting
+      end
+
       def validation?
         @validation != UndefinedSetting
       end
@@ -321,6 +363,13 @@ module TTY
         @in != UndefinedSetting
       end
 
+      # Set quiet mode.
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # @api public
       def to_s
         message.to_s