mini_readline 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba0cff3f1c82679c0bdf6c1c6e65a04c3b9f2354
-  data.tar.gz: f1935e5795e939426f20991657a8d12a95d22468
+  metadata.gz: 63c0d0b393fbbae9881b657135bd97f34befd2ed
+  data.tar.gz: cba975451eecdd8e3a960bf176326dd64fa0a092
 SHA512:
-  metadata.gz: a9258f743e1c7fc664d065587adfc684c64eb61429b6f11dc2252bffa7b0e32596caf2f9656362b02aeb65e91495f69dcb5608dd6f81f5d0fcf004a1d600d9e2
-  data.tar.gz: 973efb417ef924216fcbf9a8523987bf86f9974ed70ba77fbde7390fd5452a9aee4f30ae1c026724534652d593813b0a51ee423e9fff11316a83dc426152c1d0
+  metadata.gz: 5b363e4ff27560dd63ffdcc77311f9c0ad564fa89f030bf0d393304f8bf5fb05d8e3d796fffbfcf1e71879e86c0090df4fbd6234d8aa31c5ea3dc26a3811b4ab
+  data.tar.gz: eefdd7034858baef7e5306947e31a627adc96925a6e1ba40d7bfa72d80a9051aa8277eeb3fe4e5275541edbaa5bb2af3fd1ef2ffade686d324f7fcdb741dc7b5

data/README.md

@@ -77,6 +77,8 @@ replaced by Escape followed by the appropriate letter.
 * References to Pad keys under Windows assume that Num Lock is not engaged.
 * Support for End of Input is controlled by the eoi_detect option. See options
 below.
+* These keyboard mappings are the standard ones included with mini_readline.
+See the section Adding Custom Key Maps below for more info.
 
 ## Usage
 
@@ -367,7 +369,55 @@ statement to permit the use of clearer, easier to read access to regular
 expression results.
 
 <br> An example of a custom auto-complete facility may be found in the mysh
-gem located at: https://github.com/PeterCamilleri/mysh/blob/master/lib/mysh/user_input/smart_source.rb
+gem located at: https://github.com/PeterCamilleri/mysh/blob/master/lib/mysh/sources/smart_auto_complete.rb
+
+### Adding Custom Key Maps
+It is possible to override the default keyboard maps used by the mini_readline
+gem. The following shows the installation of a retro, WordStar(TM) inspired
+keyboard mapping for a Windows system:
+
+```ruby
+MiniTerm.add_map(:windows) do |map|
+  map[" ".."~"] = :insert_text
+
+  #Left Arrows
+  map["\x13"]  = :go_left
+  map["\x01"]  = :word_left
+
+  #Right Arrows
+  map["\x04"]  = :go_right
+  map["\x06"]  = :word_right
+
+  #Up Arrows
+  map["\x05"]  = :previous_history
+
+  #Down Arrows
+  map["\x18"]  = :next_history
+
+  #The Home and End keys
+  map["\x17"]  = :go_home
+  map["\x12"]  = :go_end
+
+  #The Backspace and Delete keys
+  map["\x08"]  = :delete_left
+  map["\x7F"]  = :delete_right
+  map["\x11\x13"] = :delete_all_left
+  map["\x11\x04"] = :delete_all_right
+
+  #Auto-completion.
+  map["\t"]    = :auto_complete
+
+  #The Enter key
+  map["\x0D"]  = :enter
+
+  #The Escape key
+  map["\e"]    = :cancel
+
+  #End of Input
+  map["\x1A"]  = :end_of_input
+end
+```
+
 
 ### Important Security Note
 
@@ -378,24 +428,25 @@ command line itself. Untrusted users should **never** be given such access!
 
 ## Demo
 A simple demo of mini_readline in action is available. To access this demo use
-the following from the mini_readline root folder:
+the following:
 
-    $ ruby sire.rb
+    $ sire
 
 This will launch SIRE, a Simple Interactive Ruby Environment, a sort of
