tty2-prompt 0.23.1.3

data/lib/tty2/prompt/enum_list.rb

@@ -0,0 +1,433 @@
+# frozen_string_literal: true
+
+require "English"
+
+require_relative "choices"
+require_relative "block_paginator"
+require_relative "paginator"
+
+module TTY2
+  class Prompt
+    # A class reponsible for rendering enumerated list menu.
+    # Used by {Prompt} to display static choice menu.
+    #
+    # @api private
+    class EnumList
+      PAGE_HELP = "(Press tab/right or left to reveal more choices)"
+
+      # Checks type of default parameter to be integer
+      INTEGER_MATCHER = /\A[-+]?\d+\Z/.freeze
+
+      # Create instance of EnumList menu.
+      #
+      # @api public
+      def initialize(prompt, **options)
+        @prompt       = prompt
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
+        @enum         = options.fetch(:enum) { ")" }
+        @default      = options.fetch(:default, nil)
+        @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 }
+        @cycle        = options.fetch(:cycle, false)
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
+        @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
+        @input        = nil
+        @done         = false
+        @first_render = true
+        @failure      = false
+        @active       = @default
+        @choices      = Choices.new
+        @per_page     = options[:per_page]
+        @page_help    = options[:page_help] || PAGE_HELP
+        @paginator    = BlockPaginator.new
+        @page_active  = @default
+      end
+
+      # Change symbols used by this prompt
+      #
+      # @param [Hash] new_symbols
+      #   the new symbols to use
+      #
+      # @api public
+      def symbols(new_symbols = (not_set = true))
+        return @symbols if not_set
+
+        @symbols.merge!(new_symbols)
+      end
+
+      # Set default option selected
+      #
+      # @api public
+      def default(default)
+        @default = default
+      end
+
+      # Check if default value is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def default?
+        !@default.to_s.empty?
+      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
+
+      # Set selecting active index using number pad
+      #
+      # @api public
+      def enum(value)
+        @enum = value
+      end
+
+      # Set quiet mode
+      #
+      # @api public
+      def quiet(value)
+        @quiet = 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 = (not_set = true))
+        if not_set
+          @choices
+        else
+          values.each { |val| @choices << val }
+        end
+      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[self] if block
+        setup_defaults
+        @prompt.subscribe(self) do
+          render
+        end
+      end
+
+      def keypress(event)
+        if %i[backspace delete].include?(event.key.name)
+          return if @input.empty?
+
+          @input.chop!
+          mark_choice_as_active
+        elsif event.value =~ /^\d+$/
+          @input += event.value
+          mark_choice_as_active
+        end
+      end
+
+      def keyreturn(*)
+        @failure = false
+        num = @input.to_i
+        choice_disabled = choices[num - 1] && choices[num - 1].disabled?
+        choice_in_range = num > 0 && num <= @choices.size
+
+        if choice_in_range && !choice_disabled || @input.empty?
+          @done = true
+        else
+          @input = ""
+          @failure = true
+        end
+      end
+      alias keyenter keyreturn
+
+      def keyright(*)
+        if (@page_active + page_size) <= @choices.size
+          @page_active += page_size
+        elsif @cycle
+          @page_active = 1
+        end
+      end
+      alias keytab keyright
+
+      def keyleft(*)
+        if (@page_active - page_size) >= 0
+          @page_active -= page_size
+        elsif @cycle
+          @page_active = @choices.size - 1
+        end
+      end
+
+      private
+
+      # Find active choice or set to default
+      #
+      # @return [nil]
+      #
+      # @api private
+      def mark_choice_as_active
+        next_active = @choices[@input.to_i - 1]
+
+        if next_active && next_active.disabled?
+          # noop
+        elsif (@input.to_i > 0) && next_active
+          @active = @input.to_i
+        else
+          @active = @default
+        end
+        @page_active = @active
+      end
+
+      # Validate default indexes to be within range
+      #
+      # @api private
+      def validate_defaults
+        msg = if @default.nil? || @default.to_s.empty?
+                "default index must be an integer in range (1 - #{choices.size})"
+              elsif @default.to_s !~ INTEGER_MATCHER
+                validate_default_name
+              elsif @default < 1 || @default > @choices.size
+                "default index #{@default} out of range (1 - #{@choices.size})"
+              elsif choices[@default - 1] && choices[@default - 1].disabled?
+                "default index #{@default} matches disabled choice item"
+              end
+
+        raise(ConfigurationError, msg) if msg
+      end
+
+      # Validate default choice name
+      #
+      # @return [String]
+      #
+      # @api private
+      def validate_default_name
+        default_choice = choices.find_by(:name, @default.to_s)
+        if default_choice.nil?
+          "no choice found for the default name: #{@default.inspect}"
+        elsif default_choice.disabled?
+          "default name #{@default.inspect} matches disabled choice"
+        end
+      end
+
+      # Setup default option and active selection
+      #
+      # @api private
+      def setup_defaults
+        if @default.to_s.empty?
+          @default = (0..choices.length).find { |i| !choices[i].disabled? } + 1
+        end
+        validate_defaults
+        if default_choice = choices.find_by(:name, @default)
+          @default = choices.index(default_choice) + 1
+        end
+        mark_choice_as_active
+      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
+          question = render_question
+          @prompt.print(question)
+          @prompt.print(render_error) if @failure
+          if paginated? && !@done
+            @prompt.print(render_page_help)
+          end
+          @prompt.read_keypress
+          question_lines = question.split($INPUT_RECORD_SEPARATOR, -1)
+          @prompt.print(refresh(question_lines_count(question_lines)))
+        end
+        @prompt.print(render_question) unless @quiet
+        answer
+      end
+
+      # Count how many screen lines the question spans
+      #
+      # @return [Integer]
+      #
+      # @api private
+      def question_lines_count(question_lines)
+        question_lines.reduce(0) do |acc, line|
+          acc + @prompt.count_screen_lines(line)
+        end
+      end
+
+      # Find value for the choice selected
+      #
+      # @return [nil, Object]
+      #
+      # @api private
+      def answer
+        @choices[@active - 1].value
+      end
+
+      # Determine area of the screen to clear
+      #
+      # @param [Integer] lines
+      #   the lines to clear
+      #
+      # @return [String]
+      #
+      # @api private
+      def refresh(lines)
+        @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}\n"]
+        unless @done
+          header << render_menu
+          header << render_footer
+        end
+        header.join
+      end
+
+      # Error message when incorrect index chosen
+      #
+      # @api private
+      def error_message
+        error = "Please enter a valid number"
+        "\n" + @prompt.decorate(">>", @error_color) + " " + error
+      end
+
+      # Render error message and return cursor to position of input
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_error
+        error = error_message.dup
+        if !paginated?
+          error << @prompt.cursor.prev_line
+          error << @prompt.cursor.forward(render_footer.size)
+        end
+        error
+      end
+
+      # Render chosen option
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_header
+        return "" unless @done
+        return "" unless @active
+
+        selected_item = @choices[@active - 1].name.to_s
+        @prompt.decorate(selected_item, @active_color)
+      end
+
+      # Render footer for the indexed menu
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_footer
+        "  Choose 1-#{@choices.size} [#{@default}]: #{@input}"
+      end
+
+      # Pagination help message
+      #
+      # @return [String]
+      #
+      # @api private
+      def page_help_message
+        return "" unless paginated?
+
+        "\n" + @prompt.decorate(@page_help, @help_color)
+      end
+
+      # Render page help
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_page_help
+        help = page_help_message.dup
+        if @failure
+          help << @prompt.cursor.prev_line
+        end
+        help << @prompt.cursor.prev_line
+        help << @prompt.cursor.forward(render_footer.size)
+      end
+
+      # Render menu with indexed choices to select from
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_menu
+        output = []
+
+        @paginator.paginate(@choices, @page_active, @per_page) do |choice, index|
+          num = (index + 1).to_s + @enum + " "
+          selected = num.to_s + choice.name.to_s
+          output << if index + 1 == @active && !choice.disabled?
+                      (" " * 2) + @prompt.decorate(selected, @active_color)
+                    elsif choice.disabled?
+                      @prompt.decorate(@symbols[:cross], :red) + " " +
+                      selected + " " + choice.disabled.to_s
+                    else
+                      (" " * 2) + selected
+                    end
+          output << "\n"
+        end
+
+        output.join
+      end
+    end # EnumList
+  end # Prompt
+end # TTY2

