mini_readline 0.0.1

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

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

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

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+#* read_line/window/edit/delete_right.rb - Process :delete_right
+module MiniReadline
+
+  #* read_line/window/edit/delete_right.rb - Process :delete_right
+  class Edit
+
+    #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
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+#* read_line/window/edit/next_history.rb - Process :next_history
+module MiniReadline
+
+  #* read_line/window/edit/next_history.rb - Process :next_history
+  class Edit
+
+    #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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+#* read_line/window/edit/previous_history.rb - Process :previous_history
+module MiniReadline
+
+  #* read_line/window/edit/previous_history.rb - Process :previous_history
+  class Edit
+
+    #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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+#* read_line/window/edit/unmapped.rb - Process :unmapped
+module MiniReadline
+
+  #* read_line/window/edit/unmapped.rb - Process :unmapped
+  class Edit
+
+    #An unmapped key was pressed. Beep!
+    def unmapped(keyboard_args)
+      if @options[:debug]
+        puts keyboard_args.inspect
+      end
+
+      @term.beep
+    end
+  end
+end

data/lib/mini_readline/read_line/edit_window.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+require_relative 'edit_window/sync_window'
+require_relative 'edit_window/sync_cursor'
+
+#* read_line/edit_window.rb - Edit window support.
+module MiniReadline
+
+  #* read_line/edit_window.rb - Support for the edit window.
+  class EditWindow
+
+    #Determine the edit window limits.
+    def initialize_parms(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 = 0, ""
+    end
+
+    #What is the offset of the window's left margin?
+    attr_accessor :left_margin
+
+    #What is the offset of the window's right margin?
+    def right_margin
+      left_margin + active_width - 1
+    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 right_margin=(value)
+      @left_margin = value - scroll_width + 1
+    end
+
+    #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?
+    attr_accessor :window_buffer
+
+    #The width of the window with the base prompt
+    attr_reader :base_width
+
+    #The width of the window with the alternate prompt
+    attr_reader :scroll_width
+
+    #What is the full window width?
+    def window_width
+      @options[:window_width]
+    end
+
+    #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?
+    def prompt
+      window_scrolled? ? @options[:scroll_prompt] : @options[:base_prompt]
+    end
+
+    #What is the scroll step?
+    def scroll_step
+       @options[:scroll_step]
+    end
+  end
+end

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

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

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

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+#* read_line/window/sync_window.rb - Keeping the screen in sync.
+module MiniReadline
+
+  #* read_line/window/sync_window.rb - Keeping the screen in sync.
+  class EditWindow
+
+    #Keep the edit window in sync!
+    def sync_window(edit_buffer, edit_posn)
+      window_buffer.clear unless check_margins(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)
+      old_margins = [left_margin, right_margin]
+
+      if 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]
+    end
+
+    #Compute what should be on the screen.
+    def build_screen_image(edit_buffer)
+      prompt + edit_buffer[left_margin..right_margin].ljust(window_width)
+    end
+
+    #Bring the screen into agreement with the image.
+    def update_screen(image)
+      (0...window_width).each do |index|
+        if (image_char = image[index]) != window_buffer[index]
+          @term.set_posn(index)
+          @term.put_string(image_char)
+        end
+      end
+    end
+
+  end
+end

data/lib/mini_readline/read_line/history.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+
+#* read_line/history.rb - Edit history support
+module MiniReadline
+
+  #* read_line/history.rb - Support for the edit history.
+  class History
+
+    #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.
+    def initialize_parms(options)
+      @options = options
+      goto_end_of_history
+    end
+
+    #Go to the end of the history array.
+    def goto_end_of_history
+      @history_cursor = history.length
+    end
+
+    #Get the previous history string.
+    def get_previous_history
+      if @history_cursor > 0
+        @history_cursor -= 1
+        self.history[@history_cursor]
+      else
+        false
+      end
+    end
+
+    #Get the next history string
+    def get_next_history
+      if @history_cursor < history.length
+        @history_cursor += 1
+        history[@history_cursor] || ""
+      else
+        false
+      end
+    end
+
+    #Append a string to the history buffer if enabled.
+    def append_history(str)
+      str_strip = str.strip
+
+      return if (str_strip == '')             && @options[:no_blanks]
+      return if (history.include?(str_strip)) && @options[:no_dups]
+
+      history << str
+    end
+
+    #Get the history buffer associated with this instance.
+    def history
+      @_buffer || []
+    end
+  end
+end

data/lib/mini_readline/version.rb

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

data/mini_readline.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mini_readline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_readline"
+  spec.version       = MiniReadline::VERSION
+  spec.authors       = ["Peter Camilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = "A simplified replacement for readline."
+  spec.description   = "A gem for console command entry with line edit and history."
+  spec.homepage      = "http://teuthida-technologies.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>=1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end