rawline 0.3.0 → 0.3.1

data/lib/rawline.rb

@@ -1,119 +1,109 @@
-#!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.
-#
-#	<tt>require 'rawline'</tt>
-#	<tt>include Rawline</tt>
-#	
-#	You'll get...
-#
-#	* <tt>readline(prompt="", add_history=false)</tt> - to read characters from $stdin
-#	* <tt>Rawline::HISTORY</tt> - to access line history (an instance of RawLine::HistoryBuffer)
-#	* <tt>Rawline::FILENAME_COMPLETION_PROC</tt> -  a Proc object used for filename completion
-#	* <tt>Rawline.completion_proc</tt> - the Proc object used for TAB completion (defaults to FILENAME_COMPLETION_PROC).
-#	* <tt>Rawline.completion_matches</tt> - an array of completion matches.
-#	* <tt>Rawline.completion_append_char</tt> - a character to append after a successful completion.
-#	* <tt>Rawline.basic_word_break_characters</tt> - a String listing all the characters used as word separators.
-#	* <tt>Rawline.completer_word_break_characters</tt> - same as above. 
-#	* <tt>Rawline.library_version</tt> - the current version of the Rawline library.
-#	* <tt>Rawline.clear_history</tt> - to clear the current history.
-#	* <tt>Rawline.match_hidden_files</tt> - whether FILENAME_COMPLETION_PROC matches hidden files and folders or not.
-#
-#	And also <tt>Rawline.editor</tt>, an instance of RawLine::Editor which can be used for anything you like.
-#
-module RawLine
-
-	def self.rawline_version
-		"0.3.0"
-	end
-
-	class BindingException < RuntimeError; end
-
-	if RUBY_PLATFORM.match(/mswin/i) then
-		begin
-			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
-
-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/editor"
-
-module RawLine
-	self.instance_eval do
-		class << self;	attr_accessor :editor, :implemented_methods;	end
-		@editor = RawLine::Editor.new
-
-		@implemented_methods = 
-			[
-				:completion_proc,
-				:completion_proc=,
-				:completion_matches,
-				:completion_append_char,
-				:completion_append_char=,
-				:basic_word_break_characters,
-				:basic_word_break_characters=,
-				:completer_word_break_characters,
-				:completer_word_break_characters=,
-				:library_version,
-				:clear_history,
-				:match_hidden_files,
-				:match_hidden_files=
-			]
-
-		self.module_eval do
-			HISTORY = RawLine.editor.history
-			FILENAME_COMPLETION_PROC = RawLine.editor.filename_completion_proc
-
-			def readline(prompt="", add_history=false)
-				RawLine.editor.read prompt, add_history
-			end
-
-			alias rawline readline
-		end
-
-		@implemented_methods.each do |meth|				
-			self.class.module_eval do
-				define_method meth do |*args|
-					case args.length
-					when 0 then
-						@editor.send(meth)
-					when 1 then
-						@editor.send(meth, args[0])
-					else
-						raise ArgumentError, "There are no Readline methods with more than one parameter"						
-					end
-				end
-			end
-		end
-
-	end
-
-end
+#!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.1"
+	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/editor"
+
+module RawLine
+	self.instance_eval do
+		class << self;	attr_accessor :editor end
+		@editor = RawLine::Editor.new
+
+		@implemented_methods = 
+			[
+				:completion_proc,
+				:completion_proc=,
+				:completion_matches,
+				:completion_append_character,
+				:completion_append_character=,
+				:basic_word_break_characters,
+				:basic_word_break_characters=,
+				:completer_word_break_characters,
+				:completer_word_break_characters=,
+				:library_version,
+				:clear_history,
+				:match_hidden_files,
+				:match_hidden_files=
+			]
+
+		@implemented_methods.each do |meth|				
+			self.class.module_eval do
+				define_method meth do |*args|
+					case args.length
+					when 0 then
+						@editor.send(meth)
+					when 1 then
+						@editor.send(meth, args[0])
+					else
+						raise ArgumentError, "There are no Readline methods with more than one parameter"						
+					end
+				end
+			end
+		end
+		
+		private
+		
+		HISTORY = RawLine.editor.history
+		FILENAME_COMPLETION_PROC = RawLine.editor.filename_completion_proc
+
+		readline_method = lambda do
+
+			def readline(prompt="", add_history=false)
+				RawLine.editor.read prompt, add_history
+			end
+
+			alias rawline readline
+		end
+		
+		self.class.module_eval &readline_method
+		self.module_eval &readline_method
+
+	end
+end

