tty-prompt 0.1.0 → 0.2.0

data/lib/tty/prompt/cursor.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Cursor
+      ECMA_CSI = "\e[".freeze
+      DEC_RST  = 'l'.freeze
+      DEC_SET  = 'h'.freeze
+      DEC_TCEM = '?25'.freeze
+      ECMA_CLR = 'K'.freeze
+
+      attr_reader :shell
+
+      def initialize(stream = nil, options = {})
+        @stream = stream || $stdout
+        @shell  = options.fetch(:shell, false)
+        @hidden = options.fetch(:hidden, false)
+      end
+
+      def print
+        self.class.new(@stream, shell: true)
+      end
+
+      def show
+        @hidden = false
+        ECMA_CSI + DEC_TCEM + DEC_SET
+      end
+
+      def hide
+        show if @hidden
+        @hidden = true
+        ECMA_CSI + DEC_TCEM + DEC_RST
+      end
+
+      # Switch off cursor for the block
+      # @api public
+      def invisible
+        hide
+        yield
+      ensure
+        show
+      end
+
+      # Save current position
+      # @api public
+      def save
+        ECMA_CSI + "s"
+      end
+
+      # Restore cursor position
+      # @api public
+      def restore
+        ECMA_CSI + "u"
+      end
+
+      def current
+        ECMA_CSI + "6n"
+      end
+
+      # Move cursor relative to its current position
+      # @api public
+      def move(x, y)
+      end
+
+      # Move cursor up by number of lines
+      #
+      # @param [Integer] count
+      #
+      # @api public
+      def move_up(count = nil)
+        ECMA_CSI + "#{(count || 1)}A"
+      end
+
+      def move_down(count = nil)
+        ECMA_CSI + "#{(count || 1)}B"
+      end
+
+      # Move to start of the line
+      #
+      # @api public
+      def move_start
+        ECMA_CSI + '1000D'
+      end
+
+      # @param [Integer] count
+      #   how far to go left
+      # @api public
+      def move_left(count = nil)
+        ECMA_CSI + "#{count || 1}D"
+      end
+
+      # @api public
+      def move_right(count = nil)
+        ECMA_CSI + "#{count || 1}C"
+      end
+
+      def next_line
+        ECMA_CSI + 'E'
+      end
+
+      def prev_line
+        ECMA_CSI + 'F'
+      end
+
+      # @api public
+      def clear_line
+        move_start + ECMA_CSI + ECMA_CLR
+      end
+
+      # @api public
+      def clear_lines(amount, direction = :up)
+        amount.times.reduce("") do |acc|
+          dir = direction == :up ? move_up : move_down
+          acc << dir + clear_line
+        end
+      end
+
+      # Clear screen down from current position
+      # @api public
+      def clear_down
+        ECMA_CSI + "J"
+      end
+
+      # Clear screen up from current position
+      # @api public
+      def clear_up
+        ECMA_CSI + "1J"
+      end
+    end # Cursor
+  end # Prompt
+end # TTY

data/lib/tty/prompt/list.rb

@@ -0,0 +1,209 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    # A class responsible for rendering select list menu
+    # Used by {Prompt} to display interactive menu.
+    #
+    # @api private
+    class List
+      HELP = '(Use arrow keys, press Enter to select)'.freeze
+
+      # 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
+      #
+      # @api public
+      def initialize(prompt, options)
+        @prompt = prompt
+        @reader = Reader.new(@prompt)
+        @pastel = Pastel.new
+        @cursor = Cursor.new
+
+        @first_render = true
+        @done         = false
+        @default      = Array[options.fetch(:default) { 1 }]
+        @active       = @default.first
+        @choices      = Choices.new
+        @color        = options.fetch(:color) { :green }
+        @marker       = options.fetch(:marker) { Codes::ITEM_SELECTED }
+        @help         = options.fetch(:help) { HELP }
+      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
+
+      # 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
+
+      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 < 1 || d > @choices.size
+            fail PromptConfigurationError,
+                 "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.output.print(@cursor.hide)
+        until @done
+          render_question
+          process_input
+          refresh
+        end
+        render_question
+        answer = render_answer
+      ensure
+        @prompt.output.print(@cursor.show)
+        answer
+      end
+
+      # Find value for the choice selected
+      #
+      # @return [nil, Object]
+      #
+      # @api private
+      def render_answer
+        @choices[@active - 1].value
+      end
+
+      # Process keyboard input
+      #
+      # @api private
+      def process_input
+        chars = @reader.read_keypress
+        case chars
+        when Codes::SIGINT, Codes::ESCAPE
+          exit 130
+        when Codes::RETURN, Codes::SPACE
+          @done = true
+        when Codes::KEY_UP, Codes::CTRL_K, Codes::CTRL_P
+          @active = (@active == 1) ? @choices.length : @active - 1
+        when Codes::KEY_DOWN, Codes::CTRL_J, Codes::CTRL_N
+          @active = (@active == @choices.length) ? 1 : @active + 1
+        end
+      end
+
+      # Determine area of the screen to clear
+      #
+      # @api private
+      def refresh
+        lines = @question.scan("\n").length + @choices.length + 1
+        @prompt.output.print(@cursor.clear_lines(lines))
+      end
+
+      # Render question with instructions and menu
+      #
+      # @api private
+      def render_question
+        header = @question + Codes::SPACE + render_header
+        @prompt.output.puts(header)
+        @first_render = false
+        render_menu unless @done
+      end
+
+      # Render initial help and selected choice
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_header
+        if @done
+          selected_item = "#{@choices[@active - 1].name}"
+          @pastel.decorate(selected_item, @color)
+        elsif @first_render
+          @pastel.decorate(@help, :bright_black)
+        else
+          ''
+        end
+      end
+
+      # Render menu with choices to select from
+      #
+      # @api private
+      def render_menu
+        @choices.each_with_index do |choice, index|
+          message = if index + 1 == @active
+                      selected = @marker + Codes::SPACE + choice.name
+                      @pastel.decorate("#{selected}", @color)
+                    else
+                      Codes::SPACE * 2 + choice.name
+                    end
+          @prompt.output.puts(message)
+        end
+      end
+    end # List
+  end # Prompt
+end # TTY

