tty-prompt 0.3.0 → 0.4.0

data/examples/slider.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+prompt.slider("What size?", min: 32, max: 54, step: 2)

data/lib/tty-prompt.rb

@@ -8,12 +8,14 @@ require 'tty-platform'
 require 'tty/prompt'
 require 'tty/prompt/choice'
 require 'tty/prompt/choices'
+require 'tty/prompt/enum_list'
 require 'tty/prompt/evaluator'
 require 'tty/prompt/list'
 require 'tty/prompt/multi_list'
 require 'tty/prompt/question'
 require 'tty/prompt/mask_question'
 require 'tty/prompt/reader'
+require 'tty/prompt/slider'
 require 'tty/prompt/statement'
 require 'tty/prompt/suggestion'
 require 'tty/prompt/symbols'
@@ -24,5 +26,9 @@ require 'tty/prompt/version'
 # A collection of small libraries for building CLI apps,
 # each following unix philosophy of focused task
 module TTY
-  PromptConfigurationError = Class.new(StandardError)
-end
+  class Prompt
+    ConfigurationError = Class.new(StandardError)
+
+    ConversionError = Class.new(StandardError)
+  end
+end # TTY

data/lib/tty/prompt.rb

@@ -44,6 +44,14 @@ module TTY
 
     def_delegators :@output, :print, :puts, :flush
 
+    def self.messages
+      {
+        range?: 'Value %{value} must be within the range %{in}',
+        valid?: 'Your answer is invalid (must match %{valid})',
+        required?: 'Value must be provided'
+      }
+    end
+
     # Initialize a Prompt
     #
     # @api public
@@ -77,7 +85,7 @@ module TTY
     # @api public
     def ask(message, *args, &block)
       options = Utils.extract_options!(args)
-
+      options.merge!(self.class.messages)
       question = Question.new(self, options)
       question.call(message, &block)
     end
@@ -143,17 +151,7 @@ module TTY
     #
     # @api public
     def select(question, *args, &block)
-      options = Utils.extract_options!(args)
-      choices = if block
-                  []
-                elsif args.empty?
-                  options
-                else
-                  args.flatten
-                end
-
-      list = List.new(self, options)
-      list.call(question, choices, &block)
+      invoke_select(List, question, *args, &block)
     end
 
     # Ask a question with multiple attributes activated
@@ -173,6 +171,40 @@ module TTY
     #
     # @api public
     def multi_select(question, *args, &block)
+      invoke_select(MultiList, question, *args, &block)
+    end
+
+    # Ask a question with indexed list
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   editors = %w(emacs nano vim)
+    #   prompt.enum_select(EnumList, "Select editor: ", editors)
+    #
+    # @param [String] question
+    #   the question to ask
+    #
+    # @param [Array[Object]] choices
+    #   the choices to select from
+    #
+    # @return [String]
+    #
+    # @api public
+    def enum_select(question, *args, &block)
+      invoke_select(EnumList, question, *args, &block)
+    end
+
+    # Invoke a list type of prompt
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   editors = %w(emacs nano vim)
+    #   prompt.invoke_select(EnumList, "Select editor: ", editors)
+    #
+    # @return [String]
+    #
+    # @api public
+    def invoke_select(object, question, *args, &block)
       options = Utils.extract_options!(args)
       choices = if block
                   []
@@ -182,7 +214,7 @@ module TTY
                   args.flatten
                 end
 
-      list = MultiList.new(self, options)
+      list = object.new(self, options)
       list.call(question, choices, &block)
     end
 
@@ -203,6 +235,24 @@ module TTY
       ask(question, *args, &block)
     end
 
+    # Ask a question with a range slider
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   prompt.slider('What size?', min: 32, max: 54, step: 2)
+    #
+    # @param [String] question
+    #   the question to ask
+    #
+    # @return [String]
+    #
+    # @api public
+    def slider(question, *args, &block)
+      options = Utils.extract_options!(args)
+      slider = Slider.new(self, options)
+      slider.call(question, &block)
+    end
+
     # A shortcut method to ask the user negative question and return
     # true for 'no' reply.
     #

data/lib/tty/prompt/converters.rb

@@ -17,9 +17,15 @@ module TTY
         end
       end
 
+      def self.on_error
+        yield
+      rescue Necromancer::ConversionTypeError => e
+        raise ConversionError, e.message
+      end
+
       converter(:bool) do |input|
         converter = Necromancer.new
-        converter.convert(input).to(:boolean, strict: true)
+        on_error { converter.convert(input).to(:boolean, strict: true) }
       end
 
       converter(:string) do |input|
@@ -32,27 +38,27 @@ module TTY
 
       converter(:date) do |input|
         converter = Necromancer.new
