yap-rawline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76acdc9b7eb8468db86e98f86c2eb40383b61497
+  data.tar.gz: 54fe99a5a89a602cdcbe0ad54cbf139ff041423a
+SHA512:
+  metadata.gz: 6000eefda9f5121e4d2f697f09b9dcd95980b377b685192a23fe6e62934ff06224f6ed3874532974eae7d25dfb9093284c3fe3853ae8245307f2d3b547be26c0
+  data.tar.gz: d982956b2abe6c8a0531060072117f15513809dc5ba1cbd6260236376f4a7753f0327da46a1046a96b539e308feb0dfffd34d98bf4b1ad62e97dfbaa458ca2ad

data/CHANGELOG.rdoc

@@ -0,0 +1,42 @@
+== Version 0.3.1
+
+* Renamed completion_append_char to complation_append_character (Readline compatibility).
+* Fixed minor bugs in HistoryBuffer (push and << methods are now redefined properly).
+* The string returned by Editor#read (and Rawline#readline) does not contain a trailing newline character anymore (Readline compatibility)
+* It is now possible to set Line#word_separator to an empty string or nil (Readline compatibility).
+* Fixed #6 (Fixnum#ord not defined on Ruby 1.8.6)
+* Fixed #7 (Win32Console gem not required)
+* Fixed #8 (Rawline.version not defined)
+* Fixed #9 (Readline compatibility issues)
+
+
+== Version 0.3.0
+
+* Fixed linux-specific bugs.
+* Added RawLine::Line#words method, which returns the words typed in the current line.
+* undo and redo action now bound to C-u and C-r instead of C-z and C-y to avoid conflicts on Linux.
+* test file and directory renaming.
+* Fixed #1 [#21300] bad requirement because sensitive case error.
+* Fixed #2 [#21301] unitialized constant when no WIN32CONSOLE.
+* Added Ruby 1.9.1 support.
+* Editor#read now takes an optional parameter (default: false) to enable or disable history.
+* Line is no longer added to history when calling Editor#history_back.
+* Added Editor#filename_completion_proc.
+* Editor#completion_proc defaults to Editor#filename_completion_proc.
+*  RawLine is now a drop-in replacement for Readline.
+* Added examples/readline_emulation.rb.
+* Moved repository to GitHub.
+
+== Version 0.2.0
+
+* Added /examples and /test directory to gem.
+* Escape codes can now be used in prompt.
+* It is now possible to use bind(key, &block) with a String as key, even if the corresponding escape sequence is not defined.
+* Added Editor#write_line(string) to print a any string (and "hit return").
+* Library name changed to "RawLine" to avoid name collision issues (Bug 18879: http://rubyforge.org/tracker/?func=detail&aid=18879&group_id=5622&atid=21788).
+* Provided alternative implementation for left and right arrows if terminal
+supports escape sequences (on Windows, it requires the Win32Console gem).
+
+== Version 0.1.0
+
+First preview release of InLine, implementing some of the functionality provided by the ReadLine library such as basic line editing, history and word completion. 

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2008-2013, Fabio Cevasco
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/README.rdoc

@@ -0,0 +1,60 @@
+= RawLine
+
+RawLine was created to provide 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:
+
+  gem install rawline
+
+== Usage
+
+Editor initialization:
+
+  require 'rawline'
+  editor = RawLine::Editor.new
+
+Key binding:
+
+  editor.bind(:ctrl_z) { editor.undo }
+  editor.bind(:up_arrow) { editor.history_back }
+  editor.bind(:ctrl_x) { puts "Exiting..."; exit }
+
+Setup word completion
+
+  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 = " "
+
+Read input:
+
+  editor.read("=> ", true)
+
+== Replacing Readline
+
+Simply include the RawLine (or Rawline) module:
+  
+  include Rawline
+
+...and you'll get:
+
+  readline(prompt, add_history) # RawLine::Editor#read(prompt, add_history)
+  HISTORY  # RawLine::Editor#history
+  FILENAME_COMPLETION_PROC  # Rawline::Editor#filename_completion_proc
+  ...
+
+but also:
+
+  Rawline.editor  # RawLine::Editor
+
+...which opens a world of endless possibilities! ;-)
+ 

data/examples/key_tester.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'highline/system_extensions'
+
+include HighLine::SystemExtensions
+
+puts "Press a key to view the corresponding ASCII code(s) (or CTRL-X to exit)."
+
+loop do
+
+  print "=> "
+  char = get_character.ord rescue nil
+  case char
+  when ?\C-x.ord then
+     puts "Exiting..."; exit;
+  else 
+    puts "#{char.chr} [#{char}] (hex: #{char.to_s(16)})";
+  end
+  
+end

data/examples/rawline_irb.rb

