mini_readline 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '03240235936a20a5408ecd9162d0633b81f75d5c'
-  data.tar.gz: 0e5e19408057351bdd835f84d8f4256627a84fd3
+  metadata.gz: 13d29a79c8b695d0491081997bfd2f78c2d6b6f4
+  data.tar.gz: a13e598d917734a3448e4d9316aee17cabc701b3
 SHA512:
-  metadata.gz: 492cf0e29207d1daec3f523672aa8e33b6d157978b1cb949668862049312a5cdbb06a10dfa2b4c94d303568e435e419f7269f7b98ff2d75dbd496b71003c61ff
-  data.tar.gz: f4a29768fdf9de8ef867de94257d1978b168a39ef21bf150bc06845aeb339ad503a79fe00d65143da7c3728cb1d9790bcce680664e6a23c917e249e4db106de5
+  metadata.gz: a92268026fa1ac6abfd573cb6debd80b4055fbe047dd58bae5a666f39745831397c089b54615537ad1aee765a19d480375fe208234ca2f957bb640abb46c2570
+  data.tar.gz: 568fa17fc7a40b0bf8f4bc7d01214e947f1503b8f49166a56636c049be91b595fd7284b86499942a91187cf75049855cc8eb0a13815400f56cf2ba2c3f6a7b1c

data/README.md

@@ -225,11 +225,8 @@ BASE_OPTIONS = {
                               #string "*" to use stars or " "
                               #for invisible secrets.
 
-  :initial       => "",       #The initial text for the entry.
+  :initial       => ""}       #The initial text for the entry.
                               #An empty string for none.
