linen 0.6.4 → 0.7.0

data/lib/linen.rb

@@ -18,8 +18,8 @@ require 'string_extensions'
 
 
 module Linen
-	VERSION = "0.6.4"
-	SVNRev  = %q$Rev: 223 $
+	VERSION = "0.7.0"
+	SVNRev  = %q$Rev: 231 $
 
 
 	def self::plugins

data/lib/linen/argument.rb

@@ -13,7 +13,7 @@ class Linen::Plugin::Argument
 	def initialize( plugin, name, opts )
 		@plugin  = plugin
 		@name    = name
-		@prompt  = opts[ :prompt  ] || "Please enter the value for #{@name}"
+		@prompt  = opts[ :prompt  ] || "Please enter the value for #{@name}: "
 		@regex   = opts[ :regex   ] || //
 		@process = opts[ :process ] || nil
 	end
@@ -32,7 +32,7 @@ class Linen::Plugin::Argument
 			end
 		end
 		
-		raise Linen::Plugin::ArgumentError, "Invalid entry." unless value =~ @regex
+		raise Linen::Plugin::ArgumentError, "The value entered ('#{value}') is not a valid #{@name}." unless value =~ @regex
 		return value unless @process
 
 		begin

data/lib/linen/exceptions.rb

@@ -40,3 +40,5 @@ end
 
 class Linen::WorkspaceError < RuntimeError ; end
 class Linen::HandlerError   < RuntimeError ; end
+
+class Linen::Abort < RuntimeError ; end

data/lib/linen/handler.rb

@@ -8,10 +8,17 @@
 ##############################################################
 
 class Linen::Handler
-	# placeholder.  This will eventually become the abstract
-	# class from which all handlers inherit.
-	
-	def self::say( input )
+	def self::say( input = '' )
 		raise NotImplementedError, "You must override say() in the handler"
 	end
+	
+	
+	def self::die( input = '' )
+		raise NotImplementedError, "You must override die() in the handler"
+	end
+	
+	
+	def self::history
+		raise NotImplementedError, "Handlers must provide a #history method that quacks like an Array"
+	end
 end

data/lib/linen/handlers/cli.rb

@@ -55,6 +55,10 @@ class Linen::CLI < Linen::Handler
 			end
 		elsif plugin.nil? or command.nil?
 			puts "You must enter both a plugin name and a command."
+		elsif Linen.plugins[ plugin ].nil?
+			puts "Plugin '#{plugin}' not found."
+		elsif Linen.plugins[ plugin ].commands[ command ].nil?
+			puts "Command '#{command}' not found in '#{plugin}' plugin."
 		else
 			plugin, command, *args = canonicalize( input ).split
 
@@ -68,26 +72,43 @@ class Linen::CLI < Linen::Handler
 
 	def self::start
 		loop do
+			input = nil
+
 			begin
 				input = Readline.readline( @prompt )
-			rescue Interrupt
-				puts "\nPlease type 'quit' or 'exit' to quit."
-			else
 				parse_command input
+			rescue Interrupt
+				if input
+					puts "\nCommand aborted."
+				else
+					puts "\nPlease type 'quit' or 'exit' to quit."
+				end
+			rescue Linen::Plugin::ArgumentError => e
+				puts e.message
 			end
 
 			puts # blank line to clean things up
 		end
 	end
+	
+	
+	def self::history
+		return Readline::HISTORY
+	end
 
 
 	#######
 	private
 	#######
 	
-	def self::say( input = "" )
+	def self::say( input = '' )
 		puts input.wrap
 	end
+	
+	
+	def self::die( input = '' )
+		raise Linen::Abort, input
+	end
 
 
 	def self::canonicalize( input )
@@ -207,7 +228,7 @@ END
 	end
 
 
-	def self::reprompt( prompt = "Re-enter: " )
+	def self::prompt( prompt = "Re-enter: " )
 		old_completion_proc = Readline.completion_proc
 		Readline.completion_proc = proc {}
 

