tty-prompt 0.3.0 → 0.4.0

data/lib/tty/prompt/multi_list.rb

@@ -9,8 +9,7 @@ module TTY
     #
     # @api private
     class MultiList < List
-
-      HELP = '(Use arrow keys, press Space to select and Enter to finish)'.freeze
+      HELP = '(Use arrow%s keys, press Space to select and Enter to finish)'.freeze
 
       # Create instance of TTY::Prompt::MultiList menu.
       #
@@ -21,14 +20,14 @@ module TTY
       def initialize(prompt, options)
         super
         @selected = []
-        @help     = options.fetch(:help) { HELP }
-        @default  = options.fetch(:default) { [] }
+        @help    = options[:help]
+        @default = options.fetch(:default) { [] }
       end
 
       # Callback fired when space key is pressed
       #
       # @api private
-      def keyspace(event)
+      def keyspace(*)
         active_choice = @choices[@active - 1]
         if @selected.include?(active_choice)
           @selected.delete(active_choice)
@@ -57,9 +56,7 @@ module TTY
         elsif @selected.size.nonzero?
           @selected.map(&:name).join(', ')
         elsif @first_render
-          @prompt.decorate(@help, :bright_black)
-        else
-          ''
+          @prompt.decorate(help, :bright_black)
         end
       end
 
@@ -76,18 +73,21 @@ module TTY
       #
       # @api private
       def render_menu
+        output = ''
         @choices.each_with_index do |choice, index|
+          num = enumerate? ? (index + 1).to_s + @enum + Symbols::SPACE : ''
           indicator = (index + 1 == @active) ?  @marker : Symbols::SPACE
           indicator += Symbols::SPACE
           message = if @selected.include?(choice)
                       selected = @prompt.decorate(Symbols::RADIO_CHECKED, :green)
-                      selected + Symbols::SPACE + choice.name
+                      selected + Symbols::SPACE + num + choice.name
                     else
-                      Symbols::RADIO_UNCHECKED + Symbols::SPACE + choice.name
+                      Symbols::RADIO_UNCHECKED + Symbols::SPACE + num + choice.name
                     end
           newline = (index == @choices.length - 1) ? '' : "\n"
-          @prompt.print(indicator + message + newline)
+          output << indicator + message + newline
         end
+        output
       end
     end # MultiList
   end # Prompt

data/lib/tty/prompt/question.rb

@@ -16,8 +16,6 @@ module TTY
       include Checks
       include Converters
 
-      BLANK_REGEX = /\A[[:space:]]*\z/o.freeze
-
       UndefinedSetting = Module.new
 
       # Store question message
@@ -44,6 +42,7 @@ module TTY
         @read       = options.fetch(:read) { UndefinedSetting }
         @convert    = options.fetch(:convert) { UndefinedSetting }
         @color      = options.fetch(:color) { :green }
+        @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
         @done       = false
         @input      = nil
 
@@ -56,6 +55,33 @@ module TTY
         @evaluator << CheckModifier
       end
 