-simple minded irb knock-off. This starts off by requiring the mini
-readline gem from either the system gem library or the local lib folder or
-if all fails, it will load the "classic" Readline gem. Here is a typical run:
+simple minded irb knock-off. The utility supports a number of options that
+allow the behaviour of the gem to be explored. These are:
 
-    C:\Sites\mini_readline>ruby sire.rb
+Option | Effect
+-------|-------
+local  | Use the mini_readline in the lib folder. For testing.
+gem    | Use the mini_readline installed as a gem. The default.
+old    | Use the old readline facility.
+map1   | Install a Wordstar keyboard map.
+help   | Display usage info and exit.
+-?     | Same thing.
 
+#### Testing Shell Out Bugs
 
-    Loaded mini_readline from the local code folder.
-
-    Welcome to a Simple Interactive Ruby Environment
-    Use the command 'quit' to exit.
-
-    SIRE>
 Of note, the run method can be used to test for the shell process bug. For
 example:
 
@@ -412,15 +463,12 @@ example:
      "sire.rb",
      "tests"]
     SIRE>
+    
 After this command is run, the program should continue to operate correctly
-and not go bannanas. To test the behavior of the standard readline library, use:
-
-    $ ruby sire.rb old
-
-To test the local copy of mini_readline in the lib folder instead of the
-system gem, use this:
+and not go bannanas. To test the behavior of the (currently broken) standard 
+readline library, use:
 
-    $ ruby sire.rb local
+    $ sire.rb old
 
 ## Cross Platform Portability Progress
 

data/bin/sire

@@ -0,0 +1,218 @@
+#!/usr/bin/env ruby
+#
+# A Simple Interactive Ruby Environment
+#
+
+require 'pp'
+
+# Capture a binding for code evaluation.
+sire_binding = binding
+
+# Process command line arguments.
+valid_options = {'local' => :reader,
+                 'gem'   => :reader,
+                 'old'   => :reader,
+                 'map1'  => :map,
+                 'help'  => :help,
+                 '?'     => :help}
+
+options = {reader: 'gem'}
+
+# Display help for SIRE and exit.
+def display_help(error=nil)
+  puts "SIRE: a Simple Interactive Ruby Environment\n"
+
+  if error
+    puts "Invalid option: #{error}"
+  end
+
+  puts "", "Usage: sire <options>"
+  puts "  local       Use the local mini_readline code."
+  puts "  gem         Use the mini_readline installed gem."
+  puts "  old         Use the standard readline gem."
+  puts "  map1        Use the alternate key mapping in Windows."
+  puts "  help  -?    Display this help and exit."
+
+  exit
+end
+
+ARGV.each do |arg|
+  key = valid_options[arg]
+  display_help(arg) unless key
+  options[key] = arg
+end
+
+display_help if options[:help]
+
+case options[:reader]
+when 'local'
+  require_relative '../lib/mini_readline'
+  puts "", "Option(local). Loaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
+when 'gem'
+  require 'mini_readline'
+  puts "", "Loaded mini_readline from the system gem. Version #{MiniReadline::VERSION}"
+when 'old'
+  require 'readline'
+  class MiniReadlineEOI < StandardError; end #Compatibility stub.
+  puts "", "Loaded the standard readline gem. Version #{Readline::VERSION}"
+end
+
+MiniReadline = Readline unless defined?(MiniReadline)
+
+class Object
+  # Generate the class lineage of the object.
+  def classes
+    begin
+      result = ""
+      klass  = self.instance_of?(Class) ? self : self.class
+
+      begin
+        result << klass.to_s
+        klass = klass.superclass
+        result << " < " if klass
+      end while klass
+
+      result
+    end
+  end
+
+  private
+
+  # Quit the interactive session.
+  def quit
+    puts "Quit command.", ""
+    exit
+  end
+
+  # Get a mapped keystroke.
+  def get_mapped
+    if old?
+      puts 'Not supported by old readline.'
+    else
+      print 'Press a key: '
+      MiniTerm.get_mapped_char
+    end
+  end
+
+  # Test spawning a process. This breaks the regular readline gem.
+  def run(command)
+    IO.popen(command, "r+") do |io|
+      io.close_write
+      return io.read
+    end
+  end
+
+  def old?
+    defined?(Readline)
+  end
+
+end
+
+if options[:map] == 'map1'
+  if old?
+    puts 'An option is not supported by old readline.'
+    exit
+  end
+
+  [:windows, :ansi].each do |target|
+    MiniTerm.add_map(target) do |map|
+      map[" ".."~"] = :insert_text
+
+      #Left Arrows
+      map["\x13"]  = :go_left
+      map["\x01"]  = :word_left
+
+      #Right Arrows
+      map["\x04"]  = :go_right
+      map["\x06"]  = :word_right
+
+      #Up Arrows
+      map["\x05"]  = :previous_history
+
+      #Down Arrows
+      map["\x18"]  = :next_history
+
+      #The Home and End keys
+      map["\x17"]  = :go_home
+      map["\x12"]  = :go_end
+
+      #The Backspace and Delete keys
+      map["\x08"]  = :delete_left
+      map["\x7F"]  = :delete_right
+      map["\x11\x13"] = :delete_all_left
+      map["\x11\x04"] = :delete_all_right
+
+      #Auto-completion.
+      map["\t"]    = :auto_complete
+
+      #The Enter key
+      map["\x0D"]  = :enter
+
+      #The Escape key
+      map["\e"]    = :cancel
+
+      #End of Input
+      map["\x1A"]  = :end_of_input
+    end
+  end
+end
+
+#The SIRE module contains a simplistic R.E.P.L. to test out mini_readline.
+module SIRE
+
+  # Run the interactive session.
+  def self.run_sire(evaluator)
+    @evaluator = evaluator
+
+    unless old?
+      MiniReadline::BASE_OPTIONS[:auto_complete] = true
+      MiniReadline::BASE_OPTIONS[:eoi_detect] = true
+    end
+
+    puts
+    puts "Welcome to a Simple Interactive Ruby Environment\n"
+    puts "Use the command 'quit' to exit.\n\n"
+
+    loop do
+      exec_line(get_line)
+    end
+
+    puts "\n\n"
+
+  rescue MiniReadlineEOI, Interrupt => e
+    puts "\n"
+  end
+
+  private
+
+  # Get a line of input from the user.
+  def self.get_line
+    initial_input = MiniReadline.readline("SIRE>", true)
+    get_extra_input(initial_input)
+  end
+
+  # Get any continuations of the inputs
+  def self.get_extra_input(str)
+    if /\\\s*$/ =~ str
+      get_extra_input($PREMATCH + "\n" + MiniReadline.readline("SIRE\\", true))
+    else
+      str
+    end
+  end
+
+  # Execute a single line.
+  def self.exec_line(line)
+    result = @evaluator.eval(line)
+    pp result unless line.length == 0
+
+  rescue Interrupt => e
+    puts "", "Execution Interrupted!"
+    puts "", "#{e.class} detected: #{e}", ""
+
+  rescue StandardError, ScriptError => e
+    puts "", "#{e.class} detected: #{e}", ""
+  end
+
+end
+
+SIRE.run_sire(sire_binding)

data/lib/mini_readline/version.rb

@@ -3,7 +3,7 @@
 # Version info for the gem.
 module MiniReadline
   #The current version of the mini_readline gem.
-  VERSION = "0.9.1".freeze
+  VERSION = "0.9.2".freeze
 
   # A brief description.
   DESCRIPTION = "mini_readline: Get console input with edit, history, and auto-complete.".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_term
@@ -102,6 +102,7 @@ email:
 - peter.c.camilleri@gmail.com
 executables:
 - irbm
+- sire
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,6 +113,7 @@ files:
 - LICENSE.txt
 - README.md
 - bin/irbm
+- bin/sire
 - irbt.rb
 - lib/mini_readline.rb
 - lib/mini_readline/exceptions.rb
@@ -152,7 +154,6 @@ files:
 - mini_readline.gemspec
 - rakefile.rb
 - reek.txt
