mini_readline 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeadfb80cae515eb0fb0b55dde44df6e84025f8e
-  data.tar.gz: a299a996d90db9ca83680c01917a78798710cfd6
+  metadata.gz: 634b35a4a125886de4969dd4f807fdf2b35e5ec3
+  data.tar.gz: d6be43dd1584f371fea17f7600ee5b5e49ccefc4
 SHA512:
-  metadata.gz: 0654a25c5f4e36736df2e22f3394509ea10811c5ac43c8f73dba1a7e20b0ff2663910ff227329f491dcf99a5b0123c91e6e6a517e543055288f41f38b95206c2
-  data.tar.gz: f0519c20d588ae84c4d3496e697f61ca4a5d84f732b10010155790d057b940f54419e98aca6d207ce0db25a365b74514b952764460cda96c3baf9d802d599e50
+  metadata.gz: 09a90d21011cc4e47143fda7e2b01d2ae88bbea694e5c1bf350214a9af3d69f874211d26aa3cd7c065254f95b3b7ccca4fd102db2d21260eda190afe14606bd2
+  data.tar.gz: f713ffa03366f00f15203215656f4225c36e2e929f298bedd824e908885c005ddaf60c5581f8b46ca852ef0ad003c6cd6a932ac2f6b40002ba6e48b2016260f0

data/README.md

@@ -56,11 +56,13 @@ Erase Left       | Backspace, Ctrl-H                | Backspace, Ctrl-H
 Erase Right      | Delete, Ctrl-Backspace           | Delete, Ctrl-Backspace
 Erase All        | Escape                           | Ctrl-L
 Auto-complete    | Tab, Ctrl-I                      | Tab, Ctrl-I
+End of Input     | Ctrl-Z                           | Alt-z
 
 ### Notes
 * The label "Other" is an umbrella that bundles together the Linux, Mac,
 and Cygwin platforms.
 * 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.
 
 ## Usage
 
@@ -130,12 +132,12 @@ of the history buffer of the edit object with:
 hist = edit.history
 ```
 This method answers an array of strings. Entries added to this array are
-available to the edit instance. For example, the following makes a rather
-menacing part of the history buffer.
+available to the edit instance. For example, the following adds a rather
+menacing entry to the history buffer.
 ```ruby
-hist << "launch --weapons:nuclear --all"
+edit.history << "launch --weapons:nuclear --all"
 ```
-<br>Maybe I should cut back on the Fallout/4?
+Maybe I should cut back on the Fallout/4?
 
 ### Options
 In mini_readline, options exist at three levels:
@@ -168,6 +170,8 @@ BASE_OPTIONS = {
   :auto_complete => false,    #Is auto complete enabled?
   :auto_source   => nil,      #Filled in by auto_complete.rb
 
+  :eoi_detect    => false,    #Is end of input detection enabled?
+
   :history       => false,    #Is the history buffer enabled?
   :no_blanks     => true,     #No empty lines in history.
   :no_dups       => true,     #No duplicate lines in history.
@@ -180,7 +184,7 @@ BASE_OPTIONS = {
 <br>While most of these options are self explanatory, a few could stand some
 further description:
 * :alt_prompt is the prompt used when the text must be scrolled to fit on the
-screen.
+screen. If this is set to nil, then the main prompt is always used.
 * :auto_complete is disabled by default. Of course there are a number of ways
 to enable it, or to make auto-complete enabled the default use:
 ```ruby
@@ -190,6 +194,9 @@ MiniReadline::BASE_OPTION[:auto_complete] = true
 * :auto_source is the class of the source for auto-complete data. By default this
 is MiniReadline::FileFolderSource. This option can be changed up to get auto-complete
 data other than files and folders.
+* :eoi_detect is used to control the end of input detection logic. If disabled,
+eoi inputs are treated as unmapped. If enabled, they raise a MiniReadlineEOI
+exception.
 * :term is the interactive source of data, the console by default. This can be
 changed to get data from another source (like a serial attached terminal).
 

