tty-prompt 0.11.0 → 0.12.0

data/lib/tty/prompt/enum_list.rb

@@ -197,12 +197,17 @@ module TTY
       def render
         @input = ''
         until @done
-          lines = render_question
+          question = render_question
+          @prompt.print(question)
+          @prompt.print(render_error) if @failure
+          if paginated? && !@done
+            @prompt.print(render_page_help)
+          end
           @prompt.read_keypress
-          refresh(lines)
+          @prompt.print(refresh(question.lines.count))
         end
-        render_question
-        render_answer
+        @prompt.print(render_question)
+        answer
       end
 
       # Find value for the choice selected
@@ -210,7 +215,7 @@ module TTY
       # @return [nil, Object]
       #
       # @api private
-      def render_answer
+      def answer
         @choices[@active - 1].value
       end
 
@@ -219,27 +224,26 @@ module TTY
       # @param [Integer] lines
       #   the lines to clear
       #
+      # @return [String]
+      #
       # @api private
       def refresh(lines)
-        @prompt.print(@prompt.clear_lines(lines))
-        @prompt.print(@prompt.cursor.clear_screen_down)
+        @prompt.clear_lines(lines) +
+          @prompt.cursor.clear_screen_down
       end
 
       # Render question with the menu options
       #
+      # @return [String]
+      #
       # @api private
       def render_question
-        header = "#{@prefix}#{@question} #{render_header}"
-        @prompt.puts(header)
-        lines = header.lines.count
+        header = "#{@prefix}#{@question} #{render_header}\n"
         unless @done
-          menu = render_menu + render_footer
-          lines += menu.lines.count
-          @prompt.print(menu)
+          header << render_menu
+          header << render_footer
         end
-        render_error if @failure
-        render_page_help if paginated? && !@done
-        lines
+        header
       end
 
       # Error message when incorrect index chosen
@@ -252,13 +256,16 @@ module TTY
 
       # Render error message and return cursor to position of input
       #
+      # @return [String]
+      #
       # @api private
       def render_error
-        @prompt.print(error_message)
+        error = error_message.dup
         if !paginated?
-          @prompt.print(@prompt.cursor.prev_line)
-          @prompt.print(@prompt.cursor.forward(render_footer.size))
+          error << @prompt.cursor.prev_line
+          error << @prompt.cursor.forward(render_footer.size)
         end
+        error
       end
 
       # Render chosen option
@@ -294,14 +301,16 @@ module TTY
 
       # Render page help
       #
+      # @return [String]
+      #
       # @api private
       def render_page_help
-        @prompt.print(page_help_message)
+        help = page_help_message.dup
         if @failure
-          @prompt.print(@prompt.cursor.prev_line)
+          help << @prompt.cursor.prev_line
         end
-        @prompt.print(@prompt.cursor.prev_line)
-        @prompt.print(@prompt.cursor.forward(render_footer.size))
+        help << @prompt.cursor.prev_line
+        help << @prompt.cursor.forward(render_footer.size)
       end
 
       # Render menu with indexed choices to select from

data/lib/tty/prompt/expander.rb

@@ -158,19 +158,25 @@ module TTY
       def render
         @input = ''
         until @done
-          render_question
+          question = render_question
+          @prompt.print(question)
           read_input
-          refresh
+          @prompt.print(refresh(question.lines.count))
         end
-        render_question
-        render_answer
+        @prompt.print(render_question)
+        answer
       end
 
       # @api private
-      def render_answer
+      def answer
         @selected.value
       end
 
+      # Render message with options
+      #
+      # @return [String]
+      #
+      # @api private
       def render_header
         header = "#{@prefix}#{@message} "
         if @done
@@ -184,27 +190,34 @@ module TTY
         header
       end
 
+      # Show hint for selected option key
+      #
+      # return [String]
+      #
       # @api private
       def render_hint
         hint = "\n"
         hint << @prompt.decorate('>> ', @active_color)
         hint << @hint
