tty-prompt 0.11.0 → 0.12.0

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

@@ -44,8 +44,10 @@ module TTY
             escape:    "\e",
             space:     " ",
             backspace: ?\C-?,
+            home:      "\e[1~",
             insert:    "\e[2~",
             delete:    "\e[3~",
+            end:       "\e[4~",
             page_up:   "\e[5~",
             page_down: "\e[6~",
 
@@ -54,8 +56,6 @@ module TTY
             right:  "\e[C",
             left:   "\e[D",
             clear:  "\e[E",
-            end:    "\e[F",
-            home:   "\e[H",
 
             f1_xterm: "\eOP",
             f2_xterm: "\eOQ",
@@ -86,6 +86,8 @@ module TTY
             escape:    "\e",
             space:     " ",
             backspace: "\b",
+            home:      [224, 71].pack('U*'),
+            end:       [224, 79].pack('U*'),
             insert:    [224, 82].pack('U*'),
             delete:    [224, 83].pack('U*'),
             page_up:   [224, 73].pack('U*'),
@@ -96,8 +98,6 @@ module TTY
             right:  [224, 77].pack('U*'),
             left:   [224, 75].pack('U*'),
             clear:  [224, 83].pack('U*'),
-            end:    [224, 79].pack('U*'),
-            home:   [224, 71].pack('U*'),
 
             f1:  "\x00;",
             f2:  "\x00<",

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

@@ -26,7 +26,7 @@ module TTY
 
         def initialize(input)
           @input = input
-          @mode  = Mode.new
+          @mode  = Mode.new(input)
           @keys  = Codes.keys
           @escape_codes = [[ESC.ord], CSI.bytes.to_a]
         end

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

@@ -0,0 +1,145 @@
+# encoding: utf-8
+
+require 'forwardable'
+
+module TTY
+  class Prompt
+    class Reader
+      # A class responsible for storing a history of all lines entered by
+      # user when interacting with shell prompt.
+      #
+      # @api private
+      class History
+        include Enumerable
+        extend Forwardable
+
+        # Default maximum size
+        DEFAULT_SIZE = 32 << 4
+
+        def_delegators :@history, :size, :length, :to_s, :inspect
+
+        # Set and retrieve the maximum size of the buffer
+        attr_accessor :max_size
+
+        attr_reader :index
+
+        attr_accessor :cycle
+
+        attr_accessor :duplicates
+
+        attr_accessor :exclude
+
+        # Create a History buffer
+        #
+        # param [Integer] max_size
+        #   the maximum size for history buffer
+        #
+        # param [Hash[Symbol]] options
+        # @option options [Boolean] :duplicates
+        #   whether or not to store duplicates, true by default
+        #
+        # @api public
+        def initialize(max_size = DEFAULT_SIZE, options = {})
+          @max_size   = max_size
+          @index      = 0
+          @history    = []
+          @duplicates = options.fetch(:duplicates) { true }
+          @exclude    = options.fetch(:exclude) { proc {} }
+          @cycle      = options.fetch(:cycle) { false }
+          yield self if block_given?
+        end
+
+        # Iterates over history lines
+        #
+        # @api public
+        def each
+          if block_given?
+            @history.each { |line| yield line }
+          else
+            @history.to_enum
+          end
+        end
+
+        # Add the last typed line to history buffer
+        #
+        # @param [String] line
+        #
+        # @api public
+        def push(line)
+          @history.delete(line) unless @duplicates
+          return if line.to_s.empty? || @exclude[line]
+
+          @history.shift if size >= max_size
+          @history << line
+          @index = @history.size - 1
+
+          self
+        end
+        alias << push
+
+        # Move the pointer to the next line in the history
+        #
+        # @api public
+        def next
+          return if size.zero?
+          if @index == size - 1
+            @index = 0 if @cycle
+          else
+            @index += 1
+          end
+        end
+
+        def next?
+          size > 0 && !(@index == size - 1 && !@cycle)
+        end
+
+        # Move the pointer to the previous line in the history
+        def previous
+          return if size.zero?
+          if @index.zero?
+            @index = size - 1 if @cycle
+          else
+            @index -= 1
+          end
+        end
+
+        def previous?
+          size > 0 && !(@index < 0 && !@cycle)
+        end
+
+        # Return line at the specified index
+        #
+        # @raise [IndexError] index out of range
+        #
+        # @api public
+        def [](index)
+          if index < 0
+            index += @history.size if index < 0
+          end
+          line = @history[index]
+          if line.nil?
+            raise IndexError, 'invalid index'
+          end
+          line.dup
+        end
+
+        # Get current line
+        #
+        # @api public
+        def get
+          return if size.zero?
+
+          self[@index]
+        end
+
+        # Empty all history lines
+        #
+        # @api public
+        def clear
+          @history.clear
+          @index = 0
+        end
+      end # History
+    end # Reader
+  end # Prompt
+end # TTY

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

@@ -49,9 +49,13 @@ module TTY
           when keys[:down]  then key.name = :down
           when keys[:left]  then key.name = :left
           when keys[:right] then key.name = :right
+          # editing
           when keys[:clear] then key.name = :clear
           when keys[:end]   then key.name = :end
           when keys[:home]  then key.name = :home
+          when keys[:insert]    then key.name = :insert
+          when keys[:page_up]   then key.name = :page_up
+          when keys[:page_down] then key.name = :page_down
           when proc { |cs| ctrls.any? { |name| keys[name] == cs } }
             key.name = keys.key(char)
             key.ctrl = true

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

