mini_readline 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f2544e80871d4cdeb122d167832d6e09c74fbb3
-  data.tar.gz: e072a14bf924b8f046355c499655230b220f9a3f
+  metadata.gz: 18650c39506de94d12cb3f292413549722ec55fb
+  data.tar.gz: 7cba8a96b929d75870ee5eeb5b7f20d0b0eb04c8
 SHA512:
-  metadata.gz: c8d40fe8058e368fa90d7aeb1216706fbac6de549f888fe0e91acfd59801a6d6de831c66f895f7ec6894af2fd9559174dcf457f2a0c06c8b565047c0df148aa6
-  data.tar.gz: 1b28d4f253743d843f3697c1116008d76dc9c9c9ba7081a36ccf893012399ce83fae0cea41b0ae8c93996a93afb75559da6d2b0ba330c5a30a39f3d295ce56d1
+  metadata.gz: b859c1130980260216186916fb5f23a3375ac1973fb3748cebe665890684a2a63dee2edabf771974ddb67049722902709583d93164f25d3bff328b10216b2ce1
+  data.tar.gz: de055b2fb3843cea35b0358d8f6f735d1c90591f714b69b26f1a2511985676b002e4bf6beddf028691059e35e7f4bce9e5ae409b5e24a4dfd84884db07cf0b16

data/README.md

@@ -18,6 +18,8 @@ that I will see the same bugs and fix them. Then perhaps it can be seen how
 the original code can also be fixed. In the long run, this is perhaps the
 most important goal.
 
+<br>The mini_readline gem is designed for use with MRI version 1.9.3 or later.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,6 +36,29 @@ Or install it yourself as:
 
     $ gem install mini_readline
 
+## Key Mappings
+The mini_readline gem supports a simple set of editing commands. These vary
+somewhat based on the system platform. The keyboard mappings (and alias
+mappings) are listed below:
+
+Editor Action    | Windows Key               | Other Key
+-----------------|---------------------------|------------
+Enter            | Enter                     | Enter
+Left             | Left Arrow, Keypad Left   | Left Arrow
+Right            | Right Arrow, Keypad Right | Right Arrow
+Go to start      | Home, Keypad Home         | Home, Ctrl-A
+Go to end        | End, Keypad End           | End, Ctrl-E
+Previous History | Up Arrow, Keypad Up       | Up Arrow, Ctrl-R
+Next History     | Down Arrow, Keypad Down   | Down Arrow
+Erase Left       | Backspace                 | Backspace, Ctrl-H
+Erase Right      | Delete, Ctrl-Backspace    | Delete, Ctrl-Backspace
+Erase All        | Escape                    | Ctrl-B
+
+### Notes
+* The label "Other" is an umbrella that bundles together the Linux, Mac,
+and Cygwin platforms.
+* References to Keypad keys under Windows assume that Num Lock is not engaged.
+
 ## Usage
 
 The typical way of utilizing this gem is to place the following:

data/lib/mini_readline/raw_term.rb

@@ -1,14 +1,40 @@
 # coding: utf-8
 
-#Select the type of platform in use.
-if (RUBY_PLATFORM =~ /\bcygwin\b/i) || (RUBY_PLATFORM !~ /mswin|mingw/)
-  require_relative 'raw_term/other'
-else
-  require_relative 'raw_term/windows'
-end
+require_relative 'raw_term/mapper'
 
 #* raw_term.rb - Platform determination for raw terminal access.
 module MiniReadline
