highline 0.4.0 → 0.5.0

data/CHANGELOG

@@ -2,6 +2,22 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+== 0.5.0
+
+* Implemented <tt>echo = false</tt> for HighLine::Question objects, primarily to
+  make fetching passwords trivial.
+* Fixed an auto-complete bug that could cause a crash when the user gave an
+  answer that didn't complete to any valid choice.
+* Implemented +case+ for HighLine::Question objects to provide character case 
+  conversions on given answers.  Can be set to <tt>:up</tt>, <tt>:down</tt>, or
+  <tt>:capitalize</tt>.
+* Exposed <tt>@answer</tt> to the response system, to allow response that are
+  aware of incorrect input.
+* Implemented +confirm+ for HighLine::Question objects to allow for verification
+  for sensitive user choices.  If set to +true+, user will have to answer an
+  "Are you sure?  " question.  Can also be set to the question to confirm with
+  the user.
+
 == 0.4.0
 
 * Added <tt>@wrap_at</tt> and <tt>@page_at</tt> settings and accessors to

data/Rakefile

@@ -28,7 +28,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = "highline"
-	spec.version = "0.4.0"
+	spec.version = "0.5.0"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "HighLine is a high-level line oriented console interface."
 	spec.files = Dir.glob("{examples,lib,test}/**/*.rb").

data/TODO

@@ -6,6 +6,6 @@ order.
 * Support <tt>ask(..., Array)</tt>, better than the current
   <tt>ask(..., lambda { |arr| arr.split(",") })</tt> or similar.
 * Support <tt>ask(..., Hash)</tt>.
+* Support <tt>ask(..., File)</tt>.
 * Implement choose() for simple menu handling.
-* Provide a +no_echo+ option, for password requests.
-* Add an "Are you sure?" check for ask().
+* Add readline support for history and editing.

data/examples/basic_usage.rb

@@ -40,7 +40,10 @@ begin
 	entry[:company]     = ask("Company?  ") { |q| q.default = "none" }
 	entry[:address]     = ask("Address?  ")
 	entry[:city]        = ask("City?  ")
-	entry[:state]       = ask("State?  ") { |q| q.validate = /\A[A-Z]{2}\Z/ }
+	entry[:state]       = ask("State?  ") do |q|
+		q.case     = :up
+		q.validate = /\A[A-Z]{2}\Z/
+	end
 	entry[:zip]         = ask("Zip?  ") do |q|
 		q.validate = /\A\d{5}(?:-?\d{4})?\Z/
 	end
@@ -64,6 +67,9 @@ begin
 end while agree("Enter another contact?  ", true)
 
 if agree("Save these contacts?  ", true)
-	file_name = ask("Enter a file name:  ") { |q| q.validate = /\A\w+\Z/ }
+	file_name = ask("Enter a file name:  ") do |q|
+		q.validate = /\A\w+\Z/
+		q.confirm  = true
+	end
 	File.open("#{file_name}.yaml", "w") { |file| YAML.dump(contacts, file) }
 end

data/examples/menus.rb

@@ -0,0 +1,16 @@
+#!/usr/local/bin/ruby -w
+
+require "rubygems"
+require "highline/import"
+
+choices = %w{ruby python perl}
+
+say("Please choose your favorite programming language:")
+say(choices.map { |c| "  #{c}\n" }.join)
+
+case ask("?  ", choices)
+when "ruby"
+	say("Good choice!")
+else
+	say("Not from around here, are you?")
+end

data/examples/password.rb

@@ -0,0 +1,7 @@
+#!/usr/local/bin/ruby -w
+
+require "rubygems"
+require "highline/import"
+
+pass = ask("Enter your password:  ") { |q| q.echo = false }
+puts "Your password is #{pass}!"

data/lib/highline.rb

@@ -132,16 +132,35 @@ class HighLine
 		
 		say(@question)
 		begin
-			answer = @question.answer_or_default(get_response )
-			unless @question.valid_answer?(answer)
+			@answer = @question.answer_or_default(get_response)
+			unless @question.valid_answer?(@answer)
 				explain_error(:not_valid)
 				raise QuestionError
 			end
 			
-			answer = @question.convert(answer)
+			@answer = @question.convert(@answer)
 			
-			if @question.in_range?(answer)
-				answer
+			if @question.in_range?(@answer)
+				if @question.confirm
+					# need to add a layer of scope to ask a question inside a
+					# question, without destroying instance data
+					context_change = self.class.new( @input, @output,
+					                                 @wrap_at, @page_at )
+					if @question.confirm == true
+						confirm_question = "Are you sure?  "
+					else
+						# evaluate ERb under initial scope, so it will have
+						# access to @question and @answer
+						template  = ERB.new(@question.confirm, nil, "%")
+						confirm_question = template.result(binding)
+					end
+					unless context_change.agree(confirm_question)
+						explain_error(nil)
+						raise QuestionError
+					end
+				end
+				
+				@answer
 			else
 				explain_error(:not_in_range)
 				raise QuestionError
