tty-reader 0.4.0 → 0.9.0

data/lib/tty/reader/console.rb

@@ -1,14 +1,17 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'keys'
-require_relative 'mode'
+require "io/wait"
+
+require_relative "keys"
+require_relative "mode"
 
 module TTY
   class Reader
     class Console
-      ESC = "\e".freeze
-      CSI = "\e[".freeze
+      ESC = "\e"
+      CSI = "\e["
+
+      TIMEOUT = 0.1
 
       # Key codes
       #
@@ -33,16 +36,25 @@ module TTY
 
       # Get a character from console with echo
       #
-      # @param [Hash[Symbol]] options
-      # @option options [Symbol] :echo
-      #   the echo toggle
+      # @param [Boolean] echo
+      #   whether to echo input back or not, defaults to true
+      # @param [Boolean] raw
+      #   whether to use raw mode or not, defaults to false
+      # @param [Boolean] nonblock
+      #   whether to wait for input or not, defaults to false
       #
       # @return [String]
       #
       # @api private
-      def get_char(options)
-        mode.raw(options[:raw]) do
-          mode.echo(options[:echo]) { input.getc }
+      def get_char(echo: true, raw: false, nonblock: false)
+        mode.raw(raw) do
+          mode.echo(echo) do
+            if nonblock
+              input.wait_readable(TIMEOUT) ? input.getc : nil
+            else
+              input.getc
+            end
+          end
         end
       end
 

data/lib/tty/reader/history.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module TTY
   class Reader
@@ -16,49 +15,72 @@ module TTY
       # Default maximum size
       DEFAULT_SIZE = 32 << 4
 
+      # Default exclude
+      DEFAULT_EXCLUDE = ->(line) { line.chomp == "" }
+
       def_delegators :@history, :size, :length, :to_s, :inspect
 
       # Set and retrieve the maximum size of the buffer
       attr_accessor :max_size
 
+      # The current index
+      #
+      # @return [Integer]
+      #
+      # @api private
       attr_reader :index
 
+      # Decides whether or not to allow cycling through stored lines.
+      #
+      # @return [Boolean]
+      #
+      # @api public
       attr_accessor :cycle
 
+      # Decides wether or not duplicate lines are stored.
+      #
+      # @return [Boolean]
+      #
+      # @api public
       attr_accessor :duplicates
 
+      # Dictates which lines are stored.
+      #
+      # @return [Proc]
+      #
+      # @public
       attr_accessor :exclude
 
       # Create a History buffer
       #
-      # param [Integer] max_size
+      # @param [Integer] max_size
       #   the maximum size for history buffer
-      #
-      # param [Hash[Symbol]] options
-      # @option options [Boolean] :cycle
+      # @param [Boolean] cycle
       #   whether or not the history should cycle, false by default
-      # @option options [Boolean] :duplicates
+      # @param [Boolean] duplicates
       #   whether or not to store duplicates, true by default
-      # @option options [Boolean] :exclude
+      # @param [Boolean] exclude
       #   a Proc to exclude items from storing in history
       #
       # @api public
-      def initialize(max_size = DEFAULT_SIZE, **options)
+      def initialize(max_size = DEFAULT_SIZE, duplicates: true, cycle: false,
+                     exclude: DEFAULT_EXCLUDE)
         @max_size   = max_size
         @index      = nil
         @history    = []
-        @duplicates = options.fetch(:duplicates) { true }
-        @exclude    = options.fetch(:exclude) { proc {} }
-        @cycle      = options.fetch(:cycle) { false }
+        @duplicates = duplicates
+        @exclude    = exclude
+        @cycle      = cycle
+
         yield self if block_given?
       end
 
       # Iterates over history lines
       #
       # @api public
-      def each
+      def each(&block)
         if block_given?
-          @history.each { |line| yield line }
+          @history.each(&block)
         else
           @history.to_enum
         end
@@ -86,6 +108,7 @@ module TTY
       # @api public
       def next
         return if size.zero?
+
         if @index == size - 1
           @index = 0 if @cycle
         else
@@ -100,6 +123,7 @@ module TTY
       # 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
@@ -122,7 +146,7 @@ module TTY
         end
         line = @history[index]
         if line.nil?
-          raise IndexError, 'invalid index'
+          raise IndexError, "invalid index"
         end
         line.dup
       end

data/lib/tty/reader/key_event.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'keys'
+require_relative "keys"
 
 module TTY
   class Reader
