tty-prompt 0.10.1 → 0.11.0

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

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require_relative 'codes'
+require_relative 'mode'
+
+module TTY
+  class Prompt
+    class Reader
+      class Console
+        ESC = "\e".freeze
+        CSI = "\e[".freeze
+
+        # Key codes
+        #
+        # @return [Hash[Symbol]]
+        #
+        # @api public
+        attr_reader :keys
+
+        # Escape codes
+        #
+        # @return [Array[Integer]]
+        #
+        # @api public
+        attr_reader :escape_codes
+
+        def initialize(input)
+          @input = input
+          @mode  = Mode.new
+          @keys  = Codes.keys
+          @escape_codes = [[ESC.ord], CSI.bytes.to_a]
+        end
+
+        # Get a character from console with echo
+        #
+        # @param [Hash[Symbol]] options
+        # @option options [Symbol] :echo
+        #   the echo toggle
+        #
+        # @return [String]
+        #
+        # @api private
+        def get_char(options)
+          mode.raw(options[:raw]) do
+            mode.echo(options[:echo]) { input.getc }
+          end
+        end
+
+        protected
+
+        attr_reader :mode
+
+        attr_reader :input
+      end # Console
+    end # Reader
+  end # Prompt
+end # TTY

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

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'tty/prompt/reader/codes'
-
 module TTY
   class Prompt
     class Reader
@@ -10,10 +8,7 @@ module TTY
       # @api private
       class Key < Struct.new(:name, :ctrl, :meta, :shift)
         def initialize(*)
-          super
-          @ctrl = false
-          @meta = false
-          @shift = false
+          super(nil, false, false, false)
         end
       end
 
@@ -21,101 +16,69 @@ module TTY
       #
       # @api public
       class KeyEvent < Struct.new(:value, :key)
