rawline 0.3.0 → 0.3.1

data/lib/rawline/history_buffer.rb

@@ -1,134 +1,134 @@
-#!usr/bin/env ruby
-
-#
-#	history_buffer.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.
-#
-#
-#
-module RawLine
-
-	# 
-	# The HistoryBuffer class is used to hold the editor and line histories, as well
-	# as word completion matches.
-	#
-	class HistoryBuffer < Array
-
-		attr_reader :position, :size
-		attr_accessor :duplicates, :exclude, :cycle
-
-		undef <<
-
-		#
-		# Create an instance of RawLine::HistoryBuffer. 
-		# This method takes an optional block used to override the 
-		# following instance attributes:
-		# * <tt>@duplicates</tt> - whether or not duplicate items will be stored in the buffer.
-		# * <tt>@exclude</tt> - a Proc object defining exclusion rules to prevent items from being added to the buffer.
-		# * <tt>@cycle</tt> - Whether or not the buffer is cyclic.
-		#
-		def initialize(size)
-			@duplicates = true
-			@exclude = lambda{|a|}
-			@cycle = false
-			yield self if block_given?
-			@size = size
-			@position = nil
-		end
-
-		#
-		# Resize the buffer, resetting <tt>@position</tt> to nil.
-		#
-		def resize(new_size)
-			if new_size < @size
-				@size-new_size.times { pop }
-			end
-			@size = new_size
-			@position = nil 
-		end
-		
-		# 
-		# Clear the content of the buffer and reset <tt>@position</tt> to nil.
-		#
-		def empty
-			@position = nil 
-			clear
-		end
-
-		# 
-		# Retrieve the element at <tt>@position</tt>.
-		#
-		def get
-			return nil unless length > 0
-			@position = length-1 unless @position
-			at @position
-		end
-
-		# 
-		# Return true if <tt>@position</tt> is at the end of the buffer.
-		#
-		def end?
-			@position == length-1
-		end
-
-		# 
-		# Return true if <tt>@position</tt> is at the start of the buffer.
-		#
-		def start?
-			@position == 0
-		end
-
-		#
-		# Decrement <tt>@position</tt>.
-		#
-		def back
-			return nil unless length > 0
-			case @position
-			when nil then
-				@position = length-1
-			when 0 then
-			 	@position = length-1 if @cycle
-			else 
-				@position -= 1
-			end
-		end
-
-		#
-		# Increment <tt>@position</tt>.
-		#
-		def forward
-			return nil unless length > 0
-			case @position
-			when nil then
-				@position = length-1
-			when length-1 then
-			 	@position = 0 if @cycle
-			else 
-				@position += 1
-			end
-		end
-
-		# 
-		# Add a new item to the buffer.
-		#
-		def <<(item)
-			delete(item) unless @duplicates
-			unless @exclude.call(item)
-				# Remove the oldest element if size is exceeded
-				if @size <= length
-					reverse!.pop 
-					reverse!
-				end
-				# Add the new item and reset the position
-				push(item)
-				@position = nil 
-			end
-		end
-
-	end
-
-end
+#!usr/bin/env ruby
+
+#
+#	history_buffer.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.
+#
+#
+#
+module RawLine
+
+	# 
+	# The HistoryBuffer class is used to hold the editor and line histories, as well
+	# as word completion matches.
+	#
+	class HistoryBuffer < Array
+
+		attr_reader :position, :size
+		attr_accessor :duplicates, :exclude, :cycle
+
+		#
+		# Create an instance of RawLine::HistoryBuffer. 
+		# This method takes an optional block used to override the 
+		# following instance attributes:
+		# * <tt>@duplicates</tt> - whether or not duplicate items will be stored in the buffer.
+		# * <tt>@exclude</tt> - a Proc object defining exclusion rules to prevent items from being added to the buffer.
+		# * <tt>@cycle</tt> - Whether or not the buffer is cyclic.
+		#
+		def initialize(size)
+			@duplicates = true
+			@exclude = lambda{|a|}
+			@cycle = false
+			yield self if block_given?
+			@size = size
+			@position = nil
+		end
+
+		#
+		# Resize the buffer, resetting <tt>@position</tt> to nil.
+		#
+		def resize(new_size)
+			if new_size < @size
+				@size-new_size.times { pop }
+			end
+			@size = new_size
+			@position = nil 
+		end
+		
+		# 
+		# Clear the content of the buffer and reset <tt>@position</tt> to nil.
+		#
+		def empty
+			@position = nil 
+			clear
+		end
+
+		# 
+		# Retrieve the element at <tt>@position</tt>.
+		#
+		def get
+			return nil unless length > 0
+			@position = length-1 unless @position
+			at @position
+		end
+
+		# 
+		# Return true if <tt>@position</tt> is at the end of the buffer.
+		#
+		def end?
+			@position == length-1
+		end
+
+		# 
+		# Return true if <tt>@position</tt> is at the start of the buffer.
+		#
+		def start?
+			@position == 0
+		end
+
+		#
+		# Decrement <tt>@position</tt>.
+		#
+		def back
+			return nil unless length > 0
+			case @position
+			when nil then
+				@position = length-1
+			when 0 then
+			 	@position = length-1 if @cycle
+			else 
+				@position -= 1
+			end
+		end
+
+		#
+		# Increment <tt>@position</tt>.
+		#
+		def forward
+			return nil unless length > 0
+			case @position
+			when nil then
+				@position = length-1
+			when length-1 then
+			 	@position = 0 if @cycle
+			else 
+				@position += 1
+			end
+		end
+
+		# 
+		# Add a new item to the buffer.
+		#
+		def push(item)
+			delete(item) unless @duplicates
+			unless @exclude.call(item)
+				# Remove the oldest element if size is exceeded
+				if @size <= length
+					reverse!.pop 
+					reverse!
+				end
+				# Add the new item and reset the position
+				super(item)
+				@position = nil 
+			end
+		end
+
+		alias << push
+
+	end
+
+end

