tty-prompt 0.18.0 → 0.22.0

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../const"
+
 module TTY
   class Prompt
     class Question
@@ -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/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,76 @@
+# 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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'symbols'
-
 module TTY
   # A class responsible for shell prompt interactions.
   class Prompt
@@ -9,11 +7,9 @@ module TTY
     #
     # @api public
     class Slider
-      include Symbols
-
-      HELP = '(Use arrow keys, press Enter to select)'.freeze
+      HELP = "(Use %s arrow keys, press Enter to select)"
 
-      FORMAT = ':slider %d'.freeze
+      FORMAT = ":slider %d"
 
       # Initailize a Slider
       #
@@ -27,7 +23,7 @@ module TTY
       # @option options [String] :format The display format
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @min          = options.fetch(:min) { 0 }
@@ -37,10 +33,26 @@ module TTY
         @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
       end
 
+      # Change symbols used by this prompt
+      #
+      # @param [Hash] new_symbols
+      #   the new symbols to use
+      #
+      # @api public
+      def symbols(new_symbols = (not_set = true))
+        return @symbols if not_set
+
+        @symbols.merge!(new_symbols)
+      end
+
       # Setup initial active position
       #
       # @return [Integer]
@@ -54,11 +66,39 @@ module TTY
         end
       end
 
+      # Default help text
+      #
+      # @api public
+      def default_help
+        arrows = @symbols[:arrow_left] + "/" + @symbols[:arrow_right]
+        sprintf(HELP, arrows)
+      end
+
+      # Set help text
+      #
+      # @param [String] text
+      #
+      # @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
+
       # Range of numbers to render
       #
       # @return [Array[Integer]]
       #
-      # @apip private
+      # @api private
       def range
         (@min..@max).step(@step).to_a
       end
@@ -87,6 +127,13 @@ module TTY
         @format = value
       end
 
+      # Set quiet mode.
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Call the slider by passing question
       #
       # @param [String] question
@@ -120,6 +167,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
@@ -131,7 +192,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)
@@ -167,8 +228,9 @@ module TTY
         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
@@ -180,11 +242,16 @@ module TTY
       #
       # @api private
       def render_slider
-        slider = (symbols[:line] * @active) +
-                 @prompt.decorate(symbols[:handle], @active_color) +
-                 (symbols[:line] * (range.size - @active - 1))
-        value = " #{range[@active]}"
-        @format.gsub(':slider', slider) % [value]
+        slider = (@symbols[:line] * @active) +
+                 @prompt.decorate(@symbols[:bullet], @active_color) +
+                 (@symbols[:line] * (range.size - @active - 1))
+        value = range[@active]
+        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 }
@@ -97,14 +97,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

data/lib/tty/prompt/symbols.rb

@@ -7,43 +7,67 @@ module TTY
     # @api public
     module Symbols
       KEYS = {
-        tick: '✓',
-        cross: '✘',
-        star: '★',
-        square: '◼',
-        square_empty: '◻',
-        dot: '•',
-        pointer: '‣',
-        line: '─',
-        pipe: '|',
-        handle: 'O',
-        ellipsis: '…',
-        radio_on: '⬢',
-        radio_off: '⬡',
-        checkbox_on: '☒',
-        checkbox_off: '☐',
-        circle_on: 'ⓧ',
-        circle_off: 'Ⓘ'
+        tick: "✓",
+        cross: "✘",
+        star: "★",
+        square: "◼",
+        square_empty: "◻",
+        dot: "•",
+        bullet: "●",
+        bullet_empty: "○",
+        marker: "‣",
+        line: "─",
+        pipe: "|",
+        ellipsis: "…",
+        radio_on: "⬢",
+        radio_off: "⬡",
+        checkbox_on: "☒",
+        checkbox_off: "☐",
+        circle: "◯",
+        circle_on: "ⓧ",
+        circle_off: "Ⓘ",
+        arrow_up: "↑",
+        arrow_down: "↓",
+        arrow_up_down: "↕",
+        arrow_left: "←",
+        arrow_right: "→",
+        arrow_left_right: "↔",
+        heart: "♥",
+        diamond: "♦",
+        club: "♣",
+        spade: "♠"
       }.freeze
 
       WIN_KEYS = {
-        tick: '√',
-        cross: 'x',
-        star: '*',
-        square: '[█]',
-        square_empty: '[ ]',
-        dot: '.',
-        pointer: '>',
-        line: '-',
-        pipe: '|',
-        handle: 'O',
-        ellipsis: '...',
-        radio_on: '(*)',
-        radio_off: '( )',
-        checkbox_on: '[×]',
-        checkbox_off: '[ ]',
-        circle_on: '(x)',
-        circle_off: '( )'
+        tick: "√",
+        cross: "x",
+        star: "*",
+        square: "[█]",
+        square_empty: "[ ]",
+        dot: ".",
+        bullet: "O",
+        bullet_empty: "○",
+        marker: ">",
+        line: "-",
+        pipe: "|",
+        ellipsis: "...",
+        radio_on: "(*)",
+        radio_off: "( )",
+        checkbox_on: "[×]",
+        checkbox_off: "[ ]",
+        circle: "( )",
+        circle_on: "(x)",
+        circle_off: "( )",
+        arrow_up: "↑",
+        arrow_down: "↓",
+        arrow_up_down: "↕",
+        arrow_left: "←",
+        arrow_right: "→",
+        arrow_left_right: "↔",
+        heart: "♥",
+        diamond: "♦",
+        club: "♣",
+        spade: "♠"
       }.freeze
 
       def symbols