-- sire.rb
 - tests/history_tests.rb
 - tests/mini_readline_tests.rb
 homepage: https://github.com/PeterCamilleri/mini_readline

data/sire.rb

@@ -1,145 +0,0 @@
-# coding: utf-8
-# A Simple Interactive Ruby Environment
-
-require 'pp'
-
-#Some SIRE control variables.
-$sire_done    = false
-$sire_binding = binding
-$sire_old     = (ARGV[0] == 'old') || defined?(Readline)
-
-if $sire_old
-  require 'readline'
-  class MiniReadlineEOI < StandardError; end #Compatibility stub.
-  puts "\nLoaded the standard readline gem. Version #{Readline::VERSION}"
-elsif ARGV[0] == 'local'
-  require './lib/mini_readline'
-  puts "\nOption(local). Loaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
-elsif defined?(MiniReadline)
-  puts "\nThe mini_readline gem is already loaded. Version #{MiniReadline::VERSION}"
-else
-  begin
-    require 'mini_readline'
-    puts "\nLoaded mini_readline from the system gem. Version #{MiniReadline::VERSION}"
-  rescue LoadError
-    begin
-      require './lib/mini_readline'
-      puts "\nLoaded mini_readline from the local code folder. Version #{MiniReadline::VERSION}"
-    rescue LoadError
-      require 'readline'
-      puts "\nLoaded the standard readline gem. Version #{Readline::VERSION}"
-    end
-  end
-end
-
-Readline = MiniReadline unless defined?(Readline)
-
-class Object
-  #Generate the class lineage of the object.
-  def classes
-    begin
-      result = ""
-      klass  = self.instance_of?(Class) ? self : self.class
-
-      begin
-        result << klass.to_s
-        klass = klass.superclass
-        result << " < " if klass
-      end while klass
-
-      result
-    end
-  end
-
-  private
-
-  #Quit the interactive session.
-  def quit
-    $sire_done = true
-    puts
-    "Quit command."
-  end
-
-  #Get a mapped keystroke.
-  def get_mapped
-    if $sire_old
-      puts 'Not supported by old readline.'
-    else
-      print 'Press a key:'
-      MiniTerm.get_mapped_char
-    end
-  end
-
-  #Test spawning a process. This breaks the regular readline gem.
-  def run(command)
-    IO.popen(command, "r+") do |io|
-      io.close_write
-      return io.read
-    end
-  end
-
-end
-
-#The SIRE class contains the simplistic R.E.P.L.
-class SIRE
-
-  #Run the interactive session.
-  def run_sire
-    unless $sire_old
-      MiniReadline::BASE_OPTIONS[:auto_complete] = true
-      MiniReadline::BASE_OPTIONS[:eoi_detect] = true
-    end
-
-    puts
-    puts "Welcome to a Simple Interactive Ruby Environment\n"
-    puts "Use the command 'quit' to exit.\n\n"
-
-    until $sire_done
-      exec_line(get_line)
-    end
-
-    puts "\n\n"
-
-  rescue MiniReadlineEOI, Interrupt => e
-    puts "\n"
-  end
-
-  private
-
-  #Get a line of input from the user.
-  def get_line
-    initial_input = Readline.readline("SIRE>", true)
-    get_extra_input(initial_input)
-  end
-
-  #Get any continuations of the inputs
-  def get_extra_input(str)
-    if /\\\s*$/ =~ str
-      get_extra_input($PREMATCH + "\n" + Readline.readline("SIRE\\", true))
-    else
-      str
-    end
-  end
-
-  #Execute a single line.
-  def exec_line(line)
-    result = $sire_binding.eval(line)
-    pp result unless line.length == 0
-
-  rescue Interrupt => e
-    puts "\nExecution Interrupted!"
-    puts "\n#{e.class} detected: #{e}\n"
-    puts e.backtrace
-    puts "\n"
-
-  rescue Exception => e
-    puts "\n#{e.class} detected: #{e}\n"
-    puts e.backtrace
-    puts
-  end
-
-end
-
-if __FILE__ == $0
-  SIRE.new.run_sire
-end