mini_readline 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdfa436a71940734402798fef36869a990280c8a
-  data.tar.gz: 3d895f85d7c7f8a965362068aed8728fec2536c5
+  metadata.gz: af31e49431ef4c0e691617e54b7a49682f0ff54c
+  data.tar.gz: 2d8eec7c4e57644c35e8c48eb64f59de7eaa0be7
 SHA512:
-  metadata.gz: 558703724da30c6794aa066ded902f72a1a41496b5fb88b2ac05cace0baa4021e06b4b2b03bf8a0f7db1edeabc87773a36f5e3595fe0fe11c583e56047bba3b1
-  data.tar.gz: e219431676db413815d454a5b4d9c6996ad71d20552f22c0df75130954413aa55ca419cf705aa6f96c1c0a960b760956e9b7af183e2dc905b835868ed64ed1b7
+  metadata.gz: faa8d05392d4f11c966b5a3e803701a4e6830f2e734ce75907563642d3f5985baec7d44db4c3534b04156b2da7091f4bc588074358f287e888f530dc5e3e754a
+  data.tar.gz: 6473692e2bfa5b592e64dd30afb51ec6314690de7ebeb91dc622a6f23f029027a913a5a7440a1edae0a3d2c11d7272a64a00b8bc6117cecebee7172933b40bde

data/README.md

@@ -5,7 +5,8 @@ inline editing and command history.
 
 The mini readline gem is an experiment in replacing the standard readline gem
 that is part of Ruby. The mini readline will focus on the needs of Ruby programs
-as opposed to a UN*X shell program.
+as opposed to a UN*X shell program. It will also try to correct a number of
+irritating issues encountered when running under a Windows platform.
 
 The mini_readline gem is designed for use with MRI version 1.9.3 or later.
 The original readline tried to support older versions of Ruby.
@@ -188,13 +189,18 @@ require 'mini_readline'
 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. See Auto-Compete below for more details.
+is MiniReadline::QuotedFileFolderSource. This option can be changed up to get
+auto-complete data other than files and folders. See Auto-Compete below for
+more details.
 * :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).
+* :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.
 
 #### Notes
 * Since the compatibility mode does not accept an options hash, the only way to
@@ -205,15 +211,67 @@ 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 two auto-complete engines. These are:
+The mini readline gem comes with three auto-complete engines. These are:
 * MiniReadline::ArraySource - Make a selection from an array of choices. That
 array is found in the option :array_src. This can either be an array of
 strings or a proc (or lambda) that returns an array of strings.
 * MiniReadline::FileFolderSource - A simple, in-line auto-complete for files
 and folders that do **not** contain embedded spaces.
 * MiniReadline::QuotedFileFolderSource - A simple, in-line auto-complete for
-files and folders embedded in quotes "foo bar.rb" that may contain spaces.
-This is the default auto-complete data source.
+files and folders embedded in quotes. For example "foo bar.rb". Note that the
+file names may contain spaces. This is the default auto-complete data source.
+
+### Adding Custom Auto-Completers
+It is possible, and fairly straightforward to add application specific
+auto-completers to mini readline. To show how this might be done, the
+File and Folder data source is shown. Essential components of this class are
+the initialize, rebuild, and next methods.
+
+```ruby
+  class FileFolderSource
+
+    #Create a new file/folder auto-data source. NOP
+    def initialize(options)
+      # Save or ignore the options hash.
+    end
+
+    #Construct a new data list for auto-complete given the current contents
+    #of the mini_readline edit buffer. Return true-ish for success and
+    #false-ish for failure.
+    def rebuild(str)
+      extract_root_pivot(str)
+
+      list = Dir.glob(@pivot + '*')
+
+      @cycler = list.empty? ? nil : list.cycle
+    end
+
+    #Parse the string into the two basic components. This is not part of the
+    #protocol but is included to give an example of splitting the invariant
+    #(root) part of the buffer from the variable (pivot) part.
+    def extract_root_pivot(str)
+      @root, @pivot = /\S+$/ =~ str ? [$PREMATCH, $MATCH] : [str, ""]
+    end
+
+    #Get the next string for auto-complete. Note that this is the entire
+    #string, not just the pivot bit at the end.
+    def next
+      @root + @cycler.next
+    end
+
+  end
+```
+To enable the use of a custom auto-completer, three things mst be done:
+* The option[:auto_complete] must be set to true
+* The option[:auto_source] must be set to the class name of the new completer.
+* Any optional, additional options required by the completer must be set.
+
+<br> See the section Options above for more details on setting/controlling
+options.
+
+<br>Note: Elsewhere in the code above there exists a require 'English'
+statement to permit the use of clearer, easier to read access to regular
+expression results.
 
 ## Demo
 A simple demo of mini_readline in action is available. To access this demo use

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

@@ -17,11 +17,7 @@ module MiniReadline
 
       list = (get_array.select {|str| str.start_with?(@pivot)}).sort
 
-      unless list.empty?
-        @cycler = list.cycle
-      else
-        @cycler = nil
-      end
+      @cycler = list.empty? ? nil : list.cycle
     end
 
     #Parse the string into the two basic components.

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

@@ -15,11 +15,7 @@ module MiniReadline
 
       list = Dir.glob(@pivot + '*')
 