+
+  #The class used to manipulate console i/o on a low level.
+  class RawTerm
+
+    #Create a mapper.
+    MAP = Mapper.new
+
+    #Map the printable characters.
+    (32..126).each do |code|
+      char = code.chr
+      MAP[char] = [:insert_text, char]
+    end
+
+    #Get a mapped sequence.
+    def get_mapped_keystroke
+      MAP.get_mapped_keystroke {get_raw_char}
+    end
+
+    #Start on a new line.
+    def put_new_line
+      print("\n")
+    end
+  end
+
+  #Select the type of platform in use.
+  if (RUBY_PLATFORM =~ /\bcygwin\b/i) || (RUBY_PLATFORM !~ /mswin|mingw/)
+    require_relative 'raw_term/other'
+  else
+    require_relative 'raw_term/windows'
+  end
+
   #Get an instance of a raw terminal controller object.
   BASE_OPTIONS[:term] = RawTerm.new
 end

data/lib/mini_readline/raw_term/mapper.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+#* raw_term/mapper.rb - Support for keystroke mapping.
+module MiniReadline
+
+  #* raw_term/mapper.rb - Support for keystroke mapping.
+  class Mapper
+
+    #Set up the keystroke mapper.
+    def initialize
+      @map = Hash.new {|_hash, key| [:unmapped, key]}
+    end
+
+    #Add a map entry
+    def []=(index, value)
+      process_non_terminals(index)
+      @map[index] = value
+    end
+
+    #Handle the preamble characters in the command sequence.
+    def process_non_terminals(index)
+      seq = ""
+
+      index.chop.chars.each do |char|
+        seq << char
+        fail "Ambiguous entry #{index.inspect}" if @map.has_key?(seq) && @map[seq]
+        @map[seq] = false
+      end
+    end
+
+    #Get a mapped input sequence.
+    def get_mapped_keystroke
+      key_seq, key_cmd = "", nil
+
+      begin
+        key_seq << yield
+        key_cmd = @map[key_seq]
+      end until key_cmd
+
+      key_cmd
+    end
+  end
+end

data/lib/mini_readline/raw_term/other.rb

@@ -19,10 +19,6 @@ module MiniReadline
     #Bell
     BELL            = "\x07"
 
-    #Set up the Other Raw Terminal.
-    def initialize
-    end
-
     #Output a string
     def put_string(str)
       scan_string(str)
@@ -34,11 +30,6 @@ module MiniReadline
       put_string CARRIAGE_RETURN
     end
 
-    #Start on a new line.
-    def put_new_line
-      print("\n")
-    end
-
     #Sound a beep
     def beep
       print BELL

data/lib/mini_readline/raw_term/other/map.rb

@@ -6,20 +6,6 @@ module MiniReadline
   #* other/map.rb - Character mapping for other systems.
   class RawTerm
 
-    #Create a hash with a default value.
-    MAP = Hash.new {|_hash, key| [:unmapped, key]}
-
-    #Map the printable characters.
-    (32..126).each do |code|
-      char = code.chr
-      MAP[char] = [:insert_text, char]
-    end
-
-    #Map the non-terminal entries.
-    MAP["\e"]   = false
-    MAP["\e["]  = false
-    MAP["\eO"]  = false
-
     #Map the non-printing characters.
 
     #Left Arrows
@@ -33,6 +19,7 @@ module MiniReadline
     #Up Arrows
     MAP["\e[A"]  = [:previous_history]
     MAP["\eOA"]  = [:previous_history]
+    MAP["\x12"]  = [:previous_history]
 
     #Down Arrows
     MAP["\e[B"]  = [:next_history]
@@ -41,17 +28,19 @@ module MiniReadline
     #The Home keys
     MAP["\e[H"]  = [:go_home]
     MAP["\eOH"]  = [:go_home]
+    MAP["\x01"]  = [:go_home]
 
     #The End keys
     MAP["\e[F"]  = [:go_end]
     MAP["\eOF"]  = [:go_end]
+    MAP["\x05"]  = [:go_end]
 
     #The Backspace key
     MAP["\x7F"]  = [:delete_left]
+    MAP["\x08"]  = [:delete_left]
 
     #The Delete keys
     MAP["\x1F"]  = [:delete_right]
-    MAP["\e[3"]  = false
     MAP["\e[3~"] = [:delete_right]
 
     #The Enter key