@@ -0,0 +1,162 @@
+# encoding: utf-8
+
+require 'forwardable'
+
+module TTY
+  class Prompt
+    class Reader
+      class Line
+        extend Forwardable
+
+        def_delegators :@text, :size, :length, :to_s, :inspect,
+                       :slice!, :empty?
+
+        attr_accessor :text
+
+        attr_accessor :cursor
+
+        def initialize(text = "")
+          @text = text
+          @cursor = [0, @text.length].max
+          yield self if block_given?
+        end
+
+        # Check if cursor reached beginning of the line
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        def start?
+          @cursor == 0
+        end
+
+        # Check if cursor reached end of the line
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        def end?
+          @cursor == @text.length
+        end
+
+        # Move line position to the left by n chars
+        #
+        # @api public
+        def left(n = 1)
+          @cursor = [0, @cursor - n].max
+        end
+
+        # Move line position to the right by n chars
+        #
+        # @api public
+        def right(n = 1)
+          @cursor = [@text.length, @cursor + n].min
+        end
+
+        # Move cursor to beginning position
+        #
+        # @api public
+        def move_to_start
+          @cursor = 0
+        end
+
+        # Move cursor to end position
+        #
+        # @api public
+        def move_to_end
+          @cursor = @text.length # put cursor outside of text
+        end
+
+        # Insert characters inside a line. When the lines exceeds
+        # maximum length, an extra space is added to accomodate index.
+        #
+        # @param [Integer] i
+        #   the index to insert at
+        #
+        # @example
+        #   text = 'aaa'
+        #   line[5]= 'b'
+        #   => 'aaa  b'
+        #
+        # @api public
+        def []=(i, chars)
+          if i.is_a?(Range)
+            @text[i] = chars
+            @cursor += chars.length
+            return
+          end
+
+          if i <= 0
+            before_text = ''
+            after_text = @text.dup
+          elsif i == @text.length - 1
+            before_text = @text.dup
+            after_text = ''
+          elsif i > @text.length - 1
+            before_text = @text.dup
+            after_text = ?\s * (i - @text.length)
+            @cursor += after_text.length
+          else
+            before_text = @text[0..i-1].dup
+            after_text  = @text[i..-1].dup
+          end
+
+          if i > @text.length - 1
+            @text = before_text << after_text << chars
+          else
+            @text = before_text << chars << after_text
+          end
+
+          @cursor = i + chars.length
+        end
+
+        # Read character
+        #
+        # @api public
+        def [](i)
+          @text[i]
+        end
+
+        # Replace current line with new text
+        #
+        # @param [String] text
+        #
+        # @api public
+        def replace(text)
+          @text = text
+          @cursor = @text.length # put cursor outside of text
+        end
+
+        # Insert char(s) at cursor position
+        #
+        # @api public
+        def insert(chars)
+          self[@cursor] = chars
+        end
+
+        # Add char and move cursor
+        #
+        # @api public
+        def <<(char)
+          @text << char
+          @cursor += 1
+        end
+
+        # Remove char from the line at current position
+        #
+        # @api public
+        def delete
+          @text.slice!(@cursor, 1)
+        end
+
+        # Remove char from the line in front of the cursor
+        #
+        # @api public
+        def remove
+          left
+          @text.slice!(@cursor, 1)
+        end
+      end # Line
+    end # Reader
+  end # Prompt
+end # TTY

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

@@ -19,7 +19,7 @@ module TTY
         #
         # @api public
         def echo(is_on = true, &block)
-          if is_on
+          if is_on || !@input.tty?
             yield
           else
             @input.noecho(&block)
@@ -32,7 +32,7 @@ module TTY
         #
         # @api public
         def raw(is_on = true, &block)
-          if is_on
+          if is_on && @input.tty?
             @input.raw(&block)
           else
             yield

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

@@ -41,7 +41,11 @@ module TTY
         #
         # @api private
         def get_char(options)
-          options[:echo] ? @input.getc : WinAPI.getch.chr
+          if options[:raw]
+            WinAPI.getch.chr
+          else
+            options[:echo] ? @input.getc : WinAPI.getch.chr
+          end
         end
       end # Console
     end # Reader

data/lib/tty/prompt/slider.rb

@@ -109,48 +109,54 @@ module TTY
       def render
         @prompt.print(@prompt.hide)
         until @done
-          render_question
+          question = render_question
+          @prompt.print(question)
           @prompt.read_keypress
-          refresh
+          refresh(question.lines.count)
         end
-        render_question
-        answer = render_answer
+        @prompt.print(render_question)
+        answer
       ensure
         @prompt.print(@prompt.show)
-        answer
       end
 
       # Clear screen
       #
+      # @param [Integer] lines
+      #   the lines to clear
+      #
       # @api private
-      def refresh
-        lines = @question.scan("\n").length + 2
+      def refresh(lines)
         @prompt.print(@prompt.clear_lines(lines))
       end
 
       # @return [Integer]
       #
       # @api private
-      def render_answer
+      def answer
         range[@active]
       end
 
       # Render question with the slider
       #
+      # @return [String]
+      #
       # @api private
       def render_question
-        header = "#{@prefix}#{@question} #{render_header}"
-        @prompt.puts(header)
+        header = "#{@prefix}#{@question} #{render_header}\n"
         @first_render = false
-        @prompt.print(render_slider) unless @done
+        header << render_slider unless @done
+        header
       end
 
       # Render actual answer or help
       #
+      # @return [String]
+      #
       # @api private
       def render_header
         if @done
-          @prompt.decorate(render_answer.to_s, @active_color)
+          @prompt.decorate(answer.to_s, @active_color)
         elsif @first_render
           @prompt.decorate(HELP, @help_color)
         end