+      # Stores all the error messages displayed to user
+      # The currently supported messages are:
+      #  * :range?
+      #  * :required?
+      #  * :valid?
+      attr_reader :messages
+
+      # Retrieve message based on the key
+      #
+      # @param [Symbol] name
+      #   the name of message key
+      #
+      # @param [Hash] tokens
+      #   the tokens to evaluate
+      #
+      # @return [Array[String]]
+      #
+      # @api private
+      def message_for(name, tokens = nil)
+        template = @messages[name]
+        if template && !template.match(/\%\{/).nil?
+          [template % tokens]
+        else
+          [template || '']
+        end
+      end
+
       # Call the question
       #
       # @param [String] message
@@ -64,7 +90,7 @@ module TTY
       #
       # @api public
       def call(message, &block)
-        return if blank?(message)
+        return if Utils.blank?(message)
         @message = message
         block.call(self) if block
         render
@@ -108,7 +134,7 @@ module TTY
       # @api private
       def process_input
         @input = read_input
-        if blank?(@input)
+        if Utils.blank?(@input)
           @input = default? ? default : nil
         end
         @evaluator.(@input)
@@ -168,7 +194,7 @@ module TTY
       #
       # @api private
       def convert_result(value)
-        if convert? & !blank?(value)
+        if convert? & !Utils.blank?(value)
           converter_registry.(@convert, value)
         else
           value
@@ -220,7 +246,8 @@ module TTY
       # @return [Boolean]
       #
       # @api public
-      def required(value = (not_set = true))
+      def required(value = (not_set = true), message = nil)
+        messages[:required?] = message if message
         return @required if not_set
         @required = value
       end
@@ -233,7 +260,8 @@ module TTY
       # @return [Question]
       #
       # @api public
-      def validate(value = nil, &block)
+      def validate(value = nil, message = nil, &block)
+        messages[:valid?] = message if message
         @validation = (value || block)
       end
 
@@ -274,7 +302,8 @@ module TTY
       # @param [String] value
       #
       # @api public
-      def in(value = (not_set = true))
+      def in(value = (not_set = true), message = nil)
+        messages[:range?] = message if message
         if in? && !@in.is_a?(Range)
           @in = converter_registry.(:range, @in)
         end
@@ -291,12 +320,7 @@ module TTY
         @in != UndefinedSetting
       end
 
-      def blank?(value)
-        value.nil? ||
-        value.respond_to?(:empty?) && value.empty? ||
-        BLANK_REGEX === value
-      end
-
+      # @api public
       def to_s
         "#{message}"
       end

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

@@ -40,7 +40,8 @@ module TTY
               (question.in? && question.in.include?(cast(value)))
               [value]
             else
-              [value, ["Value #{value} is not included in the range #{question.in}"]]
+              tokens = {value: value, in: question.in}
+              [value, question.message_for(:range?, tokens)]
             end
           end
         end
@@ -53,7 +54,8 @@ module TTY
                 Validation.new(question.validation).call(value))
               [value]
             else
-              [value, ["Your answer is invalid (must match #{question.validation.inspect})"]]
+              tokens = {valid: question.validation.inspect}
+              [value, question.message_for(:valid?, tokens)]
             end
           end
         end
@@ -73,7 +75,7 @@ module TTY
         class CheckRequired
           def self.call(question, value)
             if question.required? && !question.default? && value.nil?
-              [value, ['No value provided for required']]
+              [value, question.message_for(:required?)]
             else
               [value]
             end

data/lib/tty/prompt/reader.rb

@@ -8,6 +8,10 @@ module TTY
   # A class responsible for shell prompt interactions.
   class Prompt
     # A class responsible for reading character input from STDIN
+    #
+    # Used internally to provide key and line reading functionality
+    #
+    # @api private
     class Reader
       include Wisper::Publisher
 
@@ -56,6 +60,9 @@ module TTY
       # Read a single keypress that may include
       # 2 or 3 escape characters.
       #
+      # @param [Boolean] echo
+      #   whether to echo chars back or not, defaults to false
+      #
       # @return [String]
       #
       # @api public
@@ -64,7 +71,7 @@ module TTY
           mode.echo(echo) do
             mode.raw(true) do
               key = read_char
-              publish_keypress_event(key) if key
+              emit_key_event(key) if key
               exit 130 if key == Codes::CTRL_C
               key
             end
@@ -107,7 +114,7 @@ module TTY
           mode.echo(echo) do
             while (char = input.getbyte) &&
                 !(char == CARRIAGE_RETURN || char == NEWLINE)
-              publish_keypress_event(convert_byte(char))
+              emit_key_event(convert_byte(char))
               line = handle_char(line, char)
             end
           end
@@ -145,25 +152,12 @@ module TTY
       # @return [nil]
       #
       # @api public
-      def publish_keypress_event(char)
-        event = KeyEvent.from(char)
-        event_name = parse_key_event(event)
-        publish(event_name, event) unless event_name.nil?
+      def emit_key_event(key)
+        event = KeyEvent.from(key)
+        publish(:"key#{event.key.name}", event) if event.emit?
         publish(:keypress, event)
       end
 
-      # Interpret the key and provide event name
-      #
-      # @return [Symbol]
-      #
-      # @api public
-      def parse_key_event(event)
-        return if event.key.nil?
-        permitted_events = %w(up down left right space return enter num)
-        return unless permitted_events.include?("#{event.key.name}")
-        :"key#{event.key.name}"
-      end
-
       private
 
       trap('SIGINT') { exit 130 }

data/lib/tty/prompt/reader/codes.rb

@@ -39,15 +39,21 @@ module TTY
         CTRL_H = "\b"
         CTRL_L = "\f"
 
