austb-tty-prompt 0.13.0

data/lib/tty/prompt/list.rb

@@ -0,0 +1,317 @@
+# encoding: utf-8
+
+require_relative 'choices'
+require_relative 'paginator'
+require_relative 'symbols'
+
+module TTY
+  class Prompt
+    # A class responsible for rendering select list menu
+    # Used by {Prompt} to display interactive menu.
+    #
+    # @api private
+    class List
+      include Symbols
+
+      HELP = '(Use arrow%s keys, press Enter to select)'
+
+      PAGE_HELP = '(Move up or down to reveal more choices)'
+
+      # Create instance of TTY::Prompt::List menu.
+      #
+      # @param Hash options
+      #   the configuration options
+      # @option options [Symbol] :default
+      #   the default active choice, defaults to 1
+      # @option options [Symbol] :color
+      #   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
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
+        @enum         = options.fetch(:enum) { nil }
+        @default      = Array[options.fetch(:default) { 1 }]
+        @active       = @default.first
+        @choices      = Choices.new
+        @active_color = options.fetch(:active_color) { @prompt.active_color }
+        @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @marker       = options.fetch(:marker) { symbols[:pointer] }
+        @help         = options[:help]
+        @first_render = true
+        @done         = false
+        @per_page     = options[:per_page]
+        @page_help    = options[:page_help] || PAGE_HELP
+        @paginator    = Paginator.new
+
+        @prompt.subscribe(self)
+      end
+
+      # Set marker
+      #
+      # @api public
+      def marker(value)
+        @marker = value
+      end
+
+      # Set default option selected
+      #
+      # @api public
+      def default(*default_values)
+        @default = default_values
+      end
+
+      # Set number of items per page
+      #
+      # @api public
+      def per_page(value)
+        @per_page = value
+      end
+
+      def page_size
+        (@per_page || Paginator::DEFAULT_PAGE_SIZE)
+      end
+
+      # Check if list is paginated
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def paginated?
+        @choices.size > page_size
+      end
+
+      # @param [String] text
+      #   the help text to display per page
+      # @api pbulic
+      def page_help(text)
+        @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
+      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)
+        Array(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
+
+      # 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).cover?(value)
+        @active = value
+      end
+
+      def keyspace(*)
+        @done = true
+      end
+
+      def keyreturn(*)
+        @done = true
+      end
+
+      def keyup(*)
+        @active = (@active == 1) ? @choices.length : @active - 1
+      end
+
+      def keydown(*)
+        @active = (@active == @choices.length) ? 1 : @active + 1
+      end
+      alias keytab keydown
+
+      private
+
+      # Setup default option and active selection
+      #
+      # @api private
+      def setup_defaults
+        validate_defaults
+        @active = @default.first
+      end
+
+      # Validate default indexes to be within range
+      #
+      # @api private
+      def validate_defaults
+        @default.each do |d|
+          if d.nil? || d.to_s.empty?
+            raise ConfigurationError,
+                 "default index must be an integer in range (1 - #{@choices.size})"
+          end
+          if d < 1 || d > @choices.size
+            raise ConfigurationError,
+                 "default index `#{d}` out of range (1 - #{@choices.size})"
+          end
+        end
+      end
+
+      # Render a selection list.
+      #
+      # By default the result is printed out.
+      #
+      # @return [Object] value
+      #   return the selected value
+      #
+      # @api private
+      def render
+        @prompt.print(@prompt.hide)
+        until @done
+          question = render_question
+          @prompt.print(question)
+          @prompt.read_keypress
+          @prompt.print(refresh(question.lines.count))
+        end
+        @prompt.print(render_question)
+        answer
+      ensure
+        @prompt.print(@prompt.show)
+      end
+
+      # Find value for the choice selected
+      #
+      # @return [nil, Object]
+      #
+      # @api private
+      def answer
+        @choices[@active - 1].value
+      end
+
+      # Clear screen lines
+      #
+      # @param [String]
+      #
+      # @api private
+      def refresh(lines)
+        @prompt.clear_lines(lines)
+      end
+
+      # Render question with instructions and menu
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_question
+        header = "#{@prefix}#{@question} #{render_header}\n"
+        @first_render = false
+        rendered_menu = render_menu
+        rendered_menu << render_footer
+        header << rendered_menu unless @done
+        header
+      end
+
+      # Render initial help and selected choice
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_header
+        if @done
+          selected_item = "#{@choices[@active - 1].name}"
+          @prompt.decorate(selected_item, @active_color)
+        elsif @first_render
+          @prompt.decorate(help, @help_color)
+        end
+      end
+
+      # Render menu with choices to select from
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_menu
+        output = ''
+        @paginator.paginate(@choices, @active, @per_page) do |choice, index|
+          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
+          message = if index + 1 == @active
+                      selected = @marker + ' ' + num + choice.name
+                      @prompt.decorate("#{selected}", @active_color)
+                    else
+                      ' ' * 2 + num + choice.name
+                    end
+          max_index = paginated? ? @paginator.max_index : @choices.size - 1
+          newline = (index == max_index) ? '' : "\n"
+          output << (message + newline)
+        end
+        output
+      end
+
+      # Render page info footer
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_footer
+        return '' unless paginated?
+        colored_footer = @prompt.decorate(@page_help, @help_color)
+        "\n" << colored_footer
+      end
+    end # List
+  end # Prompt
+end # TTY

data/lib/tty/prompt/mask_question.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require_relative 'question'
+require_relative 'symbols'
+
+module TTY
+  class Prompt
+    class MaskQuestion < Question
+      # Create masked question
+      #
+      # @param [Hash] options
+      # @option options [String] :mask
+      #
+      # @api public
+      def initialize(prompt, options = {})
+        super
+        @mask        = options.fetch(:mask) { Symbols.symbols[:dot] }
+        @done_masked = false
+        @failure     = false
+        @prompt.subscribe(self)
+      end
+
+      # Set character for masking the STDIN input
+      #
+      # @param [String] char
+      #
+      # @return [self]
+      #
+      # @api public
+      def mask(char = (not_set = true))
+        return @mask if not_set
+        @mask = char
+      end
+
+      def keyreturn(event)
+        @done_masked = true
+      end
+
+      def keyenter(event)
+        @done_masked = true
+      end
+
+      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
+      end
+
+      # Render question and input replaced with masked character
+      #
+      # @api private
+      def render_question
+        header = "#{@prefix}#{message} "
+        if echo?
+          masked = "#{@mask * "#{@input}".length}"
+          if @done_masked && !@failure
+            masked = @prompt.decorate(masked, @active_color)
+          elsif @done_masked && @failure
+            masked = @prompt.decorate(masked, @error_color)
+          end
+          header += masked
+        end
+        header << "\n" if @done
+        header
+      end
+
+      def render_error(errors)
+        @failure = !errors.empty?
+        super
+      end
+
+      # Read input from user masked by character
+      #
+      # @private
+      def read_input(question)
+        @done_masked = false
+        @failure = false
+        @input = ''
+        until @done_masked
+          @prompt.read_keypress
+          @prompt.print(@prompt.clear_line)
+          @prompt.print(render_question)
+        end
+        @prompt.puts
+        @input
+      end
+    end # MaskQuestion
+  end # Prompt
+end # TTY

data/lib/tty/prompt/multi_list.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+require_relative 'list'
+
+module TTY
+  class Prompt
+    # A class responsible for rendering multi select list menu.
+    # Used by {Prompt} to display interactive choice menu.
+    #
+    # @api private
+    class MultiList < List
+      HELP = '(Use arrow%s keys, press Space to select and Enter to finish)'.freeze
+
+      # Create instance of TTY::Prompt::MultiList menu.
+      #
+      # @param [Prompt] :prompt
+      # @param [Hash] options
+      #
+      # @api public
+      def initialize(prompt, options)
+        super
+        @selected = []
+        @help    = options[:help]
+        @default = Array(options[:default])
+        @echo = options.fetch(:echo, true)
+      end
+
+      # Callback fired when space key is pressed
+      #
+      # @api private
+      def keyspace(*)
+        active_choice = @choices[@active - 1]
+        if @selected.include?(active_choice)
+          @selected.delete(active_choice)
+        else
+          @selected << active_choice
+        end
+      end
+
+      private
+
+      # Setup default options and active selection
+      #
+      # @api private
+      def setup_defaults
+        validate_defaults
+        @selected = @choices.values_at(*@default.map { |d| d - 1 })
+        @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 && @echo
+          @prompt.decorate(selected_names, @active_color)
+        elsif @selected.size.nonzero? && @echo
+          selected_names + (@first_render ? " #{instructions}" : '')
+        elsif @first_render
+          instructions
+        end
+      end
+
+      # All values for the choices selected
+      #
+      # @return [Array[nil,Object]]
+      #
+      # @api private
+      def answer
+        @selected.map(&:value)
+      end
+
+      # Render menu with choices to select from
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_menu
+        output = ''
+        @paginator.paginate(@choices, @active, @per_page) do |choice, index|
+          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
+          indicator = (index + 1 == @active) ?  @marker : ' '
+          indicator += ' '
+          message = if @selected.include?(choice)
+                      selected = @prompt.decorate(symbols[:radio_on], @active_color)
+                      selected + ' ' + num + choice.name
+                    else
+                      symbols[:radio_off] + ' ' + num + choice.name
+                    end
+          max_index = paginated? ? @paginator.max_index : @choices.size - 1
+          newline = (index == max_index) ? '' : "\n"
+          output << indicator + message + newline
+        end
+        output
+      end
+    end # MultiList
+  end # Prompt
+end # TTY