mini_readline 0.8.1 → 0.9.0

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

@@ -1,14 +1,14 @@
 # coding: utf-8
 
-#* read_line/window/sync_cursor.rb - Keep the cursor in sync.
+# Keep the cursor in sync.
 module MiniReadline
 
-  #* read_line/window/sync_cursor.rb - Keep the cursor in sync.
+  # Keep the cursor in sync.
   class EditWindow
 
-    #Keep the cursor in sync!
+    # Keep the cursor in sync!
     def sync_cursor(edit_posn)
-      @term.set_posn(edit_posn - left_margin + prompt.length)
+      MiniTerm.set_posn(column: edit_posn - left_margin + prompt.length)
     end
 
   end

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/sync_window.rb - Keeping the screen in sync.
+# Keeping the screen in sync.
 module MiniReadline
 
-  #* read_line/window/sync_window.rb - Keeping the screen in sync.
+  # Keeping the screen in sync.
   class EditWindow
 
-    #Keep the edit window in sync!
+    # Keep the edit window in sync!
     def sync_window(edit_buffer, edit_posn)
       unless check_margins(edit_buffer.length, edit_posn)
         window_buffer.clear
@@ -18,7 +18,7 @@ module MiniReadline
       @window_buffer = image
     end
 
-    #Verify/update the window margins. Returns true if they're fine.
+    # Verify/update the window margins. Returns true if they're fine.
     def check_margins(length, edit_posn)
       old_margins = [left_margin, right_margin]
 
@@ -33,7 +33,7 @@ module MiniReadline
       old_margins == [left_margin, right_margin]
     end
 
-    #Compute what should be on the screen.
+    # Compute what should be on the screen.
     def build_screen_image(edit_buffer)
       working_region = edit_buffer[left_margin..right_margin]
 
@@ -44,17 +44,17 @@ module MiniReadline
       end.ljust(active_width)
     end
 
-    #Bring the screen into agreement with the image.
+    # Bring the screen into agreement with the image.
     def update_screen(image)
       if @show_prompt