data/lib/tty/prompt/mode/echo.rb

@@ -24,15 +24,16 @@ module TTY
         # @api public
         def echo(is_on=true, &block)
           value = nil
-          begin
-            off unless is_on
-            value = block.call if block_given?
-            on
-            return value
-          rescue NoMethodError, Interrupt
-            on
-            exit
-          end
+          off unless is_on
+          value = block.call if block_given?
+        rescue NoMethodError, Interrupt => error
+          puts "#{error.class} #{error.message}"
+          puts error.backtrace
+          on
+          exit
+        ensure
+          on
+          return value
         end
       end # Echo
     end # Mode

data/lib/tty/prompt/mode/raw.rb

@@ -24,15 +24,16 @@ module TTY
         # @api public
         def raw(is_on=true, &block)
           value = nil
-          begin
-            on if is_on
-            value = block.call if block_given?
-            off
-            return value
-          rescue NoMethodError, Interrupt
-            off
-            exit
-          end
+          on if is_on
+          value = block.call if block_given?
+        rescue NoMethodError, Interrupt => error
+          puts "#{error.class} #{error.message}"
+          puts error.backtrace
+          off
+          exit
+        ensure
+          off
+          return value
         end
       end # Raw
     end # Mode

data/lib/tty/prompt/multi_list.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+
+require 'tty/prompt/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 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.fetch(:help) { HELP }
+        @default  = options.fetch(:default) { [] }
+      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
+
+      # Process keyboard input and maintain selected choices
+      #
+      # @api private
+      def process_input
+        chars = @reader.read_keypress
+        case chars
+        when Codes::SIGINT, Codes::ESCAPE
+          exit 130
+        when Codes::RETURN
+          @done = true
+        when Codes::KEY_UP, Codes::CTRL_K, Codes::CTRL_P
+          @active = (@active == 1) ? @choices.length : @active - 1
+        when Codes::KEY_DOWN, Codes::CTRL_J, Codes::CTRL_N
+          @active = (@active == @choices.length) ? 1 : @active + 1
+        when Codes::SPACE
+          active_choice = @choices[@active - 1]
+          if @selected.include?(active_choice)
+            @selected.delete(active_choice)
+          else
+            @selected << active_choice
+          end
+        end
+      end
+
+      # Render initial help text and then currently selected choices
+      #
+      # @api private
+      def render_header
+        if @done
+          @pastel.decorate(@selected.map(&:name).join(', '), :green)
+        elsif @selected.size.nonzero?
+          @selected.map(&:name).join(', ')
+        elsif @first_render
+          @pastel.decorate(@help, :bright_black)
+        else
+          ''
+        end
+      end
+
+      # All values for the choices selected
+      #
+      # @return [Array[nil,Object]]
+      #
+      # @api private
+      def render_answer
+        @selected.map(&:value)
+      end
+
+      # Render menu with choices to select from
+      #
+      # @api private
+      def render_menu
+        @choices.each_with_index do |choice, index|
+          indicator = (index + 1 == @active) ?  @marker : Codes::SPACE
+          indicator += Codes::SPACE
+          message = if @selected.include?(choice)
+                      selected = @pastel.decorate(Codes::RADIO_CHECKED, :green)
+                      selected + Codes::SPACE + choice.name
+                    else
+                      Codes::RADIO_UNCHECKED + Codes::SPACE + choice.name
+                    end
+          @prompt.output.puts(indicator + message)
+        end
+      end
+    end # MultiList
+  end # Prompt
+end # TTY

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

@@ -47,39 +47,24 @@ module TTY
           !!validation
         end
 
-        # Test if the value matches the validation
+        # Test if the input passes the validation
         #
         # @example
-        #   validation.valid_value?(value) # => true or false
+        #   Validation.new
+        #   validation.valid?(input) # => true
         #
-        # @param [Object] value
-        #  the value to validate
+        # @param [Object] input
+        #  the input to validate
         #
-        # @return [undefined]
+        # @return [Boolean]
         #
         # @api public
-        def valid_value?(value)
-          check_validation(value)
-        end
-
-        private
-
-        # Check if provided value passes validation
-        #
-        # @param [String] value
-        #
-        # @raise [TTY::InvalidArgument] unkown type of argument
-        #
-        # @return [undefined]
-        #
-        # @api private
-        def check_validation(value)
-          if validate? && value
-            value = value.to_s
-            if validation.is_a?(Regexp) && validation =~ value
-            elsif validation.is_a?(Proc) && validation.call(value)
-            else
-              fail InvalidArgument, "Invalid input for #{value}"
+        def call(input)
+          if validate? && input
+            input = input.to_s
+            if validation.is_a?(Regexp) && validation =~ input
+            elsif validation.is_a?(Proc) && validation.call(input)
+            else fail InvalidArgument, "Invalid input for #{input}"
             end
             true
           else