data/lib/linen/plugin.rb

@@ -104,4 +104,13 @@ class Linen::Plugin
 
 		@description = input
 	end
+	
+	
+	### give validation a way to fail without explicitly raising
+	### an exception in the lambda
+	def self::fail( input = nil )
+		input ||= "Validation failed."
+
+		raise Linen::Plugin::ArgumentError, input
+	end
 end

data/lib/linen/simple_command.rb

@@ -113,37 +113,35 @@ class Linen::Plugin::SimpleCommand
 		@require_confirmation
 	end
 
-	###########
-	private #
-	###########
+	#######
+	private
+	#######
 
 	### FIXME:bbleything
 	###
-	### The reprompting stuff below is going to come back to bite us when we try to
-	### add batch mode later... that said, in the interest of getting things out the
-	### door, we're going to leave it be for now.
+	### Much of the reprompting stuff is gone, it only exists now to allow us to
+	### prompt when users don't enter anything.  We should consider moving the 
+	### argument fetching into a separate phase of execution, so as to prevent
+	### the ridiculous duplication of history-manipulation code in the following
+	### two methods (and generally make it clearer how the whole thing works), but
+	### that's probably not going to make it into 0.7.0.
 
 	def validate_one_of_arguments( arg )
 		results = IndifferentHash.new
-
-		begin
-			@arguments.each do |arg_name|
-				argument = @plugin.arguments[ arg_name ]
-
-				results[ arg_name ] = argument.process( arg ) rescue nil
-			end
-
-			raise Linen::Plugin::ArgumentError,
-				"The value you entered ('#{arg}') is invalid for all arguments." if
-					results.values.compact.empty?
-		rescue Linen::Plugin::ArgumentError => e
-			puts e.message
-			arg = Linen::CLI.reprompt.split.first
-
-			retry
+		
+		# put the argument onto the command history if it wasn't already there
+		command_line = Linen::Workspace.handler.history.pop.strip
+		command_line << " #{arg}" unless command_line =~ /#{arg}$/
+		Linen::Workspace.handler.history.push command_line.squeeze( ' ' ).strip
+		
+		@arguments.each do |arg_name|
+			argument = @plugin.arguments[ arg_name ]
+			results[ arg_name ] = argument.process( arg ) rescue nil
 		end
-
-		return results
+		
+		raise Linen::Plugin::ArgumentError,
+			"The value you entered ('#{arg}') is invalid for all arguments." if
+				results.values.compact.empty?
 	end
 
 
@@ -152,20 +150,17 @@ class Linen::Plugin::SimpleCommand
 
 		@arguments.each do |arg_name|
 			argument  = @plugin.arguments[ arg_name ]
+			
+			# prompt if we don't have the arg on the stack already
 			arg_value = args.shift
-
-			begin
-				arg_value = Linen::CLI.reprompt( argument.prompt ) if arg_value.nil?
-
-				results[ arg_name ] = argument.process( arg_value )
-			rescue Linen::Plugin::ArgumentError => e
-				puts e.message
-
-				# reset arg_value to nil so we get prompted on retry
-				arg_value = nil
-
-				retry
-			end
+			arg_value ||= Linen::Workspace.handler.prompt( argument.prompt )
+			
+			# put the arg value back onto the command line
+			command_line = Linen::Workspace.handler.history.pop
+			command_line << " #{arg_value}" unless command_line =~ /#{arg_value}$/
+			Linen::Workspace.handler.history.push command_line.squeeze( ' ' ).strip
+			
+			results[ arg_name ] = argument.process( arg_value )
 		end
 
 		return results

data/lib/linen/two_phase_command.rb

@@ -45,37 +45,6 @@ class Linen::Plugin::TwoPhaseCommand
 	# PLUGIN DEFINITION METHODS #
 	#############################
 
