tty-prompt 0.21.0 → 0.22.0

data/lib/tty/prompt/enum_list.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'English'
+require "English"
 
-require_relative 'choices'
-require_relative 'block_paginator'
-require_relative 'paginator'
+require_relative "choices"
+require_relative "block_paginator"
+require_relative "paginator"
 
 module TTY
   class Prompt
@@ -13,7 +13,7 @@ module TTY
     #
     # @api private
     class EnumList
-      PAGE_HELP = '(Press tab/right or left to reveal more choices)'
+      PAGE_HELP = "(Press tab/right or left to reveal more choices)"
 
       # Create instance of EnumList menu.
       #
@@ -21,12 +21,13 @@ module TTY
       def initialize(prompt, **options)
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
-        @enum         = options.fetch(:enum) { ')' }
+        @enum         = options.fetch(:enum) { ")" }
         @default      = options.fetch(:default) { -1 }
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color)   { @prompt.help_color }
         @error_color  = options.fetch(:error_color)  { @prompt.error_color }
         @cycle        = options.fetch(:cycle) { false }
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
         @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @input        = nil
         @done         = false
@@ -101,6 +102,13 @@ module TTY
         @enum = value
       end
 
+      # Set quiet mode
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -162,7 +170,7 @@ module TTY
         if choice_in_range && !choice_disabled || @input.empty?
           @done = true
         else
-          @input = ''
+          @input = ""
           @failure = true
         end
       end
@@ -241,7 +249,7 @@ module TTY
       #
       # @api private
       def render
-        @input = ''
+        @input = ""
         until @done
           question = render_question
           @prompt.print(question)
@@ -253,7 +261,7 @@ module TTY
           question_lines = question.split($INPUT_RECORD_SEPARATOR, -1)
           @prompt.print(refresh(question_lines_count(question_lines)))
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       end
 
@@ -308,8 +316,8 @@ module TTY
       #
       # @api private
       def error_message
-        error = 'Please enter a valid number'
-        "\n" + @prompt.decorate('>>', @error_color) + ' ' + error
+        error = "Please enter a valid number"
+        "\n" + @prompt.decorate(">>", @error_color) + " " + error
       end
 
       # Render error message and return cursor to position of input
@@ -332,8 +340,8 @@ module TTY
       #
       # @api private
       def render_header
-        return '' unless @done
-        return '' unless @active
+        return "" unless @done
+        return "" unless @active
         selected_item = @choices[@active - 1].name.to_s
         @prompt.decorate(selected_item, @active_color)
       end
@@ -353,7 +361,7 @@ module TTY
       #
       # @api private
       def page_help_message
-        return '' unless paginated?
+        return "" unless paginated?
         "\n" + @prompt.decorate(@page_help, @help_color)
       end
 
@@ -380,15 +388,15 @@ module TTY
         output = []
 
         @paginator.paginate(@choices, @page_active, @per_page) do |choice, index|
-          num = (index + 1).to_s + @enum + ' '
+          num = (index + 1).to_s + @enum + " "
           selected = num.to_s + choice.name.to_s
           output << if index + 1 == @active && !choice.disabled?
-                      (' ' * 2) + @prompt.decorate(selected, @active_color)
+                      (" " * 2) + @prompt.decorate(selected, @active_color)
                     elsif choice.disabled?
-                      @prompt.decorate(@symbols[:cross], :red) + ' ' +
-                      selected + ' ' + choice.disabled.to_s
+                      @prompt.decorate(@symbols[:cross], :red) + " " +
+                      selected + " " + choice.disabled.to_s
                     else
-                      (' ' * 2) + selected
+                      (" " * 2) + selected
                     end
           output << "\n"
         end

data/lib/tty/prompt/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TTY
+  class Prompt
+    Error = Class.new(StandardError)
+
+    # Raised when wrong parameter is used to configure prompt
+    ConfigurationError = Class.new(Error)
+
+    # Raised when type conversion cannot be performed
+    ConversionError = Class.new(Error)
+
+    # Raised when the passed in validation argument is of wrong type
+    ValidationCoercion = Class.new(Error)
+
+    # Raised when the required argument is not supplied
+    ArgumentRequired = Class.new(Error)
+
+    # Raised when the argument validation fails
+    ArgumentValidation = Class.new(Error)
+
+    # Raised when the argument is not expected
+    InvalidArgument = Class.new(Error)
+
+    # Raised when overriding already defined conversion
+    ConversionAlreadyDefined = Class.new(Error)
+
+    # Raised when conversion type isn't registered
+    UnsupportedConversion = Class.new(Error)
+  end # Prompt
+end # TTY

data/lib/tty/prompt/evaluator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'result'
+require_relative "result"
 
 module TTY
   class Prompt

data/lib/tty/prompt/expander.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'choices'
+require_relative "choices"
 
 module TTY
   class Prompt
@@ -10,8 +10,8 @@ module TTY
     # @api private
     class Expander
       HELP_CHOICE = {
-        key: 'h',
-        name: 'print help',
+        key: "h",
+        name: "print help",
         value: :help
       }.freeze
 
@@ -25,6 +25,7 @@ module TTY
         @auto_hint    = options.fetch(:auto_hint) { false }
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
         @choices      = Choices.new
         @selected     = nil
         @done         = false
@@ -56,16 +57,16 @@ module TTY
 
         selected = select_choice(@input)
 
-        if selected && selected.key.to_s == 'h'
+        if selected && selected.key.to_s == "h"
           expand
           @selected = nil
-          @input = ''
+          @input = ""
         elsif selected
           @done = true
           @selected = selected
           @hint = nil
         else
-          @input = ''
+          @input = ""
         end
       end
       alias keyreturn keyenter
@@ -103,6 +104,13 @@ module TTY
         @default = value
       end
 
+      # Set quiet mode.
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -154,19 +162,19 @@ module TTY
         elsif @input.to_s.empty? && default_key
           keys[@default - 1] = @prompt.decorate(default_key, @active_color)
         end
-        keys.join(',')
+        keys.join(",")
       end
 
       # @api private
       def render
-        @input = ''
+        @input = ""
         until @done
           question = render_question
           @prompt.print(question)
           read_input
           @prompt.print(refresh(question.lines.count))
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       end
 
@@ -199,7 +207,7 @@ module TTY
       #
       # @api private
       def render_hint
-        "\n" + @prompt.decorate('>> ', @active_color) +
+        "\n" + @prompt.decorate(">> ", @active_color) +
           @hint +
           @prompt.cursor.prev_line +
           @prompt.cursor.forward(@prompt.strip(render_header).size)
@@ -274,7 +282,7 @@ module TTY
           if @selected && @selected.key == choice.key
             chosen = @prompt.decorate(chosen, @active_color)
           end
-          output << '  ' + chosen + "\n"
+          output << "  " + chosen + "\n"
         end
         output.join
       end
@@ -294,7 +302,7 @@ module TTY
           if choice.key.length != 1
             errors << "Choice key `#{choice.key}` is more than one character long."
           end
-          if choice.key.to_s == 'h'
+          if choice.key.to_s == "h"
             errors << "Choice key `#{choice.key}` is reserved for help menu."
           end
           if keys.include?(choice.key)

data/lib/tty/prompt/keypress.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'timer'
+require_relative "question"
+require_relative "timer"
 
 module TTY
   class Prompt
@@ -20,7 +20,7 @@ module TTY
         @interval = options.fetch(:interval) {
           (@timeout != UndefinedSetting && @timeout < 1) ? @timeout : 1
         }
-        @decimals = (@interval.to_s.split('.')[1] || []).size
+        @decimals = (@interval.to_s.split(".")[1] || []).size
         @countdown = @timeout
         time = timeout? ? Float(@timeout) : nil
         @timer = Timer.new(time, Float(@interval))

data/lib/tty/prompt/list.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'English'
+require "English"
 
-require_relative 'choices'
-require_relative 'paginator'
-require_relative 'block_paginator'
+require_relative "choices"
+require_relative "paginator"
+require_relative "block_paginator"
 
 module TTY
   class Prompt
@@ -13,8 +13,6 @@ module TTY
     #
     # @api private
     class List