@@ -0,0 +1,28 @@
+#!usr/bin/env ruby
+
+require 'irb'
+require 'irb/completion'
+require File.dirname(File.expand_path(__FILE__))+'/../lib/rawline'
+
+Rawline.basic_word_break_characters= " \t\n\"\\'`><;|&{(" 
+Rawline.completion_append_character = nil
+Rawline.completion_proc = IRB::InputCompletor::CompletionProc
+
+class RawlineInputMethod < IRB::ReadlineInputMethod
+  include Rawline
+  def gets
+    if l = readline(@prompt, false)
+      HISTORY.push(l) if !l.empty?
+      @line[@line_no += 1] = l + "\n"
+    else
+      @eof = true
+      l
+    end
+  end
+end
+
+module IRB
+   @CONF[:LC_MESSAGES] = Locale.new
+  @CONF[:SCRIPT] = RawlineInputMethod.new
+end
+IRB.start

data/examples/rawline_rush.rb

@@ -0,0 +1,27 @@
+#!usr/bin/env ruby
+
+require 'rubygems'
+require 'rush'
+require File.dirname(File.expand_path(__FILE__))+'/../lib/rawline'
+
+class RawlineRush < Rush::Shell
+
+  def initialize
+    Rawline.basic_word_break_characters = "" 
+    Rawline.completion_proc = completion_proc
+    super
+  end
+
+  def run
+    loop do
+      cmd = Rawline.readline('rawline_rush> ')
+      finish if cmd.nil? or cmd == 'exit'
+      next if cmd == ""
+      Rawline::HISTORY.push(cmd)
+      execute(cmd)
+    end
+  end
+end
+
+shell = RawlineRush.new.run
+

data/examples/rawline_shell.rb