@@ -17,7 +16,7 @@ module TTY
     # Represents key event emitted during keyboard press
     #
     # @api public
-    class KeyEvent < Struct.new(:value, :key)
+    class KeyEvent < Struct.new(:key, :value, :line)
       # Create key event from read input codes
       #
       # @param [Hash[Symbol]] keys
@@ -27,7 +26,7 @@ module TTY
       # @return [KeyEvent]
       #
       # @api public
-      def self.from(keys, char)
+      def self.from(keys, char, line = "")
         key = Key.new
         key.name = (name = keys[char]) ? name : :ignore
 
@@ -43,7 +42,7 @@ module TTY
           key.ctrl = true
         end
 
-        new(char, key)
+        new(key, char, line)
       end
 
       # Check if key event can be triggered

data/lib/tty/reader/keys.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module TTY
@@ -14,12 +13,12 @@ module TTY
           ?\C-e => :ctrl_e,
           ?\C-f => :ctrl_f,
           ?\C-g => :ctrl_g,
-          ?\C-h => :ctrl_h, # identical to '\b'
-          ?\C-i => :ctrl_i, # identical to '\t'
-          ?\C-j => :ctrl_j, # identical to '\n'
+          ?\C-h => :ctrl_h, # identical to "\b"
+          ?\C-i => :ctrl_i, # identical to "\t"
+          ?\C-j => :ctrl_j, # identical to "\n"
           ?\C-k => :ctrl_k,
           ?\C-l => :ctrl_l,
-          ?\C-m => :ctrl_m, # identical to '\r'
+          ?\C-m => :ctrl_m, # identical to "\r"
           ?\C-n => :ctrl_n,
           ?\C-o => :ctrl_o,
           ?\C-p => :ctrl_p,
@@ -134,18 +133,18 @@ module TTY
           "\e" => :escape,
           " "  => :space,
           "\b" => :backspace,
-          [224, 71].pack('U*') => :home,
-          [224, 79].pack('U*') => :end,
-          [224, 82].pack('U*') => :insert,
-          [224, 83].pack('U*') => :delete,
-          [224, 73].pack('U*') => :page_up,
-          [224, 81].pack('U*') => :page_down,
+          [224, 71].pack("U*") => :home,
+          [224, 79].pack("U*") => :end,
+          [224, 82].pack("U*") => :insert,
+          [224, 83].pack("U*") => :delete,
+          [224, 73].pack("U*") => :page_up,
+          [224, 81].pack("U*") => :page_down,
 
-          [224, 72].pack('U*') => :up,
-          [224, 80].pack('U*') => :down,
-          [224, 77].pack('U*') => :right,
-          [224, 75].pack('U*') => :left,
-          [224, 83].pack('U*') => :clear,
+          [224, 72].pack("U*") => :up,
+          [224, 80].pack("U*") => :down,
+          [224, 77].pack("U*") => :right,
+          [224, 75].pack("U*") => :left,
+          [224, 83].pack("U*") => :clear,
 
           "\x00;" => :f1,
           "\x00<" => :f2,

data/lib/tty/reader/line.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module TTY
   class Reader
@@ -15,7 +15,7 @@ module TTY
       #
       # @api public
       def self.sanitize(text)
-        text.dup.gsub(ANSI_MATCHER, '')
+        text.dup.gsub(ANSI_MATCHER, "")
       end
 
       # The editable text
@@ -30,13 +30,19 @@ module TTY
       # @api public
       attr_reader :mode
 
+      # The prompt displayed before input
+      # @api public
       attr_reader :prompt
 
-      def initialize(prompt, text = '')
+      # Create a Line instance
+      #
+      # @api private
+      def initialize(text = "", prompt: "")
         @prompt = prompt.dup
         @text   = text.dup
         @cursor = [0, @text.length].max
         @mode   = :edit
+
         yield self if block_given?
       end
 
@@ -128,14 +134,18 @@ module TTY
       # @param [Integer] i
       #   the index to insert at
       #
+      # @param [String] chars
+      #   the characters to insert
+      #
       # @example
-      #   text = 'aaa'
-      #   line[5]= 'b'
-      #   => 'aaa  b'
+      #   text = "aaa"
+      #   line[5]= "b"
+      #   => "aaa  b"
       #
       # @api public
       def []=(i, chars)
         edit_mode
+
         if i.is_a?(Range)
           @text[i] = chars
           @cursor += chars.length
@@ -143,12 +153,9 @@ module TTY
         end
 
         if i <= 0