data/lib/rawline/line.rb

@@ -1,168 +1,169 @@
-#!usr/bin/env ruby
-
-#
-#	line.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.
-#
-
-module RawLine
-	
-	# 
-	# The Line class is used to represent the current line being processed and edited
-	# by RawLine::Editor. It keeps track of the characters typed, the cursor position, 
-	# the current word and maintains an internal history to allow undos and redos.
-	#
-	class Line
-
-		attr_accessor :text, :position, :history, :prompt, :history_size, :word_separator
-		attr_reader :offset
-
-		include HighLine::SystemExtensions
-
-		# 
-		# Create an instance of RawLine::Line.
-		# This method takes an optional block used to override the 
-		# following instance attributes:
-		# * <tt>@text</tt> - the line text.
-		# * <tt>@history_size</tt> - the size of the line history buffer.
-		# * <tt>@position</tt> - the current cursor position within the line.
-		# * <tt>@prompt</tt> - a prompt to prepend to the line text.
-		#
-		def initialize(history_size)
-			@text = ""
-			@history_size = history_size
-			@position = 0
-			@prompt = ""
-			@word_separator = ' '
-			yield self if block_given?
-			@history = RawLine::HistoryBuffer.new(@history_size)
-			@history << "" # Add empty line for complete undo...
-			@offset = @prompt.length
-		end
-
-		# 
-		# Return the maximum line length. By default, it corresponds to the terminal's 
-		# width minus the length of the line prompt.
-		#
-		def max_length
-			terminal_size[0]-@offset
-		end
-
-		# 
-		# Return information about the current word, as a Hash composed by the following
-		# elements:
-		# * <tt>:start</tt>: The position in the line corresponding to the word start
-		# * <tt>:end</tt>: The position in the line corresponding to the word end
-		# * <tt>:text</tt>: The word text.
-		def word
-			last = @text.index(@word_separator, @position)
-			first = @text.rindex(@word_separator, @position)
-			# Trim word separators and handle EOL and BOL
-			if first then
-			 	first +=1 
-			else 
-				first = bol
-			end
-			if last then
-			 	last -=1 
-			else 
-				last = eol+1 unless last
-			end
-			# Swap if overlapping
-			last, first = first, last if last < first
-			text = @text[first..last]
-			# Repeat the search if within word separator
-			if text.match @word_separator then
-				last = first
-				first = @text.rindex(@word_separator, first)
-			 	if first then first+=1
-				else first =	bol 
-				end
-				text = @text[first..last]
-			end
-			{:start => first, :end => last, :text => text}
-		end
-
-		#
-		# Return an array containing the words present in the current line
-		#
-		def words
-			@text.split @word_separator
-		end
-
-		# 
-		# Return the position corresponding to the beginning of the line.
-		#
-		def bol
-		 0	
-		end
-
-		# 
-		# Return true if the cursor is at the beginning of the line.
-		#
-		def bol?
-			@position<=bol
-		end
-		
-		# 
-		# Return the position corresponding to the end of the line.
-		#
-		def eol
-			@text.length-1
-		end
-
-		# 
-		# Return true if the cursor is at the end of the line.
-		#
-		def eol?
-			@position>=eol
-		end
-
-		# 
-		# Decrement the line position by <tt>offset</tt>
-		#
-		def left(offset=1)
-			@position = (@position-offset <= 0) ? 0 : @position-offset
-		end
-
-		# 
-		# Increment the line position by <tt>offset</tt>
-		#
-		def right(offset=1)
-			@position = (@position+offset >= max_length) ? max_length : @position+offset
-		end
-
-		# 
-		# Add a character (expressed as a character code) to the line text.
-		#
-		def <<(char)
-			@text << char.chr
-		end
-
-		#
-		# Access the line text at <tt>@index</tt>
-		#
-		def [](index)
-			@text[index]
-		end
-
-		#
-		#  Modify the character(s) in the line text at <tt>@index</tt>
-		#
-		def []=(index, chars)
-			@text[index] = chars
-		end
-
-		#
-		# Return the length of the line text.
-		#
-		def length
-			@text.length
-		end
-
-	end
-end
+#!usr/bin/env ruby
+
+#
+#	line.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.
+#
+
+module RawLine
+	
+	# 
+	# The Line class is used to represent the current line being processed and edited
+	# by RawLine::Editor. It keeps track of the characters typed, the cursor position, 
+	# the current word and maintains an internal history to allow undos and redos.
+	#
+	class Line
+
+		attr_accessor :text, :position, :history, :prompt, :history_size, :word_separator
+		attr_reader :offset
+
+		include HighLine::SystemExtensions
+
+		# 
+		# Create an instance of RawLine::Line.
+		# This method takes an optional block used to override the 
+		# following instance attributes:
+		# * <tt>@text</tt> - the line text.
+		# * <tt>@history_size</tt> - the size of the line history buffer.
+		# * <tt>@position</tt> - the current cursor position within the line.
+		# * <tt>@prompt</tt> - a prompt to prepend to the line text.
+		#
+		def initialize(history_size)
+			@text = ""
+			@history_size = history_size
+			@position = 0
+			@prompt = ""
+			@word_separator = ' '
+			yield self if block_given?
+			@history = RawLine::HistoryBuffer.new(@history_size)
+			@history << "" # Add empty line for complete undo...
+			@offset = @prompt.length
+		end
+
+		# 
+		# Return the maximum line length. By default, it corresponds to the terminal's 
+		# width minus the length of the line prompt.
+		#
+		def max_length
+			terminal_size[0]-@offset
+		end
+
+		# 
+		# Return information about the current word, as a Hash composed by the following
+		# elements:
+		# * <tt>:start</tt>: The position in the line corresponding to the word start
+		# * <tt>:end</tt>: The position in the line corresponding to the word end
+		# * <tt>:text</tt>: The word text.
+		def word
+			return {:start => bol, :end => eol+1, :text => @text} if @word_separator.to_s == ''
+			last = @text.index(@word_separator, @position)
+			first = @text.rindex(@word_separator, @position)
+			# Trim word separators and handle EOL and BOL
+			if first then
+			 	first +=1 
+			else 
+				first = bol
+			end
+			if last then
+			 	last -=1 
+			else 
+				last = eol+1 unless last
+			end
+			# Swap if overlapping
+			last, first = first, last if last < first
+			text = @text[first..last].to_s
+			# Repeat the search if within word separator
+			if text.match @word_separator then
+				last = first
+				first = @text.rindex(@word_separator, first)
+			 	if first then first+=1
+				else first =	bol 
+				end
+				text = @text[first..last]
+			end
+			{:start => first, :end => last, :text => text}
+		end
+
+		#
+		# Return an array containing the words present in the current line
+		#
+		def words
+			@text.split @word_separator
+		end
+
+		# 
+		# Return the position corresponding to the beginning of the line.
+		#
+		def bol
+		 0	
+		end
+
+		# 
+		# Return true if the cursor is at the beginning of the line.
+		#
+		def bol?
+			@position<=bol
+		end
+		
+		# 
+		# Return the position corresponding to the end of the line.
+		#
+		def eol
+			@text.length-1
+		end
+
+		# 
+		# Return true if the cursor is at the end of the line.
+		#
+		def eol?
+			@position>=eol
+		end
+
+		# 
+		# Decrement the line position by <tt>offset</tt>
+		#
+		def left(offset=1)
+			@position = (@position-offset <= 0) ? 0 : @position-offset
+		end
+
+		# 
+		# Increment the line position by <tt>offset</tt>
+		#
+		def right(offset=1)
+			@position = (@position+offset >= max_length) ? max_length : @position+offset
+		end
+
+		# 
+		# Add a character (expressed as a character code) to the line text.
+		#
+		def <<(char)
+			@text << char.chr
+		end
+
+		#
+		# Access the line text at <tt>@index</tt>
+		#
+		def [](index)
+			@text[index]
+		end
+
+		#
+		#  Modify the character(s) in the line text at <tt>@index</tt>
+		#
+		def []=(index, chars)
+			@text[index] = chars
+		end
+
+		#
+		# Return the length of the line text.
+		#
+		def length
+			@text.length
+		end
+
+	end
+end