-      HELP = '(Use %s arrow%s keys, press Enter to select%s)'
-
       # Allowed keys for filter, along with backspace and canc.
       FILTER_KEYS_MATCHER = /\A([[:alnum:]]|[[:punct:]])\Z/.freeze
 
@@ -45,9 +43,11 @@ module TTY
         @cycle        = options.fetch(:cycle) { false }
         @filterable   = options.fetch(:filter) { false }
         @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
         @filter       = []
         @filter_cache = {}
         @help         = options[:help]
+        @show_help    = options.fetch(:show_help) { :start }
         @first_render = true
         @done         = false
         @per_page     = options[:per_page]
@@ -135,6 +135,15 @@ module TTY
         @help = (@help.nil? && !not_set) ? value : default_help
       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
+
       # Information about arrow keys
       #
       # @return [String]
@@ -145,25 +154,27 @@ module TTY
         left_right = @symbols[:arrow_left] + "/" + @symbols[:arrow_right]
 
         arrows = [up_down]
-        arrows << " and " if paginated?
+        arrows << "/" if paginated?
         arrows << left_right if paginated?
         arrows.join
       end
 
       # Default help text
       #
-      # @api public
+      # Note that enumeration and filter are mutually exclusive
+      #
+      # @a public
       def default_help
-        # Note that enumeration and filter are mutually exclusive
-        tokens = if enumerate?
-                   [" or number (1-#{choices.size})", '']
-                 elsif filterable?
-                   ['', ', and letter keys to filter']
-                 else
-                   ['', '']
-                 end
-
-        format(self.class::HELP, arrows_help, *tokens)
+        str = []
+        str << "(Press "
+        str << "#{arrows_help} arrow"
+        str << " or 1-#{choices.size} number" if enumerate?
+        str << " to move"
+        str << (filterable? ? "," : " and")
+        str << " Enter to select"
+        str << " and letters to filter" if filterable?
+        str << ")"
+        str.join
       end
 
       # Set selecting active index using number pad
@@ -173,6 +184,13 @@ module TTY
         @enum = value
       end
 
+      # Set whether selected answers are echoed
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -198,9 +216,8 @@ module TTY
             @choices
           else
             filter_value = @filter.join.downcase
-            @filter_cache[filter_value] ||= @choices.select do |choice|
-              !choice.disabled? &&
-                choice.name.downcase.include?(filter_value)
+            @filter_cache[filter_value] ||= @choices.enabled.select do |choice|
+              choice.name.to_s.downcase.include?(filter_value)
             end
           end
         else
@@ -411,7 +428,7 @@ module TTY
 
           @prompt.print(refresh(question_lines_count(question_lines)))
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       ensure
         @prompt.print(@prompt.show)
@@ -478,6 +495,20 @@ module TTY
         "(Filter: #{@filter.join.inspect})"
       end
 
+      # 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 initial help and selected choice
       #
       # @return [String]
@@ -487,7 +518,8 @@ module TTY
         if @done
           selected_item = choices[@active - 1].name
           @prompt.decorate(selected_item.to_s, @active_color)
-        elsif @first_render
+        elsif (@first_render && (help_start? || help_always?)) ||
+              (help_always? && !@filter.any?)
           @prompt.decorate(help, @help_color)
         elsif filterable? && @filter.any?
           @prompt.decorate(filter_help, @help_color)
@@ -504,7 +536,7 @@ module TTY
 
         sync_paginators if @paging_changed
         paginator.paginate(choices, @active, @per_page) do |choice, index|
-          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
+          num = enumerate? ? (index + 1).to_s + @enum + " " : ""
           message = if index + 1 == @active && !choice.disabled?
                       selected = "#{@symbols[:marker]} #{num}#{choice.name}"
                       @prompt.decorate(selected.to_s, @active_color)
@@ -515,7 +547,7 @@ module TTY
                       "  #{num}#{choice.name}"
                     end
           end_index = paginated? ? paginator.end_index : choices.size - 1
-          newline = (index == end_index) ? '' : "\n"
+          newline = (index == end_index) ? "" : "\n"
           output << (message + newline)
         end