@@ -212,7 +231,7 @@ class HighLine
 	# of the question.
 	#
 	def explain_error( error )
-		say(@question.responses[error])
+		say(@question.responses[error]) unless error.nil?
 		if @question.responses[:ask_on_error] == :question
 			say(@question)
 		elsif @question.responses[:ask_on_error]
@@ -251,7 +270,7 @@ class HighLine
 	# requested by the Question object.
 	#
 	def get_line(  )
-		@question.remove_whitespace(@input.gets)
+		@question.change_case(@question.remove_whitespace(@input.gets))
 	end
 	
 	#
@@ -261,13 +280,24 @@ class HighLine
 	#
 	def get_response(  )
 		if @question.character.nil?
-			get_line
+			if @question.echo
+				get_line
+			else
+				line = ""
+				while character = get_character
+					line << character.chr
+					
+					break if character == 13
+				end
+				say("\n")
+				@question.change_case(@question.remove_whitespace(line))
+			end
 		elsif @question.character == :getc
-			@input.getc.chr
+			@question.change_case(@input.getc.chr)
 		else
 			response = get_character.chr
-			say("#{response}\n")
-			response
+			 say("#{if @question.echo then response else '' end}\n")
+			@question.change_case(response)
 		end
 	end
 	

data/lib/highline/question.rb

@@ -29,12 +29,15 @@ class HighLine
 			@answer_type = answer_type
 			
 			@character    = nil
+			@echo         = true
 			@whitespace   = :strip
+			@case         = nil
 			@default      = nil
 			@validate     = nil
 			@above        = nil
 			@below        = nil
 			@in           = nil
+			@confirm      = nil
 			@responses    = Hash.new
 			
 			# allow block to override settings
@@ -67,10 +70,23 @@ class HighLine
 		# 
 		attr_accessor :character
 		#
+		# Can be set to +true+ or +false+ to control whether or not input will
+		# be echoed back to the user.
+		# 
+		# This requires HighLine's character reader.  See the _character_
+		# attribute for details.
+		#
+		attr_accessor :echo
+		#
 		# Used to control whitespace processing for the answer to this question.
 		# See HighLine::Question.remove_whitespace() for acceptable settings.
 		#
 		attr_accessor :whitespace
+		#
+		# Used to control whitespace processing for the answer to this question.
+		# See HighLine::Question.change_case() for acceptable settings.
+		#
+		attr_accessor :case
 		# Used to provide a default answer to this question.
 		attr_accessor :default
 		#
@@ -84,6 +100,14 @@ class HighLine
 		# If set, answer must pass an include?() check on this object.
 		attr_accessor :in
 		#
+		# Asks a yes or no confirmation question, to ensure a user knows what
+		# they have just agreed to.  If set to +true+ the question will be,
+		# "Are you sure?  "  Any other true value for this attribute is assumed
+		# to be the question to ask.  When +false+ or +nil+ (the default), 
+		# answers are not confirmed.
+		# 
+		attr_accessor :confirm
+		#
 		# A Hash that stores the various responses used by HighLine to notify
 		# the user.  The currently used responses and their purpose are as
 		# follows:
@@ -117,6 +141,32 @@ class HighLine
 				answer_string
 			end
 		end
+		
+		#
+		# Returns the provided _answer_string_ after changing character case by
+		# the rules of this Question.  Valid settings for whitespace are:
+		#
+		# +nil+::                        Do not alter character case. 
+		#                                (Default.)
+		# <tt>:up</tt>::                 Calls upcase().
+		# <tt>:upcase</tt>::             Calls upcase().
+		# <tt>:down</tt>::               Calls downcase().
+		# <tt>:downcase</tt>::           Calls downcase().
+		# <tt>:capitalize</tt>::         Calls capitalize().
+		# 
+		# An unrecognized choice (like <tt>:none</tt>) is treated as +nil+.
+		# 
+		def change_case( answer_string )
+			if [:up, :upcase].include?(@case)
+				answer_string.upcase
+			elsif [:down, :downcase].include?(@case)
+				answer_string.downcase
+			elsif @case == :capitalize
+				answer_string.capitalize
+			else
+				answer_string
+			end
+		end
 
 		#
 		# Transforms the given _answer_string_ into the expected type for this
@@ -153,7 +203,11 @@ class HighLine
 			elsif @answer_type.is_a?(Array)
 				# cheating, using OptionParser's Completion module
 				@answer_type.extend(OptionParser::Completion)
-				@answer_type.complete(answer_string).last
+				answer = @answer_type.complete(answer_string)
+				if answer.nil?
+					raise ArgumentError, "Not matching auto-complete choice."
+				end
+				answer.last
 			elsif [Date, DateTime].include?(@answer_type) or
 			      @answer_type.is_a?(Class)
 				@answer_type.parse(answer_string)