data/lib/mini_readline/exceptions.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+
+#The exception raised when an enabled EOI is detected in a readline operation.
+class MiniReadlineEOI < StandardError
+end

data/lib/mini_readline/options.rb

@@ -12,6 +12,8 @@ module MiniReadline
                   :auto_complete => false,    #Is auto complete enabled?
                   :auto_source   => nil,      #Filled in by auto_complete.rb
 
+                  :eoi_detect    => false,    #Is end of input detection enabled?
+
                   :history       => false,    #Is the history buffer enabled?
                   :no_blanks     => true,     #No empty lines in history.
                   :no_dups       => true,     #No duplicate lines in history.

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

@@ -59,5 +59,8 @@ module MiniReadline
 
     #The Cancel key
     MAP["\f"]    = [:cancel]
+
+    #End of Input
+    MAP["\ez"] = [:end_of_input]
   end
 end

data/lib/mini_readline/raw_term/other.rb

@@ -38,6 +38,8 @@ module MiniReadline
     end
 
     #Sound a beep
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
     def beep
       $stderr.write(BELL)
       $stderr.flush

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

@@ -56,5 +56,8 @@ module MiniReadline
 
     #The Escape key
     MAP["\x1B"]  = [:cancel]
+
+    #End of Input
+    MAP["\x1A"] = [:end_of_input]
   end
 end

data/lib/mini_readline/read_line/edit/auto_complete/file_folder_source.rb

@@ -6,6 +6,10 @@ module MiniReadline
   #* file_folder_source.rb - The data source for auto-complete.
   class FileFolderSource
 