@@ -0,0 +1,189 @@
+#!usr/bin/env ruby
+
+require File.dirname(File.expand_path(__FILE__))+'/../lib/rawline'
+require 'io/console'
+require 'term/ansicolor'
+
+$z = File.open("/tmp/z.log", "w+")
+$z.sync = true
+
+# puts "*** Rawline Editor Test Shell ***"
+# puts " * Press CTRL+X to exit"
+# puts " * Press CTRL+G to clear command history"
+# puts " * Press CTRL+D for line-related information"
+# puts " * Press CTRL+E to view command history"
+
+editor = RawLine::Editor.new
+kill_ring = []
+
+editor.terminal.keys.merge!(enter: [13])
+editor.bind(:return){ editor.newline }
+
+# Move to beginning of line
+editor.bind(:ctrl_a) { editor.move_to_beginning_of_input }
+
+# Move to end of line
+editor.bind(:ctrl_e) { editor.move_to_end_of_input }
+
+# Move backward one word at a time
+editor.bind(:ctrl_b) {
+  text = editor.line.text[0...editor.line.position].reverse
+  position = text.index(/\s+/, 1)
+  position = position ? (text.length - position) : 0
+  editor.move_to_position position
+}
+
+# Move forward one word at a time
+editor.bind(:ctrl_f) {
+  text = editor.line.text
+  position = text.index(/\s+/, editor.line.position)
+  position = position ? (position + 1) : text.length
+  editor.move_to_position position
+}
+
+# Yank text from the kill ring and insert it at the cursor position
+editor.bind(:ctrl_y){
+  text = kill_ring[-1]
+  if text
+    editor.yank_forward text
+  end
+}
+
+# Backwards delete one word
+editor.bind(:ctrl_w){
+  before_text =  editor.line.text[0...editor.line.position]
+  after_text = editor.line.text[editor.line.position..-1]
+
+  have_only_seen_whitespace = true
+  position = 0
+
+  before_text.reverse.each_char.with_index do |ch, i|
+    if ch =~ /\s/ && !have_only_seen_whitespace
+      position = before_text.length - i
+      break
+    else
+      have_only_seen_whitespace = false
+    end
+  end
+
+  killed_text = before_text[position...editor.line.position]
+  kill_ring.push killed_text
+
+  text = [before_text.slice(0, position), after_text].join
+  editor.overwrite_line text
+  editor.move_to_position position
+}
+
+# History forward, but if at the end of the history then give user a
+# blank line rather than remain on the last command
+editor.bind(:down_arrow) {
+  if editor.history.searching? && !editor.history.end?
+    editor.history_forward
+  else
+    editor.overwrite_line ""
+  end
+}
+editor.bind(:up_arrow) { editor.history_back }
+
+editor.bind(:enter) { editor.newline }
+editor.bind(:tab) { editor.complete }
+editor.bind(:backspace) { editor.delete_left_character }
+
+# Delete to end of line from cursor position
+editor.bind(:ctrl_k) {
+  kill_ring.push editor.kill_forward
+}
+
+# Delete to beginning of line from cursor position
+editor.bind(:ctrl_u) {
+  kill_ring.push editor.line.text[0...editor.line.position]
+  editor.overwrite_line editor.line.text[editor.line.position..-1]
+  editor.move_to_position 0
+}
+
+# Forward delete a character, leaving the cursor in place
+editor.bind("\e[3~") {
+  before_text =  editor.line.text[0...editor.line.position]
+  after_text = editor.line.text[(editor.line.position+1)..-1]
+  text = [before_text, after_text].join
+  position = editor.line.position
+  editor.overwrite_line text
+  editor.move_to_position position
+}
+
+editor.bind(:ctrl_l){
+  editor.clear_screen
+}
+
+editor.bind(:ctrl_r) {
+   editor.redo
+}
+editor.bind(:left_arrow) { editor.move_left }
+editor.bind(:right_arrow) { editor.move_right }
+editor.bind(:up_arrow) { editor.history_back }
+editor.bind(:down_arrow) { editor.history_forward }
+editor.bind(:delete) { editor.delete_character }
+editor.bind(:insert) { editor.toggle_mode }
+
+editor.bind(:ctrl_g) { editor.clear_history }
+# editor.bind(:ctrl_l) { editor.debug_line }
+editor.bind(:ctrl_h) { editor.show_history }
+editor.bind(:ctrl_d) { puts; puts "Exiting..."; exit }
+
+# character-search; wraps around as necessary
+editor.bind(:ctrl_n) {
+  line = editor.line
+  text, start_position = line.text, line.position
+  i, new_position = start_position, nil
+
+  break_on_bytes = [editor.terminal.keys[:ctrl_c]].flatten
+  byte = [editor.read_character].flatten.first
+
+  unless break_on_bytes.include?(byte)
+    loop do
+      i += 1
+      i = 0 if i >= text.length                                    # wrap-around to the beginning
+      break if i == start_position                                 # back to where we started
+      (editor.move_to_position(i) ; break) if text[i] == byte.chr  # found a match; move and break
+    end
+  end
+}
+
+editor.completion_proc = lambda do |word|
+  if word
+    ['select', 'settle', 'seinfeld', 'sediment', 'selective', 'update', 'delete', 'debug', 'destroy'].find_all  { |e| e.match(/^#{Regexp.escape(word)}/) }
+  end
+end
+
+editor.on_word_complete do |event|
+  sub_word = event[:payload][:sub_word]
+  word = event[:payload][:word]
+  actual_completion = event[:payload][:completion]
+  possible_completions =  event[:payload][:possible_completions]
+
+  editor.content_box.content = possible_completions.map do |completion|
+    if completion == actual_completion
+      Term::ANSIColor.negative(completion)
+    else
+      completion
+    end
+  end.join("  ")
+end
+
+editor.on_word_complete_no_match do |event|
+  sub_word = event[:payload][:sub_word]
+  word = event[:payload][:word]
+  editor.content_box.content = "Failed to find a match to complete #{sub_word} portion of #{word}"
+end
+
+editor.on_read_line do |event|
+  line = event[:payload][:line]
+  puts "You typed: [#{line}]"
+  editor.reset_line
+end
+
+editor.on_word_complete_done do |event|
+  editor.content_box.content = ""
+end
+
+editor.start

data/examples/readline_emulation.rb

@@ -0,0 +1,17 @@
+#!usr/bin/env ruby
+
+require File.dirname(File.expand_path(__FILE__))+'/../lib/rawline'
+
+puts "*** Readline emulation Test Shell ***"
+puts " * Press CTRL+X to exit"
+puts " * Press <TAB> for file completion"
+
+Rawline.editor.bind(:ctrl_x) { puts; puts "Exiting..."; exit }
+
+Dir.chdir '..'
+
+include Rawline
+
+loop do
+  puts "You typed: [#{readline("=> ", true)}]"
+end

data/lib/rawline.rb

@@ -0,0 +1,60 @@
+#!usr/bin/env ruby
+
+#
+#  RawLine.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+
+require "rubygems"
+
+#
+# The RawLine (or Rawline) module can be used in the same way
+# as the Readline one.
+#
+module RawLine
+
+  def self.rawline_version
+    "0.3.2"
+  end
+
+  class BindingException < RuntimeError; end
+
+  if RUBY_PLATFORM.match(/mswin/i) then
+    begin
+      require 'win32console'
+      def self.win32console?; true; end
+      def self.ansi?; true; end
+    rescue Exception
+      def self.win32console?; false; end
+      def self.ansi?; false; end
+    end
+  else # Unix-like
+    def self.ansi?; true; end
+  end
+end
+
+# Adding Fixnum#ord for Ruby 1.8.6
+class Fixnum;  def ord; self; end;  end unless Fixnum.method_defined? :ord
+
+Rawline = RawLine
+
+dir = File.dirname(File.expand_path(__FILE__))
+require "highline"
+require "#{dir}/rawline/terminal"
+require "#{dir}/rawline/terminal/windows_terminal"
+require "#{dir}/rawline/terminal/vt220_terminal"
+require "#{dir}/rawline/history_buffer"
+require "#{dir}/rawline/line"
+require "#{dir}/rawline/prompt"
+require "#{dir}/rawline/completer"
+require "#{dir}/rawline/event_loop"
+require "#{dir}/rawline/event_registry"
+require "#{dir}/rawline/keycode_parser"
+require "#{dir}/rawline/editor"
+
+module RawLine
+end