tty-prompt 0.18.1 → 0.23.0

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
@@ -230,6 +257,7 @@ module TTY
       # @api public
       def default(value = (not_set = true))
         return @default if not_set
+
         @default = value
       end
 
@@ -250,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
       #
@@ -266,6 +295,22 @@ 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
@@ -285,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
       #
@@ -309,6 +356,7 @@ module TTY
           @in = Converters.convert(:range, @in)
         end
         return @in if not_set
+
         @in = Converters.convert(:range, value)
       end
 
@@ -321,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

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

@@ -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 %s"
 
       # Initailize a Slider
       #
@@ -27,20 +23,37 @@ 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 }
-        @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
       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]
@@ -48,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
@@ -83,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
@@ -108,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
 
@@ -120,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
@@ -131,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)
@@ -147,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
@@ -162,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
@@ -180,11 +270,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] * (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