-        @prompt.print(hint)
-        @prompt.print(@prompt.cursor.prev_line)
-        @prompt.print(@prompt.cursor.forward(@prompt.strip(render_header).size))
+        hint << @prompt.cursor.prev_line
+        hint << @prompt.cursor.forward(@prompt.strip(render_header).size)
       end
 
+      # Render question with menu
+      #
+      # @return [String]
+      #
       # @api private
       def render_question
         header = render_header
-        @prompt.print(header)
-        render_hint if @hint
-        @prompt.print("\n") if @done
+        header << render_hint if @hint
+        header << "\n" if @done
 
         if !@done && expanded?
-          @prompt.print(render_menu)
-          @prompt.print(render_footer)
+          header << render_menu
+          header << render_footer
         end
+        header
       end
 
       def render_footer
@@ -215,31 +228,22 @@ module TTY
         @prompt.read_keypress
       end
 
-      # @api private
-      def count_lines
-        lines = render_header.scan("\n").length + 1
-        if @hint
-          lines += @hint.scan("\n").length + 1
-        elsif expanded?
-          lines += @choices.length
-          lines += render_footer.scan("\n").length + 1
-        end
-        lines
-      end
-
       # Refresh the current input
       #
+      # @param [Integer] lines
+      #
+      # @return [String]
+      #
       # @api private
-      def refresh
-        lines = count_lines
+      def refresh(lines)
         if @hint && (!@selected || @done)
           @hint = nil
-          @prompt.print(@prompt.clear_lines(lines, :down))
-          @prompt.print(@prompt.cursor.prev_line)
+          @prompt.clear_lines(lines, :down) +
+            @prompt.cursor.prev_line
         elsif expanded?
-          @prompt.print(@prompt.clear_lines(lines))
+          @prompt.clear_lines(lines)
         else
-          @prompt.print(@prompt.clear_line)
+          @prompt.clear_line
         end
       end
 

data/lib/tty/prompt/keypress.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require_relative 'question'
+require_relative 'symbols'
+require_relative 'timeout'
+
+module TTY
+  class Prompt
+    class Keypress < Question
+      # Create keypress question
+      #
+      # @param [Prompt] prompt
+      # @param [Hash] options
+      #
+      # @api public
+      def initialize(prompt, options = {})
+        super
+        @echo    = options.fetch(:echo) { false }
+        @keys    = options.fetch(:keys) { UndefinedSetting }
+        @timeout = options.fetch(:timeout) { UndefinedSetting }
+        @interval = options.fetch(:interval) { 1 }
+        @pause   = true
+        @countdown = @timeout
+        @interval_handler = proc { |time|
+          question = render_question
+          @prompt.print(refresh(question.lines.count))
+          countdown(time)
+          @prompt.print(render_question)
+        }
+
+        @prompt.subscribe(self)
+      end
+
+      def countdown(value = (not_set = true))
+        return @countdown if not_set
+        @countdown = value
+      end
+
+      # Check if any specific keys are set
+      def any_key?
+        @keys == UndefinedSetting
+      end
+
+      # Check if timeout is set
+      def timeout?
+        @timeout != UndefinedSetting
+      end
+
+      def keypress(event)
+        if any_key?
+          @pause = false
+        elsif @keys.is_a?(Array) && @keys.include?(event.key.name)
+          @pause = false
+        else
+          @pause = true
+        end
+      end
+
+      def render_question
+        header = super
+        header.gsub!(/:countdown/, countdown.to_s)
+        header
+      end
+
+      def process_input(question)
+        time do
+          while @pause
+            @input = @prompt.read_keypress
+          end
+        end
+        @evaluator.(@input)
+      end
+
+      def refresh(lines)
+        @prompt.clear_lines(lines)
+      end
+
+      def time(&block)
+        if timeout?
+          secs = Integer(@timeout)
+          interval = Integer(@interval)
+          scheduler = Timeout.new(interval_handler: @interval_handler)
+          scheduler.timeout(secs, interval, &block)
+        else
+          block.()
+        end
+      rescue Timeout::Error
+      end
+    end # Keypress
+  end # Prompt
+end # TTY