-      unless list.empty?
-        @cycler = list.cycle
-      else
-        @cycler = nil
-      end
+      @cycler = list.empty? ? nil : list.cycle
     end
 
     #Parse the string into the two basic components.

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

@@ -15,11 +15,7 @@ module MiniReadline
 
       list = Dir.glob(@pivot + '*')
 
-      unless list.empty?
-        @cycler = list.cycle
-      else
-        @cycler = nil
-      end
+      @cycler = list.empty? ? nil : list.cycle
     end
 
     #The parsing regular expression.

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

@@ -60,5 +60,20 @@ module MiniReadline
     def scroll_step
        @options[:scroll_step]
     end
+
+    private
+
+    #Set the left margin
+    def set_left_margin(value)
+      @left_margin = value
+    end
+
+    #Set the right margin
+    #<br>Notes
+    #* If the right_margin is being set, then we must be scrolling. That is
+    #  why the scroll_width is used instead of active_width here.
+    def set_right_margin(value)
+      @left_margin = value - scroll_width + 1
+    end
   end
 end

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

@@ -43,20 +43,5 @@ module MiniReadline
         end
       end
     end
-
-    private
-
-    #Set the left margin
-    def set_left_margin(value)
-      @left_margin = value
-    end
-
-    #Set the right margin
-    #<br>Notes
-    #* If the right_margin is being set, then we must be scrolling. That is
-    #  why the scroll_width is used instead of active_width here.
-    def set_right_margin(value)
-      @left_margin = value - scroll_width + 1
-    end
   end
 end

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

@@ -9,7 +9,7 @@ module MiniReadline
     #The insert_text command. We are DONE!
     def end_of_input(_keyboard_args)
       if @options[:eoi_detect]
-        raise MiniReadlineEOI, "EOI Detected."
+        raise MiniReadlineEOI, "End of input detected."
       else
         @term.beep
       end

data/lib/mini_readline/version.rb

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

data/mini_readline.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>=1.9.3'
 
   spec.add_development_dependency "minitest", ">= 5.7"
-  spec.add_development_dependency "minitest_visible", ">= 0.0.2"
+  spec.add_development_dependency "minitest_visible", ">= 0.1.0"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/mini_readline.reek

@@ -103,6 +103,9 @@ UncommunicativeVariableName:
 UnusedParameters:
   enabled: true
   exclude: []
+UnusedPrivateMethod:
+  enabled: false
+  exclude: []
 UtilityFunction:
   enabled: true
   exclude: []

data/sire.rb

@@ -5,6 +5,7 @@ require 'pp'
 
 if ARGV[0] == 'old'
   require 'readline'
+  $old = true
   puts "\nOption(old). Loaded the standard readline gem. Version #{Readline::VERSION}"
 elsif ARGV[0] == 'local'
   require './lib/mini_readline'
@@ -59,8 +60,12 @@ class SIRE
 
   #Get a mapped keystroke.
   def g
-    print 'Press a key:'
-    MiniReadline::BASE_OPTIONS[:term].get_mapped_keystroke
+    if $old
+      print 'Not supported by old readline.'
+    else
+      print 'Press a key:'
+      MiniReadline::BASE_OPTIONS[:term].get_mapped_keystroke
+    end
   end
 
   #Test spawning a process. This breaks the regular readline gem.
@@ -90,22 +95,22 @@ class SIRE
 
   #Run the interactive session.
   def run_sire
-    edit = MiniReadline::Readline.new(prompt: 'SIRE>',
-                                      auto_complete: true,
-                                      history: true,
-                                      eoi_detect: true)
+    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 'q' to quit.\n\n"
 
     until @_done
-      exec_line(edit.readline)
+      exec_line(Readline.readline('SIRE>', true))
     end
 
     puts "\n\n"
 
-  rescue MiniReadlineEOI, Interrupt => e
+  rescue StandardError, Interrupt => e
     puts "\n"
   end
 

data/tests/mini_readline_tests.rb

@@ -9,7 +9,7 @@ require          'minitest_visible'
 class MiniReadlineTester < Minitest::Test
 
   #Track mini-test progress.
-  MinitestVisible.track self, __FILE__
+  include MinitestVisible
 
   def test_that_module_entities_exists
     assert_equal(Module, MiniReadline.class)
@@ -107,6 +107,25 @@ class MiniReadlineTester < Minitest::Test
     assert(fruit.include?(result))
   end
 
+  def test_file_auto
+    puts "\nPlease select an unquoted file."
+
+    edit = MiniReadline::Readline.new(auto_complete: true,
+                                      auto_source: MiniReadline::FileFolderSource)
+
+    result = edit.readline(prompt: "File: ")
+    assert(result.is_a?(String))
+  end
+
+  def test_file_quoated
+    puts "\nPlease select an quoted file."
+
+    edit = MiniReadline::Readline.new(auto_complete: true,
+                                      auto_source: MiniReadline::QuotedFileFolderSource)
+
+    result = edit.readline(prompt: "File: ")
+    assert(result.is_a?(String))
+  end
 
   def test_end_of_input_detection
     edit = MiniReadline::Readline.new()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,3 +150,4 @@ signing_key:
 specification_version: 4
 summary: A simplified replacement for readline.
 test_files: []
+has_rdoc: