Merge pull request #79 from nguyenquangminh0711/refactor/improve-key-bindings

Key bindings customization

Author: 0x2c7

.github/workflows/rspec.yml

@@ -38,7 +38,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7.1, head]
+        ruby: [2.5, 2.6, 2.7.2, head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -73,7 +73,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7.1, head]
+        ruby: [2.5, 2.6, 2.7.2, head]
     env:
       CI_PLATFORM: "macos"
     runs-on: macos-latest

.rubocop.yml

@@ -83,6 +83,8 @@ Style/NilComparison:
   Enabled: false
 Style/NonNilCheck:
   Enabled: false
+Style/WordArray:
+  Enabled: false
 
 RSpec/MultipleExpectations:
   Enabled: false

Gemfile

@@ -22,6 +22,5 @@ group :test do
   gem 'parallel_tests'
   gem 'reline', require: false
   gem 'rspec-retry'
-  gem 'simplecov', require: false
   gem 'sqlite3'
 end

lib/ruby_jard.rb

@@ -9,8 +9,8 @@
 require 'ruby_jard/path_classifier'
 require 'ruby_jard/path_filter'
 require 'ruby_jard/control_flow'
-require 'ruby_jard/config'
 require 'ruby_jard/keys'
+require 'ruby_jard/config'
 require 'ruby_jard/key_binding'
 require 'ruby_jard/key_bindings'
 require 'ruby_jard/repl_processor'
@@ -81,16 +81,6 @@ def self.error(exception)
     # Ignore
   end
 
-  def self.global_key_bindings
-    return @global_key_bindings if defined?(@global_key_bindings)
-
-    @global_key_bindings = RubyJard::KeyBindings.new
-    RubyJard::Keys::DEFAULT_KEY_BINDINGS.each do |sequence, action|
-      @global_key_bindings.push(sequence, action)
-    end
-    @global_key_bindings
-  end
-
   def self.config
     @config ||= RubyJard::Config.smart_load
   end

lib/ruby_jard/config.rb

@@ -39,7 +39,7 @@ def load_config(config, path)
     end
 
     attr_accessor :color_scheme, :alias_to_debugger, :layout
-    attr_reader :enabled_screens, :filter_version, :filter, :filter_included, :filter_excluded
+    attr_reader :enabled_screens, :filter_version, :filter, :filter_included, :filter_excluded, :key_bindings
 
     CONFIG_FILE_NAME = '.jardrc'
     DEFAULTS = [
@@ -48,7 +48,19 @@ def load_config(config, path)
       DEFAULT_LAYOUT = nil, # Pick layout automatically
       DEFAULT_FILTER = RubyJard::PathFilter::FILTER_APPLICATION,
       DEFAULT_FILTER_INCLUDED = [].freeze,
-      DEFAULT_FILTER_EXCLUDED = [].freeze
+      DEFAULT_FILTER_EXCLUDED = [].freeze,
+      DEFAULT_KEY_BINDINGS = {
+        RubyJard::Keys::F2       => 'jard filter switch',
+        RubyJard::Keys::F5       => 'list',
+        RubyJard::Keys::F6       => 'up',
+        RubyJard::Keys::SHIFT_F6 => 'down',
+        RubyJard::Keys::F7       => 'step',
+        RubyJard::Keys::SHIFT_F7 => 'step-out',
+        RubyJard::Keys::F8       => 'next',
+        RubyJard::Keys::F9       => 'continue',
+        RubyJard::Keys::CTRL_D   => 'continue',
+        RubyJard::Keys::CTRL_C   => 'interrupt'
+      }.freeze
     ].freeze
 
     def initialize
@@ -62,6 +74,8 @@ def initialize
       @alias_to_debugger = DEFAULT_ALIAS_TO_DEBUGGER.freeze
       @layout = DEFAULT_LAYOUT.freeze
       @enabled_screens = RubyJard::Screens.names.dup.freeze
+
+      @key_bindings = RubyJard::KeyBindings.new(DEFAULT_KEY_BINDINGS)
     end
 
     def config
@@ -86,5 +100,9 @@ def filter_included=(input)
       @filter_version += 1
       @filter_included = input.freeze
     end
+
+    def key_bindings=(sequences)
+      @key_bindings = RubyJard::KeyBindings.new(sequences)
+    end
   end
 end

lib/ruby_jard/key_bindings.rb

@@ -6,30 +6,15 @@ module RubyJard
   # match a key binding sequence from input.
   # As this class is performant-sensitive, a lookup tree is built
   # and updated whenever a new key is added.
-  # TODO: Write tests for this file
   class KeyBindings
-    attr_reader :indexes
+    attr_reader :indexes, :key_bindings
 
-    def initialize
+    def initialize(sequences = [])
       @key_bindings = []
       @indexes = {}
-    end
-
-    def to_a
-      @key_bindings.dup
-    end
-
-    def push(sequence, action)
-      if sequence.is_a?(Array)
-        sequence.each { |s| push(s, action) }
-        return
+      sequences.each do |sequence, action|
+        push(sequence, action)
       end
-
-      raise RubyJard::Error if sequence.to_s.empty?
-
-      key_binding = RubyJard::KeyBinding.new(sequence, action)
-      reindex(key_binding)
-      @key_bindings << key_binding
     end
 
     def match(&read_key)
@@ -56,8 +41,8 @@ def match(&read_key)
           elsif node[byte].nil?
             # It's sure that no more bindings to match
             return buffer
-          elsif buffer == node[byte].sequence
-            # Exact match current key binding
+          elsif buffer.start_with?(node[byte].sequence)
+            # Match current key binding. Discard the rest
             return node[byte]
           else
             return buffer
@@ -68,6 +53,19 @@ def match(&read_key)
 
     private
 
+    def push(sequence, action)
+      if sequence.is_a?(Array)
+        sequence.each { |s| push(s, action) }
+        return
+      end
+
+      raise RubyJard::Error if sequence.to_s.empty?
+
+      key_binding = RubyJard::KeyBinding.new(sequence, action)
+      reindex(key_binding)
+      @key_bindings << key_binding
+    end
+
     def reindex(key_binding)
       parent = nil
       node = @indexes

lib/ruby_jard/keys.rb

@@ -6,8 +6,7 @@ module RubyJard
   class Keys
     # X-Term: https://invisible-island.net/xterm/xterm-function-keys.html
     END_LINE = ["\n", "\r\n", "\r"].freeze
-    CTRL_C = "\u0003"
-    CTRL_D = "\u0004"
+    ESC = "\e"
 
     F1 = "\eOP"
     F2 = "\eOQ"
@@ -34,16 +33,172 @@ class Keys
     SHIFT_F10 = "\e[21;2~"
     SHIFT_F11 = "\e[23;2~"
     SHIFT_F12 = "\e[24;2~"
