mini_readline 0.8.1 → 0.9.0

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

@@ -6,31 +6,31 @@ require_relative 'auto_complete/auto_file_source'
 require_relative 'auto_complete/quoted_file_folder_source'
 require_relative 'auto_complete/array_source'
 
-#* read_line/window/edit/auto_complete.rb - Process :auto_complete
+# Process :auto_complete
 module MiniReadline
 
-  #Set up the default auto-complete data source.
+  # Set up the default auto-complete data source.
   BASE_OPTIONS[:auto_source] = QuotedFileFolderSource
 
-  #* read_line/window/edit/auto_complete.rb - Process :auto_complete
+  # Process :auto_complete
   class Edit
 
-    #The auto-complete command.
+    # The auto-complete command.
     def auto_complete(_keyboard_args)
       if @options[:auto_complete] && (new_buffer = auto_manager.next(auto_trim))
         @edit_buffer = new_buffer
         @edit_posn   = length
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
 
-    #Get the base part of the edit buffer.
+    # Get the base part of the edit buffer.
     def auto_trim
       @edit_buffer[0...(@edit_posn)]
     end
 
-    #Get the auto-complete manager
+    # Get the auto-complete manager
     def auto_manager
       @_auto_manager ||= AutoManager.new{@options[:auto_source].new(@options)}
     end

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

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* array_source.rb - An array as the source for auto-complete.
+# An array as the source for auto-complete.
 module MiniReadline
 
-  #* array_source.rb - An array as the source for auto-complete.
+  # An array as the source for auto-complete.
   class ArraySource
 
-    #Create a new file/folder auto-data source. NOP
+    # Create a new file/folder auto-data source. NOP
     def initialize(options)
       @options = options
     end
 
-    #Construct a new data list for auto-complete
+    # Construct a new data list for auto-complete
     def rebuild(str)
       extract_root_pivot(str)
 
@@ -20,12 +20,12 @@ module MiniReadline
       @cycler = list.empty? ? nil : list.cycle
     end
 
-    #Parse the string into the two basic components.
+    # Parse the string into the two basic components.
     def extract_root_pivot(str)
       @root, @pivot = /\S+$/ =~ str ? [$PREMATCH, $MATCH] : [str, ""]
     end
 
-    #Get the array of data from either an array or a block.
+    # Get the array of data from either an array or a block.
     def get_array
       if (src = @options[:array_src]).is_a?(Proc)
         src.call
@@ -34,7 +34,7 @@ module MiniReadline
       end
     end
 
-    #Get the next string for auto-complete
+    # Get the next string for auto-complete
     def next
       @root + @cycler.next
     end

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

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* auto_file.rb - The data source for mysh file name auto-complete.
+# The data source for mysh file name auto-complete.
 module MiniReadline
 
-  #* auto_file_source.rb - A flexible file source for shell emulation.
+  # A flexible file source for shell emulation.
   class AutoFileSource
 
-    #Create a new file/folder auto-data source. NOP
+    # Create a new file/folder auto-data source. NOP
     def initialize(_options)
       #Do nothing here!
     end
 
-    #Construct a new data list for auto-complete
+    # Construct a new data list for auto-complete
     def rebuild(str)
       extract_root_pivot(str)
 
@@ -20,46 +20,46 @@ module MiniReadline
       @cycler = list.empty? ? nil : list.cycle
     end
 
-    #The regex for extraction of the root and pivot.
+    # The regex for extraction of the root and pivot.
     EXTRACT = /("[^"\s][^"]*"?$)|(\S+$)/
 
-    #Parse the string into the two basic components.
+    # Parse the string into the two basic components.
     def extract_root_pivot(str)
       @root, @pivot = EXTRACT =~ str ? [$PREMATCH, $MATCH] : [str, ""]
     end
 
-    #Get the next string for auto-complete
+    # Get the next string for auto-complete
     def next
       @root + dress_up(@cycler.next)
     end
 
-    #Prepare the file name for internal use.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Prepare the file name for internal use.
+    # Endemic Code Smells
+    # :reek:UtilityFunction
     def dress_down(name)
       name.gsub("\\", "/").gsub('"', '')
     end
 
-    #Prepare the file name for external use.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Prepare the file name for external use.
+    # Endemic Code Smells
+    # :reek:UtilityFunction
     def dress_up(name)
       dress_up_quotes(dress_up_slashes(name))
     end
 
