tty-prompt 0.19.0 → 0.23.1

data/lib/tty/prompt/question/checks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../const"
+
 module TTY
   class Prompt
     class Question
@@ -40,7 +42,7 @@ module TTY
               (question.in? && question.in.include?(cast(value)))
               [value]
             else
-              tokens = {value: value, in: question.in}
+              tokens = { value: value, in: question.in }
               [value, question.message_for(:range?, tokens)]
             end
           end
@@ -54,7 +56,7 @@ module TTY
                 Validation.new(question.validation).call(value))
               [value]
             else
-              tokens = {valid: question.validation.inspect}
+              tokens = { valid: question.validation.inspect, value: value }
               [value, question.message_for(:valid?, tokens)]
             end
           end
@@ -81,6 +83,22 @@ module TTY
             end
           end
         end
+
+        class CheckConversion
+          def self.call(question, value)
+            if question.convert? && !Utils.blank?(value)
+              result = question.convert_result(value)
+              if result == Const::Undefined
+                tokens = { value: value, type: question.convert }
+                [value, question.message_for(:convert?, tokens)]
+              else
+                [result]
+              end
+            else
+              [value]
+            end
+          end
+        end
       end # Checks
     end # Question
   end # Prompt

data/lib/tty/prompt/question/modifier.rb

@@ -49,6 +49,7 @@ module TTY
         # @api public
         def self.letter_case(mod, value)
           return value unless value.is_a?(String)
+
           case mod
           when :up, :upcase, :uppercase
             value.upcase
@@ -75,15 +76,16 @@ module TTY
         # @api public
         def self.whitespace(mod, value)
           return value unless value.is_a?(String)
+
           case mod
           when :trim, :strip
             value.strip
           when :chomp
             value.chomp
           when :collapse
-            value.gsub(/\s+/, ' ')
+            value.gsub(/\s+/, " ")
           when :remove
-            value.gsub(/\s+/, '')
+            value.gsub(/\s+/, "")
           else
             value
           end

data/lib/tty/prompt/question/validation.rb

@@ -57,11 +57,11 @@ module TTY
         def call(input)
           if pattern.is_a?(String) || pattern.is_a?(Symbol)
             VALIDATORS.key?(pattern.to_sym)
-            !VALIDATORS[pattern.to_sym].match(input).nil?
+            !VALIDATORS[pattern.to_sym].match(input.to_s).nil?
           elsif pattern.is_a?(Regexp)
-            !pattern.match(input).nil?
+            !pattern.match(input.to_s).nil?
           elsif pattern.is_a?(Proc)
-            result = pattern.call(input)
+            result = pattern.call(input.to_s)
             result.nil? ? false : result
           else false
           end

data/lib/tty/prompt/selected_choices.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module TTY
+  class Prompt
+    # @api private
+    class SelectedChoices
+      include Enumerable
+
+      attr_reader :size
+
+      # Create selected choices
+      #
+      # @param [Array<Choice>] selected
+      # @param [Array<Integer>] indexes
+      #
+      # @api public
+      def initialize(selected = [], indexes = [])
+        @selected = selected
+        @indexes = indexes
+        @size = @selected.size
+      end
+
+      # Clear selected choices
+      #
+      # @api public
+      def clear
+        @indexes.clear
+        @selected.clear
+        @size = 0
+      end
+
+      # Iterate over selected choices
+      #
+      # @api public
+      def each(&block)
+        return to_enum unless block_given?
+
+        @selected.each(&block)
+      end
+
+      # Insert choice at index
+      #
+      # @param [Integer] index
+      # @param [Choice] choice
+      #
+      # @api public
+      def insert(index, choice)
+        insert_idx = find_index_by { |i| index < @indexes[i] }
+        insert_idx ||= -1
+        @indexes.insert(insert_idx, index)
+        @selected.insert(insert_idx, choice)
+        @size += 1
+        self
+      end
+
+      # Delete choice at index
+      #
+      # @return [Choice]
+      #   the deleted choice
+      #
+      # @api public
+      def delete_at(index)
+        delete_idx = @indexes.each_index.find { |i| index == @indexes[i] }
+        return nil unless delete_idx
+
+        @indexes.delete_at(delete_idx)
+        choice = @selected.delete_at(delete_idx)
+        @size -= 1
+        choice
+      end
+
+      def find_index_by(&search)
+        (0...@size).bsearch(&search)
+      end
+    end # SelectedChoices
+  end # Prompt
+end # TTY