data/spec/editor_spec.rb

@@ -1,167 +1,167 @@
-#!/usr/bin/env ruby
-
-dir = File.dirname(File.expand_path(__FILE__))+'/..' 
-
-require 'highline/system_extensions'
-
-module HighLine::SystemExtensions
-  # Override Windows' character reading so it's not tied to STDIN.
-  def get_character( input = STDIN )
-		input.getbyte
-  end
-end
-
-require 'stringio'
-require "#{dir}/lib/rawline"
-
-describe RawLine::Editor do
-
-	before :each do
-		@output = StringIO.new
-		@input = StringIO.new
-		@editor = RawLine::Editor.new(@input, @output)
-	end
-
-	it "reads raw characters from @input" do
-		@input << "test #1"
-		@input.rewind
-	 	@editor.read
-		@editor.line.text.should == "test #1"
-		@output.string.should == "test #1\n"
-	end
-
-	it "can bind keys to code blocks" do
-		@editor.bind(:ctrl_w) { @editor.write "test #2a" }
-		@editor.bind(?\C-q) { "test #2b" }
-		@editor.bind(21) { "test #2c" }
-		@editor.bind([22]) { "test #2d" }
-		@editor.terminal.escape_codes = [] # remove any existing escape codes
-		lambda {@editor.bind({:test => [?\e.ord, ?t.ord, ?e.ord, ?s.ord, ?t.ord]}) { "test #2e" }}.should raise_error(RawLine::BindingException)
-		@editor.terminal.escape_codes << ?\e.ord
-		lambda {@editor.bind({:test => "\etest"}) { "test #2e" }}.should_not raise_error(RawLine::BindingException)
-		lambda {@editor.bind("\etest2") { "test #2f" }}.should_not raise_error(RawLine::BindingException)
-		@input << ?\C-w.chr
-		@input.rewind
-	 	@editor.read
-		@editor.line.text.should == "test #2a"
-		@editor.char = [?\C-q.ord]
-		@editor.press_key.should == "test #2b"
-		@editor.char = [?\C-u.ord]
-		@editor.press_key.should == "test #2c"
-		@editor.char = [?\C-v.ord]
-		@editor.press_key.should == "test #2d"
-		@editor.char = [?\e.ord, ?t.ord, ?e.ord, ?s.ord, ?t.ord]
-		@editor.press_key.should == "test #2e"
-		@editor.char = [?\e.ord, ?t.ord, ?e.ord, ?s.ord, ?t.ord, ?2.ord]
-		@editor.press_key.should == "test #2f"
-	end
-
-	it "keeps track of the cursor position" do
-		@input << "test #4"
-		@input.rewind
-		@editor.read
-		@editor.line.position.should == 7
-		3.times { @editor.move_left }
-		@editor.line.position.should == 4
-		2.times { @editor.move_right }
-		@editor.line.position.should == 6
-	end
-
-	it "can delete characters" do
-		@input << "test #5"
-		@input.rewind
-		@editor.read
-		3.times { @editor.move_left }
-		4.times { @editor.delete_left_character }
-		3.times { @editor.delete_character }
-		@editor.line.text.should == ""
-		@editor.line.position.should == 0
-	end
-
-	it "can clear the whole line" do
-		@input << "test #5"
-		@input.rewind
-		@editor.read
-		@editor.clear_line
-		@editor.line.text.should == ""
-		@editor.line.position.should == 0
-	end
-
-	it "supports undo and redo" do
-		@input << "test #6"
-		@input.rewind
-		@editor.read
-		3.times { @editor.delete_left_character }
-		2.times { @editor.undo }
-		@editor.line.text.should == "test #"
-		2.times { @editor.redo }
-		@editor.line.text.should == "test"
-	end
-
-	it "supports history" do
-		@input << "test #7a"
-		@input.rewind
-		@editor.read "", true
-		@editor.newline
-		@input << "test #7b"
-		@input.pos = 8
-		@editor.read "", true
-		@editor.newline
-		@input << "test #7c"
-		@input.pos = 16
-		@editor.read "", true
-		@editor.newline
-		@input << "test #7d"
-		@input.pos = 24
-		@editor.read "", true
-		@editor.newline
-		@editor.history_back
-		@editor.line.text.should == "test #7c"
-		10.times { @editor.history_back }
-		@editor.line.text.should == "test #7a"
-		2.times { @editor.history_forward }
-		@editor.line.text.should == "test #7c"
-	end
-
-	it "can overwrite lines" do
-		@input << "test #8a"
-		@input.rewind
-		@editor.read
-		@editor.overwrite_line("test #8b", 2)
-		@editor.line.text.should == "test #8b"
-		@editor.line.position.should == 2
-	end
-
-	it "can complete words" do
-		@editor.completion_append_string = "\t"
-		@editor.bind(:tab) { @editor.complete }
-		@editor.completion_proc = lambda do |word|
-	  	if word then
- 				['select', 'update', 'delete', 'debug', 'destroy'].find_all	{ |e| e.match(/^#{Regexp.escape(word)}/) }
-			end
-		end
-		@input << "test #9 de" << ?\t.chr << ?\t.chr
-		@input.rewind
-		@editor.read
-		@editor.line.text.should == "test #9 delete\t"
-	end
-
-	it "supports INSERT and REPLACE modes" do
-		@input << "test 0" 
-		@editor.terminal.keys[:left_arrow].each { |k| @input << k.chr }
-		@input << "#1"
-		@input.rewind
-		@editor.read
-		@editor.line.text.should == "test #10"
-		@editor.toggle_mode
-		@input << "test 0" 
-		@editor.terminal.keys[:left_arrow].each { |k| @input << k.chr }
-		@input << "#1"
-		@input.rewind
-		@editor.read
-		@editor.line.text.should == "test #1test #1"
-	end
-	
-
-end
-
+#!/usr/bin/env ruby
+
+dir = File.dirname(File.expand_path(__FILE__))+'/..' 
+
+require 'highline/system_extensions'
+
+module HighLine::SystemExtensions
+  # Override Windows' character reading so it's not tied to STDIN.
+  def get_character( input = STDIN )
+		(RUBY_VERSION.gsub(/1\./, '').to_f >= 8.7) ? input.getbyte : input.getc
+  end
+end
+
+require 'stringio'
+require "#{dir}/lib/rawline"
+
+describe RawLine::Editor do
+
+	before :each do
+		@output = StringIO.new
+		@input = StringIO.new
+		@editor = RawLine::Editor.new(@input, @output)
+	end
+
+	it "reads raw characters from @input" do
+		@input << "test #1"
+		@input.rewind
+	 	@editor.read
+		@editor.line.text.should == "test #1"
+		@output.string.should == "test #1\n"
+	end
+
+	it "can bind keys to code blocks" do
+		@editor.bind(:ctrl_w) { @editor.write "test #2a" }
+		@editor.bind(?\C-q) { "test #2b" }
+		@editor.bind(21) { "test #2c" }
+		@editor.bind([22]) { "test #2d" }
+		@editor.terminal.escape_codes = [] # remove any existing escape codes
+		lambda {@editor.bind({:test => [?\e.ord, ?t.ord, ?e.ord, ?s.ord, ?t.ord]}) { "test #2e" }}.should raise_error(RawLine::BindingException)
+		@editor.terminal.escape_codes << ?\e.ord
+		lambda {@editor.bind({:test => "\etest"}) { "test #2e" }}.should_not raise_error(RawLine::BindingException)
+		lambda {@editor.bind("\etest2") { "test #2f" }}.should_not raise_error(RawLine::BindingException)
+		@input << ?\C-w.chr
+		@input.rewind
+	 	@editor.read
+		@editor.line.text.should == "test #2a"
+		@editor.char = [?\C-q.ord]
+		@editor.press_key.should == "test #2b"
+		@editor.char = [?\C-u.ord]
+		@editor.press_key.should == "test #2c"
+		@editor.char = [?\C-v.ord]
+		@editor.press_key.should == "test #2d"
+		@editor.char = [?\e.ord, ?t.ord, ?e.ord, ?s.ord, ?t.ord]
+		@editor.press_key.should == "test #2e"
+		@editor.char = [?\e.ord, ?t.ord, ?e.ord, ?s.ord, ?t.ord, ?2.ord]
+		@editor.press_key.should == "test #2f"
+	end
+
+	it "keeps track of the cursor position" do
+		@input << "test #4"
+		@input.rewind
+		@editor.read
+		@editor.line.position.should == 7
+		3.times { @editor.move_left }
+		@editor.line.position.should == 4
+		2.times { @editor.move_right }
+		@editor.line.position.should == 6
+	end
+
+	it "can delete characters" do
+		@input << "test #5"
+		@input.rewind
+		@editor.read
+		3.times { @editor.move_left }
+		4.times { @editor.delete_left_character }
+		3.times { @editor.delete_character }
+		@editor.line.text.should == ""
+		@editor.line.position.should == 0
+	end
+
+	it "can clear the whole line" do
+		@input << "test #5"
+		@input.rewind
+		@editor.read
+		@editor.clear_line
+		@editor.line.text.should == ""
+		@editor.line.position.should == 0
+	end
+
+	it "supports undo and redo" do
+		@input << "test #6"
+		@input.rewind
+		@editor.read
+		3.times { @editor.delete_left_character }
+		2.times { @editor.undo }
+		@editor.line.text.should == "test #"
+		2.times { @editor.redo }
+		@editor.line.text.should == "test"
+	end
+
+	it "supports history" do
+		@input << "test #7a"
+		@input.rewind
+		@editor.read "", true
+		@editor.newline
+		@input << "test #7b"
+		@input.pos = 8
+		@editor.read "", true
+		@editor.newline
+		@input << "test #7c"
+		@input.pos = 16
+		@editor.read "", true
+		@editor.newline
+		@input << "test #7d"
+		@input.pos = 24
+		@editor.read "", true
+		@editor.newline
+		@editor.history_back
+		@editor.line.text.should == "test #7c"
+		10.times { @editor.history_back }
+		@editor.line.text.should == "test #7a"
+		2.times { @editor.history_forward }
+		@editor.line.text.should == "test #7c"
+	end
+
+	it "can overwrite lines" do
+		@input << "test #8a"
+		@input.rewind
+		@editor.read
+		@editor.overwrite_line("test #8b", 2)
+		@editor.line.text.should == "test #8b"
+		@editor.line.position.should == 2
+	end
+
+	it "can complete words" do
+		@editor.completion_append_string = "\t"
+		@editor.bind(:tab) { @editor.complete }
+		@editor.completion_proc = lambda do |word|
+	  	if word then
+ 				['select', 'update', 'delete', 'debug', 'destroy'].find_all	{ |e| e.match(/^#{Regexp.escape(word)}/) }
+			end
+		end
+		@input << "test #9 de" << ?\t.chr << ?\t.chr
+		@input.rewind
+		@editor.read
+		@editor.line.text.should == "test #9 delete\t"
+	end
+
+	it "supports INSERT and REPLACE modes" do
+		@input << "test 0" 
+		@editor.terminal.keys[:left_arrow].each { |k| @input << k.chr }
+		@input << "#1"
+		@input.rewind
+		@editor.read
+		@editor.line.text.should == "test #10"
+		@editor.toggle_mode
+		@input << "test 0" 
+		@editor.terminal.keys[:left_arrow].each { |k| @input << k.chr }
+		@input << "#1"
+		@input.rewind
+		@editor.read
+		@editor.line.text.should == "test #1test #1"
+	end
+	
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rawline
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Fabio Cevasco
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-01 00:00:00 +01:00
+date: 2009-03-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,8 +43,10 @@ files:
 - lib/rawline/terminal/windows_terminal.rb
 - lib/rawline/terminal/vt220_terminal.rb
 - examples/readline_emulation.rb
+- examples/rawline_rush.rb
 - examples/key_tester.rb
 - examples/rawline_shell.rb
+- examples/rawline_irb.rb
 - spec/history_buffer_spec.rb
 - spec/line_spec.rb
 - spec/rawline_spec.rb