----- 
permalink: rawline
filters_pre: 
- erb
- redcloth
title: "RawLine"
subtitle: A pure-ruby alternative to ReadLine
type: project
github: rawline
links:
- "Documentation": http://rawline.rubyforge.org
- "Download": http://rubyforge.org/projects/rawline 
- "Source": http://github.com/h3rald/rawline/tree/master 
- "Tracking": http://h3rald.lighthouseapp.com/projects/26374-rawline/overview 
status: On Hold
version: 0.3.2
-----

<%= render 'project_data', :tag => 'rawline' %>

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

h3. Installation

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

<% highlight :text do %>gem install rawline<% end %>

h3. Usage


Editor initialization:

<% highlight :ruby do %>
require 'rawline'
editor = RawLine::Editor.new
<% end %>

Key binding:

<% highlight :ruby do %>
editor.bind(:ctrl_z) { editor.undo }
editor.bind(:up_arrow) { editor.history_back }
editor.bind(:ctrl_x) { puts "Exiting..."; exit }
<% end %>

Setup word completion

<% highlight :ruby do %>
editor.completion_proc = lambda do |word|
	if word
		['select', 'update', 'delete', 'debug', 'destroy'].find_all  { |e| e.match(/^#{Regexp.escape(word)}/) }
	end
end

editor.completion_append_string = " "
<% end %>

Read input:

<% highlight :ruby do %>editor.read("=> ", true)<% end %>

h3. Replacing Readline

Simply include the RawLine (or Rawline) module:

<% highlight :ruby do %>include Rawline<% end %>

…and you’ll get:

<% highlight :ruby do %>
readline(prompt, add_history) # RawLine::Editor#read(prompt, add_history)
HISTORY # RawLine::Editor#history
FILENAME_COMPLETION_PROC # Rawline::Editor#filename_completion_proc
# ...
<% end %>

but also:

<% highlight :ruby do %>Rawline.editor # RawLine::Editor<% end %>

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

<%= render 'project_updates', :tag => 'rawline' %>