-        converter.convert(input).to(:date)
+        on_error { converter.convert(input).to(:date, strict: true) }
       end
 
       converter(:datetime) do |input|
         converter = Necromancer.new
-        converter.convert(input).to(:datetime)
+        on_error { converter.convert(input).to(:datetime, strict: true) }
       end
 
       converter(:int) do |input|
         converter = Necromancer.new
-        converter.convert(input).to(:integer)
+        on_error { converter.convert(input).to(:integer, strict: true) }
       end
 
       converter(:float) do |input|
         converter = Necromancer.new
-        converter.convert(input).to(:float)
+        on_error { converter.convert(input).to(:float, strict: true) }
       end
 
       converter(:range) do |input|
         converter = Necromancer.new
-        converter.convert(input).to(:range, strict: true)
+        on_error { converter.convert(input).to(:range, strict: true) }
       end
 
       converter(:regexp) do |input|

data/lib/tty/prompt/enum_list.rb

@@ -0,0 +1,222 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    # A class reponsible for rendering enumerated list menu.
+    # Used by {Prompt} to display static choice menu.
+    #
+    # @api private
+    class EnumList
+      # Create instance of EnumList menu.
+      #
+      # @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.subscribe(self)
+      end
+
+      # Set default option selected
+      #
+      # @api public
+      def default(default)
+        @default = default
+      end
+
+      # Set selecting active index using number pad
+      #
+      # @api public
+      def enum(value)
+        @enum = 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)
+        values.each { |val| choice(*val) }
+      end
+
+      # Call the list menu by passing question and choices
+      #
+      # @param [String] question
+      #
+      # @param
+      # @api public
+      def call(question, possibilities, &block)
+        choices(possibilities)
+        @question = question
+        block.call(self) if block
+        setup_defaults
+        render
+      end
+
+      def keypress(event)
+        if [:backspace, :delete].include?(event.key.name)
+          @input.chop! unless @input.empty?
+          mark_choice_as_active
+        elsif event.value =~ /^\d+$/
+          @input += event.value
+          mark_choice_as_active
+        end
+      end
+
+      def keyreturn(*)
+        @failure = false
+        if (@input.to_i > 0 && @input.to_i <= @choices.size) || @input.empty?
+          @done = true
+        else
+          @input = ''
+          @failure = true
+        end
+      end
+      alias_method :keyenter, :keyreturn
+
+      private
+
+      def mark_choice_as_active
+        if !@choices[@input.to_i - 1].nil?
+          @active = @input.to_i
+        else
+          @active = nil
+        end
+      end
+
+      # Setup default option and active selection
+      #
+      # @api private
+      def setup_defaults
+        validate_defaults
+        @active = @default
+      end
+
+      # Validate default indexes to be within range
+      #
+      # @api private
+      def validate_defaults
+        return if @default >= 1 && @default <= @choices.size
+        fail PromptConfigurationError,
+             "default index `#{d}` out of range (1 - #{@choices.size})"
+      end
+
+      # Render a selection list.
+      #
+      # By default the result is printed out.
+      #
+      # @return [Object] value
+      #   return the selected value
+      #
+      # @api private
+      def render
+        @input = ''
+        until @done
+          render_question
+          @prompt.read_keypress
+          refresh
+        end
+        render_question
+        render_answer
+      end
+
+      # Find value for the choice selected
+      #
+      # @return [nil, Object]
+      #
+      # @api private
+      def render_answer
+        @choices[@active - 1].value
+      end
+
+      # Determine area of the screen to clear
+      #
+      # @api private
+      def refresh
+        lines = @question.scan("\n").length + @choices.length + 2
+        @prompt.print(@prompt.clear_lines(lines))
+        @prompt.print(@prompt.cursor.clear_screen_down)
+      end
+
+      # Render question with the menu options
+      #
+      # @api private
+      def render_question
+        header = "#{@prompt.prefix}#{@question} #{render_header}"
+        @prompt.puts(header)
+        return if @done
+        @prompt.print(render_menu)
+        @prompt.print(render_footer)
+        render_error if @failure
+      end
+
+      # @api private
+      def render_error
+        error = 'Please enter a valid index'
+        @prompt.print("\n" + @prompt.decorate('>>', :red) + ' ' + error)
+        @prompt.print(@prompt.cursor.prev_line)
+        @prompt.print(@prompt.cursor.forward(render_footer.size))
+      end
+
+      # Render chosen option
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_header
+        return '' unless @done
+        return '' unless @active
+        selected_item = "#{@choices[@active - 1].name}"
+        @prompt.decorate(selected_item, @color)
+      end
+
+      # Render footer for the indexed menu
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_footer
+        "  Choose 1-#{@choices.size} [#{@default}]: #{@input}"
+      end
+
+      # Render menu with indexed choices to select from
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_menu
+        output = ''
+        @choices.each_with_index do |choice, index|
+          num = (index + 1).to_s + @enum + Symbols::SPACE
+          selected = Symbols::SPACE * 2 + num + choice.name
+          output << if index + 1 == @active
+                      @prompt.decorate("#{selected}", @color)
+                    else
+                      selected
+                    end
+          output << "\n"
+        end
+        output
+      end
+    end # EnumList
+  end # Prompt
+end # TTY

data/lib/tty/prompt/list.rb

@@ -7,7 +7,7 @@ module TTY
     #
     # @api private
     class List
-      HELP = '(Use arrow keys, press Enter to select)'.freeze
+      HELP = '(Use arrow%s keys, press Enter to select)'.freeze
 
       # Create instance of TTY::Prompt::List menu.
       #
@@ -19,18 +19,21 @@ module TTY
       #   the color for the selected item, defualts to :green
       # @option options [Symbol] :marker
       #   the marker for the selected item
+      # @option options [String] :enum
+      #   the delimiter for the item index
       #
       # @api public
       def initialize(prompt, options = {})
         @prompt       = prompt
         @first_render = true
         @done         = false
+        @enum         = options.fetch(:enum) { nil }
         @default      = Array[options.fetch(:default) { 1 }]
         @active       = @default.first
         @choices      = Choices.new
         @color        = options.fetch(:color) { :green }
         @marker       = options.fetch(:marker) { Symbols::ITEM_SELECTED }
-        @help         = options.fetch(:help) { HELP }
+        @help         = options[:help]
 
         @prompt.subscribe(self)
       end
@@ -49,6 +52,13 @@ module TTY
         @default = default_values
       end
 
+      # Set selecting active index using number pad
+      #
+      # @api public
+      def enum(value)
+        @enum = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -84,23 +94,37 @@ module TTY
         render
       end
 
-      def keyescape(event)
+      # Check if list is enumerated
+      #
+      # @return [Boolean]
+      def enumerate?
+        !@enum.nil?
+      end
+
+      def keynum(event)
+        return unless enumerate?
+        value = event.value.to_i
+        return unless (1..@choices.count).include?(value)
+        @active = value
+      end
+
+      def keyescape(*)
         exit 130
       end
 
-      def keyspace(event)
+      def keyspace(*)
         @done = true
       end
 
-      def keyreturn(event)
+      def keyreturn(*)
         @done = true
       end
 
-      def keyup(event)
+      def keyup(*)
         @active = (@active == 1) ? @choices.length : @active - 1
       end
 
-      def keydown(event)
+      def keydown(*)
         @active = (@active == @choices.length) ? 1 : @active + 1
       end
 
@@ -120,7 +144,7 @@ module TTY
       def validate_defaults
         @default.each do |d|
           if d < 1 || d > @choices.size
-            fail PromptConfigurationError,
+            fail ConfigurationError,
                  "default index `#{d}` out of range (1 - #{@choices.size})"
           end
         end
@@ -172,7 +196,15 @@ module TTY
         header = "#{@prompt.prefix}#{@question} #{render_header}"
         @prompt.puts(header)
         @first_render = false
-        render_menu unless @done
+        @prompt.print(render_menu) unless @done
+      end
+
+      # Provide help information
+      #
+      # @return [String]
+      def help
+        return @help unless @help.nil?
+        self.class::HELP % [enumerate? ? ' or number (0-9)' : '']
       end
 
       # Render initial help and selected choice
@@ -185,9 +217,7 @@ module TTY
           selected_item = "#{@choices[@active - 1].name}"
           @prompt.decorate(selected_item, @color)
         elsif @first_render
-          @prompt.decorate(@help, :bright_black)
-        else
-          ''
+          @prompt.decorate(help, :bright_black)
         end
       end
 
@@ -195,16 +225,19 @@ module TTY
       #
       # @api private
       def render_menu
+        output = ''
         @choices.each_with_index do |choice, index|
+          num = enumerate? ? (index + 1).to_s + @enum + Symbols::SPACE : ''
           message = if index + 1 == @active
-                      selected = @marker + Symbols::SPACE + choice.name
+                      selected = @marker + Symbols::SPACE + num + choice.name
                       @prompt.decorate("#{selected}", @color)
                     else
-                      Symbols::SPACE * 2 + choice.name
+                      Symbols::SPACE * 2 + num + choice.name
                     end
           newline = (index == @choices.length - 1) ? '' : "\n"
-          @prompt.print(message + newline)
+          output << (message + newline)
         end
+        output
       end
     end # List
   end # Prompt