tty-prompt 0.19.0 → 0.23.1

data/lib/tty/prompt/mask_question.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'question'
+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
@@ -27,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
@@ -75,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,8 +10,6 @@ module TTY
     #
     # @api private
     class MultiList < List
-      HELP = '(Use %s arrow%s keys, press Space to select and Enter to finish%s)'
-
       # Create instance of TTY::Prompt::MultiList menu.
       #
       # @param [Prompt] :prompt
@@ -19,12 +18,20 @@ module TTY
       # @api public
       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
@@ -32,19 +39,54 @@ module TTY
         @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
           return if @max && @selected.size >= @max
-          @selected << active_choice
+
+          @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
@@ -53,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
 
@@ -68,37 +121,63 @@ module TTY
       #
       # @api private
       def selected_names
-        @selected.map(&:name).join(', ')
+        @selected.map(&:name).join(", ")
       end
 
-      # Header part showing the maximum number of choices
+      # Header part showing the minimum/maximum number of choices
       #
       # @return [String]
       #
       # @api private
-      def max_help
-        "(max. #{@max}) "
+      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)
-        max_suffix = @max ? max_help : ""
+        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}" : ""
-          max_suffix + selected_names +
-            (@first_render ? " #{instructions}" : help_suffix)
-        elsif @first_render
-          max_suffix + instructions
+        elsif (@first_render && (help_start? || help_always?)) ||
+              (help_always? && !@filter.any? && !@done)
+          minmax_suffix +
+            (print_selected ? "#{selected_names} " : "") +
+            instructions
         elsif filterable? && @filter.any?
-          max_suffix + filter_help
-        elsif @max
-          max_help
+          minmax_suffix +
+            (print_selected ? "#{selected_names} " : "") +
+            @prompt.decorate(filter_help, @help_color)
+        else
+          minmax_suffix + (print_selected ? selected_names : "")
         end
       end
 
@@ -121,9 +200,9 @@ module TTY
 
         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 += ' '
+          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}"
@@ -134,7 +213,7 @@ module TTY
                       "#{@symbols[:radio_off]} #{num}#{choice.name}"
                     end
           end_index = paginated? ? paginator.end_index : choices.size - 1
-          newline = (index == end_index) ? '' : "\n"
+          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

@@ -40,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

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.
@@ -35,23 +35,30 @@ module TTY
       #
       # @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 }
+        # 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 }
-        @value      = options.fetch(:value) { UndefinedSetting }
-        @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
-        @done       = false
+        @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
+        @input        = nil
 
         @evaluator = Evaluator.new(self)
 
@@ -60,6 +67,7 @@ module TTY
         @evaluator << CheckRange
         @evaluator << CheckValidation
         @evaluator << CheckModifier
+        @evaluator << CheckConversion
       end
 
       # Stores all the error messages displayed to user
@@ -85,7 +93,7 @@ module TTY
         if template && !template.match(/\%\{/).nil?
           [template % tokens]
         else
-          [template || '']
+          [template || ""]
         end
       end
 
@@ -96,7 +104,7 @@ module TTY
       # @return [self]
       #
       # @api public
-      def call(message = '', &block)
+      def call(message = "", &block)
         @message = message
         block.call(self) if block
         @prompt.subscribe(self) do
@@ -122,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
@@ -141,7 +149,7 @@ module TTY
         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
@@ -162,12 +170,12 @@ module TTY
       #
       # @api private
       def read_input(question)
-        options = {echo: echo}
+        options = { echo: echo }
         if value? && @first_render
           options[:value] = @value
           @first_render = false
         end
-        @prompt.read_line(question, options).chomp
+        @prompt.read_line(question, **options).chomp
       end
 
       # Handle error condition
@@ -177,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
@@ -211,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
@@ -221,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
@@ -239,6 +257,7 @@ module TTY
       # @api public
       def default(value = (not_set = true))
         return @default if not_set
+
         @default = value
       end
 
@@ -259,9 +278,10 @@ module TTY
       def required(value = (not_set = true), message = nil)
         messages[:required?] = message if message
         return @required if not_set
+
         @required = value
       end
-      alias_method :required?, :required
+      alias required? required
 
       # Set validation rule for an argument
       #
@@ -280,6 +300,7 @@ module TTY
       # @api public
       def value(val)
         return @value if val.nil?
+
         @value = val
       end
 
@@ -309,18 +330,20 @@ module TTY
       # @api public
       def echo(value = nil)
         return @echo if value.nil?
+
         @echo = value
       end
-      alias_method :echo?, :echo
+      alias echo? echo
 
       # Turn raw mode on or off. This enables character-based input.
       #
       # @api public
       def raw(value = nil)
         return @raw if value.nil?
+
         @raw = value
       end
-      alias_method :raw?, :raw
+      alias raw? raw
 
       # Set expected range of values
       #
@@ -333,6 +356,7 @@ module TTY
           @in = Converters.convert(:range, @in)
         end
         return @in if not_set
+
         @in = Converters.convert(:range, value)
       end
 
@@ -345,6 +369,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