H3RALD

RawLine

A pure-ruby alternative to ReadLine

  • Project Status: On Hold
  • Version: 0.3.1

RawLine is a 100% Ruby alternative to the ReadLine library, providing some of its most popular features such as:

  • Basic line editing operations
  • Word completion
  • History Management
  • Custom key/key sequences bindings

Installation

The simplest method to install RawLine is to install the gem:

1gem install rawline

Usage

Editor initialization:

1require 'rawline'
2editor = RawLine::Editor.new

Key binding:

1editor.bind(:ctrl_z) { editor.undo }
2editor.bind(:up_arrow) { editor.history_back }
3editor.bind(:ctrl_x) { puts "Exiting..."; exit }

Setup word completion

1editor.completion_proc = lambda do |word|
2  if word
3    ['select', 'update', 'delete', 'debug', 'destroy'].find_all  { |e| e.match(/^#{Regexp.escape(word)}/) }
4  end
5end
6
7editor.completion_append_string = " "

Read input:

1editor.read("=> ", true)

Replacing Readline

Simply include the RawLine (or Rawline) module:

1include Rawline

…and you’ll get:

1readline(prompt, add_history) # RawLine::Editor#read(prompt, add_history)
2HISTORY # RawLine::Editor#history
3FILENAME_COMPLETION_PROC # Rawline::Editor#filename_completion_proc
4# ...

but also:

1Rawline.editor # RawLine::Editor

…which opens a world of endless possibilities! ;-)

Latest Updates