data/lib/tty/prompt/slider.rb

@@ -7,9 +7,9 @@ module TTY
     #
     # @api public
     class Slider
-      HELP = '(Use arrow keys, press Enter to select)'.freeze
+      HELP = "(Use %s arrow keys, press Enter to select)"
 
-      FORMAT = ':slider %d'.freeze
+      FORMAT = ":slider %s"
 
       # Initailize a Slider
       #
@@ -26,13 +26,17 @@ module TTY
       def initialize(prompt, **options)
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
-        @min          = options.fetch(:min) { 0 }
-        @max          = options.fetch(:max) { 10 }
-        @step         = options.fetch(:step) { 1 }
+        @choices      = Choices.new
+        @min          = options.fetch(:min, 0)
+        @max          = options.fetch(:max, 10)
+        @step         = options.fetch(:step, 1)
         @default      = options[:default]
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @format       = options.fetch(:format) { FORMAT }
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
+        @help         = options[:help]
+        @show_help    = options.fetch(:show_help) { :start }
         @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @first_render = true
         @done         = false
@@ -46,6 +50,7 @@ module TTY
       # @api public
       def symbols(new_symbols = (not_set = true))
         return @symbols if not_set
+
         @symbols.merge!(new_symbols)
       end
 
@@ -56,19 +61,43 @@ module TTY
       # @api private
       def initial
         if @default.nil?
-          range.size / 2
+          # no default - choose the middle option
+          choices.size / 2
+        elsif default_choice = choices.find_by(:name, @default)
+          # found a Choice by name - use it
+          choices.index(default_choice)
         else
-          range.index(@default)
+          # default is the index number
+          @default - 1
         end
       end
 
-      # Range of numbers to render
+      # Default help text
+      #
+      # @api public
+      def default_help
+        arrows = @symbols[:arrow_left] + "/" + @symbols[:arrow_right]
+        sprintf(HELP, arrows)
+      end
+
+      # Set help text
       #
-      # @return [Array[Integer]]
+      # @param [String] text
       #
-      # @apip private
-      def range
-        (@min..@max).step(@step).to_a
+      # @api private
+      def help(text = (not_set = true))
+        return @help if !@help.nil? && not_set
+
+        @help = (@help.nil? && not_set) ? default_help : text
+      end
+
+      # Change when help is displayed
+      #
+      # @api public
+      def show_help(value = (not_set = true))
+        return @show_ehlp if not_set
+
+        @show_help = value
       end
 
       # @api public
@@ -91,19 +120,57 @@ module TTY
         @step = value
       end
 
+      # Add a single choice
+      #
+      # @api public
+      def choice(*value, &block)
+        if block
+          @choices << (value << block)
+        else
+          @choices << value
+        end
+      end
+
+      # Add multiple choices
+      #
+      # @param [Array[Object]] values
+      #   the values to add as choices
+      #
+      # @api public
+      def choices(values = (not_set = true))
+        if not_set
+          @choices
+        else
+          values.each { |val| @choices << val }
+        end
+      end
+
+      # @api public
       def format(value)
         @format = value
       end
 
+      # Set quiet mode.
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Call the slider by passing question
       #
       # @param [String] question
       #   the question to ask
       #
       # @apu public
-      def call(question, &block)
+      def call(question, possibilities = nil, &block)
         @question = question
+        choices(possibilities) if possibilities
         block.call(self) if block
+        # set up a Choices collection for min, max, step
+        # if no possibilities were supplied
+        choices((@min..@max).step(@step).to_a) if @choices.empty?
+
         @active = initial
         @prompt.subscribe(self) do
           render