-        @term.put_string("\r#{prompt.text}\r")
+        MiniTerm.print("\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(prompt.length + index)
-          @term.put_string(image_char)
+          MiniTerm.set_posn(column: prompt.length + index)
+          MiniTerm.print(image_char)
         end
       end
     end

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

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

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/edit/enter.rb - Process :enter
+# Process :enter
 module MiniReadline
 
-  #* read_line/window/edit/enter.rb - Process :enter
+  # Process :enter
   class Edit
 
-    #The insert_text command. We are DONE!
+    # The insert_text command.
     def enter(_keyboard_args)
       @working = false
     end

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/edit/go_home.rb - Process :go_end
+# Process :go_end
 module MiniReadline
 
-  #* read_line/window/edit/go_home.rb - Process :go_end
+  # Process :go_end
   class Edit
 
-    #A lot to the right please!
+    # A lot to the right please!
     def go_end(_keyboard_args)
       @edit_posn = length
     end

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/edit/go_home.rb - Process :go_home
+# Process :go_home
 module MiniReadline
 
-  #* read_line/window/edit/go_home.rb - Process :go_home
+  # Process :go_home
   class Edit
 
-    #A lot to the left please!
+    # A lot to the left please!
     def go_home(_keyboard_args)
       @edit_posn = 0
     end

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

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* read_line/window/edit/go_left.rb - Process :go_left
+# Process :go_left
 module MiniReadline
 
-  #* read_line/window/edit/go_left.rb - Process :go_left
+  # Process :go_left
   class Edit
 
-    #A little to the left please!
+    # A little to the left please!
     def go_left(_keyboard_args)
       if @edit_posn > 0
         @edit_posn -= 1
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* read_line/window/edit/go_right.rb - Process :go_right
+# Process :go_right
 module MiniReadline
 
-  #* read_line/window/edit/go_right.rb - Process :go_right
+  # Process :go_right
   class Edit
 
-    #A little to the right please!
+    # A little to the right please!
     def go_right(_keyboard_args)
       if @edit_posn < edit_buffer.length
         @edit_posn += 1
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/edit/insert_text.rb - Process :insert_text
+# Process :insert_text
 module MiniReadline
 
-  #* read_line/window/edit/insert_text.rb - Process :insert_text
+  # Process :insert_text
   class Edit
 
-    #The insert_text command
+    # The insert_text command
     def insert_text(keyboard_args)
       @edit_buffer = @edit_buffer[0...@edit_posn] +
                      keyboard_args[1] +

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* read_line/window/edit/next_history.rb - Process :next_history
+# Process :next_history
 module MiniReadline
 
-  #* read_line/window/edit/next_history.rb - Process :next_history
+  # Process :next_history
   class Edit
 
-    #The insert_text command. We are DONE!
+    # The insert_text command. We are DONE!
     def next_history(_keyboard_args)
       if (temp = @history.get_next_history)
         @edit_buffer = temp
         @edit_posn   = temp.length
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* read_line/window/edit/previous_history.rb - Process :previous_history
+# Process :previous_history
 module MiniReadline
 
-  #* read_line/window/edit/previous_history.rb - Process :previous_history
+  # Process :previous_history
   class Edit
 
-    #The insert_text command. We are DONE!
+    # The insert_text command. We are DONE!
     def previous_history(_keyboard_args)
       if (temp = @history.get_previous_history)
         @edit_buffer = temp
         @edit_posn   = temp.length
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,14 +1,14 @@
 # coding: utf-8
 
-#* read_line/window/edit/unmapped.rb - Process :unmapped
+# Process :unmapped
 module MiniReadline
 
-  #* read_line/window/edit/unmapped.rb - Process :unmapped
+  # Process :unmapped
   class Edit
 
-    #An unmapped key was pressed. Beep!
+    # An unmapped key was pressed. Beep!
     def unmapped(_keyboard_args)
-      @term.beep
+      MiniTerm.beep
     end
   end
 end

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* read_line/window/edit/word_left.rb - Process :word_left
+# Process :word_left
 module MiniReadline
 
-  #* read_line/window/edit/word_left.rb - Process :word_left
+  # Process :word_left
   class Edit
 
-    #A little more to the left please!
+    # A little more to the left please!
     def word_left(_keyboard_args)
       if @edit_posn > 0
         left = @edit_buffer[0...@edit_posn]
         @edit_posn = (posn = left.rindex(/\s\S/)) ? posn+1 : 0
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* read_line/window/edit/word_right.rb - Process :word_right
+# Process :word_right
 module MiniReadline
 
-  #* read_line/window/edit/word_right.rb - Process :word_right
+  # Process :word_right
   class Edit
 
-    #A little more to the right please!
+    # A little more to the right please!
     def word_right(_keyboard_args)
       if @edit_posn < length
         right = @edit_buffer[(@edit_posn+1)..-1]
         @edit_posn = (posn = right.index(/\s\S/)) ? @edit_posn+posn+2 : length
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

data/lib/mini_readline/read_line/history.rb

@@ -1,29 +1,29 @@
 # coding: utf-8
 
-#* read_line/history.rb - Edit history support
+# Edit history support
 module MiniReadline
 
-  #* read_line/history.rb - Support for the edit history.
+  # Support for the edit history.
   class History
 
-    #Setup the history array of the mini line editor.
+    # Setup the history array of the mini line editor.
     def initialize(buffer)
       @_buffer = buffer
       goto_end_of_history
     end
 
-    #Get the history object ready for the next read line operation.
+    # Get the history object ready for the next read line operation.
     def initialize_parms(options)
       @options = options
       goto_end_of_history
     end
 
-    #Go to the end of the history array.
+    # Go to the end of the history array.
     def goto_end_of_history
       @history_cursor = history.length
     end
 
-    #Get the previous history string.
+    # Get the previous history string.
     def get_previous_history
       if @history_cursor > 0
         @history_cursor -= 1
@@ -33,7 +33,7 @@ module MiniReadline
       end
     end
 
-    #Get the next history string
+    # Get the next history string
     def get_next_history
       if @history_cursor < history.length
         @history_cursor += 1
@@ -43,7 +43,7 @@ module MiniReadline
       end
     end
 
-    #Append a string to the history buffer if enabled.
+    # Append a string to the history buffer if enabled.
     def append_history(str)
       return              if @options[:no_blanks] && str.strip.empty?
       history.delete(str) if @options[:no_dups]
@@ -51,7 +51,7 @@ module MiniReadline
       history << str
     end
 
-    #Get the history buffer associated with this instance.
+    # Get the history buffer associated with this instance.
     def history
       @_buffer
     end

data/lib/mini_readline/read_line/no_history.rb

@@ -1,34 +1,34 @@
 # coding: utf-8
 
-#* read_line/no_history.rb - Support for the edit without history.
+# Support for the edit without history.
 module MiniReadline
 
-  #* read_line/no_history.rb - Support for the edit without history.
+  # Support for the edit without history.
   class NoHistory
 
-    #Get the history object ready for the next read line operation. NOP
+    # Get the history object ready for the next read line operation. NOP
     def initialize_parms(_options)
     end
 
-    #Go to the end of the history array. NOP
+    # Go to the end of the history array. NOP
     def goto_end_of_history
     end
 
-    #Get the previous history string. NOP
+    # Get the previous history string. NOP
     def get_previous_history
       false
     end
 
-    #Get the next history string. NOP
+    # Get the next history string. NOP
     def get_next_history
       false
     end
 
-    #Append a string to the history buffer if enabled. NOP
+    # Append a string to the history buffer if enabled. NOP
     def append_history(_str)
     end
 
-    #Get the history buffer associated with this instance. Empty
+    # Get the history buffer associated with this instance. Empty
     def history
       []
     end

data/lib/mini_readline/read_line/prompt.rb

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