data/lib/tty2/prompt/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TTY2
+  class Prompt
+    Error = Class.new(StandardError)
+
+    # Raised when wrong parameter is used to configure prompt
+    ConfigurationError = Class.new(Error)
+
+    # Raised when type conversion cannot be performed
+    ConversionError = Class.new(Error)
+
+    # Raised when the passed in validation argument is of wrong type
+    ValidationCoercion = Class.new(Error)
+
+    # Raised when the required argument is not supplied
+    ArgumentRequired = Class.new(Error)
+
+    # Raised when the argument validation fails
+    ArgumentValidation = Class.new(Error)
+
+    # Raised when the argument is not expected
+    InvalidArgument = Class.new(Error)
+
+    # Raised when overriding already defined conversion
+    ConversionAlreadyDefined = Class.new(Error)
+
+    # Raised when conversion type isn't registered
+    UnsupportedConversion = Class.new(Error)
+  end # Prompt
+end # TTY2

data/lib/tty2/prompt/evaluator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "result"
+
+module TTY2
+  class Prompt
+    # Evaluates provided parameters and stops if any of them fails
+    # @api private
+    class Evaluator
+      attr_reader :results
+
+      def initialize(question, &block)
+        @question = question
+        @results = []
+        instance_eval(&block) if block
+      end
+
+      def call(initial)
+        seed = Result::Success.new(@question, initial)
+        results.reduce(seed, &:with)
+      end
+
+      def check(proc = nil, &block)
+        results << (proc || block)
+      end
+      alias << check
+    end # Evaluator
+  end # Prompt
+end # TTY2