data/lib/tty/prompt/list.rb

@@ -92,6 +92,27 @@ module TTY
         @page_help = text
       end
 
+      # Provide help information
+      #
+      # @param [String] value
+      #   the new help text
+      #
+      # @return [String]
+      #
+      # @api public
+      def help(value = (not_set = true))
+        return @help if !@help.nil? && not_set
+
+        @help = (@help.nil? && !not_set) ? value : default_help
+      end
+
+      # Default help text
+      #
+      # @api public
+      def default_help
+        self.class::HELP % [enumerate? ? " or number (1-#{@choices.size})" : '']
+      end
+
       # Set selecting active index using number pad
       #
       # @api public
@@ -117,7 +138,7 @@ module TTY
       #
       # @api public
       def choices(values)
-        values.each { |val| choice(*val) }
+        Array(values).each { |val| choice(*val) }
       end
 
       # Call the list menu by passing question and choices
@@ -202,12 +223,13 @@ module TTY
       def render
         @prompt.print(@prompt.hide)
         until @done
-          lines = render_question
+          question = render_question
+          @prompt.print(question)
           @prompt.read_keypress
-          refresh(lines)
+          @prompt.print(refresh(question.lines.count))
         end
-        render_question
-        render_answer
+        @prompt.print(render_question)
+        answer
       ensure
         @prompt.print(@prompt.show)
       end
@@ -217,42 +239,31 @@ module TTY
       # @return [nil, Object]
       #
       # @api private
-      def render_answer
+      def answer
         @choices[@active - 1].value
       end
 
       # Clear screen lines
       #
-      # @param [Integer] lines
-      #   the lines to clear
+      # @param [String]
       #
       # @api private
       def refresh(lines)
-        @prompt.print(@prompt.clear_lines(lines))
+        @prompt.clear_lines(lines)
       end
 
       # Render question with instructions and menu
       #
-      # @return [Integer] The number of lines for menu
+      # @return [String]
       #
       # @api private
       def render_question
-        header = "#{@prefix}#{@question} #{render_header}"
-        @prompt.puts(header)
+        header = "#{@prefix}#{@question} #{render_header}\n"
         @first_render = false
         rendered_menu = render_menu
         rendered_menu << render_footer
-        @prompt.print(rendered_menu) unless @done
-
-        header.lines.count + rendered_menu.lines.count
-      end
-
-      # Provide help information
-      #
-      # @return [String]
-      def help
-        return @help unless @help.nil?
-        self.class::HELP % [enumerate? ? " or number (1-#{@choices.size})" : '']
+        header << rendered_menu unless @done
+        header
       end
 
       # Render initial help and selected choice
@@ -271,6 +282,8 @@ module TTY
 
       # Render menu with choices to select from
       #
+      # @return [String]
+      #
       # @api private
       def render_menu
         output = ''
@@ -291,6 +304,8 @@ module TTY
 
       # Render page info footer
       #
+      # @return [String]
+      #
       # @api private
       def render_footer
         return '' unless paginated?

data/lib/tty/prompt/mask_question.rb

@@ -62,10 +62,8 @@ module TTY
           end
           header += masked
         end
-        @prompt.print(header)
-        @prompt.puts if @done
-
-        header.lines.count + (@done ? 1 : 0)
+        header << "\n" if @done
+        header
       end
 
       def render_error(errors)
@@ -76,15 +74,14 @@ module TTY
       # Read input from user masked by character
       #
       # @private
-      def read_input
+      def read_input(question)
         @done_masked = false
         @failure = false
         @input = ''
-
         until @done_masked
           @prompt.read_keypress
           @prompt.print(@prompt.clear_line)
-          render_question
+          @prompt.print(render_question)
         end
         @prompt.puts
         @input