-    DEFAULT_KEY_BINDINGS = {
-      F2       => (ACTION_FILTER   = 'jard filter switch'),
-      F5       => (ACTION_LIST     = 'list'),
-      F6       => (ACTION_UP       = 'up'),
-      SHIFT_F6 => (ACTION_DOWN     = 'down'),
-      F7       => (ACTION_STEP     = 'step'),
-      SHIFT_F7 => (ACTION_STEP_OUT = 'step-out'),
-      F8       => (ACTION_NEXT     = 'next'),
-      F9       => (ACTION_CONTINUE = 'continue'),
-      CTRL_D   => ACTION_CONTINUE
-    }.freeze
+
+    CTRL_A = "\C-a"
+    CTRL_B = "\C-b"
+    CTRL_C = "\C-c"
+    CTRL_D = "\C-d"
+    CTRL_E = "\C-e"
+    CTRL_F = "\C-f"
+    CTRL_G = "\C-g"
+    CTRL_H = "\C-h"
+    CTRL_I = "\C-i"
+    CTRL_J = "\C-j"
+    CTRL_K = "\C-k"
+    CTRL_L = "\C-l"
+    CTRL_M = "\C-m"
+    CTRL_N = "\C-n"
+    CTRL_O = "\C-o"
+    CTRL_P = "\C-p"
+    CTRL_Q = "\C-q"
+    CTRL_R = "\C-r"
+    CTRL_S = "\C-s"
+    CTRL_T = "\C-t"
+    CTRL_U = "\C-u"
+    CTRL_V = "\C-v"
+    CTRL_W = "\C-w"
+    CTRL_X = "\C-x"
+    CTRL_Y = "\C-y"
+    CTRL_Z = "\C-z"
+
+    CTRL_F1 = "\e[1;5P"
+    CTRL_F2 = "\e[1;5Q"
+    CTRL_F3 = "\e[1;5R"
+    CTRL_F4 = "\e[1;5S"
+    CTRL_F5 = "\e[15;5~"
+    CTRL_F6 = "\e[17;5~"
+    CTRL_F7 = "\e[18;5~"
+    CTRL_F8 = "\e[19;5~"
+    CTRL_F9 = "\e[20;5~"
+    CTRL_F10 = "\e[21;5~"
+    CTRL_F11 = "\e[23;5~"
+    CTRL_F12 = "\e[24;5~"
+
+    CTRL_SHIFT_F1 = "\e[1;6P"
+    CTRL_SHIFT_F2 = "\e[1;6Q"
+    CTRL_SHIFT_F3 = "\e[1;6R"
+    CTRL_SHIFT_F4 = "\e[1;6S"
+    CTRL_SHIFT_F5 = "\e[15;6~"
+    CTRL_SHIFT_F6 = "\e[17;6~"
+    CTRL_SHIFT_F7 = "\e[18;6~"
+    CTRL_SHIFT_F8 = "\e[19;6~"
+    CTRL_SHIFT_F9 = "\e[20;6~"
+    CTRL_SHIFT_F10 = "\e[21;6~"
+    CTRL_SHIFT_F11 = "\e[23;6~"
+    CTRL_SHIFT_F12 = "\e[24;6~"
+
+    META_A = "\ea"
+    META_B = "\eb"
+    META_C = "\ec"
+    META_D = "\ed"
+    META_E = "\ee"
+    META_F = "\ef"
+    META_G = "\eg"
+    META_H = "\eh"
+    META_I = "\ei"
+    META_J = "\ej"
+    META_K = "\ek"
+    META_L = "\el"
+    META_M = "\em"
+    META_N = "\en"
+    META_O = "\eo"
+    META_P = "\ep"
+    META_Q = "\eq"
+    META_R = "\er"
+    META_S = "\es"
+    META_T = "\et"
+    META_U = "\eu"
+    META_V = "\ev"
+    META_W = "\ew"
+    META_X = "\ex"
+    META_Y = "\ey"
+    META_Z = "\ez"
+
+    META_F1 = "\e[1;3P"
+    META_F2 = "\e[1;3Q"
+    META_F3 = "\e[1;3R"
+    META_F4 = "\e[1;3S"
+    META_F5 = "\e[15;3~"
+    META_F6 = "\e[17;3~"
+    META_F7 = "\e[18;3~"
+    META_F8 = "\e[19;3~"
+    META_F9 = "\e[20;3~"
+    META_F10 = "\e[21;3~"
+    META_F11 = "\e[23;3~"
+    META_F12 = "\e[24;3~"
+
+    META_SHIFT_A = "\eA"
+    META_SHIFT_B = "\eB"
+    META_SHIFT_C = "\eC"
+    META_SHIFT_D = "\eD"
+    META_SHIFT_E = "\eE"
+    META_SHIFT_F = "\eF"
+    META_SHIFT_G = "\eG"
+    META_SHIFT_H = "\eH"
+    META_SHIFT_I = "\eI"
+    META_SHIFT_J = "\eJ"
+    META_SHIFT_K = "\eK"
+    META_SHIFT_L = "\eL"
+    META_SHIFT_M = "\eM"
+    META_SHIFT_N = "\eN"
+    META_SHIFT_O = "\eO"
+    META_SHIFT_P = "\eP"
+    META_SHIFT_Q = "\eQ"
+    META_SHIFT_R = "\eR"
+    META_SHIFT_S = "\eS"
+    META_SHIFT_T = "\eT"
+    META_SHIFT_U = "\eU"
+    META_SHIFT_V = "\eV"
+    META_SHIFT_W = "\eW"
+    META_SHIFT_X = "\eX"
+    META_SHIFT_Y = "\eY"
+    META_SHIFT_Z = "\eZ"
+
+    META_SHIFT_F1 = "\e[1;4P"
+    META_SHIFT_F2 = "\e[1;4Q"
+    META_SHIFT_F3 = "\e[1;4R"
+    META_SHIFT_F4 = "\e[1;4S"
+    META_SHIFT_F5 = "\e[15;4~"
+    META_SHIFT_F6 = "\e[17;4~"
+    META_SHIFT_F7 = "\e[18;4~"
+    META_SHIFT_F8 = "\e[19;4~"
+    META_SHIFT_F9 = "\e[20;4~"
+    META_SHIFT_F10 = "\e[21;4~"
+    META_SHIFT_F11 = "\e[23;4~"
+    META_SHIFT_F12 = "\e[24;4~"
+
+    CTRL_META_A = "\e\C-a"
+    CTRL_META_B = "\e\C-b"
+    CTRL_META_C = "\e\C-c"
+    CTRL_META_D = "\e\C-d"
+    CTRL_META_E = "\e\C-e"
+    CTRL_META_F = "\e\C-f"
+    CTRL_META_G = "\e\C-g"
+    CTRL_META_H = "\e\C-h"
+    CTRL_META_I = "\e\C-i"
+    CTRL_META_J = "\e\C-j"
+    CTRL_META_K = "\e\C-k"
+    CTRL_META_L = "\e\C-l"
+    CTRL_META_M = "\e\C-m"
+    CTRL_META_N = "\e\C-n"
+    CTRL_META_O = "\e\C-o"
+    CTRL_META_P = "\e\C-p"
+    CTRL_META_Q = "\e\C-q"
+    CTRL_META_R = "\e\C-r"
+    CTRL_META_S = "\e\C-s"
+    CTRL_META_T = "\e\C-t"
+    CTRL_META_U = "\e\C-u"
+    CTRL_META_V = "\e\C-v"
+    CTRL_META_W = "\e\C-w"
+    CTRL_META_X = "\e\C-x"
+    CTRL_META_Y = "\e\C-y"
+    CTRL_META_Z = "\e\C-z"
+
+    REVERSED_KEYS = constants(false).map do |con|
+      [
+        RubyJard::Keys.const_get(con),
+        con.to_s.split('_').map(&:capitalize).join('+')
+      ]
+    end.to_h
   end
 end