-        META_KEY_CODE_RE = /^(?:\e+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/
-
-        def self.from(char)
+        # Create key event from read input codes
+        #
+        # @param [Hash[Symbol]] keys
+        #   the keys and codes mapping
+        # @param [Array[Integer]] codes
+        #
+        # @return [KeyEvent]
+        #
+        # @api public
+        def self.from(keys, char)
           key = Key.new
+          ctrls = keys.keys.grep(/ctrl/)
 
           case char
-          when Codes::RETURN   then key.name = :return
-          when Codes::LINEFEED then key.name = :enter
-          when Codes::TAB      then key.name = :tab
-          when Codes::BACKSPACE, Codes::CTRL_H,
-              "#{Codes::ESCAPE}#{Codes::BACKSPACE}",
-              "#{Codes::ESCAPE}#{Codes::CTRL_H}"
-            key.name = :backspace
-            key.meta = (char.chars.to_a[0] == Codes::ESCAPE)
-          when Codes::DELETE   then key.name = :delete
-          when Codes::SPACE, "#{Codes::ESCAPE}#{Codes::SPACE}"
-            key.name = :space
-            key.meta = (char.size == 2)
-          when Codes::ESCAPE, "#{Codes::ESCAPE}#{Codes::ESCAPE}"
-            key.name = :escape
-            key.meta = (char.size == 2)
-          when proc { |c| c.length == 1 && c =~ /[a-z]/ }
-            key.name = char
-          when proc { |c| c.length == 1 && c =~ /[A-Z]/ }
-            key.name = char.downcase
+          when keys[:return] then key.name = :return
+          when keys[:enter]  then key.name = :enter
+          when keys[:tab]    then key.name = :tab
+          when keys[:backspace] then key.name = :backspace
+          when keys[:delete] then key.name = :delete
+          when keys[:space]  then key.name = :space
+          when keys[:escape] then key.name = :escape
+          when proc { |c| c =~ /^[a-z]{1}$/ }
+            key.name = :alpha
+          when proc { |c| c =~ /^[A-Z]{1}$/ }
+            key.name = :alpha
             key.shift = true
-          when /^\d+$/
+          when proc { |c| c =~ /^\d+$/ }
             key.name = :num
-          when META_KEY_CODE_RE # ansi escape
-            parts = META_KEY_CODE_RE.match(char)
-            code = "#{parts[1]}#{parts[2]}#{parts[4]}#{parts[6]}"
-            modifier = (parts[3] || parts[5] || 1) - 1
-
-            key.ctrl = (modifier & 4) != 0
-            key.meta = (modifier & 10) != 0
-            key.shift = (modifier & 1) != 0
-
-            case code
-            # f1 - f12
-            when Codes::F1_XTERM, Codes::F1_GNOME, Codes::F1_WIN then key.name = :f1
-            when Codes::F2_XTERM, Codes::F2_GNOME, Codes::F2_WIN then key.name = :f2
-            when Codes::F3_XTERM, Codes::F3_GNOME, Codes::F3_WIN then key.name = :f3
-            when Codes::F4_XTERM, Codes::F4_GNOME, Codes::F4_WIN then key.name = :f4
-            when Codes::F5, Codes::F5_WIN then key.name = :f5
-            when Codes::F6 then key.name = :f6
-            when Codes::F7 then key.name = :f7
-            when Codes::F8 then key.name = :f8
-            when Codes::F9 then key.name = :f9
-            when Codes::F10 then key.name = :f10
-            when Codes::F11 then key.name = :f11
-            when Codes::F12 then key.name = :f12
-            # navigation
-            when Codes::KEY_UP, Codes::KEY_UP_XTERM,
-                 Codes::CTRL_K, Codes::CTRL_P
-              key.name = :up
-            when Codes::KEY_UP_SHIFT then key.name = :up; key.shift = true
-            when Codes::KEY_UP_CTRL  then key.name = :up; key.ctrl  = true
-
-            when Codes::KEY_DOWN, Codes::KEY_DOWN_XTERM,
-                 Codes::CTRL_J, Codes::CTRL_N
-              key.name = :down
-            when Codes::KEY_DOWN_SHIFT then key.name = :down; key.shift = true
-            when Codes::KEY_DOWN_CTRL  then key.name = :down; key.ctrl = true
-
-            when Codes::KEY_RIGHT, Codes::KEY_RIGHT_XTERM, Codes::CTRL_L
-              key.name = :right
-            when Codes::KEY_RIGHT_SHIFT then key.name = :right; key.shift = true
-            when Codes::KEY_RIGHT_CTRL  then key.name = :right; key.ctrl = true
-
-            when Codes::KEY_LEFT, Codes::KEY_LEFT_XTERM, Codes::CTRL_H
-              key.name = :left
-            when Codes::KEY_LEFT_SHIFT then key.name = :left; key.shift = true
-            when Codes::KEY_LEFT_CTRL  then key.name = :left; key.ctrl = true
-
-            when Codes::KEY_CLEAR, Codes::KEY_CLEAR_XTERM
-              key.name = :clear
-            when Codes::KEY_CLEAR_SHIFT then key.name = :clear; key.shift = true
-            when Codes::KEY_CLEAR_CTRL  then key.name = :clear; key.ctrl = true
-
-            when Codes::KEY_END, Codes::KEY_END_XTERM
-              key.name = :end
-
-            when Codes::KEY_HOME, Codes::KEY_HOME_XTERM
-              key.name = :home
-            end
+          # arrows
+          when keys[:up]    then key.name = :up
+          when keys[:down]  then key.name = :down
+          when keys[:left]  then key.name = :left
+          when keys[:right] then key.name = :right
+          when keys[:clear] then key.name = :clear
+          when keys[:end]   then key.name = :end
+          when keys[:home]  then key.name = :home
+          when proc { |cs| ctrls.any? { |name| keys[name] == cs } }
+            key.name = keys.key(char)
+            key.ctrl = true
+          # f1 - f12
+          when keys[:f1], keys[:f1_xterm] then key.name = :f1
+          when keys[:f2], keys[:f2_xterm] then key.name = :f2
+          when keys[:f3], keys[:f3_xterm] then key.name = :f3
+          when keys[:f4], keys[:f4_xterm] then key.name = :f4
+          when keys[:f5] then key.name = :f5
+          when keys[:f6] then key.name = :f6
+          when keys[:f7] then key.name = :f7
+          when keys[:f8] then key.name = :f8
+          when keys[:f9] then key.name = :f9
+          when keys[:f10] then key.name = :f10
+          when keys[:f11] then key.name = :f11
+          when keys[:f12] then key.name = :f12
           end
+
           new(char, key)
         end
 
-        # Check if key event can be emitted
+        # Check if key event can be triggered
         #
         # @return [Boolean]
         #
         # @api public
-        def emit?
+        def trigger?
           !key.nil? && !key.name.nil?
         end
       end # KeyEvent

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

@@ -19,11 +19,11 @@ module TTY
         #
         # @api public
         def echo(is_on = true, &block)
-          previous = @input.echo?
-          @input.echo = is_on
-          yield
-        ensure
-          @input.echo = previous
+          if is_on
+            yield
+          else
+            @input.noecho(&block)
+          end
         end
 
         # Use raw mode in the given block

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

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'fiddle'
+
+module TTY
+  class Prompt
+    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")
+
+        def getch
+          @@getch ||= Fiddle::Function.new(CRT_HANDLE["_getch"], [], TYPE_INT)
+          @@getch.call
+        end
+        module_function :getch
+
+        def getche
+          @@getche ||= Fiddle::Function.new(CRT_HANDLE["_getche"], [], TYPE_INT)
+          @@getche.call
+        end
+        module_function :getche
+      end # WinAPI
+    end # Reader
+  end # Prompt
+end # TTY

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

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require_relative 'codes'
+
+module TTY
+  class Prompt
+    class Reader
+      class WinConsole
+        ESC     = "\e".freeze
+        NUL_HEX = "\x00".freeze
+        EXT_HEX = "\xE0".freeze
+
+        # Key codes
+        #
+        # @return [Hash[Symbol]]
+        #
+        # @api public
+        attr_reader :keys
+
+        # Escape codes
+        #
+        # @return [Array[Integer]]
+        #
+        # @api public
+        attr_reader :escape_codes
+
+        def initialize(input)
+          require_relative 'win_api'
+          @input = input
+          @keys = Codes.win_keys
+          @escape_codes = [[NUL_HEX.ord], [ESC.ord], EXT_HEX.bytes.to_a]
+        end
+
+        # Get a character from console with echo
+        #
+        # @param [Hash[Symbol]] options
+        # @option options [Symbol] :echo
+        #   the echo toggle
+        #
+        # @return [String]
+        #
+        # @api private
+        def get_char(options)
+          options[:echo] ? @input.getc : WinAPI.getch.chr
+        end
+      end # Console
+    end # Reader
+  end # Prompt
+end # TTY

data/lib/tty/prompt/slider.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative 'symbols'
+
 module TTY
   # A class responsible for shell prompt interactions.
   class Prompt
@@ -7,6 +9,8 @@ module TTY
     #
     # @api public
     class Slider
+      include Symbols
+
       HELP = '(Use arrow keys, press Enter to select)'.freeze
 
       # Initailize a Slider
@@ -88,7 +92,7 @@ module TTY
       alias_method :keydown, :keyleft
 
       def keyright(*)
-        @active += 1 if (@active + @step) <= range.size
+        @active += 1 if (@active + @step) < range.size
       end
       alias_method :keyup, :keyright
 
@@ -159,11 +163,11 @@ module TTY
       # @api private
       def render_slider
         output = ''
-        output << Symbols::SLIDER_END
-        output << '-' * @active
-        output << @prompt.decorate(Symbols::SLIDER_HANDLE, @active_color)
-        output << '-' * (range.size - @active - 1)
-        output << Symbols::SLIDER_END
+        output << symbols[:pipe]
+        output << symbols[:line] * @active
+        output << @prompt.decorate(symbols[:handle], @active_color)
+        output << symbols[:line] * (range.size - @active - 1)
+        output << symbols[:pipe]
         output << " #{range[@active]}"
         output
       end

data/lib/tty/prompt/suggestion.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'tty/prompt/distance'
+require_relative 'distance'
 
 module TTY
   # A class responsible for terminal prompt interactions.

data/lib/tty/prompt/symbols.rb

@@ -2,18 +2,60 @@
 
 module TTY
   class Prompt
+    # Cross platform common Unicode symbols.
+    #
+    # @api public
     module Symbols
-      SPACE   = " "
-      SUCCESS = "✓"
-      FAILURE = "✘"
+      KEYS = {
+        tick: '✓',
+        cross: '✘',
+        star: '★',
+        dot: '•',
+        pointer: '‣',
+        line: '─',
+        pipe: '|',
+        handle: 'O',
+        ellipsis: '…',
+        radio_on: '⬢',
+        radio_off: '⬡',
+        checkbox_on: '☒',
+        checkbox_off: '☐',
+        circle_on: 'ⓧ',
+        circle_off: 'Ⓘ'
+      }.freeze
 
-      ITEM_SECURE     = "•"
-      ITEM_SELECTED   = "‣"
-      RADIO_CHECKED   = "⬢"
-      RADIO_UNCHECKED = "⬡"
-      SLIDER_HANDLE   = 'O'
-      SLIDER_RANGE    = '-'
-      SLIDER_END      = '|'
+      WIN_KEYS = {
+        tick: '√',
+        cross: '×',
+        star: '*',
+        dot: '.',
+        pointer: '>',
+        line: '-',
+        pipe: '|',
+        handle: 'O',
+        ellipsis: '...',
+        radio_on: '(*)',
+        radio_off: '( )',
+        checkbox_on: '[×]',
+        checkbox_off: '[ ]',
+        circle_on: '(x)',
+        circle_off: '( )'
+      }.freeze
+
+      def symbols
+        @symbols ||= windows? ? WIN_KEYS : KEYS
+      end
+      module_function :symbols
+
+      # Check if Windowz
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def windows?
+        ::File::ALT_SEPARATOR == "\\"
+      end
+      module_function :windows?
     end # Symbols
   end # Prompt
 end # TTY