-
-  :term          => nil}      #Filled in by raw_term.rb
-                              #MiniReadline::RawTerm
 ```
 
 <br>While most of these options are self explanatory, a few could stand some
@@ -260,12 +257,6 @@ the history option **TURNED OFF**. Otherwise later entries will be able to
 retrieve the secret codes by just scrolling through previous entries.
 * :initial is the initial text used to prefill the readline edit area with the
 specified text. Leave as an empty string to default to the empty edit area.
-* :term is the interactive source of data, the console by default. The raw
-terminal console driver automatically adapts to the system environment
-(Windows or Other) so that correct operation is normally achieved with no
-further actions on the part of the user. The terminal support class can be
-changed, to a user supplied class, to get data from another source, such as
-a serial attached terminal.
 
 Finally the :window_width option is now ignored. Screen width now automatically
 determined.
@@ -274,10 +265,6 @@ determined.
 #### Notes
 * Since the compatibility mode does not accept an options hash, the only way to
 affect options in this case is to modify the MiniReadline::BASE_OPTIONS hash.
-* The :term option is the low level console io object used to get data
-from the user and control what is displayed. This gem automatically adapts to
-the environment and plugs in the needed object. This can be overridden where
-special io needs exist.
 
 ### Auto-Complete
 The mini readline gem comes with four auto-complete engines. These are:
@@ -417,29 +404,14 @@ system gem, use this:
 ## Cross Platform Portability Progress
 
 The mini_readline gem was initially designed for use with MRI version 1.9.3 or
-later. The long term goal is to be as portable to as many versions of Ruby and
-on as many operating systems platforms as is possible. So far the matrix of
-support looks like:
-
-Ruby           | Win32   | Win64   | Cygwin  | Linux   | Mac
----------------|---------|---------|---------|---------|---------
-ruby 1.9.3p484 | Yes     | Yes     | ?       | ?       | ?
-ruby 2.1.6p336 | Yes     | ?       | ?       | ?       | ?
-ruby 2.2.3p173 | ?       | ?       | Yes     | ?       | ?
-ruby 2.3.3p222 | ?       | Yes     | ?       | ?       | ?
-jruby 9.1.5.0  | Mostly  | ?       | Planned | Planned | Planned
-rubinius       | N/A     | N/A     | N/A     | Maybe   | Maybe
-
-<br>Where:
-
-* 'Yes' means good to go! Coded and tested OK!
-* 'Mostly' is mostly working but still some minor issues (See issue #7).
-* '?' _should_ work but are untested.
-* 'Planned' are not there yet and some work and much testing are needed.
-* 'N/A' entries reflect the fact that Rubinius does not run under Windows.
-* 'Maybe' entries are not on the radar now, but maybe later.
-
-There is clearly a lot of work to do.
+later. With version 0.9.0, the internal raw_term code is replaced with the new
+mini_term gem. That gem requires Ruby 2.0.0 or greater and now so does
+mini_readline.
+
+As almost all of the platform specific responsibility has been moved to the
+mini_term gem, the tracking of portability progress issues now resides there
+as well. Please see [mini_term](https://github.com/PeterCamilleri/mini_term)
+for more information.
 
 ## Contributing
 

data/lib/mini_readline.rb

@@ -1,14 +1,17 @@
 # coding: utf-8
 
-require          "English"
+require "English"
+
+require "mini_term"
+MiniTerm.open(quiet: true, pass_ctrl_s: true)
+
+require_relative "mini_readline/maps"
 require_relative "mini_readline/version"
 require_relative "mini_readline/exceptions"
 require_relative "mini_readline/options"
-require_relative "mini_readline/raw_term"
 require_relative "mini_readline/read_line"
 
-#The \MiniReadline module.
-#* mini_readline.rb - The root file that gathers up all the system's parts.
+# The MiniReadline main module.
 module MiniReadline
 
   private_constant :Prompt
@@ -17,14 +20,15 @@ module MiniReadline
   private_constant :History
   private_constant :NoHistory
 
-  #Get the shared instance of Readline.
-  def self.get_reader
-    @reader ||= Readline.new()
-  end
-
-  #The (limited) compatibility module function.
+  # The (limited) compatibility module function.
   def self.readline(prompt = "", history = nil, options = {})
     get_reader.readline(options.merge({prompt: prompt, history: history}))
   end
 
+private
+
+  # Get the shared instance of Readline.
+  def self.get_reader
+    @reader ||= Readline.new()
+  end
 end

data/lib/mini_readline/exceptions.rb

@@ -3,9 +3,6 @@
 # The exception raised when an enabled EOI is detected in a readline operation.
 class MiniReadlineEOI < StandardError; end
 
-# The exception raised when the keyboard mapping is invalid.
-class MiniReadlineKME < RuntimeError; end
-
 # The exception raised when the prompt is too long to fit.
 class MiniReadlinePLE < RuntimeError; end
 

data/lib/mini_readline/maps.rb

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+# Create the keyboard maps used by mini_readline.
+
+# The Windows mapping.
+MiniTerm.add_map(:windows) do |map|
+  # Make local copies of the prefixes for brevity.
+  x00 = MiniTerm::PREFIX_00
+  xe0 = MiniTerm::PREFIX_E0
+
+  map[" ".."~"] = :insert_text
+
+  #Left Arrows
+  map[x00+"K"] = :go_left
+  map[xe0+"K"] = :go_left
+
+  map[x00+"s"] = :word_left
+  map[xe0+"s"] = :word_left
+
+  #Right Arrows
+  map[x00+"M"] = :go_right
+  map[xe0+"M"] = :go_right
+
+  map[x00+"t"] = :word_right
+  map[xe0+"t"] = :word_right
+
+  #Up Arrows
+  map[x00+"H"] = :previous_history
+  map[xe0+"H"] = :previous_history
+
+  #Down Arrows
+  map[x00+"P"] = :next_history
+  map[xe0+"P"] = :next_history
+
+  #The Home keys
+  map[x00+"G"] = :go_home
+  map[xe0+"G"] = :go_home
+
+  #The End keys
+  map[x00+"O"] = :go_end
+  map[xe0+"O"] = :go_end
+
+  #The Backspace key
+  map["\x08"]  = :delete_left
+
+  #The Delete keys
+  map["\x7F"]  = :delete_right
+  map[x00+"S"] = :delete_right
+  map[xe0+"S"] = :delete_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
+
+# The ANSI mapping.
+MiniTerm.add_map(:ansi) do |map|
+
+  map[" ".."~"] = :insert_text
+
+  #Left Arrows
+  map["\e[D"]  = :go_left
+  map["\eOD"]  = :go_left
+  map["\x02"]  = :go_left
+
+  map["\e[1;5D"] = :word_left
+  map["\eb"]     = :word_left
+
+  #Right Arrows
+  map["\e[C"]  = :go_right
+  map["\eOC"]  = :go_right
+  map["\x06"]  = :go_right
+
+  map["\e[1;5C"] = :word_right
+  map["\ef"]     = :word_right
+
+  #Up Arrows
+  map["\e[A"]  = :previous_history
+  map["\eOA"]  = :previous_history
+  map["\x12"]  = :previous_history
+
+  #Down Arrows
+  map["\e[B"]  = :next_history
+  map["\eOB"]  = :next_history
+
+  #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
+  map["\x15"]  = :delete_all_left
+
+  #The Delete keys
+  map["\x1F"]  = :delete_right
+  map["\e[3~"] = :delete_right
+  map["\x0B"]  = :delete_all_right
+
+  #Auto-completion.
+  map["\t"]    = :auto_complete
+
+  #The Enter key
+  map["\x0D"]  = :enter
+
+  #The Cancel key
+  map["\f"]    = :cancel
+
+  #End of Input
+  map["\ez"] = :end_of_input
+end
+

data/lib/mini_readline/options.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* options.rb - Options selection, control, and access
+# Options selection, control, and access
 module MiniReadline
 
-  #The base options shared by all instances.
+  # The base options shared by all instances.
   BASE_OPTIONS = {:scroll_step   => 12,       #The amount scrolled.
 
                   :prompt        => ">",      #The default prompt.
@@ -25,10 +25,6 @@ module MiniReadline
                                               #string "*" to use stars or " "
                                               #for invisible secrets.
 
-                  :initial       => "",       #The initial text for the entry.
+                  :initial       => ""}       #The initial text for the entry.
                                               #An empty string for none.
-
-                  :term          => nil}      #Filled in by raw_term.rb
-                                              #MiniReadline::RawTerm
-
 end

data/lib/mini_readline/read_line.rb

@@ -5,21 +5,18 @@ require_relative 'read_line/edit'
 require_relative 'read_line/history'
 require_relative 'read_line/no_history'
 
-
-#* read_line.rb - The ReadLine class that does the actual work.
+# The ReadLine class that does the actual work.
 module MiniReadline
 
-  #The \Readline class that does the actual work of getting lines from the
+  #The Readline class that does the actual work of getting lines from the
   #user. Note that each instance of this class maintains its own copy of
   #the optional command history.
   class Readline
 
-    #The options specifically associated with this instance.
+    # The options specifically associated with this instance.
     attr_reader :instance_options
 
-    #Setup the instance of the mini line editor.
-    #<br>Parameters:
-    #* instance_options - A hash of options owned by this \Readline instance.
+    # Setup the instance of the mini line editor.
     def initialize(instance_options={})
       @instance_options = instance_options
       log = (@instance_options[:log] || BASE_OPTIONS[:log] || []).clone
@@ -27,26 +24,23 @@ module MiniReadline
       @no_history = NoHistory.new
     end
 
-    #Get the history buffer of this read line instance.
+    # Get the history buffer of this read line instance.
     def history
       @history.history
     end
 
-    #Read a line from the console with edit and history.
-    #<br>Parameters:
-    #* prompt - A string used to prompt the user. '>' is popular.
-    #* options - A hash of options; Typically symbol: value
+    # Read a line from the console with edit and history.
     def readline(options = {})
       suppress_warnings
       initialize_parms(options)
-      @edit.edit_process
+      MiniTerm.raw { @edit.edit_process }
     ensure
-      @term.conclude
       restore_warnings
+      puts
     end
 
-    #Initialize the read line process. This basically process the arguments
-    #of the readline method.
+    # Initialize the read line process. This basically process the arguments
+    # of the readline method.
     def initialize_parms(options)
       set_options(options)
 
@@ -56,20 +50,18 @@ module MiniReadline
       @history.initialize_parms(@options)
     end
 
-    #Set up the options
+    # Set up the options
     def set_options(options)
       @options = MiniReadline::BASE_OPTIONS
                    .merge(instance_options)
                    .merge(options)
 
-      (@term = @options[:term]).initialize_parms
-
-      @options[:window_width] = @term.window_width - 1
+      @options[:window_width] = MiniTerm.width - 1
       set_prompt(@options[:prompt])
       verify_mask(@options[:secret_mask])
     end
 
-    #Set up the prompt.
+    # Set up the prompt.
     def set_prompt(prompt)
       @options[:base_prompt]   = Prompt.new(prompt)
       @options[:scroll_prompt] = Prompt.new(@options[:alt_prompt] || prompt)
@@ -78,7 +70,7 @@ module MiniReadline
       verify_prompt(@options[:scroll_prompt])
     end
 
-    #Verify that the prompt will fit!
+    # Verify that the prompt will fit!
     def verify_prompt(prompt)
       unless (@options[:window_width] - prompt.length) >
              (@options[:scroll_step] * 2)
@@ -86,20 +78,20 @@ module MiniReadline
       end
     end
 
-    #Verify the secret mask
+    # Verify the secret mask
     def verify_mask(secret)
       if secret && secret.length != 1
         fail MiniReadlineSME, "Secret mask must be nil or a single character string."
       end
     end
 
-    #No warnings please!
+    # No warnings please!
     def suppress_warnings
       @old_stderr = $stderr
       $stderr = File.open(File::NULL, 'w')
     end
 
-    #Restore warnings to their typical ugliness.
+    # Restore warnings to their typical ugliness.
     def restore_warnings
       $stderr.close
       $stderr = @old_stderr

data/lib/mini_readline/read_line/edit.rb

@@ -28,17 +28,16 @@ require_relative 'edit/end_of_input'
 
 require_relative 'edit/unmapped'
 
-#* read_line/edit.rb - The line editor.
+# The line editor.
 module MiniReadline
 
-  #* read_line/edit.rb - The line editor.
+  # The line editor.
   class Edit
 
-    #Set up the edit instance.
+    # Set up the edit instance.
     def initialize(history, options)
       @options     = options
       @history     = history
-      @term        = @options[:term]
       @edit_buffer = @options[:initial]
       @edit_posn   = @edit_buffer.length
       @working     = true
@@ -46,36 +45,36 @@ module MiniReadline
       @edit_window = EditWindow.new(@options)
     end
 
-    #The main edit buffer
+    # The main edit buffer
     attr_reader :edit_buffer
 
-    #The current edit position
+    # The current edit position
     attr_reader :edit_posn
 
-    #How long is the current string?
+    # How long is the current string?
     def length
       edit_buffer.length
     end
 
-    #Interact with the user
+    # Interact with the user
     def edit_process
       result = edit_loop
       @history.append_history(result)
       result + "\n"
     end
 
-    #The line editor processing loop.
+    # The line editor processing loop.
     def edit_loop
       while @working
         @edit_window.sync_window(edit_buffer, edit_posn)
         @edit_window.sync_cursor(edit_posn)
-        process_keystroke(@term.get_mapped_keystroke)
+        process_keystroke(MiniTerm.get_mapped_char)
       end
 
       edit_buffer
     end
 
-    #Process a keystroke.
+    # Process a keystroke.
     def process_keystroke(key_cmd)
       send(key_cmd[0], key_cmd)
     end