coolline 0.3.0 → 0.4.0

data/lib/coolline.rb

@@ -1,6 +1,8 @@
 require 'coolline/handler'
 require 'coolline/history'
+require 'coolline/ansi'
 require 'coolline/editor'
+require 'coolline/menu'
 
 require 'coolline/coolline'
 

data/lib/coolline/ansi.rb

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+
+class Coolline
+  # Mixin that allows to manipulate strings that contain ANSI color codes:
+  # getting their length, printing their n first characters, etc.
+  #
+  # Additionally, it can output certain commonly needed sequences — using the
+  # {#print} method to write to the output.
+  module ANSI
+    Code = %r{(\e\[\??\d+(?:[;\d]*)\w)}
+
+    # @return [Integer] Amount of characters within the string, disregarding
+    #   color codes.
+    def ansi_length(string)
+      strip_ansi_codes(string).length
+    end
+
+    # @return [String] The initial string without ANSI codes.
+    def strip_ansi_codes(string)
+      string.gsub(Code, "")
+    end
+
+    # @return [Boolean] True if the beginning of the string is an ANSI code.
+    def start_with_ansi_code?(string)
+      (string =~ Code) == 0
+    end
+
+    # Prints a slice of a string containing ANSI color codes. This allows to
+    # print a string of a fixed width, while still keeping the right colors,
+    # etc.
+    #
+    # @param [String] string
+    # @param [Integer] start
+    # @param [Integer] stop Stop index, excluded from the range.
+    def ansi_print(string, start, stop)
+      i = 0
+      string.split(Code).each do |str|
+        if start_with_ansi_code? str
+          print str
+        else
+          if i >= start
+            print str[0..(stop - i - 1)]
+          elsif i < start && i + str.size >= start
+            print str[(start - i), stop - start - 1]
+          end
+
+          i += str.size
+          break if i >= stop
+        end
+      end
+    end
+
+    # Clears the current line and resets the select graphics settings.
+    def reset_line
+      print "\r\e[0m\e[0K"
+    end
+
+    # Clears the screen and moves the cursor to the top-left corner.
+    def clear_screen
+      print "\e[2J"
+      go_to(1, 1)
+    end
+
+    # Moves the cursor to (x, y), where x is the colmun and y the line
+    # number. Both are 1-indexed. The origin is the top-left corner.
+    #
+    # @param [Integer] x
+    # @param [Integer] y
+    def go_to(x, y)
+      print "\e[#{y};#{x}H"
+    end
+
+    # Moves the cursor to the given (1-indexed) column number.
+    def go_to_col(x)
+      print "\e[#{x}G"
+    end
+
+    # Resets the current ansi color codes.
+    def reset_color
+      print "\e[0m"
+    end
+
+    # Erases the current line.
+    def erase_line
+      print "\e[0K"
+    end
+
+    # Moves to the beginning of the next line.
+    def go_to_next_line
+      print "\e[E"
+    end
+
+    # Moves to the beginning of the previous line.
+    def go_to_previous_line
+      print "\e[F"
+    end
+  end
+end

data/lib/coolline/coolline.rb

@@ -1,6 +1,8 @@
 require 'io/console'
 
 class Coolline
+  include ANSI
+
   if config_home = ENV["XDG_CONFIG_HOME"] and !config_home.empty?
     ConfigDir = File.join(config_home, "coolline")
   else
@@ -22,8 +24,6 @@ class Coolline
                "/dev/null"
              end
 
-  AnsiCode = %r{(\e\[\??\d+(?:[;\d]*)\w)}
-
   # @return [Hash] All the defaults settings
   Settings = {
     :word_boundaries => [" ", "-", "_"],
@@ -34,7 +34,7 @@ class Coolline
      Handler.new(?\C-a, &:beginning_of_line),
      Handler.new(?\C-e, &:end_of_line),
      Handler.new(?\C-k, &:kill_line),
-     Handler.new(?\C-u, &:clear_line),
+     Handler.new(?\C-u, &:kill_beginning_of_line),
      Handler.new(?\C-f, &:forward_char),
      Handler.new(?\C-b, &:backward_char),
      Handler.new(?\C-d, &:kill_current_char_or_leave),
@@ -73,7 +73,7 @@ class Coolline
     ],
 
     :unknown_char_proc => :insert_string.to_proc,
-    :transform_proc    => :line.to_proc,
+    :transform_proc    => proc { |line| line },
     :completion_proc   => proc { |cool| [] },
 
     :history_file => HistoryFile,
@@ -127,6 +127,8 @@ class Coolline
     yield self if block_given?
 
     @history ||= History.new(@history_file, @history_size)
+
+    @menu = Menu.new(@input, @output)
   end
 
   # @return [IO]
@@ -173,6 +175,9 @@ class Coolline
   # @return [String] Current prompt
   attr_accessor :prompt
 
+  # @return [Menu]
+  attr_accessor :menu
+
   # Reads a line from the terminal
   # @param [String] prompt Characters to print before each line
   def readline(prompt = ">> ")
@@ -188,13 +193,15 @@ class Coolline
 
     @should_exit = false
 
-    print "\r\e[0m\e[0K"
+    reset_line
     print @prompt
 
     @history.index = @history.size - 1
     @history << @line
 
     until (char = @input.getch) == "\r"
+      @menu.erase
+
       handle(char)
       return if @should_exit
 
@@ -202,49 +209,11 @@ class Coolline
         @history_moved = false
       end
 
-      width          = @input.winsize[1]
-      prompt_size    = strip_ansi_codes(@prompt).size
-      line           = transform(@line)
-
-      stripped_line_width = strip_ansi_codes(line).size
-      line << " " * [width - stripped_line_width - prompt_size, 0].max
-
-      # reset the color, and kill the line
-      print "\r\e[0m\e[0K"
-
-      if strip_ansi_codes(@prompt + line).size <= width
-        print @prompt + line
-        print "\e[#{prompt_size + @pos + 1}G"
-      else
-        print @prompt
-
-        left_width = width - prompt_size
-
-        start_index = [@pos - left_width + 1, 0].max
-        end_index   = start_index + left_width - 1
-
-        i = 0
-        line.split(AnsiCode).each do |str|
-          if start_with_ansi_code? str
-            # always print ansi codes to ensure the color is right
-            print str
-          else
-            if i >= start_index
-              print str[0..(end_index - i)]
-            elsif i < start_index && i + str.size >= start_index
-              print str[(start_index - i), left_width]
-            end
-
-            i += str.size
-            break if i >= end_index
-          end
-        end
-        if @pos < left_width + 1
-          print "\e[#{prompt_size + @pos + 1}G"
-        end
-      end
+      render
     end
 
+    @menu.erase
+
     print "\n"
 
     @history[-1] = @line if @history.size != 0
@@ -252,7 +221,35 @@ class Coolline
 
     @history.save_line
 
-    @line + "\n"
+    @line
+  end
+
+  # Displays the current code on the terminal
+  def render
+    width       = @input.winsize[1]
+    prompt_size = ansi_length(@prompt)
+    line        = transform(@line)
+
+    stripped_line_width = ansi_length(line)
+    line += " " * [width - stripped_line_width - prompt_size, 0].max
+
+    reset_line
+
+    if ansi_length(@prompt + line) <= width
+      print @prompt + line
+    else
+      print @prompt
+
+      left_width = width - prompt_size
+
+      start_index = [@pos - left_width + 1, 0].max
+      end_index   = start_index + left_width
+
+      ansi_print(line, start_index, end_index)
+    end
+
+    @menu.display
+    go_to_col [prompt_size + @pos + 1, width].min
   end
 
   # Reads a line with no prompt
@@ -367,40 +364,40 @@ class Coolline
     line[word_beginning_before(pos)...pos]
   end
 
-  # Tries to complete the current word
-  def complete
-    return if word_boundary? line[pos - 1]
-
-    completions = @completion_proc.call(self)
-    return if completions.empty?
+  # Sets the word at point, and moves the cursor to after the end of said word.
+  def completed_word=(string)
+    beg = word_beginning_before(pos)
+    line[beg...pos] = string
+    self.pos = beg + string.size
+  end
 
-    result = completions.inject do |common, el|
+  # @param [Array<String>] candidates
+  # @return [String] The common part between all completion candidates
+  def common_beginning(candidates)
+    candidates.inject do |common, el|
       i = 0
       i += 1 while common[i] == el[i]
 
       el[0...i]
     end
-
-    beg = word_beginning_before(pos)
-    line[beg...pos] = result
-    self.pos = beg + result.size
   end
 
-  def word_boundary?(char)
-    char =~ word_boundaries_regexp
-  end
+  # Tries to complete the current word
+  def complete
+    return if word_boundary? line[pos - 1]
 
-  def strip_ansi_codes(string)
-    string.gsub(AnsiCode, "")
-  end
+    completions = @completion_proc.call(self)
 
-  def start_with_ansi_code?(string)
-    (string =~ AnsiCode) == 0
+    if completions.empty?
+      menu.string = "(No completions found)"
+    else
+      menu.list = completions
+      self.completed_word = common_beginning(completions)
+    end
   end
 
-  def clear_screen
-    print "\e[2J"   # clear
-    print "\e[0;0H" # goto 0, 0
+  def word_boundary?(char)
+    char =~ word_boundaries_regexp
   end
 
   private

data/lib/coolline/editor.rb

@@ -128,6 +128,12 @@ class Coolline
       line[pos..-1] = ""
     end
 
+    # Removes everything up to the current character
+    def kill_beginning_of_line
+      line[0...pos] = ""
+      self.pos = 0
+    end
+
     # Removes all the characters in the line
     def clear_line
       line.clear

data/lib/coolline/menu.rb

@@ -0,0 +1,107 @@
+class Coolline
+  # A menu allows to display some information on a rectangle below the cursor.
+  #
+  # It displays a string or a list of strings until the user presses another
+  # key.
+  class Menu
+    include ANSI
+
+    def initialize(input, output)
+      @input  = input
+      @output = output
+
+      @string = ""
+
+      @last_line_count = 0
+    end
+
+    # @return [String] Information to be displayed
+    attr_accessor :string
+
+    # Sets the menu's string to a list of items, formatted in columns.
+    #
+    # @param [Array<String>] items
+    def list=(items)
+      if items.empty?
+        self.string = ""
+      else
+        height, width = @input.winsize
+
+        col_width  = items.map { |s| ansi_length(s) }.max
+        col_count  = width / col_width
+        item_count = col_count * (height - 1)
+
+        self.string = format_columns(items[0, item_count], col_count, col_width)
+      end
+    end
+
+    # Renders the menu below the current line.
+    #
+    # This will ensure not to draw to much, so that the line currently being
+    # edited will always stay visible.
+    #
+    # Once the menu is drawn, the cursor returns to the correct line.
+    def display
+      # An empty string shouldn't be treated like a 1-line string.
+      return if @string.empty?
+
+      height, width = @input.winsize
+
+      lines = @string.lines.to_a
+
+      lines[0, height - 1].each do |line|
+        print "\n\r"
+        ansi_print(line.chomp, 0, width)
+      end
+      reset_color
+
+      [lines.size, height].min.times { go_to_previous_line }
+
+      @last_line_count = [height - 1, lines.size].min
+    end
+
+    # Erases anything that had been written by the menu.
+    #
+    # This allows to hide the menu once it is no longer relevant.
+    #
+    # Notice it can only work by knowing how many lines the menu drew on the
+    # screen last time it was called, and assuming the terminal size didn't
+    # change.
+    def erase
+      return if @last_line_count.zero?
+
+      self.string = ""
+
+      @last_line_count.times do
+        go_to_next_line
+        erase_line
+      end
+      reset_color
+
+      @last_line_count.times { go_to_previous_line }
+
+      @last_line_count = 0
+    end
+
+    private
+
+    # @param [Array<String>] items Items to show
+    # @param [Integer] col_count Amount of columns to show
+    # @param [Integer] col_width Width of each column
+    #
+    # @return [String] Items formatted appropriately
+    def format_columns(items, col_count, col_width)
+      string = ""
+
+      items.each_slice(col_count) do |line|
+        string << line.map { |s| s.ljust(col_width - 1) } * " " << "\n"
+      end
+
+      string
+    end
+
+    def print(*objs)
+      @output.print(*objs)
+    end
+  end
+end

data/lib/coolline/version.rb

@@ -1,3 +1,3 @@
 class Coolline
-  Version = "0.3.0"
+  Version = "0.4.0"
 end

data/repl.rb

@@ -5,7 +5,7 @@ require 'coderay'
 require 'pp'
 
 Coolline.bind "\C-z" do |c|
-  puts c.object_id
+  c.menu.string = "Coolline object id: #{c.object_id}"
 end
 
 cool = Coolline.new do |c|

data/test/editor_test.rb

@@ -63,6 +63,13 @@ context "editor of an empty line" do
     asserts(:line).equals ""
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals ""
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 
@@ -142,6 +149,13 @@ context "editor before many words" do
     asserts(:line).equals ""
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals "a lovely dragon"
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 
@@ -216,6 +230,13 @@ context "editor between two words" do
     asserts(:line).equals "foo "
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals " bar"
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 
@@ -318,6 +339,13 @@ context "editor between two out of three words" do
     asserts(:line).equals "foo bar"
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals " baz"
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 
@@ -425,6 +453,13 @@ context "editor at the end of a line" do
     asserts(:line).equals "a lovely dragon"
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals ""
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 
@@ -537,6 +572,13 @@ context "editor in the middle of a sentence" do
     asserts(:line).equals "foo bar "
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals "baz qux"
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 
@@ -649,6 +691,13 @@ context "editor in the middle of a word" do
     asserts(:line).equals "foo bar b"
   end
 
+  context "after killing the beginning of the line" do
+    hookup { topic.kill_beginning_of_line }
+
+    asserts(:pos).equals 0
+    asserts(:line).equals "az qux"
+  end
+
   context "after transposing words" do
     hookup { topic.transpose_words }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coolline
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &18648680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18648680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'A readline-like library that allows to change how the input
 
   is displayed.
@@ -32,17 +37,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/coolline/editor.rb
+- lib/coolline/ansi.rb
+- lib/coolline/version.rb
+- lib/coolline/menu.rb
 - lib/coolline/handler.rb
 - lib/coolline/history.rb
-- lib/coolline/editor.rb
 - lib/coolline/coolline.rb
-- lib/coolline/version.rb
 - lib/coolline.rb
 - test/helpers.rb
-- test/editor_test.rb
 - test/coolline_test.rb
-- test/run_all.rb
 - test/history_test.rb
+- test/editor_test.rb
+- test/run_all.rb
 - repl.rb
 - .gemtest
 homepage: http://github.com/Mon-Ouie/coolline
@@ -65,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Sounds like readline, smells like readline, but isn't readline