-          before_text = ''
+          before_text = ""
           after_text = @text.dup
-        elsif i == @text.length - 1
-          before_text = @text.dup
-          after_text = ''
-        elsif i > @text.length - 1
+        elsif i > @text.length - 1 # insert outside of line input
           before_text = @text.dup
           after_text = ?\s * (i - @text.length)
           @cursor += after_text.length
@@ -202,16 +209,19 @@ module TTY
       # Remove char from the line at current position
       #
       # @api public
-      def delete
-        @text.slice!(@cursor, 1)
+      def delete(n = 1)
+        @text.slice!(@cursor, n)
       end
 
       # Remove char from the line in front of the cursor
       #
+      # @param [Integer] n
+      #   the number of chars to remove
+      #
       # @api public
-      def remove
-        left
-        @text.slice!(@cursor, 1)
+      def remove(n = 1)
+        left(n)
+        @text.slice!(@cursor, n)
       end
 
       # Full line with prompt as string
@@ -226,7 +236,10 @@ module TTY
       #
       # @api public
       def prompt_size
-        self.class.sanitize(@prompt).size
+        p = self.class.sanitize(@prompt).split(/\r?\n/)
+        # return the length of each line + screen width for every line past the first
+        # which accounts for multi-line prompts
+        p.join.length + ((p.length - 1) * TTY::Screen.width )
       end
 
       # Text size

data/lib/tty/reader/mode.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'io/console'
+require "io/console"
 
 module TTY
   class Reader

data/lib/tty/reader/version.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Reader
-    VERSION = '0.4.0'.freeze
+    VERSION = "0.9.0"
   end # Reader
 end # TTY

data/lib/tty/reader/win_api.rb

@@ -1,16 +1,13 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'fiddle'
+require "fiddle"
 
 module TTY
   class Reader
     module WinAPI
       include Fiddle
 
-      Handle = RUBY_VERSION >= "2.0.0" ? Fiddle::Handle : DL::Handle
-
-      CRT_HANDLE = Handle.new("msvcrt") rescue Handle.new("crtdll")
+      CRT_HANDLE = Fiddle::Handle.new("msvcrt") rescue Fiddle::Handle.new("crtdll")
 
       # Get a character from the console without echo.
       #

data/lib/tty/reader/win_console.rb

@@ -1,14 +1,13 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'keys'
+require_relative "keys"
 
 module TTY
   class Reader
     class WinConsole
-      ESC     = "\e".freeze
-      NUL_HEX = "\x00".freeze
-      EXT_HEX = "\xE0".freeze
+      ESC     = "\e"
+      NUL_HEX = "\x00"
+      EXT_HEX = "\xE0"
 
       # Key codes
       #
@@ -25,7 +24,7 @@ module TTY
       attr_reader :escape_codes
 
       def initialize(input)
-        require_relative 'win_api'
+        require_relative "win_api"
         @input = input
         @keys = Keys.ctrl_keys.merge(Keys.win_keys)
         @escape_codes = [[NUL_HEX.ord], [ESC.ord], EXT_HEX.bytes.to_a]
@@ -33,26 +32,27 @@ module TTY
 
       # Get a character from console blocking for input
       #
-      # @param [Hash[Symbol]] options
-      # @option options [Symbol] :echo
-      #   the echo mode toggle
-      # @option options [Symbol] :raw
-      #   the raw mode toggle
+      # @param [Boolean] echo
+      #   whether to echo input back or not, defaults to true
+      # @param [Boolean] raw
+      #   whether to use raw mode or not, defaults to false
+      # @param [Boolean] nonblock
+      #   whether to wait for input or not, defaults to false
       #
       # @return [String]
       #
       # @api private
-      def get_char(options)
-        if options[:raw] && options[:echo]
-          if options[:nonblock]
+      def get_char(echo: true, raw: false, nonblock: false)
+        if raw && echo
+          if nonblock
             get_char_echo_non_blocking
           else
             get_char_echo_blocking
           end
-        elsif options[:raw] && !options[:echo]
-          options[:nonblock] ? get_char_non_blocking : get_char_blocking
-        elsif !options[:raw] && !options[:echo]
-          options[:nonblock] ? get_char_non_blocking : get_char_blocking
+        elsif raw && !echo
+          nonblock ? get_char_non_blocking : get_char_blocking
+        elsif !raw && !echo
+          nonblock ? get_char_non_blocking : get_char_blocking
         else
           @input.getc
         end