+    #Create a new file/folder auto-data source. NOP
+    def initialize(_options)
+    end
+
     #Construct a new data list for auto-complete
     def rebuild(str)
       @root, pivot = /\S+$/ =~ str ? [$`.to_s, $~.to_s] : [str, ""]

data/lib/mini_readline/read_line/edit/auto_complete.rb

@@ -29,7 +29,7 @@ module MiniReadline
 
     #Get the auto-complete manager
     def auto_manager
-      @_auto_manager ||= AutoManager.new { @options[:auto_source].new }
+      @_auto_manager ||= AutoManager.new{@options[:auto_source].new(@options)}
     end
   end
 

data/lib/mini_readline/read_line/edit/edit_window/sync_window.rb

@@ -8,23 +8,25 @@ module MiniReadline
 
     #Keep the edit window in sync!
     def sync_window(edit_buffer, edit_posn)
-      window_buffer.clear unless check_margins(edit_posn)
+      window_buffer.clear unless check_margins(edit_buffer.length, edit_posn)
       image = build_screen_image(edit_buffer)
       update_screen(image)
       @window_buffer = image
     end
 
     #Verify/update the window margins. Returns true if they're fine.
-    def check_margins(edit_posn)
+    def check_margins(length, edit_posn)
       old_margins = [left_margin, right_margin]
 
-      if edit_posn < left_margin
-        self.left_margin  = [edit_posn - scroll_step, 0].max
+      if length < base_width
+        self.left_margin = 0
+      elsif edit_posn < left_margin
+        self.left_margin = [edit_posn - scroll_step, 0].max
       elsif edit_posn > right_margin
         self.right_margin = edit_posn + scroll_step
       end
 
-       old_margins == [left_margin, right_margin]
+      old_margins == [left_margin, right_margin]
     end
 
     #Compute what should be on the screen.

data/lib/mini_readline/read_line/edit/end_of_input.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+#* read_line/window/edit/end_of_input.rb - Process :end_of_input
+module MiniReadline
+
+  #* read_line/window/edit/end_of_input.rb - Process :end_of_input
+  class Edit
+
+    #The insert_text command. We are DONE!
+    def end_of_input(_keyboard_args)
+      if @options[:eoi_detect]
+        raise MiniReadlineEOI, "EOI Detected."
+      else
+        @term.beep
+      end
+    end
+  end
+end

data/lib/mini_readline/read_line/edit.rb

@@ -22,6 +22,7 @@ require_relative 'edit/previous_history'
 require_relative 'edit/next_history'
 
 require_relative 'edit/auto_complete'
+require_relative 'edit/end_of_input'
 
 require_relative 'edit/unmapped'
 

data/lib/mini_readline/version.rb

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

data/lib/mini_readline.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 
 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"

data/sire.rb

@@ -71,6 +71,55 @@ class SIRE
     end
   end
 
+  #Strict Windows Regex.
+  # a File name character, no spaces.
+  # b File name character, with spaces.
+  # c Drive specification.
+  # x Non-quoted file spec.
+  # y Quoted file spec.
+  WRE = %r{
+    (?<a> [^\/\\\:\*\?\<\>\"\s]){0}
+    (?<b> [^\/\\\:\*\?\<\>\"]){0}
+    (?<c> ([a-zA-z]\:)?\\){0}
+    (?<x> \g<c>?(\g<a>*\\?)*){0}
+    (?<y> \"\g<c>?(\g<a>(\g<b>*\g<a>)?\\?)*\"){0}
+
+    (\g<x>|\g<y>)$
+  }x
+
+  #Rubified Windows Regex.
+  # a File name character, no spaces.
+  # b File name character, with spaces.
+  # c Drive specification.
+  # x Non-quoted file spec.
+  # y Quoted file spec.
+  RRE = %r{
+    (?<a> [^\/\\\:\*\?\<\>\"\s]){0}
+    (?<b> [^\/\\\:\*\?\<\>\"]){0}
+    (?<c> ([a-zA-z]\:)?\/){0}
+    (?<x> \g<c>?(\g<a>*\/?)*){0}
+    (?<y> \"\g<c>?(\g<a>(\g<b>*\g<a>)?\/?)*\"){0}
+
+    (\g<x>|\g<y>)$
+  }x
+
+  #Other Platforms Regex.
+  # a File name character, no spaces.
+  # b File name character, with spaces.
+  # c Root specification.
+  # x Non-quoted file spec.
+  # y Quoted file spec.
+  ORE = %r{
+    (?<a> [^\/\\\:\*\?\<\>\"\s]){0}
+    (?<b> [^\/\\\:\*\?\<\>\"]){0}
+    (?<c> \/){0}
+    (?<x> \g<c>?(\g<a>*\/?)*){0}
+    (?<y> \"\g<c>?(\g<a>(\g<b>*\g<a>)?\/?)*\"){0}
+
+    (\g<x>|\g<y>)$
+  }x
+
+
   #Execute a single line.
   def exec_line(line)
     result = eval line
@@ -99,6 +148,9 @@ class SIRE
     end
 
     puts "\n\n"
+
+  rescue Interrupt => e
+    puts "\n"
   end
 
 end

data/tests/mini_readline_tests.rb

@@ -54,6 +54,12 @@ class MiniReadlineTester < Minitest::Test
     assert_equal("quit", result)
   end
 
+  def test_end_of_input_detection
+    edit = MiniReadline::Readline.new()
+    puts "Exit by signaling end of input"
+    assert_raises(MiniReadlineEOI) {edit.readline(">", eoi_detect: true)}
+  end
+
   def test_prompt_verification
     opts = {:window_width  => 39}
     edit = MiniReadline::Readline.new()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -81,6 +81,7 @@ files:
 - README.md
 - Rakefile
 - lib/mini_readline.rb
+- lib/mini_readline/exceptions.rb
 - lib/mini_readline/options.rb
 - lib/mini_readline/raw_term.rb
 - lib/mini_readline/raw_term/mapper.rb
@@ -102,6 +103,7 @@ files:
 - lib/mini_readline/read_line/edit/edit_window.rb
 - lib/mini_readline/read_line/edit/edit_window/sync_cursor.rb
 - lib/mini_readline/read_line/edit/edit_window/sync_window.rb
+- lib/mini_readline/read_line/edit/end_of_input.rb
 - lib/mini_readline/read_line/edit/enter.rb
 - lib/mini_readline/read_line/edit/go_end.rb
 - lib/mini_readline/read_line/edit/go_home.rb