@@ -116,7 +183,7 @@ module TTY
       alias keydown keyleft
 
       def keyright(*)
-        @active += 1 if (@active + 1) < range.size
+        @active += 1 if (@active + 1) < choices.size
       end
       alias keyup keyright
 
@@ -128,6 +195,20 @@ module TTY
 
       private
 
+      # 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 an interactive range slider.
       #
       # @api private
@@ -139,7 +220,7 @@ module TTY
           @prompt.read_keypress
           refresh(question.lines.count)
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       ensure
         @prompt.print(@prompt.show)
@@ -155,11 +236,11 @@ module TTY
         @prompt.print(@prompt.clear_lines(lines))
       end
 
-      # @return [Integer]
+      # @return [Integer, String]
       #
       # @api private
       def answer
-        range[@active]
+        choices[@active].value
       end
 
       # Render question with the slider
@@ -170,13 +251,14 @@ module TTY
       def render_question
         header = ["#{@prefix}#{@question} "]
         if @done
-          header << @prompt.decorate(answer.to_s, @active_color)
+          header << @prompt.decorate(choices[@active].to_s, @active_color)
           header << "\n"
         else
           header << render_slider
         end
-        if @first_render
-          header << "\n" + @prompt.decorate(HELP, @help_color)
+        if @first_render && (help_start? || help_always?) ||
+            (help_always? && !@done)
+          header << "\n" + @prompt.decorate(help, @help_color)
           @first_render = false
         end
         header.join
@@ -190,9 +272,14 @@ module TTY
       def render_slider
         slider = (@symbols[:line] * @active) +
                  @prompt.decorate(@symbols[:bullet], @active_color) +
-                 (@symbols[:line] * (range.size - @active - 1))
-        value = " #{range[@active]}"
-        @format.gsub(':slider', slider) % [value]
+                 (@symbols[:line] * (choices.size - @active - 1))
+        value = choices[@active].name
+        case @format
+        when Proc
+          @format.call(slider, value)
+        else
+          @format.gsub(":slider", slider) % [value]
+        end
       end
     end # Slider
   end # Prompt

data/lib/tty/prompt/statement.rb

@@ -28,10 +28,10 @@ module TTY
       #   change the message display to color
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, newline: true, color: false)
         @prompt  = prompt
-        @newline = options.fetch(:newline) { true }
-        @color   = options.fetch(:color) { false }
+        @newline = newline
+        @color   = color
       end
 
       # Output the message to the prompt

data/lib/tty/prompt/suggestion.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'distance'
+require_relative "distance"
 
 module TTY
   # A class responsible for terminal prompt interactions.
@@ -11,9 +11,9 @@ module TTY
     class Suggestion
       DEFAULT_INDENT = 8
 
-      SINGLE_TEXT    = 'Did you mean this?'
+      SINGLE_TEXT    = "Did you mean this?"
 
-      PLURAL_TEXT    = 'Did you mean one of these?'
+      PLURAL_TEXT    = "Did you mean one of these?"
 
       # Number of spaces
       #
@@ -33,7 +33,7 @@ module TTY
       # Initialize a Suggestion
       #
       # @api public
-      def initialize(options = {})
+      def initialize(**options)
         @indent      = options.fetch(:indent) { DEFAULT_INDENT }
         @single_text = options.fetch(:single_text) { SINGLE_TEXT }
         @plural_text = options.fetch(:plural_text) { PLURAL_TEXT }
@@ -88,6 +88,7 @@ module TTY
       # @api private
       def evaluate
         return @suggestions if @suggestions.empty?
+
         if @suggestions.one?
           build_single_suggestion
         else
@@ -97,14 +98,14 @@ module TTY
 
       # @api private
       def build_single_suggestion
-        single_text + "\n" + (' ' * indent) + @suggestions.first
+        single_text + "\n" + (" " * indent) + @suggestions.first
       end
 
       # @api private
       def build_multiple_suggestions
         plural_text + "\n" +
         @suggestions.map do |sugest|
-          ' ' * indent + sugest
+          " " * indent + sugest
         end.join("\n")
       end
     end # Suggestion