@@ -207,6 +261,8 @@ class HighLine
 		# 
 		# An unrecognized choice (like <tt>:none</tt>) is treated as +nil+.
 		# 
+		# This process is skipped, for single character input.
+		# 
 		def remove_whitespace( answer_string )
 			if @whitespace.nil?
 				answer_string
@@ -233,6 +289,9 @@ class HighLine
 		#
 		# Returns +true+ if the provided _answer_string_ is accepted by the 
 		# _validate_ attribute or +false+ if it's not.
+		# 
+		# It's important to realize that an answer is validated after whitespace
+		# and case handling.
 		#
 		def valid_answer?( answer_string )
 			@validate.nil? or 

data/test/tc_highline.rb

@@ -44,6 +44,46 @@ class TestHighLine < Test::Unit::TestCase
 		assert_equal(name, @terminal.ask("What is your name?  "))
 	end
 	
+	def test_bug_fixes
+		# auto-complete bug
+		@input << "ruby\nRuby\n"
+		@input.rewind
+
+		languages = [:Perl, :Python, :Ruby]
+		answer = @terminal.ask( "What is your favorite programming language?  ",
+		                        languages )
+		assert_equal(languages.last, answer)
+
+		@input.truncate(@input.rewind)
+		@input << "ruby\n"
+		@input.rewind
+
+		answer = @terminal.ask( "What is your favorite programming language?  ",
+		                        languages ) do |q|
+			q.case = :capitalize
+		end
+		assert_equal(languages.last, answer)
+	end
+	
+	def test_case_changes
+		@input << "jeg2\n"
+		@input.rewind
+
+		answer = @terminal.ask("Enter your initials  ") do |q|
+			q.case = :up
+		end
+		assert_equal("JEG2", answer)
+
+		@input.truncate(@input.rewind)
+		@input << "cRaZY\n"
+		@input.rewind
+
+		answer = @terminal.ask("Enter a search string:  ") do |q|
+			q.case = :down
+		end
+		assert_equal("crazy", answer)
+	end
+	
 	def test_character_reading
 		# WARNING:  This method does NOT cover Unix and Windows savvy testing!
 		@input << "12345"
@@ -79,6 +119,35 @@ class TestHighLine < Test::Unit::TestCase
                       @output.string )
 	end
 	
+	def test_confirm
+		@input << "junk.txt\nno\nsave.txt\ny\n"
+		@input.rewind
+
+		answer = @terminal.ask("Enter a filename:  ") do |q|
+			q.confirm = "Are you sure you want to overwrite <%= @answer %>?  "
+			q.responses[:ask_on_error] = :question
+		end
+		assert_equal("save.txt", answer)
+		assert_equal( "Enter a filename:  " +
+		              "Are you sure you want to overwrite junk.txt?  " +
+		              "Enter a filename:  " +
+		              "Are you sure you want to overwrite save.txt?  ",
+		              @output.string )
+
+		@input.truncate(@input.rewind)
+		@input << "junk.txt\nyes\nsave.txt\nn\n"
+		@input.rewind
+		@output.truncate(@output.rewind)
+
+		answer = @terminal.ask("Enter a filename:  ") do |q|
+			q.confirm = "Are you sure you want to overwrite <%= @answer %>?  "
+		end
+		assert_equal("junk.txt", answer)
+		assert_equal( "Enter a filename:  " +
+		              "Are you sure you want to overwrite junk.txt?  ",
+		              @output.string )
+	end
+	
 	def test_defaults
 		@input << "\nNo Comment\n"
 		@input.rewind
@@ -159,6 +228,28 @@ class TestHighLine < Test::Unit::TestCase
 		assert_equal("Edward", answer.middle)
 	end
 	
+	def test_no_echo
+		@input << "password\r"
+		@input.rewind
+
+		answer = @terminal.ask("Please enter your password:  ") do |q|
+			q.echo = false
+		end
+		assert_equal("password", answer)
+		assert_equal("Please enter your password:  \n", @output.string)
+
+		@input.rewind
+		@output.truncate(@output.rewind)
+		
+		answer = @terminal.ask("Pick a letter or number:  ") do |q|
+			q.character = true
+			q.echo      = false
+		end
+		assert_equal("p", answer)
+		assert_equal("a", @input.getc.chr)
+		assert_equal("Pick a letter or number:  \n", @output.string)
+	end
+	
 	def test_paging
 		@terminal.page_at = 22
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: highline
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2005-05-07
+  version: 0.5.0
+date: 2005-05-09
 summary: HighLine is a high-level line oriented console interface.
 require_paths: 
   - lib
@@ -31,7 +31,9 @@ authors:
 files: 
   - examples/ansi_colors.rb
   - examples/basic_usage.rb
+  - examples/menus.rb
   - examples/page_and_wrap.rb
+  - examples/password.rb
   - lib/highline.rb
   - lib/highline/import.rb
   - lib/highline/question.rb