tty-prompt 0.4.0 → 0.5.0

data/lib/tty/prompt/enum_list.rb

@@ -11,14 +11,17 @@ module TTY
       #
       # @api public
       def initialize(prompt, options = {})
-        @prompt  = prompt
-        @done    = false
-        @failure = false
-        @enum    = options.fetch(:enum) { ')' }
-        @default = options.fetch(:default) { 1 }
-        @active  = @default
-        @choices = Choices.new
-        @color   = options.fetch(:color) { :green }
+        @prompt       = prompt
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
+        @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 }
+        @done         = false
+        @failure      = false
+        @active       = @default
+        @choices      = Choices.new
 
         @prompt.subscribe(self)
       end
@@ -161,7 +164,7 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{@prompt.prefix}#{@question} #{render_header}"
+        header = "#{@prefix}#{@question} #{render_header}"
         @prompt.puts(header)
         return if @done
         @prompt.print(render_menu)
@@ -172,7 +175,7 @@ module TTY
       # @api private
       def render_error
         error = 'Please enter a valid index'
-        @prompt.print("\n" + @prompt.decorate('>>', :red) + ' ' + error)
+        @prompt.print("\n" + @prompt.decorate('>>', @error_color) + ' ' + error)
         @prompt.print(@prompt.cursor.prev_line)
         @prompt.print(@prompt.cursor.forward(render_footer.size))
       end
@@ -186,7 +189,7 @@ module TTY
         return '' unless @done
         return '' unless @active
         selected_item = "#{@choices[@active - 1].name}"
-        @prompt.decorate(selected_item, @color)
+        @prompt.decorate(selected_item, @active_color)
       end
 
       # Render footer for the indexed menu
@@ -209,7 +212,7 @@ module TTY
           num = (index + 1).to_s + @enum + Symbols::SPACE
           selected = Symbols::SPACE * 2 + num + choice.name
           output << if index + 1 == @active
-                      @prompt.decorate("#{selected}", @color)
+                      @prompt.decorate("#{selected}", @active_color)
                     else
                       selected
                     end

data/lib/tty/prompt/expander.rb

@@ -0,0 +1,288 @@
+# encoding: utf-8
+
+require 'tty/prompt/question'
+
+module TTY
+  class Prompt
+    # A class responsible for rendering expanding options
+    # Used by {Prompt} to display key options question.
+    #
+    # @api private
+    class Expander
+      HELP_CHOICE = {
+        key: 'h',
+        name: 'print help',
+        value: :help
+      }
+
+      # Create instance of Expander
+      #
+      # @api public
+      def initialize(prompt, options = {})
+        @prompt       = prompt
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
+        @default      = options.fetch(:default) { 1 }
+        @active_color = options.fetch(:active_color) { @prompt.active_color }
+        @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @choices      = Choices.new
+        @selected     = nil
+        @done         = false
+        @status       = :collapsed
+        @hint         = nil
+        @default_key  = false
+
+        @prompt.subscribe(self)
+      end
+
+      def expanded?
+        @status == :expanded
+      end
+
+      def collapsed?
+        @status == :collapsed
+      end
+
+      def expand
+        @status = :expanded
+      end
+
+      # Respond to submit event
+      #
+      # @api public
+      def keyenter(_)
+        if @input.nil? || @input.empty?
+          @input = @choices[@default - 1].key
+          @default_key = true
+        end
+
+        selected = select_choice(@input)
+
+        if selected && selected.key.to_s == 'h'
+          expand
+          @selected = nil
+          @input = ''
+        elsif selected
+          @done = true
+          @selected = selected
+        else
+          @input = ''
+        end
+      end
+      alias_method :keyreturn, :keyenter
+
+      # Respond to key press event
+      #
+      # @api public
+      def keypress(event)
+        if [:backspace, :delete].include?(event.key.name)
+          @input.chop! unless @input.empty?
+        elsif event.value =~ /^[^\e\n\r]/
+          @input += event.value
+        end
+        @selected = select_choice(@input)
+        if @selected && !@default_key && collapsed?
+          @hint = @selected.name
+        end
+      end
+
+      # Select choice by given key
+      #
+      # @return [Choice]
+      #
+      # @api private
+      def select_choice(key)
+        @choices.find_by(:key, key)
+      end
+
+      # Set default value.
+      #
+      # @api public
+      def default(value = (not_set = true))
+        return @default if not_set
+        @default = value
+      end
+
+      # Add a single choice
+      #
+      # @api public
+      def choice(value, &block)
+        if block
+          @choices << value.update(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)
+        values.each { |val| choice(val) }
+      end
+
+      # Execute this prompt
+      #
+      # @api public
+      def call(message, possibilities, &block)
+        choices(possibilities)
+        @message = message
+        block.call(self) if block
+        setup_defaults
+        choice(HELP_CHOICE)
+        render
+      end
+
+      private
+
+      # Create possible keys with current choice highlighted
+      #
+      # @return [String]
+      #
+      # @api private
+      def possible_keys
+        keys = @choices.pluck(:key)
+        default_key = keys[@default - 1]
+        if @selected
+          index = keys.index(@selected.key)
+          keys[index] = @prompt.decorate(keys[index], @active_color)
+        elsif @input.to_s.empty? && default_key
+          keys[@default - 1] = @prompt.decorate(default_key, @active_color)
+        end
+        keys.join(',')
+      end
+
+      # @api private
+      def render
+        @input = ''
+        until @done
+          render_question
+          read_input
+          refresh
+        end
+        render_question
+        render_answer
+      end
+
+      # @api private
+      def render_answer
+        @selected.value
+      end
+
+      def render_header
+        header = "#{@prefix}#{@message} "
+        if @done
+          selected_item = "#{@selected.name}"
+          header << @prompt.decorate(selected_item, @active_color)
+        elsif collapsed?
+          header << %[(enter "h" for help) ]
+          header << "[#{possible_keys}] "
+          header << @input
+        end
+        header
+      end
+
+      # @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))
+      end
+
+      # @api private
+      def render_question
+        header = render_header
+        @prompt.print(header)
+        render_hint if @hint
+        @prompt.print("\n") if @done
+
+        if !@done && expanded?
+          @prompt.print(render_menu)
+          @prompt.print(render_footer)
+        end
+      end
+
+      def render_footer
+        "  Choice [#{@choices[@default - 1].key}]: #{@input}"
+      end
+
+      def read_input
+        @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
+      #
+      # @api private
+      def refresh
+        lines = count_lines
+        if @hint && (!@selected || @done)
+          @hint = nil
+          @prompt.print(@prompt.clear_lines(lines, :down))
+          @prompt.print(@prompt.cursor.prev_line)
+        elsif expanded?
+          @prompt.print(@prompt.clear_lines(lines))
+        else
+          @prompt.print(@prompt.clear_line)
+        end
+      end
+
+      # Render help menu
+      #
+      # @api private
+      def render_menu
+        output = "\n"
+        @choices.each do |choice|
+          chosen = %(#{choice.key} - #{choice.name})
+          if @selected && @selected.key == choice.key
+            chosen = @prompt.decorate(chosen, @active_color)
+          end
+          output << '  ' + chosen + "\n"
+        end
+        output
+      end
+
+      def setup_defaults
+        validate_choices
+      end
+
+      def validate_choices
+        errors = []
+        keys = []
+        @choices.each do |choice|
+          if choice.key.nil?
+            errors <<  "Choice #{choice.name} is missing a :key attribute"
+            next
+          end
+          if choice.key.length != 1
+            errors << "Choice key `#{choice.key}` is more than one character long."
+          end
+          if choice.key.to_s == 'h'
+            errors << "Choice key `#{choice.key}` is reserved for help menu."
+          end
+          if keys.include?(choice.key)
+            errors << "Choice key `#{choice.key}` is a duplicate."
+          end
+          keys << choice.key if choice.key
+        end
+        errors.each { |err| fail ConfigurationError, err }
+      end
+    end # Expander
+  end # Prompt
+end # TTY

data/lib/tty/prompt/list.rb

@@ -25,15 +25,17 @@ module TTY
       # @api public
       def initialize(prompt, options = {})
         @prompt       = prompt
-        @first_render = true
-        @done         = false
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @enum         = options.fetch(:enum) { nil }
         @default      = Array[options.fetch(:default) { 1 }]
         @active       = @default.first
         @choices      = Choices.new
-        @color        = options.fetch(:color) { :green }
+        @active_color = options.fetch(:active_color) { @prompt.active_color }
+        @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @marker       = options.fetch(:marker) { Symbols::ITEM_SELECTED }
         @help         = options[:help]
+        @first_render = true
+        @done         = false
 
         @prompt.subscribe(self)
       end
@@ -143,6 +145,10 @@ module TTY
       # @api private
       def validate_defaults
         @default.each do |d|
+          if d.nil? || d.to_s.empty?
+            fail ConfigurationError,
+                 "default index must be an integer in range (1 - #{@choices.size})"
+          end
           if d < 1 || d > @choices.size
             fail ConfigurationError,
                  "default index `#{d}` out of range (1 - #{@choices.size})"
@@ -193,7 +199,7 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{@prompt.prefix}#{@question} #{render_header}"
+        header = "#{@prefix}#{@question} #{render_header}"
         @prompt.puts(header)
         @first_render = false
         @prompt.print(render_menu) unless @done
@@ -204,7 +210,7 @@ module TTY
       # @return [String]
       def help
         return @help unless @help.nil?
-        self.class::HELP % [enumerate? ? ' or number (0-9)' : '']
+        self.class::HELP % [enumerate? ? " or number (1-#{@choices.size})" : '']
       end
 
       # Render initial help and selected choice
@@ -215,9 +221,9 @@ module TTY
       def render_header
         if @done
           selected_item = "#{@choices[@active - 1].name}"
-          @prompt.decorate(selected_item, @color)
+          @prompt.decorate(selected_item, @active_color)
         elsif @first_render
-          @prompt.decorate(help, :bright_black)
+          @prompt.decorate(help, @help_color)
         end
       end
 
@@ -230,7 +236,7 @@ module TTY
           num = enumerate? ? (index + 1).to_s + @enum + Symbols::SPACE : ''
           message = if index + 1 == @active
                       selected = @marker + Symbols::SPACE + num + choice.name
-                      @prompt.decorate("#{selected}", @color)
+                      @prompt.decorate("#{selected}", @active_color)
                     else
                       Symbols::SPACE * 2 + num + choice.name
                     end

data/lib/tty/prompt/mask_question.rb

@@ -49,11 +49,11 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{prompt.prefix}#{message} "
+        header = "#{@prefix}#{message} "
         if echo?
           masked = "#{@mask * "#{@input}".length}"
           if @done_masked && !@failure
-            masked = @prompt.decorate(masked, @color)
+            masked = @prompt.decorate(masked, @active_color)
           end
           header += masked
         end

data/lib/tty/prompt/multi_list.rb

@@ -47,16 +47,26 @@ module TTY
         @active = @default.last unless @selected.empty?
       end
 
+      # Generate selected items names
+      #
+      # @return [String]
+      #
+      # @api private
+      def selected_names
+        @selected.map(&:name).join(', ')
+      end
+
       # Render initial help text and then currently selected choices
       #
       # @api private
       def render_header
+        instructions = @prompt.decorate(help, :bright_black)
         if @done
-          @prompt.decorate(@selected.map(&:name).join(', '), :green)
+          @prompt.decorate(selected_names, @active_color)
         elsif @selected.size.nonzero?
-          @selected.map(&:name).join(', ')
+          selected_names + (@first_render ? " #{instructions}" : '')
         elsif @first_render
-          @prompt.decorate(help, :bright_black)
+          instructions
         end
       end
 
@@ -79,7 +89,7 @@ module TTY
           indicator = (index + 1 == @active) ?  @marker : Symbols::SPACE
           indicator += Symbols::SPACE
           message = if @selected.include?(choice)
-                      selected = @prompt.decorate(Symbols::RADIO_CHECKED, :green)
+                      selected = @prompt.decorate(Symbols::RADIO_CHECKED, @active_color)
                       selected + Symbols::SPACE + num + choice.name
                     else
                       Symbols::RADIO_UNCHECKED + Symbols::SPACE + num + choice.name