-    #Dress up slashes and backslashes.
+    # Dress up slashes and backslashes.
     def dress_up_slashes(name)
       backslash? ? name.gsub("/", "\\") : name
     end
 
-    #Dress up in quotes if needed.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Dress up in quotes if needed.
+    # Endemic Code Smells
+    # :reek:UtilityFunction
     def dress_up_quotes(name)
       name[' '] ? "\"#{name}\"" : name
     end
 
-    #Does this file name use backslashes?
+    # Does this file name use backslashes?
     def backslash?
       if @pivot.end_with?("\\")
         true
@@ -70,7 +70,7 @@ module MiniReadline
       elsif @pivot["/"]
         false
       else
-        MiniReadline::PLATFORM == :windows
+        MiniTerm.windows?
       end
     end
 

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* auto_manager.rb - The controller for auto-complete.
+# The controller for auto-complete.
 module MiniReadline
 
-  #* auto_manager.rb - The controller for auto-complete.
+  # The controller for auto-complete.
   class AutoManager
 
-    #Create a new auto-complete manager.
+    # Create a new auto-complete manager.
     def initialize(&block)
       @_block = block
       @active = nil
     end
 
-    #Get the next buffer string
+    # Get the next buffer string
     def next(buffer)
       unless @active && @old_buffer == buffer
         @active = source.rebuild(buffer)
@@ -25,7 +25,7 @@ module MiniReadline
       end
     end
 
-    #Get the data source
+    # Get the data source
     def source
       @_source ||= @_block.call
     end

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

@@ -1,15 +1,15 @@
 # coding: utf-8
 
-#* file_folder_source.rb - The data source for auto-complete.
+# The data source for auto-complete.
 module MiniReadline
 
-  #* file_folder_source.rb - The data source for auto-complete.
+  # The data source for auto-complete.
   class FileFolderSource
 
-    #Create a new file/folder auto-data source. NOP
+    # Create a new file/folder auto-data source. NOP
     def initialize(_options); end
 
-    #Construct a new data list for auto-complete
+    # Construct a new data list for auto-complete
     def rebuild(str)
       extract_root_pivot(str)
 
@@ -18,12 +18,12 @@ module MiniReadline
       @cycler = list.empty? ? nil : list.cycle
     end
 
-    #Parse the string into the two basic components.
+    # Parse the string into the two basic components.
     def extract_root_pivot(str)
       @root, @pivot = /\S+$/ =~ str ? [$PREMATCH, $MATCH] : [str, ""]
     end
 
-    #Get the next string for auto-complete
+    # Get the next string for auto-complete
     def next
       @root + @cycler.next
     end

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

@@ -1,15 +1,15 @@
 # coding: utf-8
 
-#* quoted_file_folder_source.rb - The data source for auto-complete.
+# The data source for auto-complete.
 module MiniReadline
 
-  #* quoted_file_folder_source.rb - The data source for auto-complete.
+  # The data source for auto-complete.
   class QuotedFileFolderSource
 
-    #Create a new file/folder auto-data source. NOP
+    # Create a new file/folder auto-data source. NOP
     def initialize(_options); end
 
-    #Construct a new data list for auto-complete
+    # Construct a new data list for auto-complete
     def rebuild(str)
       extract_root_pivot(str)
 
@@ -18,15 +18,15 @@ module MiniReadline
       @cycler = list.empty? ? nil : list.cycle
     end
 
