mini_readline 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af31e49431ef4c0e691617e54b7a49682f0ff54c
-  data.tar.gz: 2d8eec7c4e57644c35e8c48eb64f59de7eaa0be7
+  metadata.gz: 9f85684d28ccc8db527dfffaa18a44cacc0d895a
+  data.tar.gz: 10ab8d5a4e563e544b421348932e9955db9e2ba5
 SHA512:
-  metadata.gz: faa8d05392d4f11c966b5a3e803701a4e6830f2e734ce75907563642d3f5985baec7d44db4c3534b04156b2da7091f4bc588074358f287e888f530dc5e3e754a
-  data.tar.gz: 6473692e2bfa5b592e64dd30afb51ec6314690de7ebeb91dc622a6f23f029027a913a5a7440a1edae0a3d2c11d7272a64a00b8bc6117cecebee7172933b40bde
+  metadata.gz: 6066051c11226c1910cffc07230c43c222968f52bd48589b6f2f40688ad88e51e1e51cc42880fe68f6d8a4df4658a71eefe047807ae57a67c8e153121d765515
+  data.tar.gz: d8c18d10e928dadb05d629f8a0957b679a78d51642c7312f7667dbd6092728bc8dcb142fa2f5e72dfe26473284921765d4d58332c7c2c38082093c6286548fc5

data/README.md

@@ -180,17 +180,21 @@ BASE_OPTIONS = {
 
 <br>While most of these options are self explanatory, a few could stand some
 further description:
+* :prompt is the standard prompt used when text is not scrolled.
 * :alt_prompt is the prompt used when the text must be scrolled to fit on the
 screen. If this is set to nil, then the main prompt is always used.
+<br>Both the prompt and alt_prompt may contain ANSI terminal control sequences.
+These are restricted, however, to those commands that do not alter the position
+of the cursor. So basically colors, highlighting, etc.
 * :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
 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::QuotedFileFolderSource. This option can be changed up to get
-auto-complete data other than files and folders. See Auto-Compete below for
+* :auto_source is the class of the source for auto-complete data. By default
+this 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
@@ -261,7 +265,7 @@ the initialize, rebuild, and next methods.
 
   end
 ```
-To enable the use of a custom auto-completer, three things mst be done:
+To enable the use of a custom auto-completer, three things must 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.
@@ -325,7 +329,8 @@ To date this code has been tested under:
 * Windows 7 with ruby 2.1.6p336 (2015-04-13 revision 50298) [i386-mingw32]
 * Windows 7+Cygwin with ruby 2.2.3p173 (2015-08-18 revision 51636) [i386-cygwin]
 
-<br>**More testing is clearly called for and suggestions/bug reports are most welcomed!!!**
+<br>**More testing is clearly called for and suggestions/bug reports are most
+welcomed!!!**
 
 ## Contributing
 

data/lib/mini_readline/read_line.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 
+require_relative 'read_line/prompt'
 require_relative 'read_line/edit'
 require_relative 'read_line/history'
 require_relative 'read_line/no_history'
@@ -63,18 +64,18 @@ module MiniReadline
 
     #Set up the prompt.
     def set_prompt(prompt)
-      @options[:base_prompt]   = prompt
-      @options[:scroll_prompt] = @options[:alt_prompt] || prompt
+      @options[:base_prompt]   = Prompt.new(prompt)
+      @options[:scroll_prompt] = Prompt.new(@options[:alt_prompt] || prompt)
 
       verify_prompt(@options[:base_prompt])
       verify_prompt(@options[:scroll_prompt])
     end
 
     #Verify that the prompt will fit!
-    def verify_prompt(str)
-      unless (@options[:window_width] - str.length) >
+    def verify_prompt(prompt)
+      unless (@options[:window_width] - prompt.length) >
              (@options[:scroll_step] * 2)
-        fail "Prompt too long: #{str.inspect}"
+        fail "Too long: #{prompt.inspect}"
       end
     end
   end

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

@@ -16,7 +16,7 @@ module MiniReadline
       @scroll_width = window_width - @options[:scroll_prompt].length
       @term         = @options[:term]
 
-      @left_margin, @window_buffer = 0, ""
+      @left_margin, @window_buffer, @show_prompt = 0, "", true
     end
 
     #What is the offset of the window's left margin?

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

@@ -8,7 +8,11 @@ module MiniReadline
 
     #Keep the edit window in sync!
     def sync_window(edit_buffer, edit_posn)
-      window_buffer.clear unless check_margins(edit_buffer.length, edit_posn)
+      unless check_margins(edit_buffer.length, edit_posn)
+        window_buffer.clear
+        @show_prompt = true
+      end
+
       image = build_screen_image(edit_buffer)
       update_screen(image)
       @window_buffer = image
@@ -31,14 +35,19 @@ module MiniReadline
 
     #Compute what should be on the screen.
     def build_screen_image(edit_buffer)
-      prompt + edit_buffer[left_margin..right_margin].ljust(window_width)
+      edit_buffer[left_margin..right_margin].ljust(active_width)
     end
 
     #Bring the screen into agreement with the image.
     def update_screen(image)
-      (0...window_width).each do |index|
+      if @show_prompt
+        @term.put_string("\r#{prompt.text}\r")
+        @show_prompt = false
+      end
+
+      (0...active_width).each do |index|
         if (image_char = image[index]) != window_buffer[index]
-          @term.set_posn(index)
+          @term.set_posn(prompt.length + index)
           @term.put_string(image_char)
         end
       end

data/lib/mini_readline/read_line/prompt.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+#Support for the specialized prompt string class.
+module MiniReadline
+
+  #A class used to hold prompt strings that may contain ANSI terminal
+  #control embellishments.
+  class Prompt
+
+    #Get the text.
+    attr_reader :text
+
+    #Get the length without ANSI sequences.
+    attr_reader :length
+
+    def initialize(text)
+      @text = text
+      @length = text.gsub(/\x1B\[(\d|;)*[@-~]/, "").length
+    end
+
+    #Inspect the prompt
+    def inspect
+      "<Prompt: #{@text.inspect}>"
+    end
+
+  end
+
+end

data/lib/mini_readline/version.rb

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

data/sire.rb

@@ -105,7 +105,7 @@ class SIRE
     puts "Use the command 'q' to quit.\n\n"
 
     until @_done
-      exec_line(Readline.readline('SIRE>', true))
+      exec_line(Readline.readline("\e[7mSIRE>\e[0m", true))
     end
 
     puts "\n\n"

data/tests/mini_readline_tests.rb

@@ -85,7 +85,7 @@ class MiniReadlineTester < Minitest::Test
                                       auto_source: MiniReadline::ArraySource,
                                       array_src: fruit)
 
-    result = edit.readline(prompt: "Fruit: ")
+    result = edit.readline(prompt: "\e[7mFruit:\e[0m ")
     assert(fruit.include?(result))
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_readline
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -119,6 +119,7 @@ files:
 - lib/mini_readline/read_line/edit/word_right.rb
 - lib/mini_readline/read_line/history.rb
 - lib/mini_readline/read_line/no_history.rb
+- lib/mini_readline/read_line/prompt.rb
 - lib/mini_readline/version.rb
 - mini_readline.gemspec
 - mini_readline.reek