@@ -59,17 +48,5 @@ module MiniReadline
 
     #The Cancel key
     MAP["\x02"]  = [:cancel]
-
-    #Get a mapped sequence.
-    def get_mapped_keystroke
-      key_seq, key_cmd = "", nil
-
-      begin
-        key_seq << get_raw_char
-        key_cmd = MAP[key_seq]
-      end until key_cmd
-
-      key_cmd
-    end
   end
 end

data/lib/mini_readline/raw_term/windows.rb

@@ -27,21 +27,15 @@ module MiniReadline
       @_getch = Win32API.new("msvcrt", "_getch", [])
       @_kbhit = Win32API.new("msvcrt", "_kbhit", [])
       @_beep  = Win32API.new("user32", "MessageBeep", ['L'])
-
-      @_set_cursor_posn = Win32API.new("kernel32",
-                                       "SetConsoleCursorPosition",
+      @_set_cursor_posn = Win32API.new("kernel32", "SetConsoleCursorPosition",
                                        ['L','L'])
-
-      @_get_screen_info = Win32API.new("kernel32",
-                                       "GetConsoleScreenBufferInfo",
+      @_get_screen_info = Win32API.new("kernel32", "GetConsoleScreenBufferInfo",
                                        ['L','P'])
-
       @_get_handle = Win32API.new("kernel32", "GetStdHandle", ['L'])
     end
 
     #Output a string
     def put_string(str)
-      scan_string(str) unless @_out_handle
       print(str)
     end
 
@@ -51,38 +45,18 @@ module MiniReadline
       put_string CARRIAGE_RETURN
     end
 
-    #Start on a new line.
-    def put_new_line
-      print("\n")
-    end
-
     #Sound a beep
     def beep
       @_beep.call(0)
     end
 
-    #Wait for a key to be pressed.
-    def wait_for_key
+    #Get a uncooked character keystroke.
+    def get_raw_char
       while (@_kbhit.call == 0)
         sleep(WAIT_SLEEP)
       end
-    end
 
-    #Get a uncooked character keystroke.
-    def get_raw_char
-      wait_for_key
       @_getch.call.chr
     end
-
-    #Determine the affect of a string on the cursor.
-    def scan_string(str)
-      str.chars.each do |char|
-        if char == CARRIAGE_RETURN
-          @cursor_posn = 0
-        else
-          @cursor_posn += 1
-        end
-      end
-    end
   end
 end

data/lib/mini_readline/raw_term/windows/map.rb

@@ -6,21 +6,8 @@ module MiniReadline
   #* windows/map.rb - Character mapping for windows systems.
   class RawTerm
 
-    #Create a hash with a default value.
-    MAP = Hash.new {|_hash, key| [:unmapped, key]}
-
-    #Map the printable characters.
-    (32..126).each do |code|
-      char = code.chr
-      MAP[char] = [:insert_text, char]
-    end
-
     pfx = 0xE0.chr
 
-    #Map the non-terminal entries.
-    MAP["\x00"] = false
-    MAP[  pfx ] = false
-
     #Map the non-printing characters.
 
     #Left Arrows
@@ -60,12 +47,5 @@ module MiniReadline
 
     #The Escape key
     MAP["\x1B"]  = [:cancel]
-
-    #Get a mapped sequence.
-    def get_mapped_keystroke
-      first_char = get_raw_char
-
-      MAP[first_char] || MAP[first_char + get_raw_char]
-    end
   end
 end

data/lib/mini_readline/raw_term/windows/set_posn.rb

@@ -6,17 +6,8 @@ module MiniReadline
   #* windows/set_posn.rb - Set the column of the cursor.
   class RawTerm
 
-    #Set the position of the screen cursor within the line.
-    def set_posn(new_posn)
-      if @_out_handle
-        api_set_posn(new_posn)
-      else
-        term_set_posn(new_posn)
-      end
-    end
-
     #Move the cursor using windows voodoo API.
-    def api_set_posn(new_posn)
+    def set_posn(new_posn)
       raw_buffer = 0.chr * 24
       @_get_screen_info.call(@_out_handle, raw_buffer)
       y_posn = (raw_buffer[6,2].unpack('S'))[0]
@@ -24,17 +15,5 @@ module MiniReadline
       @_set_cursor_posn.call(@_out_handle, y_posn * 65536 + new_posn)
     end
 
-    #Move the cursor using terminal primitives.
-    def term_set_posn(new_posn)
-
-      if new_posn > @cursor_posn
-        print("\e#{new_posn - @cursor_posn}C")
-      elsif new_posn < @cursor_posn
-        print("\e#{@cursor_posn - new_posn}D")
-      end
-
-      @cursor_posn = new_posn
-    end
-
   end
 end

data/lib/mini_readline/read_line/history.rb

@@ -45,10 +45,8 @@ module MiniReadline
 
     #Append a string to the history buffer if enabled.
     def append_history(str)
-      str_strip = str.strip
-
-      return if (str_strip == '')             && @options[:no_blanks]
-      return if (history.include?(str_strip)) && @options[:no_dups]
+      return              if @options[:no_blanks] && str.strip.empty?
+      history.delete(str) if @options[:no_dups]
 
       history << str
     end

data/lib/mini_readline/version.rb

@@ -1,4 +1,4 @@
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mini_readline.gemspec

@@ -10,7 +10,11 @@ Gem::Specification.new do |spec|
   spec.email         = ["peter.c.camilleri@gmail.com"]
 
   spec.summary       = "A simplified replacement for readline."
-  spec.description   = "A gem for console command entry with line edit and history."
+  spec.description   = "A gem for console command entry with line edit and "  +
+                       "history. This gem is like the standard readline "     +
+                       "gem except that it has been redesigned, simplified, " +
+                       "and extensively cleaned up."
+
   spec.homepage      = "http://teuthida-technologies.com/"
   spec.license       = "MIT"
 

data/sire.rb

@@ -10,7 +10,7 @@ elsif ARGV[0] == 'local'
   require './lib/mini_readline'
   puts "\nOption(local). Loaded mini_readline from the local code folder."
 elsif defined?(MiniReadline)
-  puts "The mini_readline gem is already loaded."
+  puts "\nThe mini_readline gem is already loaded."
 else
   begin
     require 'mini_readline'
@@ -57,6 +57,12 @@ class SIRE
     "Bye bye for now!"
   end
 
+  #Get a mapped keystroke.
+  def g
+    print 'Press a key:'
+    MiniReadline::BASE_OPTIONS[:term].get_mapped_keystroke
+  end
+
   #Test spawning a process. This breaks the regular readline gem.
   def run(command)
     IO.popen(command, "r+") do |io|

data/tests/mini_readline_tests.rb

@@ -17,6 +17,7 @@ class MiniReadlineTester < Minitest::Test
     assert_equal(Class,  MiniReadline::Readline.class)
     assert_equal(Class,  MiniReadline::Edit.class)
     assert_equal(Class,  MiniReadline::EditWindow.class)
+    assert_equal(Class,  MiniReadline::Mapper.class)
   end
 
   def test_platform_detection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-09 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: A gem for console command entry with line edit and history.
+description: A gem for console command entry with line edit and history. This gem
+  is like the standard readline gem except that it has been redesigned, simplified,
+  and extensively cleaned up.
 email:
 - peter.c.camilleri@gmail.com
 executables: []
@@ -53,6 +55,7 @@ files:
 - lib/mini_readline.rb
 - lib/mini_readline/options.rb
 - lib/mini_readline/raw_term.rb
+- lib/mini_readline/raw_term/mapper.rb
 - lib/mini_readline/raw_term/other.rb
 - lib/mini_readline/raw_term/other/map.rb
 - lib/mini_readline/raw_term/other/set_posn.rb