-    #The parsing regular expression.
+    # The parsing regular expression.
     REGEX = /(?<=\")([^\"\s][^\"]*)?(?=\"?$)/
 
-    #Parse the string into the two basic components.
+    # Parse the string into the two basic components.
     def extract_root_pivot(str)
       @root, @pivot = REGEX =~ str ? [$PREMATCH, $MATCH] : [str + '"', ""]
     end
 
-    #Get the next string for auto-complete
+    # Get the next string for auto-complete
     def next
       "#{@root}#{@cycler.next}\""
     end

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/edit/cancel.rb - Process :cancel
+# Process :cancel
 module MiniReadline
 
-  #* read_line/window/edit/cancel.rb - Process :cancel - delete all text.
+  # Process :cancel - delete all text.
   class Edit
 
-    #All right! Scrap all of this and start over!
+    # All right! Scrap all of this and start over!
     def cancel(_keyboard_args)
       @edit_buffer = ""
       @edit_posn = 0

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* read_line/window/edit/delete_left.rb - Process :delete_left
+# Process :delete_left
 module MiniReadline
 
-  #* read_line/window/edit/delete_all_left.rb - Process :delete_all_left
+  # Process :delete_all_left
   class Edit
 
-    #The delete to the left command
+    # The delete to the left command
     def delete_all_left(_keyboard_args)
       if @edit_posn > 0
         @edit_buffer = @edit_buffer[@edit_posn..-1]
         @edit_posn = 0
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* read_line/window/edit/delete_all_right.rb - Process :delete_all_right
+# Process :delete_all_right
 module MiniReadline
 
-  #* read_line/window/edit/delete_right.rb - Process :delete_right
+  # Process :delete_right
   class Edit
 
-    #The delete to the right
+    # The delete to the right
     def delete_all_right(_keyboard_args)
       if @edit_posn < self.length
         @edit_buffer = @edit_buffer[0...@edit_posn]
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* read_line/window/edit/delete_left.rb - Process :delete_left
+# Process :delete_left
 module MiniReadline
 
-  #* read_line/window/edit/delete_left.rb - Process :delete_left
+  # Process :delete_left
   class Edit
 
-    #The delete to the left command
+    # The delete to the left command
     def delete_left(_keyboard_args)
       if @edit_posn > 0
         @edit_buffer = @edit_buffer[0...(@edit_posn-1)] +
@@ -14,7 +14,7 @@ module MiniReadline
 
         @edit_posn -= 1
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* read_line/window/edit/delete_right.rb - Process :delete_right
+# Process :delete_right
 module MiniReadline
 
-  #* read_line/window/edit/delete_right.rb - Process :delete_right
+  # Process :delete_right
   class Edit
 
-    #The delete to the right
+    # The delete to the right
     def delete_right(_keyboard_args)
       if @edit_posn < self.length
         @edit_buffer = @edit_buffer[0...(@edit_posn)] +
                        @edit_buffer[@edit_posn+1..-1]
       else
-        @term.beep
+        MiniTerm.beep
       end
     end
   end

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

@@ -3,75 +3,73 @@
 require_relative 'edit_window/sync_window'
 require_relative 'edit_window/sync_cursor'
 
-#* read_line/edit_window.rb - Edit window support.
+# Edit window support.
 module MiniReadline
 
-  #* read_line/edit_window.rb - Support for the edit window.
+  # Support for the edit window.
   class EditWindow
 
-    #Determine the edit window limits.
+    # Determine the edit window limits.
     def initialize(options)
       @options      = options
       @base_width   = window_width - @options[:base_prompt].length
       @scroll_width = window_width - @options[:scroll_prompt].length
-      @term         = @options[:term]
 
       @left_margin, @window_buffer, @show_prompt = 0, "", true
     end
 
-    #What is the offset of the window's left margin?
+    # What is the offset of the window's left margin?
     attr_reader :left_margin
 
-    #What is the offset of the window's right margin?
+    # What is the offset of the window's right margin?
     def right_margin
       left_margin + active_width - 1
     end
 
-    #Is the window currently in the scrolled state?
+    # Is the window currently in the scrolled state?
     def window_scrolled?
       left_margin > 0
     end
 
-    #The shadow copy of what is actually on the screen?
+    # The shadow copy of what is actually on the screen?
     attr_reader :window_buffer
 
-    #The width of the window with the base prompt
+    # The width of the window with the base prompt
     attr_reader :base_width
 
-    #The width of the window with the alternate prompt
+    # The width of the window with the alternate prompt
     attr_reader :scroll_width
 
-    #What is the full window width?
+    # What is the full window width?
     def window_width
       @options[:window_width]
     end
 
-    #How wide is the active region of the window now?
+    # How wide is the active region of the window now?
     def active_width
       window_scrolled? ? scroll_width : base_width
     end
 
-    #What is the current prompt?
+    # What is the current prompt?
     def prompt
       window_scrolled? ? @options[:scroll_prompt] : @options[:base_prompt]
     end
 
-    #What is the scroll step?
+    # What is the scroll step?
     def scroll_step
        @options[:scroll_step]
     end
 
     private
 
-    #Set the left margin
+    # 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.
+    # Set the right margin
+    # 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