-        F1 = "\eOP"
-        F2 = "\eOQ"
-        F3 = "\eOR"
-        F4 = "\eOS"
-
-        F1_ALT = "\e[11~"
-        F2_ALT = "\e[12~"
-        F3_ALT = "\e[13~"
-        F4_ALT = "\e[14~"
+        F1_XTERM = "\eOP"
+        F2_XTERM = "\eOQ"
+        F3_XTERM = "\eOR"
+        F4_XTERM = "\eOS"
+
+        F1_GNOME = "\e[11~"
+        F2_GNOME = "\e[12~"
+        F3_GNOME = "\e[13~"
+        F4_GNOME = "\e[14~"
+
+        F1_WIN = "\e[[A"
+        F2_WIN = "\e[[B"
+        F3_WIN = "\e[[C"
+        F4_WIN = "\e[[D"
+        F5_WIN = "\e[[E"
 
         F5 =  "\e[15~"
         F6 =  "\e[17~"

data/lib/tty/prompt/reader/key_event.rb

@@ -21,46 +21,73 @@ module TTY
       #
       # @api public
       class KeyEvent < Struct.new(:value, :key)
-        META_KEY_CODE_RE = /^(?:\x1b+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/
+        META_KEY_CODE_RE = /^(?:\e)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/
 
         def self.from(char)
           key = Key.new
           case char
-          when Codes::RETURN
-            key.name = :return
-          when Codes::LINEFEED
-            key.name = :enter
-          when Codes::TAB
-            key.name = :tab
-          when Codes::BACKSPACE
+          when Codes::RETURN   then key.name = :return
+          when Codes::LINEFEED then key.name = :enter
+          when Codes::TAB      then key.name = :tab
+          when Codes::BACKSPACE, Codes::CTRL_H,
+              "#{Codes::ESCAPE}#{Codes::BACKSPACE}",
+              "#{Codes::ESCAPE}#{Codes::CTRL_H}"
             key.name = :backspace
-          when Codes::DELETE
-            key.name = :delete
-          when Codes::SPACE
-            key.name = :space
-          when Codes::CTRL_C, Codes::ESCAPE
-            key.name = :escape
-          when proc { |c| c <= "\x1a" }
-            codes = char.each_codepoint.to_a
-            key.name = "#{codes}"
-            key.ctrl = true
-          when /\d/
+          when Codes::DELETE   then key.name = :delete
+          when Codes::SPACE    then key.name = :space
+          when Codes::CTRL_C, Codes::ESCAPE then key.name = :escape
+          when proc { |c| c.length == 1 && c =~ /[a-z]/ }
+            key.name = char
+          when proc { |c| c.length == 1 && c =~ /[A-Z]/ }
+            key.name = char.downcase
+            key.shift = true
+          when /^\d+$/
             key.name = :num
-          when META_KEY_CODE_RE
+          when META_KEY_CODE_RE # ansi escape
             key.meta = true
+
             case char
-            when Codes::KEY_UP, Codes::CTRL_K, Codes::CTRL_P
+            # f1 - f12
+            when Codes::F1_XTERM, Codes::F1_GNOME, Codes::F1_WIN then key.name = :f1
+            when Codes::F2_XTERM, Codes::F2_GNOME, Codes::F2_WIN then key.name = :f2
+            when Codes::F3_XTERM, Codes::F3_GNOME, Codes::F3_WIN then key.name = :f3
+            when Codes::F4_XTERM, Codes::F4_GNOME, Codes::F4_WIN then key.name = :f4
+            when Codes::F5 then key.name = :f5
+            when Codes::F6 then key.name = :f6
+            when Codes::F7 then key.name = :f7
+            when Codes::F8 then key.name = :f8
+            when Codes::F9 then key.name = :f9
+            when Codes::F10 then key.name = :f10
+            when Codes::F11 then key.name = :f11
+            when Codes::F12 then key.name = :f12
+            # navigation
+            when Codes::KEY_UP, Codes::KEY_UP_ALT, Codes::CTRL_K, Codes::CTRL_P
               key.name = :up
-            when Codes::KEY_DOWN, Codes::CTRL_J, Codes::CTRL_N
+            when Codes::KEY_DOWN, Codes::KEY_DOWN_ALT, Codes::CTRL_J, Codes::CTRL_N
               key.name = :down
-            when Codes::KEY_RIGHT, Codes::CTRL_L
+            when Codes::KEY_RIGHT, Codes::KEY_RIGHT_ALT, Codes::CTRL_L
               key.name = :right
-            when Codes::KEY_LEFT, Codes::CTRL_H
+            when Codes::KEY_LEFT, Codes::KEY_LEFT_ALT, Codes::CTRL_H
               key.name = :left
+            when Codes::KEY_CLEAR, Codes::KEY_CLEAR_ALT
+              key.name = :clear
+            when Codes::KEY_END, Codes::KEY_END_ALT
+              key.name = :end
+            when Codes::KEY_HOME, Codes::KEY_HOME_ALT
+              key.name = :home
             end
           end
           new(char, key)
         end
+
+        # Check if key event can be emitted
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        def emit?
+          !key.nil? && !key.name.nil?
+        end
       end # KeyEvent
     end # Reader
   end # Prompt

data/lib/tty/prompt/slider.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+
+module TTY
+  # A class responsible for shell prompt interactions.
+  class Prompt
+    # A class responsible for gathering numeric input from range
+    #
+    # @api public
+    class Slider
+      HELP = '(Use arrow keys, press Enter to select)'.freeze
+
+      # Initailize a Slider
+      #
+      # @api public
+      def initialize(prompt, options = {})
+        @prompt       = prompt
+        @first_render = true
+        @done         = false
+        @color        = options.fetch(:color) { :green }
+        @min          = options.fetch(:min) { 0 }
+        @max          = options.fetch(:max) { 10 }
+        @step         = options.fetch(:step) { 1 }
+        @default      = options[:default]
+
+        @prompt.subscribe(self)
+      end
+
+      # Setup initial active position
+      #
+      # @return [Integer]
+      #
+      # @api private
+      def initial
+        if @default.nil?
+          range.size / 2
+        else
+          range.index(@default)
+        end
+      end
+
+      # Range of numbers to render
+      #
+      # @return [Array[Integer]]
+      #
+      # @apip private
+      def range
+        (@min..@max).step(@step).to_a
+      end
+
+      # @api public
+      def default(value)
+        @default = value
+      end
+
+      # @api public
+      def min(value)
+        @min = value
+      end
+
+      # @api public
+      def max(value)
+        @max = value
+      end
+
+      # @api public
+      def step(value)
+        @step = value
+      end
+
+      # Call the slider by passing question
+      #
+      # @param [String] question
+      #   the question to ask
+      #
+      # @apu public
+      def call(question, &block)
+        @question = question
+        block.call(self) if block
+        @active = initial
+        render
+      end
+
+      def keyleft(*)
+        @active -= 1 if @active > 0
+      end
+      alias_method :keydown, :keyleft
+
+      def keyright(*)
+        @active += 1 if (@active + @step) <= range.size
+      end
+      alias_method :keyup, :keyright
+
+      def keyreturn(*)
+        @done = true
+      end
+      alias_method :keyspace, :keyreturn
+
+      private
+
+      # Render an interactive range slider.
+      #
+      # @api private
+      def render
+        @prompt.print(@prompt.hide)
+        until @done
+          render_question
+          @prompt.read_keypress
+          refresh
+        end
+        render_question
+        answer = render_answer
+      ensure
+        @prompt.print(@prompt.show)
+        answer
+      end
+
+      # Clear screen
+      #
+      # @api private
+      def refresh
+        lines = @question.scan("\n").length + 2
+        @prompt.print(@prompt.clear_lines(lines))
+      end
+
+      # @return [Integer]
+      #
+      # @api private
+      def render_answer
+        range[@active]
+      end
+
+      # Render question with the slider
+      #
+      # @api private
+      def render_question
+        header = "#{@prompt.prefix}#{@question} #{render_header}"
+        @prompt.puts(header)
+        @first_render = false
+        @prompt.print(render_slider) unless @done
+      end
+
+      # Render actual answer or help
+      #
+      # @api private
+      def render_header
+        if @done
+          @prompt.decorate(render_answer.to_s, @color)
+        elsif @first_render
+          @prompt.decorate(HELP, :bright_black)
+        end
+      end
+
+      # Render slider representation
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_slider
+        output = ''
+        output << Symbols::SLIDER_END
+        output << '-' * @active
+        output << @prompt.decorate(Symbols::SLIDER_HANDLE, @color)
+        output << '-' * (range.size - @active - 1)
+        output << Symbols::SLIDER_END
+        output << " #{range[@active]}"
+        output
+      end
+    end # Slider
+  end # Prompt
+end # TTY