-
-	# def one_of( *args )
-	# 	raise Linen::Plugin::ArgumentError,
-	# 		"You may not specify both required and one_of arguments" if @argument_type == :required
-	# 
-	# 	@argument_type = :one_of
-	# 
-	# 	args.each do |arg|
-	# 		raise Linen::Plugin::ArgumentError,
-	# 			"Argument '#{arg}' has not been defined" unless @plugin.arguments.include? arg
-	# 
-	# 		@arguments << arg
-	# 	end
-	# end
-	# 
-	# 
-	# def required_arguments( *args )
-	# 	raise Linen::Plugin::ArgumentError,
-	# 		"You may not specify both required and one_of arguments" if @argument_type == :one_of
-	# 
-	# 	@argument_type = :required
-	# 
-	# 	args.each do |arg|
-	# 		raise Linen::Plugin::ArgumentError,
-	# 			"Argument '#{arg}' has not been defined" unless @plugin.arguments.include? arg
-	# 
-	# 		@arguments << arg
-	# 	end
-	# end
-	# alias required_argument required_arguments
-
 	def lookup_by( attr_name, &block )
 		@lookup_attr  = attr_name
 		@lookup_block = block
@@ -121,27 +90,21 @@ class Linen::Plugin::TwoPhaseCommand
 		argument  = @plugin.arguments[ @lookup_attr ]
 		arg_value = input
 		
-		begin
-			arg_value = Linen::CLI.reprompt( argument.prompt ) if arg_value.nil?
-
-			processed_argument = argument.process( arg_value )
+		# prompt if we didn't get an arg value
+		arg_value ||= Linen::CLI.prompt( argument.prompt )
 
-			results[ @lookup_attr ] = @lookup_block.call( processed_argument )
-		rescue Linen::Plugin::ArgumentError => e
-			# reset arg_value to nil so we get prompted on retry
-			arg_value = nil
-			
-			retry
-		end
+		# put the command back onto the history
+		command_line = Linen::Workspace.handler.history.pop
+		command_line << " #{arg_value}" unless command_line =~ /#{arg_value}$/
+		Linen::Workspace.handler.history.push command_line.squeeze( ' ' ).strip
+		
+		processed_argument = argument.process( arg_value )
+		results[ @lookup_attr ] = @lookup_block.call( processed_argument )
 
 		return results
 	end
-	
-	### FIXME:bbleything
-	###
-	### The reprompting stuff below is going to come back to bite us when we try to
-	### add batch mode later... that said, in the interest of getting things out the
-	### door, we're going to leave it be for now.
+
+
 	def validate_arguments( args )
 		results = IndifferentHash.new
 		
@@ -150,7 +113,7 @@ class Linen::Plugin::TwoPhaseCommand
 			arg_value = args.shift
 			
 			begin
-				arg_value = Linen::CLI.reprompt( argument.prompt ) if arg_value.nil?
+				arg_value = Linen::CLI.prompt( argument.prompt ) if arg_value.nil?
 
 				result = argument.process( arg_value, :mode => :edit )
 				
@@ -162,6 +125,8 @@ class Linen::Plugin::TwoPhaseCommand
 					results[ arg_name ] = result
 				end
 			rescue Linen::Plugin::ArgumentError => e
+				puts e.message
+
 				# reset arg_value to nil so we get prompted on retry
 				arg_value = nil ; retry
 			end

data/lib/linen/workspace.rb

@@ -38,4 +38,8 @@ class Linen::Workspace
 	def method_missing( *args )
 		@@handler.send( *args )
 	end
+	
+	def self::handler
+		return @@handler
+	end
 end

data/lib/string_extensions.rb

@@ -9,7 +9,7 @@
 
 class String
 	def wrap(line_width = 72)
-		self.gsub(/\n/, "\n\n").gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
+		self.gsub(/\n/, "\n\n").gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").chomp
 	end
 end
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: linen
 version: !ruby/object:Gem::Version 
-  version: 0.6.4
+  version: 0.7.0
 date: 2007-09-10 00:00:00 -07:00
 summary: Linen - A pluggable command-line interface library
 require_paths: